Contentful

Contentful module for RobinPath.

Package: @robinpath/contentful | Category: Cms | Type: Integration

Authentication

contentful.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the contentful module when you need to:

• listEntries -- Use contentful.listEntries to perform this operation
• getEntry -- Use contentful.getEntry to perform this operation
• createEntry -- Use contentful.createEntry to perform this operation
• updateEntry -- Use contentful.updateEntry to perform this operation
• deleteEntry -- Use contentful.deleteEntry to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure contentful credentials.	object
listEntries	listEntries	object
getEntry	getEntry	object
createEntry	createEntry	object
updateEntry	updateEntry	object
deleteEntry	deleteEntry	object
publishEntry	publishEntry	object
unpublishEntry	unpublishEntry	object
listAssets	listAssets	object
getAsset	getAsset	object
createAsset	createAsset	object
publishAsset	publishAsset	object
listContentTypes	listContentTypes	object
getContentType	getContentType	object
createContentType	createContentType	object
listEnvironments	listEnvironments	object
getSpace	getSpace	object
searchEntries	searchEntries	object
listLocales	listLocales	object
getWebhooks	getWebhooks	object
archiveEntry	archiveEntry	object

Functions

setCredentials

Configure contentful credentials.

Module: contentful | Returns: object -- API response.

contentful.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken
spaceId	string	Yes	spaceId

---

listEntries

listEntries

Module: contentful | Returns: object -- API response.

contentful.listEntries

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getEntry

getEntry

Module: contentful | Returns: object -- API response.

contentful.getEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createEntry

createEntry

Module: contentful | Returns: object -- API response.

contentful.createEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateEntry

updateEntry

Module: contentful | Returns: object -- API response.

contentful.updateEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteEntry

deleteEntry

Module: contentful | Returns: object -- API response.

contentful.deleteEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

publishEntry

publishEntry

Module: contentful | Returns: object -- API response.

contentful.publishEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

unpublishEntry

unpublishEntry

Module: contentful | Returns: object -- API response.

contentful.unpublishEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listAssets

listAssets

Module: contentful | Returns: object -- API response.

contentful.listAssets

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAsset

getAsset

Module: contentful | Returns: object -- API response.

contentful.getAsset

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createAsset

createAsset

Module: contentful | Returns: object -- API response.

contentful.createAsset

Parameter	Type	Required	Description
input	string	No	Input parameter

---

publishAsset

publishAsset

Module: contentful | Returns: object -- API response.

contentful.publishAsset

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listContentTypes

listContentTypes

Module: contentful | Returns: object -- API response.

contentful.listContentTypes

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getContentType

getContentType

Module: contentful | Returns: object -- API response.

contentful.getContentType

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createContentType

createContentType

Module: contentful | Returns: object -- API response.

contentful.createContentType

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listEnvironments

listEnvironments

Module: contentful | Returns: object -- API response.

contentful.listEnvironments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSpace

getSpace

Module: contentful | Returns: object -- API response.

contentful.getSpace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchEntries

searchEntries

Module: contentful | Returns: object -- API response.

contentful.searchEntries

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listLocales

listLocales

Module: contentful | Returns: object -- API response.

contentful.listLocales

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getWebhooks

getWebhooks

Module: contentful | Returns: object -- API response.

contentful.getWebhooks

Parameter	Type	Required	Description
input	string	No	Input parameter

---

archiveEntry

archiveEntry

Module: contentful | Returns: object -- API response.

contentful.archiveEntry

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Contentful API error (${res.status}): ${t}	Check the error message for details
contentful.setCredentials requires accessToken, spaceId.	Check the error message for details
contentful.updateEntry requires an ID.	Check the error message for details
contentful.deleteEntry requires an ID.	Check the error message for details
contentful.publishEntry requires an ID.	Check the error message for details
contentful.unpublishEntry requires an ID.	Check the error message for details
contentful.publishAsset requires an ID.	Check the error message for details
contentful.archiveEntry requires an ID.	Check the error message for details

@desc "List entries and validate result"
do
  set $result as contentful.listEntries
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Entries

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "List entries and iterate results"
do
  set $result as contentful.listEntries
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createEntry

Create a new resource and capture the result.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "Create entry"
do
  set $result as contentful.createEntry
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "Create entry and update entry"
do
  set $created as contentful.createEntry
  # Update the created item
  contentful.updateEntry
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "List entries and create entry"
do
  set $existing as contentful.listEntries
  if $existing == null
    contentful.createEntry
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Contentful workflow

Chain multiple contentful operations together.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "List entries, get entry, and more"
do
  set $r_listEntries as contentful.listEntries
  set $r_getEntry as contentful.getEntry
  set $r_createEntry as contentful.createEntry
  print "All operations complete"
enddo

6. Safe listEntries with validation

Check results before proceeding.

@desc "Setup authentication"
do
  contentful.setCredentials $token
enddo

@desc "List entries and validate result"
do
  set $result as contentful.listEntries
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• json -- JSON module for complementary functionality