@datocms/cma-client/resources.json

JS client for DatoCMS REST Content Management API

[
  {
    "jsonApiType": "role",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/create",
        "rel": "create",
        "urlTemplate": "/roles",
        "method": "POST",
        "comment": "Create a new role",
        "urlPlaceholders": [],
        "requestBodyType": "RoleCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "role",
          "attributes": [
            "name",
            "can_edit_favicon",
            "can_edit_site",
            "can_edit_schema",
            "can_manage_menu",
            "can_edit_environment",
            "can_promote_environments",
            "environments_access",
            "can_manage_users",
            "can_manage_shared_filters",
            "can_manage_upload_collections",
            "can_manage_build_triggers",
            "can_manage_webhooks",
            "can_manage_environments",
            "can_manage_sso",
            "can_access_audit_log",
            "can_manage_workflows",
            "can_manage_access_tokens",
            "can_perform_site_search",
            "can_access_build_events_log",
            "positive_item_type_permissions",
            "negative_item_type_permissions",
            "positive_upload_permissions",
            "negative_upload_permissions",
            "positive_build_trigger_permissions",
            "negative_build_trigger_permissions"
          ],
          "relationships": ["inherits_permissions_from"]
        },
        "queryParamsRequired": false,
        "responseType": "RoleCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/update",
        "rel": "update",
        "urlTemplate": "/roles/${roleId}",
        "method": "PUT",
        "comment": "Update a role",
        "urlPlaceholders": [
          {
            "variableName": "roleId",
            "isEntityId": true,
            "relType": "RoleData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "roleId",
          "isEntityId": true,
          "relType": "RoleData"
        },
        "requestBodyType": "RoleUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "role",
          "idRequired": true,
          "attributes": [
            "name",
            "can_edit_favicon",
            "can_edit_site",
            "can_edit_schema",
            "can_manage_menu",
            "can_edit_environment",
            "can_promote_environments",
            "environments_access",
            "can_manage_users",
            "can_manage_shared_filters",
            "can_manage_upload_collections",
            "can_manage_build_triggers",
            "can_manage_webhooks",
            "can_manage_environments",
            "can_manage_sso",
            "can_access_audit_log",
            "can_manage_workflows",
            "can_manage_access_tokens",
            "can_perform_site_search",
            "can_access_build_events_log",
            "positive_item_type_permissions",
            "negative_item_type_permissions",
            "positive_upload_permissions",
            "negative_upload_permissions",
            "positive_build_trigger_permissions",
            "negative_build_trigger_permissions"
          ],
          "relationships": ["inherits_permissions_from"]
        },
        "queryParamsRequired": false,
        "responseType": "RoleUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/instances",
        "rel": "instances",
        "urlTemplate": "/roles",
        "method": "GET",
        "comment": "List all roles",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "RoleInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/self",
        "rel": "self",
        "urlTemplate": "/roles/${roleId}",
        "method": "GET",
        "comment": "Retrieve a role",
        "urlPlaceholders": [
          {
            "variableName": "roleId",
            "isEntityId": true,
            "relType": "RoleData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "roleId",
          "isEntityId": true,
          "relType": "RoleData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "RoleSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/destroy",
        "rel": "destroy",
        "urlTemplate": "/roles/${roleId}",
        "method": "DELETE",
        "comment": "Delete a role",
        "urlPlaceholders": [
          {
            "variableName": "roleId",
            "isEntityId": true,
            "relType": "RoleData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "roleId",
          "isEntityId": true,
          "relType": "RoleData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "RoleDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/role/duplicate",
        "rel": "duplicate",
        "urlTemplate": "/roles/${roleId}/duplicate",
        "method": "POST",
        "comment": "Duplicate a role",
        "urlPlaceholders": [
          {
            "variableName": "roleId",
            "isEntityId": true,
            "relType": "RoleData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "roleId",
          "isEntityId": true,
          "relType": "RoleData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "RoleDuplicateTargetSchema",
        "name": "duplicate",
        "rawName": "rawDuplicate"
      }
    ],
    "namespace": "roles",
    "resourceClassName": "Role"
  },
  {
    "jsonApiType": "user",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/update",
        "rel": "update",
        "urlTemplate": "/users/${userId}",
        "method": "PUT",
        "comment": "Update a collaborator",
        "urlPlaceholders": [
          {
            "variableName": "userId",
            "isEntityId": true,
            "relType": "UserData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "userId",
          "isEntityId": true,
          "relType": "UserData"
        },
        "requestBodyType": "UserUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "user",
          "idRequired": true,
          "attributes": ["is_active"],
          "relationships": ["role"]
        },
        "queryParamsRequired": false,
        "responseType": "UserUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/instances",
        "rel": "instances",
        "urlTemplate": "/users",
        "method": "GET",
        "comment": "List all collaborators",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "UserInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/self",
        "rel": "self",
        "urlTemplate": "/users/${userId}",
        "method": "GET",
        "comment": "Retrieve a collaborator",
        "urlPlaceholders": [
          {
            "variableName": "userId",
            "isEntityId": true,
            "relType": "UserData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "userId",
          "isEntityId": true,
          "relType": "UserData"
        },
        "optionalRequestBody": false,
        "queryParamsType": "UserSelfHrefSchema",
        "queryParamsRequired": false,
        "responseType": "UserSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/me",
        "rel": "me",
        "urlTemplate": "/users/me",
        "method": "GET",
        "comment": "Retrieve current signed-in user",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsType": "UserMeHrefSchema",
        "queryParamsRequired": false,
        "responseType": "UserMeTargetSchema",
        "name": "findMe",
        "rawName": "rawFindMe"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/user/destroy",
        "rel": "destroy",
        "urlTemplate": "/users/${userId}",
        "method": "DELETE",
        "comment": "Delete a collaborator",
        "urlPlaceholders": [
          {
            "variableName": "userId",
            "isEntityId": true,
            "relType": "UserData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "userId",
          "isEntityId": true,
          "relType": "UserData"
        },
        "optionalRequestBody": false,
        "queryParamsType": "UserDestroyHrefSchema",
        "queryParamsRequired": false,
        "responseType": "UserDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      }
    ],
    "namespace": "users",
    "resourceClassName": "User"
  },
  {
    "jsonApiType": "sso_user",
    "endpoints": [
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/instances",
        "rel": "instances",
        "urlTemplate": "/sso-users",
        "method": "GET",
        "comment": "List all users",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "SsoUserInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/self",
        "rel": "self",
        "urlTemplate": "/sso-users/${userId}",
        "method": "GET",
        "comment": "Returns a SSO user",
        "urlPlaceholders": [
          {
            "variableName": "userId",
            "isEntityId": false,
            "relType": "UserData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "SsoUserSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users",
        "rel": "copy_users",
        "urlTemplate": "/sso-users/copy-users",
        "method": "POST",
        "comment": "Copy editors as SSO users",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "SsoUserCopyUsersTargetSchema",
        "name": "copyUsers",
        "rawName": "rawCopyUsers"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy",
        "rel": "destroy",
        "urlTemplate": "/sso-users/${userId}",
        "method": "DELETE",
        "comment": "Delete a SSO user",
        "urlPlaceholders": [
          {
            "variableName": "userId",
            "isEntityId": false,
            "relType": "UserData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsType": "SsoUserDestroyHrefSchema",
        "queryParamsRequired": false,
        "responseType": "SsoUserDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      }
    ],
    "namespace": "ssoUsers",
    "resourceClassName": "SsoUser"
  },
  {
    "jsonApiType": "audit_log_event",
    "endpoints": [
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query",
        "rel": "query",
        "urlTemplate": "/audit-log-events/query",
        "method": "POST",
        "comment": "List Audit Log events",
        "urlPlaceholders": [],
        "requestBodyType": "AuditLogEventQuerySchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "audit_log_query",
          "attributes": ["filter", "next_token", "detailed_log"],
          "relationships": []
        },
        "queryParamsRequired": false,
        "responseType": "AuditLogEventQueryTargetSchema",
        "name": "query",
        "rawName": "rawQuery"
      }
    ],
    "namespace": "auditLogEvents",
    "resourceClassName": "AuditLogEvent"
  },
  {
    "jsonApiType": "menu_item",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/create",
        "rel": "create",
        "urlTemplate": "/menu-items",
        "method": "POST",
        "comment": "Create a new menu item",
        "urlPlaceholders": [],
        "requestBodyType": "MenuItemCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "menu_item",
          "attributes": [
            "label",
            "external_url",
            "position",
            "open_in_new_tab"
          ],
          "relationships": ["item_type", "item_type_filter", "parent"]
        },
        "queryParamsRequired": false,
        "responseType": "MenuItemCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/update",
        "rel": "update",
        "urlTemplate": "/menu-items/${menuItemId}",
        "method": "PUT",
        "comment": "Update a menu item",
        "urlPlaceholders": [
          {
            "variableName": "menuItemId",
            "isEntityId": true,
            "relType": "MenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "menuItemId",
          "isEntityId": true,
          "relType": "MenuItemData"
        },
        "requestBodyType": "MenuItemUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "menu_item",
          "idRequired": true,
          "attributes": [
            "label",
            "external_url",
            "position",
            "open_in_new_tab"
          ],
          "relationships": ["item_type", "item_type_filter", "parent"]
        },
        "queryParamsRequired": false,
        "responseType": "MenuItemUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/instances",
        "rel": "instances",
        "urlTemplate": "/menu-items",
        "method": "GET",
        "comment": "List all menu items",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsType": "MenuItemInstancesHrefSchema",
        "queryParamsRequired": false,
        "responseType": "MenuItemInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/self",
        "rel": "self",
        "urlTemplate": "/menu-items/${menuItemId}",
        "method": "GET",
        "comment": "Retrieve a menu item",
        "urlPlaceholders": [
          {
            "variableName": "menuItemId",
            "isEntityId": true,
            "relType": "MenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "menuItemId",
          "isEntityId": true,
          "relType": "MenuItemData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "MenuItemSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy",
        "rel": "destroy",
        "urlTemplate": "/menu-items/${menuItemId}",
        "method": "DELETE",
        "comment": "Delete a menu item",
        "urlPlaceholders": [
          {
            "variableName": "menuItemId",
            "isEntityId": true,
            "relType": "MenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "menuItemId",
          "isEntityId": true,
          "relType": "MenuItemData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "MenuItemDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/menu-item/reorder",
        "rel": "reorder",
        "urlTemplate": "/menu-items/reorder",
        "method": "POST",
        "comment": "Reorders a set of menu items",
        "urlPlaceholders": [],
        "requestBodyType": "MenuItemReorderSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "menu_item",
          "idRequired": true,
          "attributes": ["position"],
          "relationships": ["parent"]
        },
        "queryParamsRequired": false,
        "responseType": "MenuItemReorderJobSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "reorder",
        "rawName": "rawReorder"
      }
    ],
    "namespace": "menuItems",
    "resourceClassName": "MenuItem"
  },
  {
    "jsonApiType": "schema_menu_item",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/create",
        "rel": "create",
        "urlTemplate": "/schema-menu-items",
        "method": "POST",
        "comment": "Create a new schema menu item",
        "urlPlaceholders": [],
        "requestBodyType": "SchemaMenuItemCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "schema_menu_item",
          "attributes": ["label", "position", "kind"],
          "relationships": ["item_type", "parent"]
        },
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/update",
        "rel": "update",
        "urlTemplate": "/schema-menu-items/${schemaMenuItemId}",
        "method": "PUT",
        "comment": "Update a schema menu item",
        "urlPlaceholders": [
          {
            "variableName": "schemaMenuItemId",
            "isEntityId": true,
            "relType": "SchemaMenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "schemaMenuItemId",
          "isEntityId": true,
          "relType": "SchemaMenuItemData"
        },
        "requestBodyType": "SchemaMenuItemUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "schema_menu_item",
          "idRequired": true,
          "attributes": ["label", "position", "kind"],
          "relationships": ["item_type", "parent", "children"]
        },
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/instances",
        "rel": "instances",
        "urlTemplate": "/schema-menu-items",
        "method": "GET",
        "comment": "List all schema menu items",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsType": "SchemaMenuItemInstancesHrefSchema",
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/self",
        "rel": "self",
        "urlTemplate": "/schema-menu-items/${schemaMenuItemId}",
        "method": "GET",
        "comment": "Retrieve a schema menu item",
        "urlPlaceholders": [
          {
            "variableName": "schemaMenuItemId",
            "isEntityId": true,
            "relType": "SchemaMenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "schemaMenuItemId",
          "isEntityId": true,
          "relType": "SchemaMenuItemData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/destroy",
        "rel": "destroy",
        "urlTemplate": "/schema-menu-items/${schemaMenuItemId}",
        "method": "DELETE",
        "comment": "Delete a schema menu item",
        "urlPlaceholders": [
          {
            "variableName": "schemaMenuItemId",
            "isEntityId": true,
            "relType": "SchemaMenuItemData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "schemaMenuItemId",
          "isEntityId": true,
          "relType": "SchemaMenuItemData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/schema-menu_item/reorder",
        "rel": "reorder",
        "urlTemplate": "/schema-menu-items/reorder",
        "method": "POST",
        "comment": "Reorders a set of schema menu items",
        "urlPlaceholders": [],
        "requestBodyType": "SchemaMenuItemReorderSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "schema_menu_item",
          "idRequired": true,
          "attributes": ["position"],
          "relationships": ["parent"]
        },
        "queryParamsRequired": false,
        "responseType": "SchemaMenuItemReorderJobSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "reorder",
        "rawName": "rawReorder"
      }
    ],
    "namespace": "schemaMenuItems",
    "resourceClassName": "SchemaMenuItem"
  },
  {
    "jsonApiType": "upload_collection",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/create",
        "rel": "create",
        "urlTemplate": "/upload-collections",
        "method": "POST",
        "comment": "Create a new upload collection",
        "urlPlaceholders": [],
        "requestBodyType": "UploadCollectionCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "upload_collection",
          "attributes": ["label", "position"],
          "relationships": ["parent"]
        },
        "queryParamsRequired": false,
        "responseType": "UploadCollectionCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/update",
        "rel": "update",
        "urlTemplate": "/upload-collections/${uploadCollectionId}",
        "method": "PUT",
        "comment": "Update a upload collection",
        "urlPlaceholders": [
          {
            "variableName": "uploadCollectionId",
            "isEntityId": true,
            "relType": "UploadCollectionData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "uploadCollectionId",
          "isEntityId": true,
          "relType": "UploadCollectionData"
        },
        "requestBodyType": "UploadCollectionUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "upload_collection",
          "idRequired": true,
          "attributes": ["label", "position"],
          "relationships": ["parent", "children"]
        },
        "queryParamsRequired": false,
        "responseType": "UploadCollectionUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/instances",
        "rel": "instances",
        "urlTemplate": "/upload-collections",
        "method": "GET",
        "comment": "List all upload collections",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsType": "UploadCollectionInstancesHrefSchema",
        "queryParamsRequired": false,
        "responseType": "UploadCollectionInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/self",
        "rel": "self",
        "urlTemplate": "/upload-collections/${uploadCollectionId}",
        "method": "GET",
        "comment": "Retrieve a upload collection",
        "urlPlaceholders": [
          {
            "variableName": "uploadCollectionId",
            "isEntityId": true,
            "relType": "UploadCollectionData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "uploadCollectionId",
          "isEntityId": true,
          "relType": "UploadCollectionData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "UploadCollectionSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/destroy",
        "rel": "destroy",
        "urlTemplate": "/upload-collections/${uploadCollectionId}",
        "method": "DELETE",
        "comment": "Delete a upload collection",
        "urlPlaceholders": [
          {
            "variableName": "uploadCollectionId",
            "isEntityId": true,
            "relType": "UploadCollectionData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "uploadCollectionId",
          "isEntityId": true,
          "relType": "UploadCollectionData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "UploadCollectionDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/upload-collection/reorder",
        "rel": "reorder",
        "urlTemplate": "/upload-collections/reorder",
        "method": "POST",
        "comment": "Reorders a set of upload collections",
        "urlPlaceholders": [],
        "requestBodyType": "UploadCollectionReorderSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "upload_collection",
          "idRequired": true,
          "attributes": ["position"],
          "relationships": ["parent"]
        },
        "queryParamsRequired": false,
        "responseType": "UploadCollectionReorderJobSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "reorder",
        "rawName": "rawReorder"
      }
    ],
    "namespace": "uploadCollections",
    "resourceClassName": "UploadCollection"
  },
  {
    "jsonApiType": "item_type",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/create",
        "rel": "create",
        "urlTemplate": "/item-types",
        "method": "POST",
        "comment": "Create a new model",
        "urlPlaceholders": [],
        "requestBodyType": "ItemTypeCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "item_type",
          "attributes": [
            "name",
            "api_key",
            "singleton",
            "all_locales_required",
            "sortable",
            "modular_block",
            "draft_mode_active",
            "draft_saving_active",
            "tree",
            "ordering_direction",
            "ordering_meta",
            "collection_appeareance",
            "collection_appearance",
            "hint",
            "inverse_relationships_enabled"
          ],
          "relationships": [
            "ordering_field",
            "presentation_title_field",
            "presentation_image_field",
            "title_field",
            "image_preview_field",
            "excerpt_field",
            "workflow"
          ]
        },
        "queryParamsType": "ItemTypeCreateHrefSchema",
        "queryParamsRequired": false,
        "responseType": "ItemTypeCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/update",
        "rel": "update",
        "urlTemplate": "/item-types/${itemTypeId}",
        "method": "PUT",
        "comment": "Update a model",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": true,
            "relType": "ItemTypeData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "itemTypeId",
          "isEntityId": true,
          "relType": "ItemTypeData"
        },
        "requestBodyType": "ItemTypeUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "item_type",
          "idRequired": true,
          "attributes": [
            "name",
            "api_key",
            "collection_appeareance",
            "collection_appearance",
            "singleton",
            "all_locales_required",
            "sortable",
            "modular_block",
            "draft_mode_active",
            "draft_saving_active",
            "tree",
            "ordering_direction",
            "ordering_meta",
            "has_singleton_item",
            "hint",
            "inverse_relationships_enabled"
          ],
          "relationships": [
            "ordering_field",
            "presentation_title_field",
            "presentation_image_field",
            "title_field",
            "image_preview_field",
            "excerpt_field",
            "workflow"
          ]
        },
        "queryParamsRequired": false,
        "responseType": "ItemTypeUpdateJobSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/instances",
        "rel": "instances",
        "urlTemplate": "/item-types",
        "method": "GET",
        "comment": "List all models",
        "urlPlaceholders": [],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "ItemTypeInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/self",
        "rel": "self",
        "urlTemplate": "/item-types/${itemTypeId}",
        "method": "GET",
        "comment": "Retrieve a model",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": true,
            "relType": "ItemTypeData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "itemTypeId",
          "isEntityId": true,
          "relType": "ItemTypeData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "ItemTypeSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate",
        "rel": "duplicate",
        "urlTemplate": "/item-types/${itemTypeId}/duplicate",
        "method": "POST",
        "comment": "Duplicate model",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": true,
            "relType": "ItemTypeData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "itemTypeId",
          "isEntityId": true,
          "relType": "ItemTypeData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "ItemTypeDuplicateTargetSchema",
        "name": "duplicate",
        "rawName": "rawDuplicate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/destroy",
        "rel": "destroy",
        "urlTemplate": "/item-types/${itemTypeId}",
        "method": "DELETE",
        "comment": "Delete a model",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": true,
            "relType": "ItemTypeData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "itemTypeId",
          "isEntityId": true,
          "relType": "ItemTypeData"
        },
        "optionalRequestBody": false,
        "queryParamsType": "ItemTypeDestroyHrefSchema",
        "queryParamsRequired": false,
        "responseType": "ItemTypeDestroyJobSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item-type/reorder_fields_and_fieldsets",
        "rel": "reorder_fields_and_fieldsets",
        "urlTemplate": "/item-types/${itemTypeId}/reorder-fields-and-fieldsets",
        "method": "POST",
        "comment": "Reorders a set of fields and fieldsets within the model",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": true,
            "relType": "ItemTypeData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "itemTypeId",
          "isEntityId": true,
          "relType": "ItemTypeData"
        },
        "requestBodyType": "ItemTypeReorderFieldsAndFieldsetsSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "*",
          "idRequired": true,
          "attributes": "*",
          "relationships": "*"
        },
        "queryParamsRequired": false,
        "responseType": "ItemTypeReorderFieldsAndFieldsetsJobSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "rawName": "rawReorderFieldsAndFieldsets"
      }
    ],
    "namespace": "itemTypes",
    "resourceClassName": "ItemType"
  },
  {
    "jsonApiType": "field",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/create",
        "rel": "create",
        "urlTemplate": "/item-types/${itemTypeId}/fields",
        "method": "POST",
        "comment": "Create a new field",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "requestBodyType": "FieldCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "field",
          "attributes": [
            "label",
            "field_type",
            "api_key",
            "localized",
            "validators",
            "appeareance",
            "appearance",
            "position",
            "hint",
            "default_value",
            "deep_filtering_enabled"
          ],
          "relationships": ["fieldset"]
        },
        "queryParamsRequired": false,
        "responseType": "FieldCreateJobSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/update",
        "rel": "update",
        "urlTemplate": "/fields/${fieldId}",
        "method": "PUT",
        "comment": "Update a field",
        "urlPlaceholders": [
          {
            "variableName": "fieldId",
            "isEntityId": true,
            "relType": "FieldData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldId",
          "isEntityId": true,
          "relType": "FieldData"
        },
        "requestBodyType": "FieldUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "field",
          "idRequired": true,
          "attributes": [
            "default_value",
            "label",
            "api_key",
            "localized",
            "validators",
            "appeareance",
            "appearance",
            "position",
            "field_type",
            "hint",
            "deep_filtering_enabled"
          ],
          "relationships": ["fieldset"]
        },
        "queryParamsRequired": false,
        "responseType": "FieldUpdateJobSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/instances",
        "rel": "instances",
        "urlTemplate": "/item-types/${itemTypeId}/fields",
        "method": "GET",
        "comment": "List all fields",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/referencing",
        "rel": "referencing",
        "urlTemplate": "/item-types/${itemTypeId}/fields/referencing",
        "method": "GET",
        "comment": "List referenced fields",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldReferencingTargetSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "referencing",
        "rawName": "rawReferencing"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/related",
        "rel": "related",
        "urlTemplate": "/item-types/${itemTypeId}/fields/related",
        "method": "GET",
        "comment": "List related fields",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldRelatedTargetSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "related",
        "rawName": "rawRelated"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/self",
        "rel": "self",
        "urlTemplate": "/fields/${fieldId}",
        "method": "GET",
        "comment": "Retrieve a field",
        "urlPlaceholders": [
          {
            "variableName": "fieldId",
            "isEntityId": true,
            "relType": "FieldData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldId",
          "isEntityId": true,
          "relType": "FieldData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/destroy",
        "rel": "destroy",
        "urlTemplate": "/fields/${fieldId}",
        "method": "DELETE",
        "comment": "Delete a field",
        "urlPlaceholders": [
          {
            "variableName": "fieldId",
            "isEntityId": true,
            "relType": "FieldData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldId",
          "isEntityId": true,
          "relType": "FieldData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldDestroyJobSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/field/duplicate",
        "rel": "duplicate",
        "urlTemplate": "/fields/${fieldId}/duplicate",
        "method": "POST",
        "comment": "Duplicate a field",
        "urlPlaceholders": [
          {
            "variableName": "fieldId",
            "isEntityId": true,
            "relType": "FieldData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldId",
          "isEntityId": true,
          "relType": "FieldData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldDuplicateJobSchema",
        "name": "duplicate",
        "rawName": "rawDuplicate"
      }
    ],
    "namespace": "fields",
    "resourceClassName": "Field"
  },
  {
    "jsonApiType": "fieldset",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/create",
        "rel": "create",
        "urlTemplate": "/item-types/${itemTypeId}/fieldsets",
        "method": "POST",
        "comment": "Create a new fieldset",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "requestBodyType": "FieldsetCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "fieldset",
          "attributes": [
            "title",
            "hint",
            "position",
            "collapsible",
            "start_collapsed"
          ],
          "relationships": []
        },
        "queryParamsRequired": false,
        "responseType": "FieldsetCreateTargetSchema",
        "name": "create",
        "rawName": "rawCreate"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/update",
        "rel": "update",
        "urlTemplate": "/fieldsets/${fieldsetId}",
        "method": "PUT",
        "comment": "Update a fieldset",
        "urlPlaceholders": [
          {
            "variableName": "fieldsetId",
            "isEntityId": true,
            "relType": "FieldsetData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldsetId",
          "isEntityId": true,
          "relType": "FieldsetData"
        },
        "requestBodyType": "FieldsetUpdateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "fieldset",
          "idRequired": true,
          "attributes": [
            "title",
            "hint",
            "position",
            "collapsible",
            "start_collapsed"
          ],
          "relationships": []
        },
        "queryParamsRequired": false,
        "responseType": "FieldsetUpdateTargetSchema",
        "name": "update",
        "rawName": "rawUpdate"
      },
      {
        "returnsCollection": true,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/instances",
        "rel": "instances",
        "urlTemplate": "/item-types/${itemTypeId}/fieldsets",
        "method": "GET",
        "comment": "List all fieldsets",
        "urlPlaceholders": [
          {
            "variableName": "itemTypeId",
            "isEntityId": false,
            "relType": "ItemTypeData"
          }
        ],
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldsetInstancesTargetSchema",
        "name": "list",
        "rawName": "rawList"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/self",
        "rel": "self",
        "urlTemplate": "/fieldsets/${fieldsetId}",
        "method": "GET",
        "comment": "Retrieve a fieldset",
        "urlPlaceholders": [
          {
            "variableName": "fieldsetId",
            "isEntityId": true,
            "relType": "FieldsetData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldsetId",
          "isEntityId": true,
          "relType": "FieldsetData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldsetSelfTargetSchema",
        "name": "find",
        "rawName": "rawFind"
      },
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/fieldset/destroy",
        "rel": "destroy",
        "urlTemplate": "/fieldsets/${fieldsetId}",
        "method": "DELETE",
        "comment": "Delete a fieldset",
        "urlPlaceholders": [
          {
            "variableName": "fieldsetId",
            "isEntityId": true,
            "relType": "FieldsetData"
          }
        ],
        "entityIdPlaceholder": {
          "variableName": "fieldsetId",
          "isEntityId": true,
          "relType": "FieldsetData"
        },
        "optionalRequestBody": false,
        "queryParamsRequired": false,
        "responseType": "FieldsetDestroyTargetSchema",
        "name": "destroy",
        "rawName": "rawDestroy"
      }
    ],
    "namespace": "fieldsets",
    "resourceClassName": "Fieldset"
  },
  {
    "jsonApiType": "session",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/session/create",
        "rel": "create",
        "urlTemplate": "/sessions",
        "method": "POST",
        "comment": "Create a new session",
        "urlPlaceholders": [],
        "requestBodyType": "SessionCreateSchema",
        "optionalRequestBody": false,
        "requestStructure": {
          "type": "email_credentials",
          "attributes": ["email", "password", "otp_code"],
          "relationships": []
        },
        "queryParamsRequired": false,
        "responseType": "SessionCreateTargetSchema",
        "deprecated": "This API call is to be considered private and might change without notice",
        "name": "create",
        "rawName": "rawCreate"
      }
    ],
    "namespace": "session",
    "resourceClassName": "Session"
  },
  {
    "jsonApiType": "access_token",
    "endpoints": [
      {
        "returnsCollection": false,
        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/acces