contentful-management 11.60.3 → 12.0.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -51
- package/dist/cjs/adapters/REST/endpoints/access-token.cjs +137 -0
- package/dist/cjs/adapters/REST/endpoints/access-token.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/ai-action-invocation.cjs +10 -0
- package/dist/cjs/adapters/REST/endpoints/ai-action-invocation.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/ai-action.cjs +58 -0
- package/dist/cjs/adapters/REST/endpoints/ai-action.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/api-key.cjs +51 -0
- package/dist/cjs/adapters/REST/endpoints/api-key.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-access-token.cjs +10 -0
- package/dist/cjs/adapters/REST/endpoints/app-access-token.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-action-call.cjs +119 -0
- package/dist/cjs/adapters/REST/endpoints/app-action-call.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-action.cjs +43 -0
- package/dist/cjs/adapters/REST/endpoints/app-action.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-bundle.cjs +40 -0
- package/dist/cjs/adapters/REST/endpoints/app-bundle.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-definition.cjs +53 -0
- package/dist/cjs/adapters/REST/endpoints/app-definition.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-details.cjs +18 -0
- package/dist/cjs/adapters/REST/endpoints/app-details.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-event-subscription.cjs +18 -0
- package/dist/cjs/adapters/REST/endpoints/app-event-subscription.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-installation.cjs +49 -0
- package/dist/cjs/adapters/REST/endpoints/app-installation.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-key.cjs +22 -0
- package/dist/cjs/adapters/REST/endpoints/app-key.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-signed-request.cjs +10 -0
- package/dist/cjs/adapters/REST/endpoints/app-signed-request.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-signing-secret.cjs +18 -0
- package/dist/cjs/adapters/REST/endpoints/app-signing-secret.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/app-upload.cjs +29 -0
- package/dist/cjs/adapters/REST/endpoints/app-upload.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/asset-key.cjs +35 -0
- package/dist/cjs/adapters/REST/endpoints/asset-key.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/asset.cjs +223 -0
- package/dist/cjs/adapters/REST/endpoints/asset.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/bulk-action.cjs +22 -0
- package/dist/cjs/adapters/REST/endpoints/bulk-action.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/comment.cjs +98 -0
- package/dist/cjs/adapters/REST/endpoints/comment.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/concept-scheme.cjs +55 -0
- package/dist/cjs/adapters/REST/endpoints/concept-scheme.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/concept.cjs +73 -0
- package/dist/cjs/adapters/REST/endpoints/concept.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/content-type.cjs +62 -0
- package/dist/cjs/adapters/REST/endpoints/content-type.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/editor-interface.cjs +27 -0
- package/dist/cjs/adapters/REST/endpoints/editor-interface.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/entry.cjs +128 -0
- package/dist/cjs/adapters/REST/endpoints/entry.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/environment-alias.cjs +47 -0
- package/dist/cjs/adapters/REST/endpoints/environment-alias.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/environment-template-installation.cjs +24 -0
- package/dist/cjs/adapters/REST/endpoints/environment-template-installation.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/environment-template.cjs +52 -0
- package/dist/cjs/adapters/REST/endpoints/environment-template.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/environment.cjs +53 -0
- package/dist/cjs/adapters/REST/endpoints/environment.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/extension.cjs +47 -0
- package/dist/cjs/adapters/REST/endpoints/extension.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/function-log.cjs +28 -0
- package/dist/cjs/adapters/REST/endpoints/function-log.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/function.cjs +26 -0
- package/dist/cjs/adapters/REST/endpoints/function.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/http.cjs +30 -0
- package/dist/cjs/adapters/REST/endpoints/http.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/index.cjs +144 -0
- package/dist/cjs/adapters/REST/endpoints/index.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/locale.cjs +40 -0
- package/dist/cjs/adapters/REST/endpoints/locale.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/oauth-application.cjs +148 -0
- package/dist/cjs/adapters/REST/endpoints/oauth-application.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/organization-invitation.cjs +30 -0
- package/dist/cjs/adapters/REST/endpoints/organization-invitation.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/organization-membership.cjs +35 -0
- package/dist/cjs/adapters/REST/endpoints/organization-membership.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/organization.cjs +29 -0
- package/dist/cjs/adapters/REST/endpoints/organization.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/personal-access-token.cjs +38 -0
- package/dist/cjs/adapters/REST/endpoints/personal-access-token.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/preview-api-key.cjs +16 -0
- package/dist/cjs/adapters/REST/endpoints/preview-api-key.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/raw.cjs +62 -0
- package/dist/cjs/adapters/REST/endpoints/raw.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/release-action.cjs +25 -0
- package/dist/cjs/adapters/REST/endpoints/release-action.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/release-asset.cjs +152 -0
- package/dist/cjs/adapters/REST/endpoints/release-asset.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/release-entry.cjs +63 -0
- package/dist/cjs/adapters/REST/endpoints/release-entry.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/release.cjs +84 -0
- package/dist/cjs/adapters/REST/endpoints/release.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/resource-provider.cjs +19 -0
- package/dist/cjs/adapters/REST/endpoints/resource-provider.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/resource-type.cjs +31 -0
- package/dist/cjs/adapters/REST/endpoints/resource-type.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/resource.cjs +11 -0
- package/dist/cjs/adapters/REST/endpoints/resource.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/role.cjs +51 -0
- package/dist/cjs/adapters/REST/endpoints/role.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/scheduled-action.cjs +44 -0
- package/dist/cjs/adapters/REST/endpoints/scheduled-action.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/snapshot.cjs +31 -0
- package/dist/cjs/adapters/REST/endpoints/snapshot.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/space-member.cjs +12 -0
- package/dist/cjs/adapters/REST/endpoints/space-member.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/space-membership.cjs +63 -0
- package/dist/cjs/adapters/REST/endpoints/space-membership.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/space.cjs +38 -0
- package/dist/cjs/adapters/REST/endpoints/space.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/tag.cjs +37 -0
- package/dist/cjs/adapters/REST/endpoints/tag.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/task.cjs +41 -0
- package/dist/cjs/adapters/REST/endpoints/task.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/team-membership.cjs +39 -0
- package/dist/cjs/adapters/REST/endpoints/team-membership.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/team-space-membership.cjs +54 -0
- package/dist/cjs/adapters/REST/endpoints/team-space-membership.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/team.cjs +39 -0
- package/dist/cjs/adapters/REST/endpoints/team.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/ui-config.cjs +22 -0
- package/dist/cjs/adapters/REST/endpoints/ui-config.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/upload-credentials.cjs +16 -0
- package/dist/cjs/adapters/REST/endpoints/upload-credentials.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/upload.cjs +43 -0
- package/dist/cjs/adapters/REST/endpoints/upload.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/usage.cjs +18 -0
- package/dist/cjs/adapters/REST/endpoints/usage.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/user-ui-config.cjs +22 -0
- package/dist/cjs/adapters/REST/endpoints/user-ui-config.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/user.cjs +28 -0
- package/dist/cjs/adapters/REST/endpoints/user.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/utils.cjs +25 -0
- package/dist/cjs/adapters/REST/endpoints/utils.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/webhook.cjs +101 -0
- package/dist/cjs/adapters/REST/endpoints/webhook.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/workflow-definition.cjs +42 -0
- package/dist/cjs/adapters/REST/endpoints/workflow-definition.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/workflow.cjs +49 -0
- package/dist/cjs/adapters/REST/endpoints/workflow.cjs.map +1 -0
- package/dist/cjs/adapters/REST/endpoints/workflows-changelog.cjs +12 -0
- package/dist/cjs/adapters/REST/endpoints/workflows-changelog.cjs.map +1 -0
- package/dist/cjs/adapters/REST/make-request.cjs +23 -0
- package/dist/cjs/adapters/REST/make-request.cjs.map +1 -0
- package/dist/cjs/adapters/REST/rest-adapter.cjs +44 -0
- package/dist/cjs/adapters/REST/rest-adapter.cjs.map +1 -0
- package/dist/cjs/common-types.cjs +7 -0
- package/dist/cjs/common-types.cjs.map +1 -0
- package/dist/cjs/common-utils.cjs +39 -0
- package/dist/cjs/common-utils.cjs.map +1 -0
- package/dist/cjs/constants/editor-interface-defaults/controls-defaults.cjs +170 -0
- package/dist/cjs/constants/editor-interface-defaults/controls-defaults.cjs.map +1 -0
- package/dist/cjs/constants/editor-interface-defaults/editors-defaults.cjs +41 -0
- package/dist/cjs/constants/editor-interface-defaults/editors-defaults.cjs.map +1 -0
- package/dist/cjs/constants/editor-interface-defaults/index.cjs +15 -0
- package/dist/cjs/constants/editor-interface-defaults/index.cjs.map +1 -0
- package/dist/cjs/constants/editor-interface-defaults/sidebar-defaults.cjs +72 -0
- package/dist/cjs/constants/editor-interface-defaults/sidebar-defaults.cjs.map +1 -0
- package/dist/cjs/constants/editor-interface-defaults/types.cjs +19 -0
- package/dist/cjs/constants/editor-interface-defaults/types.cjs.map +1 -0
- package/dist/cjs/create-adapter.cjs +22 -0
- package/dist/cjs/create-adapter.cjs.map +1 -0
- package/dist/cjs/create-app-definition-api.cjs +254 -0
- package/dist/cjs/create-app-definition-api.cjs.map +1 -0
- package/dist/cjs/create-contentful-api.cjs +590 -0
- package/dist/cjs/create-contentful-api.cjs.map +1 -0
- package/dist/cjs/create-entry-api.cjs +490 -0
- package/dist/cjs/create-entry-api.cjs.map +1 -0
- package/dist/cjs/create-environment-api.cjs +2442 -0
- package/dist/cjs/create-environment-api.cjs.map +1 -0
- package/dist/cjs/create-environment-template-api.cjs +271 -0
- package/dist/cjs/create-environment-template-api.cjs.map +1 -0
- package/dist/cjs/create-organization-api.cjs +1139 -0
- package/dist/cjs/create-organization-api.cjs.map +1 -0
- package/dist/cjs/create-space-api.cjs +1590 -0
- package/dist/cjs/create-space-api.cjs.map +1 -0
- package/dist/cjs/create-ui-config-api.cjs +55 -0
- package/dist/cjs/create-ui-config-api.cjs.map +1 -0
- package/dist/cjs/create-user-ui-config-api.cjs +55 -0
- package/dist/cjs/create-user-ui-config-api.cjs.map +1 -0
- package/dist/cjs/enhance-with-methods.cjs +27 -0
- package/dist/cjs/enhance-with-methods.cjs.map +1 -0
- package/dist/cjs/entities/access-token.cjs +37 -0
- package/dist/cjs/entities/access-token.cjs.map +1 -0
- package/dist/cjs/entities/ai-action-invocation.cjs +19 -0
- package/dist/cjs/entities/ai-action-invocation.cjs.map +1 -0
- package/dist/cjs/entities/ai-action.cjs +76 -0
- package/dist/cjs/entities/ai-action.cjs.map +1 -0
- package/dist/cjs/entities/api-key.cjs +57 -0
- package/dist/cjs/entities/api-key.cjs.map +1 -0
- package/dist/cjs/entities/app-access-token.cjs +18 -0
- package/dist/cjs/entities/app-access-token.cjs.map +1 -0
- package/dist/cjs/entities/app-action-call.cjs +72 -0
- package/dist/cjs/entities/app-action-call.cjs.map +1 -0
- package/dist/cjs/entities/app-action.cjs +49 -0
- package/dist/cjs/entities/app-action.cjs.map +1 -0
- package/dist/cjs/entities/app-bundle.cjs +49 -0
- package/dist/cjs/entities/app-bundle.cjs.map +1 -0
- package/dist/cjs/entities/app-definition.cjs +30 -0
- package/dist/cjs/entities/app-definition.cjs.map +1 -0
- package/dist/cjs/entities/app-details.cjs +40 -0
- package/dist/cjs/entities/app-details.cjs.map +1 -0
- package/dist/cjs/entities/app-event-subscription.cjs +35 -0
- package/dist/cjs/entities/app-event-subscription.cjs.map +1 -0
- package/dist/cjs/entities/app-installation.cjs +56 -0
- package/dist/cjs/entities/app-installation.cjs.map +1 -0
- package/dist/cjs/entities/app-key.cjs +45 -0
- package/dist/cjs/entities/app-key.cjs.map +1 -0
- package/dist/cjs/entities/app-signed-request.cjs +18 -0
- package/dist/cjs/entities/app-signed-request.cjs.map +1 -0
- package/dist/cjs/entities/app-signing-secret.cjs +35 -0
- package/dist/cjs/entities/app-signing-secret.cjs.map +1 -0
- package/dist/cjs/entities/app-upload.cjs +39 -0
- package/dist/cjs/entities/app-upload.cjs.map +1 -0
- package/dist/cjs/entities/asset-key.cjs +18 -0
- package/dist/cjs/entities/asset-key.cjs.map +1 -0
- package/dist/cjs/entities/asset.cjs +133 -0
- package/dist/cjs/entities/asset.cjs.map +1 -0
- package/dist/cjs/entities/bulk-action.cjs +61 -0
- package/dist/cjs/entities/bulk-action.cjs.map +1 -0
- package/dist/cjs/entities/comment.cjs +67 -0
- package/dist/cjs/entities/comment.cjs.map +1 -0
- package/dist/cjs/entities/content-type.cjs +121 -0
- package/dist/cjs/entities/content-type.cjs.map +1 -0
- package/dist/cjs/entities/editor-interface.cjs +51 -0
- package/dist/cjs/entities/editor-interface.cjs.map +1 -0
- package/dist/cjs/entities/entry.cjs +28 -0
- package/dist/cjs/entities/entry.cjs.map +1 -0
- package/dist/cjs/entities/environment-alias.cjs +59 -0
- package/dist/cjs/entities/environment-alias.cjs.map +1 -0
- package/dist/cjs/entities/environment-template-installation.cjs +24 -0
- package/dist/cjs/entities/environment-template-installation.cjs.map +1 -0
- package/dist/cjs/entities/environment-template.cjs +19 -0
- package/dist/cjs/entities/environment-template.cjs.map +1 -0
- package/dist/cjs/entities/environment.cjs +35 -0
- package/dist/cjs/entities/environment.cjs.map +1 -0
- package/dist/cjs/entities/extension.cjs +55 -0
- package/dist/cjs/entities/extension.cjs.map +1 -0
- package/dist/cjs/entities/function-log.cjs +27 -0
- package/dist/cjs/entities/function-log.cjs.map +1 -0
- package/dist/cjs/entities/function.cjs +67 -0
- package/dist/cjs/entities/function.cjs.map +1 -0
- package/dist/cjs/entities/locale.cjs +58 -0
- package/dist/cjs/entities/locale.cjs.map +1 -0
- package/dist/cjs/entities/oauth-application.cjs +67 -0
- package/dist/cjs/entities/oauth-application.cjs.map +1 -0
- package/dist/cjs/entities/organization-invitation.cjs +18 -0
- package/dist/cjs/entities/organization-invitation.cjs.map +1 -0
- package/dist/cjs/entities/organization-membership.cjs +54 -0
- package/dist/cjs/entities/organization-membership.cjs.map +1 -0
- package/dist/cjs/entities/organization.cjs +33 -0
- package/dist/cjs/entities/organization.cjs.map +1 -0
- package/dist/cjs/entities/personal-access-token.cjs +37 -0
- package/dist/cjs/entities/personal-access-token.cjs.map +1 -0
- package/dist/cjs/entities/preview-api-key.cjs +32 -0
- package/dist/cjs/entities/preview-api-key.cjs.map +1 -0
- package/dist/cjs/entities/release-action.cjs +56 -0
- package/dist/cjs/entities/release-action.cjs.map +1 -0
- package/dist/cjs/entities/release.cjs +110 -0
- package/dist/cjs/entities/release.cjs.map +1 -0
- package/dist/cjs/entities/resource-provider.cjs +139 -0
- package/dist/cjs/entities/resource-provider.cjs.map +1 -0
- package/dist/cjs/entities/resource-type.cjs +99 -0
- package/dist/cjs/entities/resource-type.cjs.map +1 -0
- package/dist/cjs/entities/resource.cjs +14 -0
- package/dist/cjs/entities/resource.cjs.map +1 -0
- package/dist/cjs/entities/role.cjs +54 -0
- package/dist/cjs/entities/role.cjs.map +1 -0
- package/dist/cjs/entities/scheduled-action.cjs +153 -0
- package/dist/cjs/entities/scheduled-action.cjs.map +1 -0
- package/dist/cjs/entities/snapshot.cjs +37 -0
- package/dist/cjs/entities/snapshot.cjs.map +1 -0
- package/dist/cjs/entities/space-member.cjs +24 -0
- package/dist/cjs/entities/space-member.cjs.map +1 -0
- package/dist/cjs/entities/space-membership.cjs +54 -0
- package/dist/cjs/entities/space-membership.cjs.map +1 -0
- package/dist/cjs/entities/space.cjs +34 -0
- package/dist/cjs/entities/space.cjs.map +1 -0
- package/dist/cjs/entities/tag.cjs +60 -0
- package/dist/cjs/entities/tag.cjs.map +1 -0
- package/dist/cjs/entities/task.cjs +61 -0
- package/dist/cjs/entities/task.cjs.map +1 -0
- package/dist/cjs/entities/team-membership.cjs +55 -0
- package/dist/cjs/entities/team-membership.cjs.map +1 -0
- package/dist/cjs/entities/team-space-membership.cjs +54 -0
- package/dist/cjs/entities/team-space-membership.cjs.map +1 -0
- package/dist/cjs/entities/team.cjs +54 -0
- package/dist/cjs/entities/team.cjs.map +1 -0
- package/dist/cjs/entities/ui-config.cjs +21 -0
- package/dist/cjs/entities/ui-config.cjs.map +1 -0
- package/dist/cjs/entities/upload.cjs +39 -0
- package/dist/cjs/entities/upload.cjs.map +1 -0
- package/dist/cjs/entities/usage.cjs +26 -0
- package/dist/cjs/entities/usage.cjs.map +1 -0
- package/dist/cjs/entities/user-ui-config.cjs +21 -0
- package/dist/cjs/entities/user-ui-config.cjs.map +1 -0
- package/dist/cjs/entities/user.cjs +29 -0
- package/dist/cjs/entities/user.cjs.map +1 -0
- package/dist/cjs/entities/webhook.cjs +78 -0
- package/dist/cjs/entities/webhook.cjs.map +1 -0
- package/dist/cjs/entities/workflow-definition.cjs +29 -0
- package/dist/cjs/entities/workflow-definition.cjs.map +1 -0
- package/dist/cjs/index.cjs +66 -0
- package/dist/cjs/index.cjs.map +1 -0
- package/dist/cjs/methods/action.cjs +53 -0
- package/dist/cjs/methods/action.cjs.map +1 -0
- package/dist/cjs/methods/content-type.cjs +49 -0
- package/dist/cjs/methods/content-type.cjs.map +1 -0
- package/dist/cjs/methods/utils.cjs +12 -0
- package/dist/cjs/methods/utils.cjs.map +1 -0
- package/dist/cjs/plain/as-iterator.cjs +39 -0
- package/dist/cjs/plain/as-iterator.cjs.map +1 -0
- package/dist/cjs/plain/checks.cjs +16 -0
- package/dist/cjs/plain/checks.cjs.map +1 -0
- package/dist/cjs/plain/pagination-helper.cjs +70 -0
- package/dist/cjs/plain/pagination-helper.cjs.map +1 -0
- package/dist/cjs/plain/plain-client.cjs +561 -0
- package/dist/cjs/plain/plain-client.cjs.map +1 -0
- package/dist/cjs/plain/wrappers/wrap.cjs +27 -0
- package/dist/cjs/plain/wrappers/wrap.cjs.map +1 -0
- package/dist/cjs/upload-http-client.cjs +17 -0
- package/dist/cjs/upload-http-client.cjs.map +1 -0
- package/dist/contentful-management.browser.js +21588 -29186
- package/dist/contentful-management.browser.js.map +1 -1
- package/dist/contentful-management.browser.min.js +2 -2
- package/dist/contentful-management.browser.min.js.map +1 -0
- package/dist/contentful-management.node.cjs +36042 -0
- package/dist/contentful-management.node.cjs.map +1 -0
- package/dist/contentful-management.react-native.js +22297 -0
- package/dist/contentful-management.react-native.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/access-token.js +131 -0
- package/dist/esm/adapters/REST/endpoints/access-token.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/ai-action-invocation.js +8 -0
- package/dist/esm/adapters/REST/endpoints/ai-action-invocation.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/ai-action.js +49 -0
- package/dist/esm/adapters/REST/endpoints/ai-action.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/api-key.js +44 -0
- package/dist/esm/adapters/REST/endpoints/api-key.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-access-token.js +8 -0
- package/dist/esm/adapters/REST/endpoints/app-access-token.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-action-call.js +112 -0
- package/dist/esm/adapters/REST/endpoints/app-action-call.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-action.js +36 -0
- package/dist/esm/adapters/REST/endpoints/app-action.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-bundle.js +35 -0
- package/dist/esm/adapters/REST/endpoints/app-bundle.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-definition.js +45 -0
- package/dist/esm/adapters/REST/endpoints/app-definition.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-details.js +14 -0
- package/dist/esm/adapters/REST/endpoints/app-details.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-event-subscription.js +14 -0
- package/dist/esm/adapters/REST/endpoints/app-event-subscription.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-installation.js +42 -0
- package/dist/esm/adapters/REST/endpoints/app-installation.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-key.js +17 -0
- package/dist/esm/adapters/REST/endpoints/app-key.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-signed-request.js +8 -0
- package/dist/esm/adapters/REST/endpoints/app-signed-request.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-signing-secret.js +14 -0
- package/dist/esm/adapters/REST/endpoints/app-signing-secret.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/app-upload.js +25 -0
- package/dist/esm/adapters/REST/endpoints/app-upload.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/asset-key.js +32 -0
- package/dist/esm/adapters/REST/endpoints/asset-key.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/asset.js +208 -0
- package/dist/esm/adapters/REST/endpoints/asset.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/bulk-action.js +17 -0
- package/dist/esm/adapters/REST/endpoints/bulk-action.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/comment.js +91 -0
- package/dist/esm/adapters/REST/endpoints/comment.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/concept-scheme.js +46 -0
- package/dist/esm/adapters/REST/endpoints/concept-scheme.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/concept.js +62 -0
- package/dist/esm/adapters/REST/endpoints/concept.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/content-type.js +53 -0
- package/dist/esm/adapters/REST/endpoints/content-type.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/editor-interface.js +23 -0
- package/dist/esm/adapters/REST/endpoints/editor-interface.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/entry.js +114 -0
- package/dist/esm/adapters/REST/endpoints/entry.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/environment-alias.js +41 -0
- package/dist/esm/adapters/REST/endpoints/environment-alias.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/environment-template-installation.js +21 -0
- package/dist/esm/adapters/REST/endpoints/environment-template-installation.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/environment-template.js +41 -0
- package/dist/esm/adapters/REST/endpoints/environment-template.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/environment.js +46 -0
- package/dist/esm/adapters/REST/endpoints/environment.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/extension.js +39 -0
- package/dist/esm/adapters/REST/endpoints/extension.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/function-log.js +25 -0
- package/dist/esm/adapters/REST/endpoints/function-log.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/function.js +22 -0
- package/dist/esm/adapters/REST/endpoints/function.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/http.js +23 -0
- package/dist/esm/adapters/REST/endpoints/http.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/index.js +142 -0
- package/dist/esm/adapters/REST/endpoints/index.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/locale.js +34 -0
- package/dist/esm/adapters/REST/endpoints/locale.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/oauth-application.js +142 -0
- package/dist/esm/adapters/REST/endpoints/oauth-application.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/organization-invitation.js +27 -0
- package/dist/esm/adapters/REST/endpoints/organization-invitation.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/organization-membership.js +30 -0
- package/dist/esm/adapters/REST/endpoints/organization-membership.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/organization.js +26 -0
- package/dist/esm/adapters/REST/endpoints/organization.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/personal-access-token.js +33 -0
- package/dist/esm/adapters/REST/endpoints/personal-access-token.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/preview-api-key.js +13 -0
- package/dist/esm/adapters/REST/endpoints/preview-api-key.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/raw.js +55 -0
- package/dist/esm/adapters/REST/endpoints/raw.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/release-action.js +21 -0
- package/dist/esm/adapters/REST/endpoints/release-action.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/release-asset.js +143 -0
- package/dist/esm/adapters/REST/endpoints/release-asset.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/release-entry.js +56 -0
- package/dist/esm/adapters/REST/endpoints/release-entry.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/release.js +73 -0
- package/dist/esm/adapters/REST/endpoints/release.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/resource-provider.js +15 -0
- package/dist/esm/adapters/REST/endpoints/resource-provider.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/resource-type.js +25 -0
- package/dist/esm/adapters/REST/endpoints/resource-type.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/resource.js +9 -0
- package/dist/esm/adapters/REST/endpoints/resource.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/role.js +43 -0
- package/dist/esm/adapters/REST/endpoints/role.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/scheduled-action.js +38 -0
- package/dist/esm/adapters/REST/endpoints/scheduled-action.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/snapshot.js +26 -0
- package/dist/esm/adapters/REST/endpoints/snapshot.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/space-member.js +9 -0
- package/dist/esm/adapters/REST/endpoints/space-member.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/space-membership.js +54 -0
- package/dist/esm/adapters/REST/endpoints/space-membership.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/space.js +31 -0
- package/dist/esm/adapters/REST/endpoints/space.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/tag.js +31 -0
- package/dist/esm/adapters/REST/endpoints/tag.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/task.js +34 -0
- package/dist/esm/adapters/REST/endpoints/task.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/team-membership.js +32 -0
- package/dist/esm/adapters/REST/endpoints/team-membership.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/team-space-membership.js +46 -0
- package/dist/esm/adapters/REST/endpoints/team-space-membership.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/team.js +32 -0
- package/dist/esm/adapters/REST/endpoints/team.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/ui-config.js +19 -0
- package/dist/esm/adapters/REST/endpoints/ui-config.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/upload-credentials.js +14 -0
- package/dist/esm/adapters/REST/endpoints/upload-credentials.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/upload.js +39 -0
- package/dist/esm/adapters/REST/endpoints/upload.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/usage.js +15 -0
- package/dist/esm/adapters/REST/endpoints/usage.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/user-ui-config.js +19 -0
- package/dist/esm/adapters/REST/endpoints/user-ui-config.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/user.js +22 -0
- package/dist/esm/adapters/REST/endpoints/user.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/utils.js +22 -0
- package/dist/esm/adapters/REST/endpoints/utils.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/webhook.js +85 -0
- package/dist/esm/adapters/REST/endpoints/webhook.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/workflow-definition.js +36 -0
- package/dist/esm/adapters/REST/endpoints/workflow-definition.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/workflow.js +42 -0
- package/dist/esm/adapters/REST/endpoints/workflow.js.map +1 -0
- package/dist/esm/adapters/REST/endpoints/workflows-changelog.js +10 -0
- package/dist/esm/adapters/REST/endpoints/workflows-changelog.js.map +1 -0
- package/dist/esm/adapters/REST/make-request.js +21 -0
- package/dist/esm/adapters/REST/make-request.js.map +1 -0
- package/dist/esm/adapters/REST/rest-adapter.js +42 -0
- package/dist/esm/adapters/REST/rest-adapter.js.map +1 -0
- package/dist/esm/common-types.js +7 -0
- package/dist/esm/common-types.js.map +1 -0
- package/dist/esm/common-utils.js +33 -0
- package/dist/esm/common-utils.js.map +1 -0
- package/dist/esm/constants/editor-interface-defaults/controls-defaults.js +162 -0
- package/dist/esm/constants/editor-interface-defaults/controls-defaults.js.map +1 -0
- package/dist/esm/constants/editor-interface-defaults/editors-defaults.js +38 -0
- package/dist/esm/constants/editor-interface-defaults/editors-defaults.js.map +1 -0
- package/dist/esm/constants/editor-interface-defaults/index.js +13 -0
- package/dist/esm/constants/editor-interface-defaults/index.js.map +1 -0
- package/dist/esm/constants/editor-interface-defaults/sidebar-defaults.js +69 -0
- package/dist/esm/constants/editor-interface-defaults/sidebar-defaults.js.map +1 -0
- package/dist/esm/constants/editor-interface-defaults/types.js +16 -0
- package/dist/esm/constants/editor-interface-defaults/types.js.map +1 -0
- package/dist/esm/create-adapter.js +20 -0
- package/dist/esm/create-adapter.js.map +1 -0
- package/dist/esm/create-app-definition-api.js +252 -0
- package/dist/esm/create-app-definition-api.js.map +1 -0
- package/dist/esm/create-contentful-api.js +588 -0
- package/dist/esm/create-contentful-api.js.map +1 -0
- package/dist/esm/create-entry-api.js +488 -0
- package/dist/esm/create-entry-api.js.map +1 -0
- package/dist/esm/create-environment-api.js +2440 -0
- package/dist/esm/create-environment-api.js.map +1 -0
- package/dist/esm/create-environment-template-api.js +269 -0
- package/dist/esm/create-environment-template-api.js.map +1 -0
- package/dist/esm/create-organization-api.js +1137 -0
- package/dist/esm/create-organization-api.js.map +1 -0
- package/dist/esm/create-space-api.js +1588 -0
- package/dist/esm/create-space-api.js.map +1 -0
- package/dist/esm/create-ui-config-api.js +53 -0
- package/dist/esm/create-ui-config-api.js.map +1 -0
- package/dist/esm/create-user-ui-config-api.js +53 -0
- package/dist/esm/create-user-ui-config-api.js.map +1 -0
- package/dist/esm/enhance-with-methods.js +25 -0
- package/dist/esm/enhance-with-methods.js.map +1 -0
- package/dist/esm/entities/access-token.js +34 -0
- package/dist/esm/entities/access-token.js.map +1 -0
- package/dist/esm/entities/ai-action-invocation.js +17 -0
- package/dist/esm/entities/ai-action-invocation.js.map +1 -0
- package/dist/esm/entities/ai-action.js +73 -0
- package/dist/esm/entities/ai-action.js.map +1 -0
- package/dist/esm/entities/api-key.js +54 -0
- package/dist/esm/entities/api-key.js.map +1 -0
- package/dist/esm/entities/app-access-token.js +16 -0
- package/dist/esm/entities/app-access-token.js.map +1 -0
- package/dist/esm/entities/app-action-call.js +66 -0
- package/dist/esm/entities/app-action-call.js.map +1 -0
- package/dist/esm/entities/app-action.js +46 -0
- package/dist/esm/entities/app-action.js.map +1 -0
- package/dist/esm/entities/app-bundle.js +46 -0
- package/dist/esm/entities/app-bundle.js.map +1 -0
- package/dist/esm/entities/app-definition.js +27 -0
- package/dist/esm/entities/app-definition.js.map +1 -0
- package/dist/esm/entities/app-details.js +38 -0
- package/dist/esm/entities/app-details.js.map +1 -0
- package/dist/esm/entities/app-event-subscription.js +33 -0
- package/dist/esm/entities/app-event-subscription.js.map +1 -0
- package/dist/esm/entities/app-installation.js +53 -0
- package/dist/esm/entities/app-installation.js.map +1 -0
- package/dist/esm/entities/app-key.js +42 -0
- package/dist/esm/entities/app-key.js.map +1 -0
- package/dist/esm/entities/app-signed-request.js +16 -0
- package/dist/esm/entities/app-signed-request.js.map +1 -0
- package/dist/esm/entities/app-signing-secret.js +33 -0
- package/dist/esm/entities/app-signing-secret.js.map +1 -0
- package/dist/esm/entities/app-upload.js +37 -0
- package/dist/esm/entities/app-upload.js.map +1 -0
- package/dist/esm/entities/asset-key.js +16 -0
- package/dist/esm/entities/asset-key.js.map +1 -0
- package/dist/esm/entities/asset.js +130 -0
- package/dist/esm/entities/asset.js.map +1 -0
- package/dist/esm/entities/bulk-action.js +59 -0
- package/dist/esm/entities/bulk-action.js.map +1 -0
- package/dist/esm/entities/comment.js +61 -0
- package/dist/esm/entities/comment.js.map +1 -0
- package/dist/esm/entities/content-type.js +118 -0
- package/dist/esm/entities/content-type.js.map +1 -0
- package/dist/esm/entities/editor-interface.js +48 -0
- package/dist/esm/entities/editor-interface.js.map +1 -0
- package/dist/esm/entities/entry.js +25 -0
- package/dist/esm/entities/entry.js.map +1 -0
- package/dist/esm/entities/environment-alias.js +56 -0
- package/dist/esm/entities/environment-alias.js.map +1 -0
- package/dist/esm/entities/environment-template-installation.js +21 -0
- package/dist/esm/entities/environment-template-installation.js.map +1 -0
- package/dist/esm/entities/environment-template.js +16 -0
- package/dist/esm/entities/environment-template.js.map +1 -0
- package/dist/esm/entities/environment.js +32 -0
- package/dist/esm/entities/environment.js.map +1 -0
- package/dist/esm/entities/extension.js +52 -0
- package/dist/esm/entities/extension.js.map +1 -0
- package/dist/esm/entities/function-log.js +24 -0
- package/dist/esm/entities/function-log.js.map +1 -0
- package/dist/esm/entities/function.js +64 -0
- package/dist/esm/entities/function.js.map +1 -0
- package/dist/esm/entities/locale.js +55 -0
- package/dist/esm/entities/locale.js.map +1 -0
- package/dist/esm/entities/oauth-application.js +64 -0
- package/dist/esm/entities/oauth-application.js.map +1 -0
- package/dist/esm/entities/organization-invitation.js +16 -0
- package/dist/esm/entities/organization-invitation.js.map +1 -0
- package/dist/esm/entities/organization-membership.js +51 -0
- package/dist/esm/entities/organization-membership.js.map +1 -0
- package/dist/esm/entities/organization.js +30 -0
- package/dist/esm/entities/organization.js.map +1 -0
- package/dist/esm/entities/personal-access-token.js +34 -0
- package/dist/esm/entities/personal-access-token.js.map +1 -0
- package/dist/esm/entities/preview-api-key.js +29 -0
- package/dist/esm/entities/preview-api-key.js.map +1 -0
- package/dist/esm/entities/release-action.js +53 -0
- package/dist/esm/entities/release-action.js.map +1 -0
- package/dist/esm/entities/release.js +107 -0
- package/dist/esm/entities/release.js.map +1 -0
- package/dist/esm/entities/resource-provider.js +137 -0
- package/dist/esm/entities/resource-provider.js.map +1 -0
- package/dist/esm/entities/resource-type.js +95 -0
- package/dist/esm/entities/resource-type.js.map +1 -0
- package/dist/esm/entities/resource.js +11 -0
- package/dist/esm/entities/resource.js.map +1 -0
- package/dist/esm/entities/role.js +51 -0
- package/dist/esm/entities/role.js.map +1 -0
- package/dist/esm/entities/scheduled-action.js +147 -0
- package/dist/esm/entities/scheduled-action.js.map +1 -0
- package/dist/esm/entities/snapshot.js +34 -0
- package/dist/esm/entities/snapshot.js.map +1 -0
- package/dist/esm/entities/space-member.js +21 -0
- package/dist/esm/entities/space-member.js.map +1 -0
- package/dist/esm/entities/space-membership.js +51 -0
- package/dist/esm/entities/space-membership.js.map +1 -0
- package/dist/esm/entities/space.js +31 -0
- package/dist/esm/entities/space.js.map +1 -0
- package/dist/esm/entities/tag.js +54 -0
- package/dist/esm/entities/tag.js.map +1 -0
- package/dist/esm/entities/task.js +55 -0
- package/dist/esm/entities/task.js.map +1 -0
- package/dist/esm/entities/team-membership.js +52 -0
- package/dist/esm/entities/team-membership.js.map +1 -0
- package/dist/esm/entities/team-space-membership.js +51 -0
- package/dist/esm/entities/team-space-membership.js.map +1 -0
- package/dist/esm/entities/team.js +51 -0
- package/dist/esm/entities/team.js.map +1 -0
- package/dist/esm/entities/ui-config.js +19 -0
- package/dist/esm/entities/ui-config.js.map +1 -0
- package/dist/esm/entities/upload.js +37 -0
- package/dist/esm/entities/upload.js.map +1 -0
- package/dist/esm/entities/usage.js +23 -0
- package/dist/esm/entities/usage.js.map +1 -0
- package/dist/esm/entities/user-ui-config.js +19 -0
- package/dist/esm/entities/user-ui-config.js.map +1 -0
- package/dist/esm/entities/user.js +26 -0
- package/dist/esm/entities/user.js.map +1 -0
- package/dist/esm/entities/webhook.js +75 -0
- package/dist/esm/entities/webhook.js.map +1 -0
- package/dist/esm/entities/workflow-definition.js +29 -0
- package/dist/esm/entities/workflow-definition.js.map +1 -0
- package/dist/esm/index.js +37 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/methods/action.js +49 -0
- package/dist/esm/methods/action.js.map +1 -0
- package/dist/esm/methods/content-type.js +47 -0
- package/dist/esm/methods/content-type.js.map +1 -0
- package/dist/esm/methods/utils.js +10 -0
- package/dist/esm/methods/utils.js.map +1 -0
- package/dist/esm/plain/as-iterator.js +37 -0
- package/dist/esm/plain/as-iterator.js.map +1 -0
- package/dist/esm/plain/checks.js +11 -0
- package/dist/esm/plain/checks.js.map +1 -0
- package/dist/esm/plain/pagination-helper.js +68 -0
- package/dist/esm/plain/pagination-helper.js.map +1 -0
- package/dist/esm/plain/plain-client.js +559 -0
- package/dist/esm/plain/plain-client.js.map +1 -0
- package/dist/esm/plain/wrappers/wrap.js +25 -0
- package/dist/esm/plain/wrappers/wrap.js.map +1 -0
- package/dist/esm/upload-http-client.js +15 -0
- package/dist/esm/upload-http-client.js.map +1 -0
- package/dist/stats-browser-min.html +4949 -0
- package/dist/types/adapters/REST/endpoints/access-token.d.ts +111 -0
- package/dist/types/adapters/REST/endpoints/access-token.js +130 -0
- package/dist/types/adapters/REST/endpoints/ai-action-invocation.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/ai-action-invocation.js +7 -0
- package/dist/types/adapters/REST/endpoints/ai-action.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/ai-action.js +48 -0
- package/dist/types/adapters/REST/endpoints/api-key.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/api-key.js +43 -0
- package/dist/types/adapters/REST/endpoints/app-access-token.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/app-access-token.js +7 -0
- package/dist/types/adapters/REST/endpoints/app-action-call.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/app-action-call.js +111 -0
- package/dist/types/adapters/REST/endpoints/app-action.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/app-action.js +35 -0
- package/dist/types/adapters/REST/endpoints/app-bundle.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/app-bundle.js +34 -0
- package/dist/types/adapters/REST/endpoints/app-definition.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/app-definition.js +44 -0
- package/dist/types/adapters/REST/endpoints/app-details.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/app-details.js +13 -0
- package/dist/types/adapters/REST/endpoints/app-event-subscription.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/app-event-subscription.js +13 -0
- package/dist/types/adapters/REST/endpoints/app-installation.d.ts +8 -0
- package/dist/types/adapters/REST/endpoints/app-installation.js +41 -0
- package/dist/types/adapters/REST/endpoints/app-key.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/app-key.js +16 -0
- package/dist/types/adapters/REST/endpoints/app-signed-request.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/app-signed-request.js +7 -0
- package/dist/types/adapters/REST/endpoints/app-signing-secret.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/app-signing-secret.js +13 -0
- package/dist/types/adapters/REST/endpoints/app-upload.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/app-upload.js +24 -0
- package/dist/types/adapters/REST/endpoints/asset-key.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/asset-key.js +31 -0
- package/dist/types/adapters/REST/endpoints/asset.d.ts +15 -0
- package/dist/types/adapters/REST/endpoints/asset.js +207 -0
- package/dist/types/adapters/REST/endpoints/bulk-action.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/bulk-action.js +16 -0
- package/dist/types/adapters/REST/endpoints/comment.d.ts +10 -0
- package/dist/types/adapters/REST/endpoints/comment.js +90 -0
- package/dist/types/adapters/REST/endpoints/concept-scheme.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/concept-scheme.js +45 -0
- package/dist/types/adapters/REST/endpoints/concept.d.ts +11 -0
- package/dist/types/adapters/REST/endpoints/concept.js +61 -0
- package/dist/types/adapters/REST/endpoints/content-type.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/content-type.js +52 -0
- package/dist/types/adapters/REST/endpoints/editor-interface.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/editor-interface.js +22 -0
- package/dist/types/adapters/REST/endpoints/entry.d.ts +14 -0
- package/dist/types/adapters/REST/endpoints/entry.js +113 -0
- package/dist/types/adapters/REST/endpoints/environment-alias.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/environment-alias.js +40 -0
- package/dist/types/adapters/REST/endpoints/environment-template-installation.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/environment-template-installation.js +20 -0
- package/dist/types/adapters/REST/endpoints/environment-template.d.ts +11 -0
- package/dist/types/adapters/REST/endpoints/environment-template.js +40 -0
- package/dist/types/adapters/REST/endpoints/environment.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/environment.js +45 -0
- package/dist/types/adapters/REST/endpoints/extension.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/extension.js +38 -0
- package/dist/types/adapters/REST/endpoints/function-log.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/function-log.js +24 -0
- package/dist/types/adapters/REST/endpoints/function.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/function.js +21 -0
- package/dist/types/adapters/REST/endpoints/http.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/http.js +22 -0
- package/dist/types/adapters/REST/endpoints/index.d.ts +139 -0
- package/dist/types/adapters/REST/endpoints/index.js +141 -0
- package/dist/types/adapters/REST/endpoints/locale.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/locale.js +33 -0
- package/dist/types/adapters/REST/endpoints/oauth-application.d.ts +122 -0
- package/dist/types/adapters/REST/endpoints/oauth-application.js +141 -0
- package/dist/types/adapters/REST/endpoints/organization-invitation.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/organization-invitation.js +26 -0
- package/dist/types/adapters/REST/endpoints/organization-membership.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/organization-membership.js +29 -0
- package/dist/types/adapters/REST/endpoints/organization.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/organization.js +25 -0
- package/dist/types/adapters/REST/endpoints/personal-access-token.d.ts +17 -0
- package/dist/types/adapters/REST/endpoints/personal-access-token.js +32 -0
- package/dist/types/adapters/REST/endpoints/preview-api-key.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/preview-api-key.js +12 -0
- package/dist/types/adapters/REST/endpoints/raw.js +54 -0
- package/dist/types/adapters/REST/endpoints/release-action.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/release-action.js +20 -0
- package/dist/types/adapters/REST/endpoints/release-asset.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/release-asset.js +142 -0
- package/dist/types/adapters/REST/endpoints/release-entry.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/release-entry.js +55 -0
- package/dist/types/adapters/REST/endpoints/release.d.ts +11 -0
- package/dist/types/adapters/REST/endpoints/release.js +72 -0
- package/dist/types/adapters/REST/endpoints/resource-provider.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/resource-provider.js +14 -0
- package/dist/types/adapters/REST/endpoints/resource-type.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/resource-type.js +24 -0
- package/dist/types/adapters/REST/endpoints/resource.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/resource.js +8 -0
- package/dist/types/adapters/REST/endpoints/role.d.ts +12 -0
- package/dist/types/adapters/REST/endpoints/role.js +42 -0
- package/dist/types/adapters/REST/endpoints/scheduled-action.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/scheduled-action.js +37 -0
- package/dist/types/adapters/REST/endpoints/snapshot.d.ts +5 -0
- package/dist/types/adapters/REST/endpoints/snapshot.js +25 -0
- package/dist/types/adapters/REST/endpoints/space-member.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/space-member.js +8 -0
- package/dist/types/adapters/REST/endpoints/space-membership.d.ts +9 -0
- package/dist/types/adapters/REST/endpoints/space-membership.js +53 -0
- package/dist/types/adapters/REST/endpoints/space.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/space.js +30 -0
- package/dist/types/adapters/REST/endpoints/tag.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/tag.js +30 -0
- package/dist/types/adapters/REST/endpoints/task.d.ts +10 -0
- package/dist/types/adapters/REST/endpoints/task.js +33 -0
- package/dist/types/adapters/REST/endpoints/team-membership.d.ts +10 -0
- package/dist/types/adapters/REST/endpoints/team-membership.js +31 -0
- package/dist/types/adapters/REST/endpoints/team-space-membership.d.ts +8 -0
- package/dist/types/adapters/REST/endpoints/team-space-membership.js +45 -0
- package/dist/types/adapters/REST/endpoints/team.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/team.js +31 -0
- package/dist/types/adapters/REST/endpoints/ui-config.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/ui-config.js +18 -0
- package/dist/types/adapters/REST/endpoints/upload-credentials.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/upload-credentials.js +13 -0
- package/dist/types/adapters/REST/endpoints/upload.d.ts +4 -0
- package/dist/types/adapters/REST/endpoints/upload.js +38 -0
- package/dist/types/adapters/REST/endpoints/usage.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/usage.js +14 -0
- package/dist/types/adapters/REST/endpoints/user-ui-config.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/user-ui-config.js +18 -0
- package/dist/types/adapters/REST/endpoints/user.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/user.js +21 -0
- package/dist/types/adapters/REST/endpoints/utils.d.ts +3 -0
- package/dist/types/adapters/REST/endpoints/utils.js +21 -0
- package/dist/types/adapters/REST/endpoints/webhook.d.ts +29 -0
- package/dist/types/adapters/REST/endpoints/webhook.js +84 -0
- package/dist/types/adapters/REST/endpoints/workflow-definition.d.ts +6 -0
- package/dist/types/adapters/REST/endpoints/workflow-definition.js +35 -0
- package/dist/types/adapters/REST/endpoints/workflow.d.ts +7 -0
- package/dist/types/adapters/REST/endpoints/workflow.js +41 -0
- package/dist/types/adapters/REST/endpoints/workflows-changelog.d.ts +2 -0
- package/dist/types/adapters/REST/endpoints/workflows-changelog.js +9 -0
- package/dist/types/adapters/REST/make-request.d.ts +7 -0
- package/dist/types/adapters/REST/make-request.js +20 -0
- package/dist/types/adapters/REST/rest-adapter.d.ts +25 -0
- package/dist/types/adapters/REST/rest-adapter.js +41 -0
- package/dist/types/adapters/REST/types.d.ts +6 -0
- package/dist/types/common-types.d.ts +2914 -0
- package/dist/types/common-types.js +6 -0
- package/dist/types/common-utils.d.ts +9 -0
- package/dist/types/common-utils.js +32 -0
- package/dist/types/constants/editor-interface-defaults/controls-defaults.d.ts +244 -0
- package/dist/types/constants/editor-interface-defaults/controls-defaults.js +161 -0
- package/dist/types/constants/editor-interface-defaults/editors-defaults.d.ts +23 -0
- package/dist/types/constants/editor-interface-defaults/editors-defaults.js +37 -0
- package/dist/types/constants/editor-interface-defaults/index.d.ts +22 -0
- package/dist/types/constants/editor-interface-defaults/index.js +12 -0
- package/dist/types/constants/editor-interface-defaults/sidebar-defaults.d.ts +13 -0
- package/dist/types/constants/editor-interface-defaults/sidebar-defaults.js +68 -0
- package/dist/types/constants/editor-interface-defaults/types.js +15 -0
- package/dist/types/create-adapter.d.ts +13 -0
- package/dist/types/create-adapter.js +19 -0
- package/dist/types/create-app-definition-api.d.ts +169 -0
- package/dist/types/create-app-definition-api.js +251 -0
- package/dist/types/create-contentful-api.d.ts +446 -0
- package/dist/types/create-contentful-api.js +587 -0
- package/dist/types/create-entry-api.d.ts +331 -0
- package/dist/types/create-entry-api.js +487 -0
- package/dist/types/create-environment-api.d.ts +1688 -0
- package/dist/types/create-environment-api.js +2439 -0
- package/dist/types/create-environment-template-api.d.ts +196 -0
- package/dist/types/create-environment-template-api.js +268 -0
- package/dist/types/create-organization-api.d.ts +1180 -0
- package/dist/types/create-organization-api.js +1136 -0
- package/dist/types/create-space-api.d.ts +1150 -0
- package/dist/types/create-space-api.js +1587 -0
- package/dist/types/create-ui-config-api.d.ts +34 -0
- package/dist/types/create-ui-config-api.js +52 -0
- package/dist/types/create-user-ui-config-api.d.ts +34 -0
- package/dist/types/create-user-ui-config-api.js +52 -0
- package/dist/types/enhance-with-methods.js +24 -0
- package/dist/types/entities/access-token.d.ts +61 -0
- package/dist/types/entities/access-token.js +33 -0
- package/dist/types/entities/ai-action-invocation.d.ts +82 -0
- package/dist/types/entities/ai-action-invocation.js +16 -0
- package/dist/types/entities/ai-action.d.ts +72 -0
- package/dist/types/entities/ai-action.js +72 -0
- package/dist/types/entities/api-key.d.ts +66 -0
- package/dist/types/entities/api-key.js +53 -0
- package/dist/types/entities/app-access-token.d.ts +34 -0
- package/dist/types/entities/app-access-token.js +15 -0
- package/dist/types/entities/app-action-call.d.ts +92 -0
- package/dist/types/entities/app-action-call.js +65 -0
- package/dist/types/entities/app-action.d.ts +161 -0
- package/dist/types/entities/app-action.js +45 -0
- package/dist/types/entities/app-bundle.d.ts +86 -0
- package/dist/types/entities/app-bundle.js +45 -0
- package/dist/types/entities/app-definition.d.ts +82 -0
- package/dist/types/entities/app-definition.js +26 -0
- package/dist/types/entities/app-details.d.ts +54 -0
- package/dist/types/entities/app-details.js +37 -0
- package/dist/types/entities/app-event-subscription.d.ts +50 -0
- package/dist/types/entities/app-event-subscription.js +32 -0
- package/dist/types/entities/app-installation.d.ts +70 -0
- package/dist/types/entities/app-installation.js +52 -0
- package/dist/types/entities/app-key.d.ts +77 -0
- package/dist/types/entities/app-key.js +41 -0
- package/dist/types/entities/app-signed-request.d.ts +42 -0
- package/dist/types/entities/app-signed-request.js +15 -0
- package/dist/types/entities/app-signing-secret.d.ts +45 -0
- package/dist/types/entities/app-signing-secret.js +32 -0
- package/dist/types/entities/app-upload.d.ts +44 -0
- package/dist/types/entities/app-upload.js +36 -0
- package/dist/types/entities/asset-key.d.ts +20 -0
- package/dist/types/entities/asset-key.js +15 -0
- package/dist/types/entities/asset.d.ts +277 -0
- package/dist/types/entities/asset.js +129 -0
- package/dist/types/entities/bulk-action.d.ts +94 -0
- package/dist/types/entities/bulk-action.js +58 -0
- package/dist/types/entities/comment.d.ts +102 -0
- package/dist/types/entities/comment.js +60 -0
- package/dist/types/entities/concept-scheme.d.ts +22 -0
- package/dist/types/entities/concept.d.ts +30 -0
- package/dist/types/entities/content-type-fields.d.ts +81 -0
- package/dist/types/entities/content-type.d.ts +213 -0
- package/dist/types/entities/content-type.js +117 -0
- package/dist/types/entities/editor-interface.d.ts +162 -0
- package/dist/types/entities/editor-interface.js +47 -0
- package/dist/types/entities/entry.d.ts +57 -0
- package/dist/types/entities/entry.js +24 -0
- package/dist/types/entities/environment-alias.d.ts +72 -0
- package/dist/types/entities/environment-alias.js +55 -0
- package/dist/types/entities/environment-template-installation.d.ts +56 -0
- package/dist/types/entities/environment-template-installation.js +20 -0
- package/dist/types/entities/environment-template.d.ts +40 -0
- package/dist/types/entities/environment-template.js +15 -0
- package/dist/types/entities/environment.d.ts +38 -0
- package/dist/types/entities/environment.js +31 -0
- package/dist/types/entities/extension.d.ts +103 -0
- package/dist/types/entities/extension.js +51 -0
- package/dist/types/entities/function-log.d.ts +46 -0
- package/dist/types/entities/function-log.js +23 -0
- package/dist/types/entities/function.d.ts +32 -0
- package/dist/types/entities/function.js +63 -0
- package/dist/types/entities/locale.d.ts +95 -0
- package/dist/types/entities/locale.js +54 -0
- package/dist/types/entities/oauth-application.d.ts +56 -0
- package/dist/types/entities/oauth-application.js +63 -0
- package/dist/types/entities/organization-invitation.d.ts +23 -0
- package/dist/types/entities/organization-invitation.js +15 -0
- package/dist/types/entities/organization-membership.d.ts +67 -0
- package/dist/types/entities/organization-membership.js +50 -0
- package/dist/types/entities/organization.d.ts +33 -0
- package/dist/types/entities/organization.js +29 -0
- package/dist/types/entities/personal-access-token.d.ts +51 -0
- package/dist/types/entities/personal-access-token.js +33 -0
- package/dist/types/entities/preview-api-key.d.ts +20 -0
- package/dist/types/entities/preview-api-key.js +28 -0
- package/dist/types/entities/release-action.d.ts +58 -0
- package/dist/types/entities/release-action.js +52 -0
- package/dist/types/entities/release.d.ts +142 -0
- package/dist/types/entities/release.js +106 -0
- package/dist/types/entities/resource-provider.d.ts +38 -0
- package/dist/types/entities/resource-provider.js +136 -0
- package/dist/types/entities/resource-type.d.ts +52 -0
- package/dist/types/entities/resource-type.js +94 -0
- package/dist/types/entities/resource.d.ts +38 -0
- package/dist/types/entities/resource.js +10 -0
- package/dist/types/entities/role.d.ts +85 -0
- package/dist/types/entities/role.js +50 -0
- package/dist/types/entities/scheduled-action.d.ts +110 -0
- package/dist/types/entities/scheduled-action.js +146 -0
- package/dist/types/entities/snapshot.d.ts +24 -0
- package/dist/types/entities/snapshot.js +33 -0
- package/dist/types/entities/space-member.d.ts +29 -0
- package/dist/types/entities/space-member.js +20 -0
- package/dist/types/entities/space-membership.d.ts +64 -0
- package/dist/types/entities/space-membership.js +50 -0
- package/dist/types/entities/space.d.ts +31 -0
- package/dist/types/entities/space.js +30 -0
- package/dist/types/entities/tag.d.ts +51 -0
- package/dist/types/entities/tag.js +53 -0
- package/dist/types/entities/task.d.ts +43 -0
- package/dist/types/entities/task.js +54 -0
- package/dist/types/entities/team-membership.d.ts +72 -0
- package/dist/types/entities/team-membership.js +51 -0
- package/dist/types/entities/team-space-membership.d.ts +82 -0
- package/dist/types/entities/team-space-membership.js +50 -0
- package/dist/types/entities/team.d.ts +71 -0
- package/dist/types/entities/team.js +50 -0
- package/dist/types/entities/ui-config.d.ts +59 -0
- package/dist/types/entities/ui-config.js +18 -0
- package/dist/types/entities/upload-credential.d.ts +43 -0
- package/dist/types/entities/upload.d.ts +41 -0
- package/dist/types/entities/upload.js +36 -0
- package/dist/types/entities/usage.d.ts +55 -0
- package/dist/types/entities/usage.js +22 -0
- package/dist/types/entities/user-ui-config.d.ts +46 -0
- package/dist/types/entities/user-ui-config.js +18 -0
- package/dist/types/entities/user.d.ts +57 -0
- package/dist/types/entities/user.js +25 -0
- package/dist/types/entities/webhook.d.ts +273 -0
- package/dist/types/entities/webhook.js +74 -0
- package/dist/types/entities/workflow-definition.d.ts +118 -0
- package/dist/types/entities/workflow-definition.js +28 -0
- package/dist/types/entities/workflow.d.ts +64 -0
- package/dist/types/entities/workflows-changelog-entry.d.ts +33 -0
- package/dist/types/export-types.d.ts +70 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/index.js +36 -0
- package/dist/types/methods/action.js +48 -0
- package/dist/types/methods/bulk-action.d.ts +14 -0
- package/dist/types/methods/content-type.d.ts +5 -0
- package/dist/types/methods/content-type.js +46 -0
- package/dist/types/methods/release-action.d.ts +15 -0
- package/dist/types/methods/utils.js +9 -0
- package/dist/types/plain/as-iterator.d.ts +5 -0
- package/dist/types/plain/as-iterator.js +36 -0
- package/dist/types/plain/checks.d.ts +13 -0
- package/dist/types/plain/checks.js +10 -0
- package/dist/types/plain/common-types.d.ts +459 -0
- package/dist/types/plain/entities/ai-action-invocation.d.ts +18 -0
- package/dist/types/plain/entities/ai-action.d.ts +84 -0
- package/dist/types/plain/entities/app-access-token.d.ts +29 -0
- package/dist/types/plain/entities/app-action-call.d.ts +147 -0
- package/dist/types/plain/entities/app-action.d.ts +157 -0
- package/dist/types/plain/entities/app-bundle.d.ts +67 -0
- package/dist/types/plain/entities/app-definition.d.ts +100 -0
- package/dist/types/plain/entities/app-details.d.ts +56 -0
- package/dist/types/plain/entities/app-event-subscription.d.ts +75 -0
- package/dist/types/plain/entities/app-installation.d.ts +87 -0
- package/dist/types/plain/entities/app-key.d.ts +91 -0
- package/dist/types/plain/entities/app-signed-request.d.ts +34 -0
- package/dist/types/plain/entities/app-signing-secret.d.ts +49 -0
- package/dist/types/plain/entities/app-upload.d.ts +55 -0
- package/dist/types/plain/entities/comment.d.ts +198 -0
- package/dist/types/plain/entities/concept-scheme.d.ts +119 -0
- package/dist/types/plain/entities/concept.d.ts +147 -0
- package/dist/types/plain/entities/editor-interface.d.ts +67 -0
- package/dist/types/plain/entities/environment-alias.d.ts +99 -0
- package/dist/types/plain/entities/environment.d.ts +116 -0
- package/dist/types/plain/entities/extension.d.ts +157 -0
- package/dist/types/plain/entities/function-log.d.ts +51 -0
- package/dist/types/plain/entities/function.d.ts +51 -0
- package/dist/types/plain/entities/locale.d.ts +112 -0
- package/dist/types/plain/entities/oauth-application.d.ts +90 -0
- package/dist/types/plain/entities/organization.d.ts +33 -0
- package/dist/types/plain/entities/resource-provider.d.ts +59 -0
- package/dist/types/plain/entities/resource-type.d.ts +14 -0
- package/dist/types/plain/entities/resource.d.ts +40 -0
- package/dist/types/plain/entities/role.d.ts +206 -0
- package/dist/types/plain/entities/space-member.d.ts +32 -0
- package/dist/types/plain/entities/space-membership.d.ts +155 -0
- package/dist/types/plain/entities/space.d.ts +102 -0
- package/dist/types/plain/entities/tag.d.ts +103 -0
- package/dist/types/plain/entities/task.d.ts +114 -0
- package/dist/types/plain/entities/team-membership.d.ts +110 -0
- package/dist/types/plain/entities/team-space-membership.d.ts +127 -0
- package/dist/types/plain/entities/team.d.ts +105 -0
- package/dist/types/plain/entities/ui-config.d.ts +44 -0
- package/dist/types/plain/entities/upload-credential.d.ts +38 -0
- package/dist/types/plain/entities/upload.d.ts +57 -0
- package/dist/types/plain/entities/usage.d.ts +49 -0
- package/dist/types/plain/entities/user-ui-config.d.ts +44 -0
- package/dist/types/plain/entities/user.d.ts +80 -0
- package/dist/types/plain/entities/webhook.d.ts +186 -0
- package/dist/types/plain/entities/workflow-definition.d.ts +90 -0
- package/dist/types/plain/entities/workflow.d.ts +118 -0
- package/dist/types/plain/entities/workflows-changelog.d.ts +26 -0
- package/dist/types/plain/pagination-helper.d.ts +22 -0
- package/dist/types/plain/pagination-helper.js +67 -0
- package/dist/types/plain/plain-client.d.ts +8 -0
- package/dist/types/plain/plain-client.js +558 -0
- package/dist/types/plain/wrappers/wrap.d.ts +32 -0
- package/dist/types/plain/wrappers/wrap.js +24 -0
- package/dist/types/upload-http-client.js +14 -0
- package/package.json +59 -54
- package/dist/contentful-management.node.js +0 -33388
- package/dist/contentful-management.node.js.map +0 -1
- package/dist/contentful-management.node.min.js +0 -2
- package/dist/es-modules/adapters/REST/endpoints/access-token.js +0 -132
- package/dist/es-modules/adapters/REST/endpoints/ai-action-invocation.js +0 -6
- package/dist/es-modules/adapters/REST/endpoints/ai-action.js +0 -61
- package/dist/es-modules/adapters/REST/endpoints/api-key.js +0 -47
- package/dist/es-modules/adapters/REST/endpoints/app-access-token.js +0 -8
- package/dist/es-modules/adapters/REST/endpoints/app-action-call.js +0 -128
- package/dist/es-modules/adapters/REST/endpoints/app-action.js +0 -32
- package/dist/es-modules/adapters/REST/endpoints/app-bundle.js +0 -36
- package/dist/es-modules/adapters/REST/endpoints/app-definition.js +0 -45
- package/dist/es-modules/adapters/REST/endpoints/app-details.js +0 -10
- package/dist/es-modules/adapters/REST/endpoints/app-event-subscription.js +0 -10
- package/dist/es-modules/adapters/REST/endpoints/app-installation.js +0 -39
- package/dist/es-modules/adapters/REST/endpoints/app-key.js +0 -13
- package/dist/es-modules/adapters/REST/endpoints/app-signed-request.js +0 -4
- package/dist/es-modules/adapters/REST/endpoints/app-signing-secret.js +0 -10
- package/dist/es-modules/adapters/REST/endpoints/app-upload.js +0 -23
- package/dist/es-modules/adapters/REST/endpoints/asset-key.js +0 -33
- package/dist/es-modules/adapters/REST/endpoints/asset.js +0 -255
- package/dist/es-modules/adapters/REST/endpoints/bulk-action.js +0 -13
- package/dist/es-modules/adapters/REST/endpoints/comment.js +0 -101
- package/dist/es-modules/adapters/REST/endpoints/concept-scheme.js +0 -52
- package/dist/es-modules/adapters/REST/endpoints/concept.js +0 -84
- package/dist/es-modules/adapters/REST/endpoints/content-type.js +0 -61
- package/dist/es-modules/adapters/REST/endpoints/editor-interface.js +0 -24
- package/dist/es-modules/adapters/REST/endpoints/entry.js +0 -132
- package/dist/es-modules/adapters/REST/endpoints/environment-alias.js +0 -46
- package/dist/es-modules/adapters/REST/endpoints/environment-template-installation.js +0 -43
- package/dist/es-modules/adapters/REST/endpoints/environment-template.js +0 -88
- package/dist/es-modules/adapters/REST/endpoints/environment.js +0 -42
- package/dist/es-modules/adapters/REST/endpoints/extension.js +0 -44
- package/dist/es-modules/adapters/REST/endpoints/function-log.js +0 -22
- package/dist/es-modules/adapters/REST/endpoints/function.js +0 -20
- package/dist/es-modules/adapters/REST/endpoints/http.js +0 -39
- package/dist/es-modules/adapters/REST/endpoints/index.js +0 -138
- package/dist/es-modules/adapters/REST/endpoints/locale.js +0 -35
- package/dist/es-modules/adapters/REST/endpoints/oauth-application.js +0 -142
- package/dist/es-modules/adapters/REST/endpoints/organization-invitation.js +0 -22
- package/dist/es-modules/adapters/REST/endpoints/organization-membership.js +0 -35
- package/dist/es-modules/adapters/REST/endpoints/organization.js +0 -26
- package/dist/es-modules/adapters/REST/endpoints/personal-access-token.js +0 -33
- package/dist/es-modules/adapters/REST/endpoints/preview-api-key.js +0 -9
- package/dist/es-modules/adapters/REST/endpoints/raw.js +0 -42
- package/dist/es-modules/adapters/REST/endpoints/release-action.js +0 -21
- package/dist/es-modules/adapters/REST/endpoints/release-asset.js +0 -176
- package/dist/es-modules/adapters/REST/endpoints/release-entry.js +0 -54
- package/dist/es-modules/adapters/REST/endpoints/release.js +0 -82
- package/dist/es-modules/adapters/REST/endpoints/resource-provider.js +0 -13
- package/dist/es-modules/adapters/REST/endpoints/resource-type.js +0 -23
- package/dist/es-modules/adapters/REST/endpoints/resource.js +0 -5
- package/dist/es-modules/adapters/REST/endpoints/role.js +0 -44
- package/dist/es-modules/adapters/REST/endpoints/scheduled-action.js +0 -35
- package/dist/es-modules/adapters/REST/endpoints/snapshot.js +0 -22
- package/dist/es-modules/adapters/REST/endpoints/space-member.js +0 -5
- package/dist/es-modules/adapters/REST/endpoints/space-membership.js +0 -55
- package/dist/es-modules/adapters/REST/endpoints/space.js +0 -32
- package/dist/es-modules/adapters/REST/endpoints/tag.js +0 -46
- package/dist/es-modules/adapters/REST/endpoints/task.js +0 -47
- package/dist/es-modules/adapters/REST/endpoints/team-membership.js +0 -34
- package/dist/es-modules/adapters/REST/endpoints/team-space-membership.js +0 -45
- package/dist/es-modules/adapters/REST/endpoints/team.js +0 -35
- package/dist/es-modules/adapters/REST/endpoints/ui-config.js +0 -16
- package/dist/es-modules/adapters/REST/endpoints/upload-credentials.js +0 -11
- package/dist/es-modules/adapters/REST/endpoints/upload.js +0 -37
- package/dist/es-modules/adapters/REST/endpoints/usage.js +0 -11
- package/dist/es-modules/adapters/REST/endpoints/user-ui-config.js +0 -16
- package/dist/es-modules/adapters/REST/endpoints/user.js +0 -20
- package/dist/es-modules/adapters/REST/endpoints/utils.js +0 -28
- package/dist/es-modules/adapters/REST/endpoints/webhook.js +0 -93
- package/dist/es-modules/adapters/REST/endpoints/workflow-definition.js +0 -46
- package/dist/es-modules/adapters/REST/endpoints/workflow.js +0 -59
- package/dist/es-modules/adapters/REST/endpoints/workflows-changelog.js +0 -6
- package/dist/es-modules/adapters/REST/make-request.js +0 -28
- package/dist/es-modules/adapters/REST/rest-adapter.js +0 -42
- package/dist/es-modules/adapters/REST/types.js +0 -1
- package/dist/es-modules/common-types.js +0 -65
- package/dist/es-modules/common-utils.js +0 -30
- package/dist/es-modules/constants/editor-interface-defaults/controls-defaults.js +0 -255
- package/dist/es-modules/constants/editor-interface-defaults/editors-defaults.js +0 -34
- package/dist/es-modules/constants/editor-interface-defaults/index.js +0 -9
- package/dist/es-modules/constants/editor-interface-defaults/sidebar-defaults.js +0 -57
- package/dist/es-modules/constants/editor-interface-defaults/types.js +0 -14
- package/dist/es-modules/contentful-management.js +0 -66
- package/dist/es-modules/create-adapter.js +0 -16
- package/dist/es-modules/create-app-definition-api.js +0 -263
- package/dist/es-modules/create-contentful-api.js +0 -663
- package/dist/es-modules/create-entry-api.js +0 -548
- package/dist/es-modules/create-environment-api.js +0 -2560
- package/dist/es-modules/create-environment-template-api.js +0 -316
- package/dist/es-modules/create-organization-api.js +0 -1306
- package/dist/es-modules/create-space-api.js +0 -1750
- package/dist/es-modules/create-ui-config-api.js +0 -60
- package/dist/es-modules/create-user-ui-config-api.js +0 -60
- package/dist/es-modules/enhance-with-methods.js +0 -22
- package/dist/es-modules/entities/access-token.js +0 -38
- package/dist/es-modules/entities/ai-action-invocation.js +0 -34
- package/dist/es-modules/entities/ai-action.js +0 -69
- package/dist/es-modules/entities/api-key.js +0 -55
- package/dist/es-modules/entities/app-access-token.js +0 -12
- package/dist/es-modules/entities/app-action-call.js +0 -69
- package/dist/es-modules/entities/app-action.js +0 -53
- package/dist/es-modules/entities/app-bundle.js +0 -44
- package/dist/es-modules/entities/app-definition.js +0 -24
- package/dist/es-modules/entities/app-details.js +0 -35
- package/dist/es-modules/entities/app-event-subscription.js +0 -30
- package/dist/es-modules/entities/app-installation.js +0 -51
- package/dist/es-modules/entities/app-key.js +0 -40
- package/dist/es-modules/entities/app-signed-request.js +0 -12
- package/dist/es-modules/entities/app-signing-secret.js +0 -30
- package/dist/es-modules/entities/app-upload.js +0 -43
- package/dist/es-modules/entities/asset-key.js +0 -12
- package/dist/es-modules/entities/asset.js +0 -131
- package/dist/es-modules/entities/bulk-action.js +0 -61
- package/dist/es-modules/entities/comment.js +0 -77
- package/dist/es-modules/entities/concept-scheme.js +0 -1
- package/dist/es-modules/entities/concept.js +0 -1
- package/dist/es-modules/entities/content-type-fields.js +0 -1
- package/dist/es-modules/entities/content-type.js +0 -146
- package/dist/es-modules/entities/editor-interface.js +0 -46
- package/dist/es-modules/entities/entry.js +0 -22
- package/dist/es-modules/entities/environment-alias.js +0 -54
- package/dist/es-modules/entities/environment-template-installation.js +0 -17
- package/dist/es-modules/entities/environment-template.js +0 -12
- package/dist/es-modules/entities/environment.js +0 -29
- package/dist/es-modules/entities/extension.js +0 -50
- package/dist/es-modules/entities/field-type.js +0 -1
- package/dist/es-modules/entities/function-log.js +0 -21
- package/dist/es-modules/entities/function.js +0 -61
- package/dist/es-modules/entities/index.js +0 -126
- package/dist/es-modules/entities/locale.js +0 -53
- package/dist/es-modules/entities/oauth-application.js +0 -62
- package/dist/es-modules/entities/organization-invitation.js +0 -12
- package/dist/es-modules/entities/organization-membership.js +0 -49
- package/dist/es-modules/entities/organization.js +0 -32
- package/dist/es-modules/entities/personal-access-token.js +0 -38
- package/dist/es-modules/entities/preview-api-key.js +0 -27
- package/dist/es-modules/entities/release-action.js +0 -53
- package/dist/es-modules/entities/release.js +0 -105
- package/dist/es-modules/entities/resource-provider.js +0 -139
- package/dist/es-modules/entities/resource-type.js +0 -93
- package/dist/es-modules/entities/resource.js +0 -7
- package/dist/es-modules/entities/role.js +0 -49
- package/dist/es-modules/entities/scheduled-action.js +0 -155
- package/dist/es-modules/entities/snapshot.js +0 -31
- package/dist/es-modules/entities/space-member.js +0 -18
- package/dist/es-modules/entities/space-membership.js +0 -49
- package/dist/es-modules/entities/space.js +0 -28
- package/dist/es-modules/entities/tag.js +0 -56
- package/dist/es-modules/entities/task.js +0 -57
- package/dist/es-modules/entities/team-membership.js +0 -50
- package/dist/es-modules/entities/team-space-membership.js +0 -49
- package/dist/es-modules/entities/team.js +0 -49
- package/dist/es-modules/entities/ui-config.js +0 -15
- package/dist/es-modules/entities/upload-credential.js +0 -33
- package/dist/es-modules/entities/upload.js +0 -34
- package/dist/es-modules/entities/usage.js +0 -20
- package/dist/es-modules/entities/user-ui-config.js +0 -15
- package/dist/es-modules/entities/user.js +0 -23
- package/dist/es-modules/entities/utils.js +0 -1
- package/dist/es-modules/entities/webhook.js +0 -80
- package/dist/es-modules/entities/widget-parameters.js +0 -1
- package/dist/es-modules/entities/workflow-definition.js +0 -87
- package/dist/es-modules/entities/workflow.js +0 -76
- package/dist/es-modules/entities/workflows-changelog-entry.js +0 -24
- package/dist/es-modules/export-types.js +0 -3
- package/dist/es-modules/methods/action.js +0 -54
- package/dist/es-modules/methods/bulk-action.js +0 -15
- package/dist/es-modules/methods/content-type.js +0 -47
- package/dist/es-modules/methods/release-action.js +0 -17
- package/dist/es-modules/methods/utils.js +0 -7
- package/dist/es-modules/plain/as-iterator.js +0 -47
- package/dist/es-modules/plain/checks.js +0 -8
- package/dist/es-modules/plain/common-types.js +0 -1
- package/dist/es-modules/plain/entities/ai-action-invocation.js +0 -1
- package/dist/es-modules/plain/entities/ai-action.js +0 -1
- package/dist/es-modules/plain/entities/app-access-token.js +0 -1
- package/dist/es-modules/plain/entities/app-action-call.js +0 -1
- package/dist/es-modules/plain/entities/app-action.js +0 -1
- package/dist/es-modules/plain/entities/app-bundle.js +0 -1
- package/dist/es-modules/plain/entities/app-definition.js +0 -1
- package/dist/es-modules/plain/entities/app-details.js +0 -1
- package/dist/es-modules/plain/entities/app-event-subscription.js +0 -1
- package/dist/es-modules/plain/entities/app-installation.js +0 -1
- package/dist/es-modules/plain/entities/app-key.js +0 -1
- package/dist/es-modules/plain/entities/app-signed-request.js +0 -1
- package/dist/es-modules/plain/entities/app-signing-secret.js +0 -1
- package/dist/es-modules/plain/entities/app-upload.js +0 -1
- package/dist/es-modules/plain/entities/comment.js +0 -1
- package/dist/es-modules/plain/entities/concept-scheme.js +0 -1
- package/dist/es-modules/plain/entities/concept.js +0 -1
- package/dist/es-modules/plain/entities/editor-interface.js +0 -1
- package/dist/es-modules/plain/entities/environment-alias.js +0 -1
- package/dist/es-modules/plain/entities/environment.js +0 -1
- package/dist/es-modules/plain/entities/extension.js +0 -1
- package/dist/es-modules/plain/entities/function-log.js +0 -1
- package/dist/es-modules/plain/entities/function.js +0 -1
- package/dist/es-modules/plain/entities/locale.js +0 -1
- package/dist/es-modules/plain/entities/oauth-application.js +0 -1
- package/dist/es-modules/plain/entities/organization.js +0 -1
- package/dist/es-modules/plain/entities/resource-provider.js +0 -1
- package/dist/es-modules/plain/entities/resource-type.js +0 -1
- package/dist/es-modules/plain/entities/resource.js +0 -1
- package/dist/es-modules/plain/entities/role.js +0 -1
- package/dist/es-modules/plain/entities/space-member.js +0 -1
- package/dist/es-modules/plain/entities/space-membership.js +0 -1
- package/dist/es-modules/plain/entities/space.js +0 -1
- package/dist/es-modules/plain/entities/tag.js +0 -1
- package/dist/es-modules/plain/entities/task.js +0 -1
- package/dist/es-modules/plain/entities/team-membership.js +0 -1
- package/dist/es-modules/plain/entities/team-space-membership.js +0 -1
- package/dist/es-modules/plain/entities/team.js +0 -1
- package/dist/es-modules/plain/entities/ui-config.js +0 -1
- package/dist/es-modules/plain/entities/upload-credential.js +0 -1
- package/dist/es-modules/plain/entities/upload.js +0 -1
- package/dist/es-modules/plain/entities/usage.js +0 -1
- package/dist/es-modules/plain/entities/user-ui-config.js +0 -1
- package/dist/es-modules/plain/entities/user.js +0 -1
- package/dist/es-modules/plain/entities/webhook.js +0 -1
- package/dist/es-modules/plain/entities/workflow-definition.js +0 -1
- package/dist/es-modules/plain/entities/workflow.js +0 -1
- package/dist/es-modules/plain/entities/workflows-changelog.js +0 -1
- package/dist/es-modules/plain/pagination-helper.js +0 -76
- package/dist/es-modules/plain/plain-client.js +0 -580
- package/dist/es-modules/plain/wrappers/wrap.js +0 -46
- package/dist/es-modules/plain/wrappers/wrap.test-d.js +0 -15
- package/dist/es-modules/upload-http-client.js +0 -17
- package/dist/typings/adapters/REST/endpoints/access-token.d.ts +0 -111
- package/dist/typings/adapters/REST/endpoints/ai-action-invocation.d.ts +0 -2
- package/dist/typings/adapters/REST/endpoints/ai-action.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/api-key.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/app-access-token.d.ts +0 -2
- package/dist/typings/adapters/REST/endpoints/app-action-call.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/app-action.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/app-bundle.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/app-definition.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/app-details.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/app-event-subscription.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/app-installation.d.ts +0 -8
- package/dist/typings/adapters/REST/endpoints/app-key.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/app-signed-request.d.ts +0 -2
- package/dist/typings/adapters/REST/endpoints/app-signing-secret.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/app-upload.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/asset-key.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/asset.d.ts +0 -15
- package/dist/typings/adapters/REST/endpoints/bulk-action.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/comment.d.ts +0 -10
- package/dist/typings/adapters/REST/endpoints/concept-scheme.d.ts +0 -10
- package/dist/typings/adapters/REST/endpoints/concept.d.ts +0 -12
- package/dist/typings/adapters/REST/endpoints/content-type.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/editor-interface.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/entry.d.ts +0 -14
- package/dist/typings/adapters/REST/endpoints/environment-alias.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/environment-template-installation.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/environment-template.d.ts +0 -11
- package/dist/typings/adapters/REST/endpoints/environment.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/extension.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/function-log.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/function.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/http.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/index.d.ts +0 -139
- package/dist/typings/adapters/REST/endpoints/locale.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/oauth-application.d.ts +0 -122
- package/dist/typings/adapters/REST/endpoints/organization-invitation.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/organization-membership.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/organization.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/personal-access-token.d.ts +0 -17
- package/dist/typings/adapters/REST/endpoints/preview-api-key.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/release-action.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/release-asset.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/release-entry.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/release.d.ts +0 -11
- package/dist/typings/adapters/REST/endpoints/resource-provider.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/resource-type.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/resource.d.ts +0 -2
- package/dist/typings/adapters/REST/endpoints/role.d.ts +0 -12
- package/dist/typings/adapters/REST/endpoints/scheduled-action.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/snapshot.d.ts +0 -5
- package/dist/typings/adapters/REST/endpoints/space-member.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/space-membership.d.ts +0 -9
- package/dist/typings/adapters/REST/endpoints/space.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/tag.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/task.d.ts +0 -10
- package/dist/typings/adapters/REST/endpoints/team-membership.d.ts +0 -10
- package/dist/typings/adapters/REST/endpoints/team-space-membership.d.ts +0 -8
- package/dist/typings/adapters/REST/endpoints/team.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/ui-config.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/upload-credentials.d.ts +0 -2
- package/dist/typings/adapters/REST/endpoints/upload.d.ts +0 -4
- package/dist/typings/adapters/REST/endpoints/usage.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/user-ui-config.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/user.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/utils.d.ts +0 -3
- package/dist/typings/adapters/REST/endpoints/webhook.d.ts +0 -29
- package/dist/typings/adapters/REST/endpoints/workflow-definition.d.ts +0 -6
- package/dist/typings/adapters/REST/endpoints/workflow.d.ts +0 -7
- package/dist/typings/adapters/REST/endpoints/workflows-changelog.d.ts +0 -2
- package/dist/typings/adapters/REST/make-request.d.ts +0 -7
- package/dist/typings/adapters/REST/rest-adapter.d.ts +0 -25
- package/dist/typings/adapters/REST/types.d.ts +0 -6
- package/dist/typings/common-types.d.ts +0 -2926
- package/dist/typings/common-utils.d.ts +0 -9
- package/dist/typings/constants/editor-interface-defaults/controls-defaults.d.ts +0 -244
- package/dist/typings/constants/editor-interface-defaults/editors-defaults.d.ts +0 -23
- package/dist/typings/constants/editor-interface-defaults/index.d.ts +0 -22
- package/dist/typings/constants/editor-interface-defaults/sidebar-defaults.d.ts +0 -13
- package/dist/typings/contentful-management.d.ts +0 -63
- package/dist/typings/create-adapter.d.ts +0 -13
- package/dist/typings/create-app-definition-api.d.ts +0 -169
- package/dist/typings/create-contentful-api.d.ts +0 -445
- package/dist/typings/create-entry-api.d.ts +0 -331
- package/dist/typings/create-environment-api.d.ts +0 -1688
- package/dist/typings/create-environment-template-api.d.ts +0 -196
- package/dist/typings/create-organization-api.d.ts +0 -1180
- package/dist/typings/create-space-api.d.ts +0 -1150
- package/dist/typings/create-ui-config-api.d.ts +0 -34
- package/dist/typings/create-user-ui-config-api.d.ts +0 -34
- package/dist/typings/entities/access-token.d.ts +0 -61
- package/dist/typings/entities/ai-action-invocation.d.ts +0 -82
- package/dist/typings/entities/ai-action.d.ts +0 -75
- package/dist/typings/entities/api-key.d.ts +0 -70
- package/dist/typings/entities/app-access-token.d.ts +0 -34
- package/dist/typings/entities/app-action-call.d.ts +0 -92
- package/dist/typings/entities/app-action.d.ts +0 -161
- package/dist/typings/entities/app-bundle.d.ts +0 -86
- package/dist/typings/entities/app-definition.d.ts +0 -82
- package/dist/typings/entities/app-details.d.ts +0 -54
- package/dist/typings/entities/app-event-subscription.d.ts +0 -50
- package/dist/typings/entities/app-installation.d.ts +0 -70
- package/dist/typings/entities/app-key.d.ts +0 -77
- package/dist/typings/entities/app-signed-request.d.ts +0 -42
- package/dist/typings/entities/app-signing-secret.d.ts +0 -45
- package/dist/typings/entities/app-upload.d.ts +0 -44
- package/dist/typings/entities/asset-key.d.ts +0 -20
- package/dist/typings/entities/asset.d.ts +0 -278
- package/dist/typings/entities/bulk-action.d.ts +0 -94
- package/dist/typings/entities/comment.d.ts +0 -102
- package/dist/typings/entities/concept-scheme.d.ts +0 -22
- package/dist/typings/entities/concept.d.ts +0 -30
- package/dist/typings/entities/content-type-fields.d.ts +0 -81
- package/dist/typings/entities/content-type.d.ts +0 -213
- package/dist/typings/entities/editor-interface.d.ts +0 -168
- package/dist/typings/entities/entry.d.ts +0 -53
- package/dist/typings/entities/environment-alias.d.ts +0 -74
- package/dist/typings/entities/environment-template-installation.d.ts +0 -56
- package/dist/typings/entities/environment-template.d.ts +0 -40
- package/dist/typings/entities/environment.d.ts +0 -38
- package/dist/typings/entities/extension.d.ts +0 -103
- package/dist/typings/entities/function-log.d.ts +0 -46
- package/dist/typings/entities/function.d.ts +0 -32
- package/dist/typings/entities/index.d.ts +0 -127
- package/dist/typings/entities/locale.d.ts +0 -95
- package/dist/typings/entities/oauth-application.d.ts +0 -56
- package/dist/typings/entities/organization-invitation.d.ts +0 -25
- package/dist/typings/entities/organization-membership.d.ts +0 -69
- package/dist/typings/entities/organization.d.ts +0 -33
- package/dist/typings/entities/personal-access-token.d.ts +0 -51
- package/dist/typings/entities/preview-api-key.d.ts +0 -20
- package/dist/typings/entities/release-action.d.ts +0 -58
- package/dist/typings/entities/release.d.ts +0 -142
- package/dist/typings/entities/resource-provider.d.ts +0 -38
- package/dist/typings/entities/resource-type.d.ts +0 -52
- package/dist/typings/entities/resource.d.ts +0 -38
- package/dist/typings/entities/role.d.ts +0 -85
- package/dist/typings/entities/scheduled-action.d.ts +0 -112
- package/dist/typings/entities/snapshot.d.ts +0 -24
- package/dist/typings/entities/space-member.d.ts +0 -31
- package/dist/typings/entities/space-membership.d.ts +0 -64
- package/dist/typings/entities/space.d.ts +0 -31
- package/dist/typings/entities/tag.d.ts +0 -51
- package/dist/typings/entities/task.d.ts +0 -43
- package/dist/typings/entities/team-membership.d.ts +0 -78
- package/dist/typings/entities/team-space-membership.d.ts +0 -88
- package/dist/typings/entities/team.d.ts +0 -73
- package/dist/typings/entities/ui-config.d.ts +0 -59
- package/dist/typings/entities/upload-credential.d.ts +0 -43
- package/dist/typings/entities/upload.d.ts +0 -41
- package/dist/typings/entities/usage.d.ts +0 -55
- package/dist/typings/entities/user-ui-config.d.ts +0 -46
- package/dist/typings/entities/user.d.ts +0 -57
- package/dist/typings/entities/webhook.d.ts +0 -279
- package/dist/typings/entities/workflow-definition.d.ts +0 -118
- package/dist/typings/entities/workflow.d.ts +0 -64
- package/dist/typings/entities/workflows-changelog-entry.d.ts +0 -33
- package/dist/typings/export-types.d.ts +0 -70
- package/dist/typings/methods/bulk-action.d.ts +0 -14
- package/dist/typings/methods/content-type.d.ts +0 -5
- package/dist/typings/methods/release-action.d.ts +0 -15
- package/dist/typings/plain/as-iterator.d.ts +0 -5
- package/dist/typings/plain/checks.d.ts +0 -13
- package/dist/typings/plain/common-types.d.ts +0 -458
- package/dist/typings/plain/entities/ai-action-invocation.d.ts +0 -18
- package/dist/typings/plain/entities/ai-action.d.ts +0 -84
- package/dist/typings/plain/entities/app-access-token.d.ts +0 -29
- package/dist/typings/plain/entities/app-action-call.d.ts +0 -147
- package/dist/typings/plain/entities/app-action.d.ts +0 -157
- package/dist/typings/plain/entities/app-bundle.d.ts +0 -67
- package/dist/typings/plain/entities/app-definition.d.ts +0 -100
- package/dist/typings/plain/entities/app-details.d.ts +0 -56
- package/dist/typings/plain/entities/app-event-subscription.d.ts +0 -75
- package/dist/typings/plain/entities/app-installation.d.ts +0 -87
- package/dist/typings/plain/entities/app-key.d.ts +0 -91
- package/dist/typings/plain/entities/app-signed-request.d.ts +0 -34
- package/dist/typings/plain/entities/app-signing-secret.d.ts +0 -49
- package/dist/typings/plain/entities/app-upload.d.ts +0 -55
- package/dist/typings/plain/entities/comment.d.ts +0 -198
- package/dist/typings/plain/entities/concept-scheme.d.ts +0 -136
- package/dist/typings/plain/entities/concept.d.ts +0 -164
- package/dist/typings/plain/entities/editor-interface.d.ts +0 -67
- package/dist/typings/plain/entities/environment-alias.d.ts +0 -99
- package/dist/typings/plain/entities/environment.d.ts +0 -116
- package/dist/typings/plain/entities/extension.d.ts +0 -157
- package/dist/typings/plain/entities/function-log.d.ts +0 -51
- package/dist/typings/plain/entities/function.d.ts +0 -51
- package/dist/typings/plain/entities/locale.d.ts +0 -112
- package/dist/typings/plain/entities/oauth-application.d.ts +0 -90
- package/dist/typings/plain/entities/organization.d.ts +0 -33
- package/dist/typings/plain/entities/resource-provider.d.ts +0 -59
- package/dist/typings/plain/entities/resource-type.d.ts +0 -14
- package/dist/typings/plain/entities/resource.d.ts +0 -40
- package/dist/typings/plain/entities/role.d.ts +0 -206
- package/dist/typings/plain/entities/space-member.d.ts +0 -32
- package/dist/typings/plain/entities/space-membership.d.ts +0 -155
- package/dist/typings/plain/entities/space.d.ts +0 -102
- package/dist/typings/plain/entities/tag.d.ts +0 -103
- package/dist/typings/plain/entities/task.d.ts +0 -114
- package/dist/typings/plain/entities/team-membership.d.ts +0 -110
- package/dist/typings/plain/entities/team-space-membership.d.ts +0 -127
- package/dist/typings/plain/entities/team.d.ts +0 -105
- package/dist/typings/plain/entities/ui-config.d.ts +0 -44
- package/dist/typings/plain/entities/upload-credential.d.ts +0 -38
- package/dist/typings/plain/entities/upload.d.ts +0 -57
- package/dist/typings/plain/entities/usage.d.ts +0 -49
- package/dist/typings/plain/entities/user-ui-config.d.ts +0 -44
- package/dist/typings/plain/entities/user.d.ts +0 -80
- package/dist/typings/plain/entities/webhook.d.ts +0 -186
- package/dist/typings/plain/entities/workflow-definition.d.ts +0 -90
- package/dist/typings/plain/entities/workflow.d.ts +0 -118
- package/dist/typings/plain/entities/workflows-changelog.d.ts +0 -26
- package/dist/typings/plain/pagination-helper.d.ts +0 -22
- package/dist/typings/plain/plain-client.d.ts +0 -8
- package/dist/typings/plain/wrappers/wrap.d.ts +0 -32
- package/types.d.ts +0 -1
- /package/dist/{typings → types}/adapters/REST/endpoints/raw.d.ts +0 -0
- /package/dist/{typings → types}/constants/editor-interface-defaults/types.d.ts +0 -0
- /package/dist/{typings → types}/enhance-with-methods.d.ts +0 -0
- /package/dist/{typings → types}/entities/field-type.d.ts +0 -0
- /package/dist/{typings → types}/entities/utils.d.ts +0 -0
- /package/dist/{typings → types}/entities/widget-parameters.d.ts +0 -0
- /package/dist/{typings → types}/methods/action.d.ts +0 -0
- /package/dist/{typings → types}/methods/utils.d.ts +0 -0
- /package/dist/{typings → types}/plain/wrappers/wrap.test-d.d.ts +0 -0
- /package/dist/{typings → types}/upload-http-client.d.ts +0 -0
|
@@ -0,0 +1,1688 @@
|
|
|
1
|
+
import type { Stream } from 'stream';
|
|
2
|
+
import type { AcceptsQueryOptions, BasicCursorPaginationOptions, CreatedAtIntervalParams, CursorBasedParams, QueryOptions } from './common-types.js';
|
|
3
|
+
import type { BasicQueryOptions, MakeRequest } from './common-types.js';
|
|
4
|
+
import { type CreateAppInstallationProps } from './entities/app-installation.js';
|
|
5
|
+
import { type CreateAppSignedRequestProps } from './entities/app-signed-request.js';
|
|
6
|
+
import { type CreateAppActionCallProps, type AppActionCallRawResponseProps } from './entities/app-action-call.js';
|
|
7
|
+
import { type AssetFileProp, type AssetProps, type CreateAssetFromFilesOptions, type CreateAssetProps } from './entities/asset.js';
|
|
8
|
+
import { type CreateAssetKeyProps } from './entities/asset-key.js';
|
|
9
|
+
import { type BulkAction, type BulkActionPayload, type BulkActionPublishPayload, type BulkActionUnpublishPayload, type BulkActionValidatePayload } from './entities/bulk-action.js';
|
|
10
|
+
import type { ReleaseActionQueryOptions } from './entities/release-action.js';
|
|
11
|
+
import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release.js';
|
|
12
|
+
import { type ContentTypeProps, type CreateContentTypeProps } from './entities/content-type.js';
|
|
13
|
+
import { type CreateEntryProps, type EntryProps, type EntryReferenceOptionsProps, type EntryReferenceProps } from './entities/entry.js';
|
|
14
|
+
import { type CreateExtensionProps } from './entities/extension.js';
|
|
15
|
+
import { type CreateLocaleProps } from './entities/locale.js';
|
|
16
|
+
import type { TagVisibility } from './entities/tag.js';
|
|
17
|
+
import { type CreateAppAccessTokenProps } from './entities/app-access-token.js';
|
|
18
|
+
import { type ResourceQueryOptions } from './entities/resource.js';
|
|
19
|
+
import type { AiActionInvocationType } from './entities/ai-action-invocation.js';
|
|
20
|
+
/**
|
|
21
|
+
* @private
|
|
22
|
+
*/
|
|
23
|
+
export type ContentfulEnvironmentAPI = ReturnType<typeof createEnvironmentApi>;
|
|
24
|
+
/**
|
|
25
|
+
* Creates API object with methods to access the Environment API
|
|
26
|
+
* @param {ContentfulEnvironmentAPI} makeRequest - function to make requests via an adapter
|
|
27
|
+
* @return {ContentfulSpaceAPI}
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
30
|
+
export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
31
|
+
/**
|
|
32
|
+
* Deletes the environment
|
|
33
|
+
* @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
|
|
34
|
+
* @example ```javascript
|
|
35
|
+
* const contentful = require('contentful-management')
|
|
36
|
+
*
|
|
37
|
+
* const client = contentful.createClient({
|
|
38
|
+
* accessToken: '<content_management_api_key>'
|
|
39
|
+
* })
|
|
40
|
+
*
|
|
41
|
+
* client.getSpace('<space_id>')
|
|
42
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
43
|
+
* .then((environment) => environment.delete())
|
|
44
|
+
* .then(() => console.log('Environment deleted.'))
|
|
45
|
+
* .catch(console.error)
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
delete: () => Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Updates the environment
|
|
51
|
+
* @return Promise for the updated environment.
|
|
52
|
+
* @example ```javascript
|
|
53
|
+
* const contentful = require('contentful-management')
|
|
54
|
+
*
|
|
55
|
+
* const client = contentful.createClient({
|
|
56
|
+
* accessToken: '<content_management_api_key>'
|
|
57
|
+
* })
|
|
58
|
+
*
|
|
59
|
+
* client.getSpace('<space_id>')
|
|
60
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
61
|
+
* .then((environment) => {
|
|
62
|
+
* environment.name = 'New name'
|
|
63
|
+
* return environment.update()
|
|
64
|
+
* })
|
|
65
|
+
* .then((environment) => console.log(`Environment ${environment.sys.id} renamed.`)
|
|
66
|
+
* .catch(console.error)
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
update: () => Promise<import("./entities/environment.js").Environment>;
|
|
70
|
+
/**
|
|
71
|
+
* Creates SDK Entry object (locally) from entry data
|
|
72
|
+
* @param entryData - Entry Data
|
|
73
|
+
* @return Entry
|
|
74
|
+
* @example ```javascript
|
|
75
|
+
* environment.getEntry('entryId').then(entry => {
|
|
76
|
+
*
|
|
77
|
+
* // Build a plainObject in order to make it usable for React (saving in state or redux)
|
|
78
|
+
* const plainObject = entry.toPlainObject();
|
|
79
|
+
*
|
|
80
|
+
* // The entry is being updated in some way as plainObject:
|
|
81
|
+
* const updatedPlainObject = {
|
|
82
|
+
* ...plainObject,
|
|
83
|
+
* fields: {
|
|
84
|
+
* ...plainObject.fields,
|
|
85
|
+
* title: {
|
|
86
|
+
* 'en-US': 'updatedTitle'
|
|
87
|
+
* }
|
|
88
|
+
* }
|
|
89
|
+
* };
|
|
90
|
+
*
|
|
91
|
+
* // Rebuild an sdk object out of the updated plainObject:
|
|
92
|
+
* const entryWithMethodsAgain = environment.getEntryFromData(updatedPlainObject);
|
|
93
|
+
*
|
|
94
|
+
* // Update with help of the sdk method:
|
|
95
|
+
* entryWithMethodsAgain.update();
|
|
96
|
+
*
|
|
97
|
+
* });
|
|
98
|
+
* ```
|
|
99
|
+
**/
|
|
100
|
+
getEntryFromData(entryData: EntryProps): import("./entities/entry.js").Entry;
|
|
101
|
+
/**
|
|
102
|
+
* Creates SDK Asset object (locally) from entry data
|
|
103
|
+
* @param assetData - Asset ID
|
|
104
|
+
* @return Asset
|
|
105
|
+
* @example ```javascript
|
|
106
|
+
* environment.getAsset('asset_id').then(asset => {
|
|
107
|
+
*
|
|
108
|
+
* // Build a plainObject in order to make it usable for React (saving in state or redux)
|
|
109
|
+
* const plainObject = asset.toPlainObject();
|
|
110
|
+
*
|
|
111
|
+
* // The asset is being updated in some way as plainObject:
|
|
112
|
+
* const updatedPlainObject = {
|
|
113
|
+
* ...plainObject,
|
|
114
|
+
* fields: {
|
|
115
|
+
* ...plainObject.fields,
|
|
116
|
+
* title: {
|
|
117
|
+
* 'en-US': 'updatedTitle'
|
|
118
|
+
* }
|
|
119
|
+
* }
|
|
120
|
+
* };
|
|
121
|
+
*
|
|
122
|
+
* // Rebuild an sdk object out of the updated plainObject:
|
|
123
|
+
* const assetWithMethodsAgain = environment.getAssetFromData(updatedPlainObject);
|
|
124
|
+
*
|
|
125
|
+
* // Update with help of the sdk method:
|
|
126
|
+
* assetWithMethodsAgain.update();
|
|
127
|
+
*
|
|
128
|
+
* });
|
|
129
|
+
* ```
|
|
130
|
+
*/
|
|
131
|
+
getAssetFromData(assetData: AssetProps): import("./entities/asset.js").Asset;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @description Get a BulkAction by ID.
|
|
135
|
+
* See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/bulk-action
|
|
136
|
+
* @param bulkActionId - ID of the BulkAction to fetch
|
|
137
|
+
* @returns - Promise with the BulkAction
|
|
138
|
+
*
|
|
139
|
+
* @example ```javascript
|
|
140
|
+
* const contentful = require('contentful-management')
|
|
141
|
+
*
|
|
142
|
+
* const client = contentful.createClient({
|
|
143
|
+
* accessToken: '<content_management_api_key>'
|
|
144
|
+
* })
|
|
145
|
+
*
|
|
146
|
+
* client.getSpace('<space_id>')
|
|
147
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
148
|
+
* .then((environment) => environment.getBulkAction('<bulk_action_id>'))
|
|
149
|
+
* .then((bulkAction) => console.log(bulkAction))
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
getBulkAction<T extends BulkActionPayload = any>(bulkActionId: string): Promise<BulkAction<T>>;
|
|
153
|
+
/**
|
|
154
|
+
* @description Creates a BulkAction that will attempt to publish all items contained in the payload.
|
|
155
|
+
* See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/publish-bulk-action
|
|
156
|
+
* @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
|
|
157
|
+
* @returns - Promise with the BulkAction
|
|
158
|
+
*
|
|
159
|
+
* @example
|
|
160
|
+
*
|
|
161
|
+
* ```javascript
|
|
162
|
+
* const contentful = require('contentful-management')
|
|
163
|
+
*
|
|
164
|
+
* const client = contentful.createClient({
|
|
165
|
+
* accessToken: '<content_management_api_key>'
|
|
166
|
+
* })
|
|
167
|
+
*
|
|
168
|
+
* const payload = {
|
|
169
|
+
* entities: {
|
|
170
|
+
* sys: { type: 'Array' }
|
|
171
|
+
* items: [
|
|
172
|
+
* { sys: { type: 'Link', id: '<entry-id>', linkType: 'Entry', version: 2 } }
|
|
173
|
+
* ]
|
|
174
|
+
* }
|
|
175
|
+
* }
|
|
176
|
+
*
|
|
177
|
+
* // Using Thenables
|
|
178
|
+
* client.getSpace('<space_id>')
|
|
179
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
180
|
+
* .then((environment) => environment.createPublishBulkAction(payload))
|
|
181
|
+
* .then((bulkAction) => console.log(bulkAction.waitProcessing()))
|
|
182
|
+
* .catch(console.error)
|
|
183
|
+
*
|
|
184
|
+
* // Using async/await
|
|
185
|
+
* try {
|
|
186
|
+
* const space = await client.getSpace('<space_id>')
|
|
187
|
+
* const environment = await space.getEnvironment('<environment_id>')
|
|
188
|
+
* const bulkActionInProgress = await environment.createPublishBulkAction(payload)
|
|
189
|
+
*
|
|
190
|
+
* // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
|
|
191
|
+
* const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
|
|
192
|
+
* console.log(bulkActionCompleted)
|
|
193
|
+
* } catch (error) {
|
|
194
|
+
* console.log(error)
|
|
195
|
+
* }
|
|
196
|
+
* ```
|
|
197
|
+
*/
|
|
198
|
+
createPublishBulkAction(payload: BulkActionPublishPayload): Promise<BulkAction<BulkActionPublishPayload>>;
|
|
199
|
+
/**
|
|
200
|
+
* @description Creates a BulkAction that will attempt to validate all items contained in the payload.
|
|
201
|
+
* See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/validate-bulk-action
|
|
202
|
+
* @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
|
|
203
|
+
* @returns - Promise with the BulkAction
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
*
|
|
207
|
+
* ```javascript
|
|
208
|
+
* const contentful = require('contentful-management')
|
|
209
|
+
*
|
|
210
|
+
* const client = contentful.createClient({
|
|
211
|
+
* accessToken: '<content_management_api_key>'
|
|
212
|
+
* })
|
|
213
|
+
*
|
|
214
|
+
* const payload = {
|
|
215
|
+
* action: 'publish',
|
|
216
|
+
* entities: {
|
|
217
|
+
* sys: { type: 'Array' }
|
|
218
|
+
* items: [
|
|
219
|
+
* { sys: { type: 'Link', id: '<entry-id>', linkType: 'Entry' } }
|
|
220
|
+
* ]
|
|
221
|
+
* }
|
|
222
|
+
* }
|
|
223
|
+
*
|
|
224
|
+
* // Using Thenables
|
|
225
|
+
* client.getSpace('<space_id>')
|
|
226
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
227
|
+
* .then((environment) => environment.createValidateBulkAction(payload))
|
|
228
|
+
* .then((bulkAction) => console.log(bulkAction.waitProcessing()))
|
|
229
|
+
* .catch(console.error)
|
|
230
|
+
*
|
|
231
|
+
* // Using async/await
|
|
232
|
+
* try {
|
|
233
|
+
* const space = await client.getSpace('<space_id>')
|
|
234
|
+
* const environment = await space.getEnvironment('<environment_id>')
|
|
235
|
+
* const bulkActionInProgress = await environment.createValidateBulkAction(payload)
|
|
236
|
+
*
|
|
237
|
+
* // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
|
|
238
|
+
* const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
|
|
239
|
+
* console.log(bulkActionCompleted)
|
|
240
|
+
* } catch (error) {
|
|
241
|
+
* console.log(error)
|
|
242
|
+
* }
|
|
243
|
+
* ```
|
|
244
|
+
*/
|
|
245
|
+
createValidateBulkAction(payload: BulkActionValidatePayload): Promise<BulkAction<BulkActionValidatePayload>>;
|
|
246
|
+
/**
|
|
247
|
+
* @description Creates a BulkAction that will attempt to unpublish all items contained in the payload.
|
|
248
|
+
* See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/unpublish-bulk-action
|
|
249
|
+
* @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
|
|
250
|
+
* @returns - Promise with the BulkAction
|
|
251
|
+
*
|
|
252
|
+
* @example
|
|
253
|
+
*
|
|
254
|
+
* ```javascript
|
|
255
|
+
* const contentful = require('contentful-management')
|
|
256
|
+
*
|
|
257
|
+
* const client = contentful.createClient({
|
|
258
|
+
* accessToken: '<content_management_api_key>'
|
|
259
|
+
* })
|
|
260
|
+
*
|
|
261
|
+
* const payload = {
|
|
262
|
+
* entities: {
|
|
263
|
+
* sys: { type: 'Array' }
|
|
264
|
+
* items: [
|
|
265
|
+
* { sys: { type: 'Link', id: 'entry-id', linkType: 'Entry' } }
|
|
266
|
+
* ]
|
|
267
|
+
* }
|
|
268
|
+
* }
|
|
269
|
+
*
|
|
270
|
+
* // Using Thenables
|
|
271
|
+
* client.getSpace('<space_id>')
|
|
272
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
273
|
+
* .then((environment) => environment.createUnpublishBulkAction(payload))
|
|
274
|
+
* .then((bulkAction) => console.log(bulkAction.waitProcessing()))
|
|
275
|
+
* .catch(console.error)
|
|
276
|
+
*
|
|
277
|
+
* // Using async/await
|
|
278
|
+
* try {
|
|
279
|
+
* const space = await clientgetSpace('<space_id>')
|
|
280
|
+
* const environment = await space.getEnvironment('<environment_id>')
|
|
281
|
+
* const bulkActionInProgress = await environment.createUnpublishBulkAction(payload)
|
|
282
|
+
*
|
|
283
|
+
* // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
|
|
284
|
+
* const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
|
|
285
|
+
* console.log(bulkActionCompleted)
|
|
286
|
+
* } catch (error) {
|
|
287
|
+
* console.log(error)
|
|
288
|
+
* }
|
|
289
|
+
* ```
|
|
290
|
+
*/
|
|
291
|
+
createUnpublishBulkAction(payload: BulkActionUnpublishPayload): Promise<BulkAction<BulkActionUnpublishPayload>>;
|
|
292
|
+
/**
|
|
293
|
+
* Gets a Content Type
|
|
294
|
+
* @param contentTypeId - Content Type ID
|
|
295
|
+
* @return Promise for a Content Type
|
|
296
|
+
* @example ```javascript
|
|
297
|
+
* const contentful = require('contentful-management')
|
|
298
|
+
*
|
|
299
|
+
* const client = contentful.createClient({
|
|
300
|
+
* accessToken: '<content_management_api_key>'
|
|
301
|
+
* })
|
|
302
|
+
*
|
|
303
|
+
* client.getSpace('<space_id>')
|
|
304
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
305
|
+
* .then((environment) => environment.getContentType('<content_type_id>'))
|
|
306
|
+
* .then((contentType) => console.log(contentType))
|
|
307
|
+
* .catch(console.error)
|
|
308
|
+
* ```
|
|
309
|
+
*/
|
|
310
|
+
getContentType(contentTypeId: string): Promise<import("./entities/content-type.js").ContentType>;
|
|
311
|
+
/**
|
|
312
|
+
* Gets a collection of Content Types
|
|
313
|
+
* @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
|
|
314
|
+
* @return Promise for a collection of Content Types
|
|
315
|
+
* @example ```javascript
|
|
316
|
+
* const contentful = require('contentful-management')
|
|
317
|
+
*
|
|
318
|
+
* const client = contentful.createClient({
|
|
319
|
+
* accessToken: '<content_management_api_key>'
|
|
320
|
+
* })
|
|
321
|
+
*
|
|
322
|
+
* client.getSpace('<space_id>')
|
|
323
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
324
|
+
* .then((environment) => environment.getContentTypes())
|
|
325
|
+
* .then((response) => console.log(response.items))
|
|
326
|
+
* .catch(console.error)
|
|
327
|
+
* ```
|
|
328
|
+
*/
|
|
329
|
+
getContentTypes(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/content-type.js").ContentType, ContentTypeProps>>;
|
|
330
|
+
/**
|
|
331
|
+
* Creates a Content Type
|
|
332
|
+
* @param data - Object representation of the Content Type to be created
|
|
333
|
+
* @return Promise for the newly created Content Type
|
|
334
|
+
* @example ```javascript
|
|
335
|
+
* const contentful = require('contentful-management')
|
|
336
|
+
*
|
|
337
|
+
* const client = contentful.createClient({
|
|
338
|
+
* accessToken: '<content_management_api_key>'
|
|
339
|
+
* })
|
|
340
|
+
*
|
|
341
|
+
* client.getSpace('<space_id>')
|
|
342
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
343
|
+
* .then((environment) => environment.createContentType({
|
|
344
|
+
* name: 'Blog Post',
|
|
345
|
+
* fields: [
|
|
346
|
+
* {
|
|
347
|
+
* id: 'title',
|
|
348
|
+
* name: 'Title',
|
|
349
|
+
* required: true,
|
|
350
|
+
* localized: false,
|
|
351
|
+
* type: 'Text'
|
|
352
|
+
* }
|
|
353
|
+
* ]
|
|
354
|
+
* }))
|
|
355
|
+
* .then((contentType) => console.log(contentType))
|
|
356
|
+
* .catch(console.error)
|
|
357
|
+
* ```
|
|
358
|
+
*/
|
|
359
|
+
createContentType(data: CreateContentTypeProps): Promise<import("./entities/content-type.js").ContentType>;
|
|
360
|
+
/**
|
|
361
|
+
* Creates a Content Type with a custom ID
|
|
362
|
+
* @param contentTypeId - Content Type ID
|
|
363
|
+
* @param data - Object representation of the Content Type to be created
|
|
364
|
+
* @return Promise for the newly created Content Type
|
|
365
|
+
* @example ```javascript
|
|
366
|
+
* const contentful = require('contentful-management')
|
|
367
|
+
*
|
|
368
|
+
* const client = contentful.createClient({
|
|
369
|
+
* accessToken: '<content_management_api_key>'
|
|
370
|
+
* })
|
|
371
|
+
*
|
|
372
|
+
* client.getSpace('<space_id>')
|
|
373
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
374
|
+
* .then((environment) => environment.createContentTypeWithId('<content-type-id>', {
|
|
375
|
+
* name: 'Blog Post',
|
|
376
|
+
* fields: [
|
|
377
|
+
* {
|
|
378
|
+
* id: 'title',
|
|
379
|
+
* name: 'Title',
|
|
380
|
+
* required: true,
|
|
381
|
+
* localized: false,
|
|
382
|
+
* type: 'Text'
|
|
383
|
+
* }
|
|
384
|
+
* ]
|
|
385
|
+
* }))
|
|
386
|
+
* .then((contentType) => console.log(contentType))
|
|
387
|
+
* .catch(console.error)
|
|
388
|
+
* ```
|
|
389
|
+
*/
|
|
390
|
+
createContentTypeWithId(contentTypeId: string, data: CreateContentTypeProps): Promise<import("./entities/content-type.js").ContentType>;
|
|
391
|
+
/**
|
|
392
|
+
* Gets an EditorInterface for a ContentType
|
|
393
|
+
* @param contentTypeId - Content Type ID
|
|
394
|
+
* @return Promise for an EditorInterface
|
|
395
|
+
* @example ```javascript
|
|
396
|
+
* const contentful = require('contentful-management')
|
|
397
|
+
*
|
|
398
|
+
* const client = contentful.createClient({
|
|
399
|
+
* accessToken: '<content_management_api_key>'
|
|
400
|
+
* })
|
|
401
|
+
*
|
|
402
|
+
* client.getSpace('<space_id>')
|
|
403
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
404
|
+
* .then((environment) => environment.getEditorInterfaceForContentType('<content_type_id>'))
|
|
405
|
+
* .then((EditorInterface) => console.log(EditorInterface))
|
|
406
|
+
* .catch(console.error)
|
|
407
|
+
* ```
|
|
408
|
+
*/
|
|
409
|
+
getEditorInterfaceForContentType(contentTypeId: string): Promise<import("./entities/editor-interface.js").EditorInterface>;
|
|
410
|
+
/**
|
|
411
|
+
* Gets all EditorInterfaces
|
|
412
|
+
* @return Promise for a collection of EditorInterface
|
|
413
|
+
* @example ```javascript
|
|
414
|
+
* const contentful = require('contentful-management')
|
|
415
|
+
*
|
|
416
|
+
* const client = contentful.createClient({
|
|
417
|
+
* accessToken: '<content_management_api_key>'
|
|
418
|
+
* })
|
|
419
|
+
*
|
|
420
|
+
* client.getSpace('<space_id>')
|
|
421
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
422
|
+
* .then((environment) => environment.getEditorInterfaces())
|
|
423
|
+
* .then((response) => console.log(response.items))
|
|
424
|
+
* .catch(console.error)
|
|
425
|
+
* ```
|
|
426
|
+
*/
|
|
427
|
+
getEditorInterfaces(): Promise<import("./common-types.js").Collection<import("./entities/editor-interface.js").EditorInterface, import("./entities/editor-interface.js").EditorInterfaceProps>>;
|
|
428
|
+
/**
|
|
429
|
+
* Gets an Entry
|
|
430
|
+
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
431
|
+
* from your entry in the backend
|
|
432
|
+
* @param id - Entry ID
|
|
433
|
+
* @param query - Object with search parameters. In this method it's only useful for `locale`.
|
|
434
|
+
* @return Promise for an Entry
|
|
435
|
+
* @example ```javascript
|
|
436
|
+
* const contentful = require('contentful-management')
|
|
437
|
+
*
|
|
438
|
+
* const client = contentful.createClient({
|
|
439
|
+
* accessToken: '<content_management_api_key>'
|
|
440
|
+
* })
|
|
441
|
+
*
|
|
442
|
+
* client.getSpace('<space_id>')
|
|
443
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
444
|
+
* .then((environment) => environment.getEntry('<entry-id>'))
|
|
445
|
+
* .then((entry) => console.log(entry))
|
|
446
|
+
* .catch(console.error)
|
|
447
|
+
* ```
|
|
448
|
+
*/
|
|
449
|
+
getEntry(id: string, query?: QueryOptions): Promise<import("./entities/entry.js").Entry>;
|
|
450
|
+
/**
|
|
451
|
+
* Deletes an Entry of this environment
|
|
452
|
+
* @param id - Entry ID
|
|
453
|
+
* @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
|
|
454
|
+
* @example ```javascript
|
|
455
|
+
* const contentful = require('contentful-management')
|
|
456
|
+
*
|
|
457
|
+
* const client = contentful.createClient({
|
|
458
|
+
* accessToken: '<content_management_api_key>'
|
|
459
|
+
* })
|
|
460
|
+
*
|
|
461
|
+
* client.getSpace('<space_id>')
|
|
462
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
463
|
+
* .then((environment) => environment.deleteEntry("4bmLXiuviAZH3jkj5DLRWE"))
|
|
464
|
+
* .then(() => console.log('Entry deleted.'))
|
|
465
|
+
* .catch(console.error)
|
|
466
|
+
* ```
|
|
467
|
+
*/
|
|
468
|
+
deleteEntry(id: string): Promise<void>;
|
|
469
|
+
/**
|
|
470
|
+
* Gets a collection of Entries
|
|
471
|
+
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
472
|
+
* from your entry in the backend
|
|
473
|
+
* @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
|
|
474
|
+
* @return Promise for a collection of Entries
|
|
475
|
+
* @example ```javascript
|
|
476
|
+
* const contentful = require('contentful-management')
|
|
477
|
+
*
|
|
478
|
+
* const client = contentful.createClient({
|
|
479
|
+
* accessToken: '<content_management_api_key>'
|
|
480
|
+
* })
|
|
481
|
+
*
|
|
482
|
+
* client.getSpace('<space_id>')
|
|
483
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
484
|
+
* .then((environment) => environment.getEntries({'content_type': 'foo'})) // you can add more queries as 'key': 'value'
|
|
485
|
+
* .then((response) => console.log(response.items))
|
|
486
|
+
* .catch(console.error)
|
|
487
|
+
* ```
|
|
488
|
+
*/
|
|
489
|
+
getEntries(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/entry.js").Entry, EntryProps<import("./common-types.js").KeyValueMap, unknown>>>;
|
|
490
|
+
/**
|
|
491
|
+
* Gets a collection of published Entries
|
|
492
|
+
* @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
|
|
493
|
+
* @return Promise for a collection of published Entries
|
|
494
|
+
* @example ```javascript
|
|
495
|
+
* const contentful = require('contentful-management')
|
|
496
|
+
*
|
|
497
|
+
* const client = contentful.createClient({
|
|
498
|
+
* accessToken: '<content_management_api_key>'
|
|
499
|
+
* })
|
|
500
|
+
*
|
|
501
|
+
* client.getSpace('<space_id>')
|
|
502
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
503
|
+
* .then((environment) => environment.getPublishedEntries({'content_type': 'foo'})) // you can add more queries as 'key': 'value'
|
|
504
|
+
* .then((response) => console.log(response.items))
|
|
505
|
+
* .catch(console.error)
|
|
506
|
+
* ```
|
|
507
|
+
*/
|
|
508
|
+
getPublishedEntries(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/entry.js").Entry, EntryProps<import("./common-types.js").KeyValueMap, unknown>>>;
|
|
509
|
+
/**
|
|
510
|
+
* Creates a Entry
|
|
511
|
+
* @param contentTypeId - The Content Type ID of the newly created Entry
|
|
512
|
+
* @param data - Object representation of the Entry to be created
|
|
513
|
+
* @return Promise for the newly created Entry
|
|
514
|
+
* @example ```javascript
|
|
515
|
+
* const contentful = require('contentful-management')
|
|
516
|
+
*
|
|
517
|
+
* const client = contentful.createClient({
|
|
518
|
+
* accessToken: '<content_management_api_key>'
|
|
519
|
+
* })
|
|
520
|
+
*
|
|
521
|
+
* client.getSpace('<space_id>')
|
|
522
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
523
|
+
* .then((environment) => environment.createEntry('<content_type_id>', {
|
|
524
|
+
* fields: {
|
|
525
|
+
* title: {
|
|
526
|
+
* 'en-US': 'Entry title'
|
|
527
|
+
* }
|
|
528
|
+
* }
|
|
529
|
+
* }))
|
|
530
|
+
* .then((entry) => console.log(entry))
|
|
531
|
+
* .catch(console.error)
|
|
532
|
+
* ```
|
|
533
|
+
*/
|
|
534
|
+
createEntry(contentTypeId: string, data: Omit<EntryProps, "sys">): Promise<import("./entities/entry.js").Entry>;
|
|
535
|
+
/**
|
|
536
|
+
* Creates a Entry with a custom ID
|
|
537
|
+
* @param contentTypeId - The Content Type of the newly created Entry
|
|
538
|
+
* @param id - Entry ID
|
|
539
|
+
* @param data - Object representation of the Entry to be created
|
|
540
|
+
* @return Promise for the newly created Entry
|
|
541
|
+
* @example ```javascript
|
|
542
|
+
* const contentful = require('contentful-management')
|
|
543
|
+
*
|
|
544
|
+
* const client = contentful.createClient({
|
|
545
|
+
* accessToken: '<content_management_api_key>'
|
|
546
|
+
* })
|
|
547
|
+
*
|
|
548
|
+
* // Create entry
|
|
549
|
+
* client.getSpace('<space_id>')
|
|
550
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
551
|
+
* .then((environment) => environment.createEntryWithId('<content_type_id>', '<entry_id>', {
|
|
552
|
+
* fields: {
|
|
553
|
+
* title: {
|
|
554
|
+
* 'en-US': 'Entry title'
|
|
555
|
+
* }
|
|
556
|
+
* }
|
|
557
|
+
* }))
|
|
558
|
+
* .then((entry) => console.log(entry))
|
|
559
|
+
* .catch(console.error)
|
|
560
|
+
* ```
|
|
561
|
+
*/
|
|
562
|
+
createEntryWithId(contentTypeId: string, id: string, data: CreateEntryProps): Promise<import("./entities/entry.js").Entry>;
|
|
563
|
+
/**
|
|
564
|
+
* Get entry references
|
|
565
|
+
* @param entryId - Entry ID
|
|
566
|
+
* @param {Object} options.include - Level of the entry descendants from 1 up to 10 maximum
|
|
567
|
+
* @returns Promise of Entry references
|
|
568
|
+
* @example ```javascript
|
|
569
|
+
* const contentful = require('contentful-management');
|
|
570
|
+
*
|
|
571
|
+
* const client = contentful.createClient({
|
|
572
|
+
* accessToken: '<contentful_management_api_key>
|
|
573
|
+
* })
|
|
574
|
+
*
|
|
575
|
+
* // Get entry references
|
|
576
|
+
* client.getSpace('<space_id>')
|
|
577
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
578
|
+
* .then((environment) => environment.getEntryReferences('<entry_id>', {include: number}))
|
|
579
|
+
* .then((entry) => console.log(entry.includes))
|
|
580
|
+
* // or
|
|
581
|
+
* .then((environment) => environment.getEntry('<entry_id>')).then((entry) => entry.references({include: number}))
|
|
582
|
+
* .catch(console.error)
|
|
583
|
+
* ```
|
|
584
|
+
*/
|
|
585
|
+
getEntryReferences(entryId: string, options?: EntryReferenceOptionsProps): Promise<EntryReferenceProps>;
|
|
586
|
+
/**
|
|
587
|
+
* Gets an Asset
|
|
588
|
+
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
589
|
+
* from your entry in the backend
|
|
590
|
+
* @param id - Asset ID
|
|
591
|
+
* @param query - Object with search parameters. In this method it's only useful for `locale`.
|
|
592
|
+
* @return Promise for an Asset
|
|
593
|
+
* @example ```javascript
|
|
594
|
+
* const contentful = require('contentful-management')
|
|
595
|
+
*
|
|
596
|
+
* const client = contentful.createClient({
|
|
597
|
+
* accessToken: '<content_management_api_key>'
|
|
598
|
+
* })
|
|
599
|
+
*
|
|
600
|
+
* client.getSpace('<space_id>')
|
|
601
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
602
|
+
* .then((environment) => environment.getAsset('<asset_id>'))
|
|
603
|
+
* .then((asset) => console.log(asset))
|
|
604
|
+
* .catch(console.error)
|
|
605
|
+
* ```
|
|
606
|
+
*/
|
|
607
|
+
getAsset(id: string, query?: QueryOptions): Promise<import("./entities/asset.js").Asset>;
|
|
608
|
+
/**
|
|
609
|
+
* Gets a collection of Assets
|
|
610
|
+
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
611
|
+
* from your entry in the backend
|
|
612
|
+
* @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
|
|
613
|
+
* @return Promise for a collection of Assets
|
|
614
|
+
* @example ```javascript
|
|
615
|
+
* const contentful = require('contentful-management')
|
|
616
|
+
*
|
|
617
|
+
* const client = contentful.createClient({
|
|
618
|
+
* accessToken: '<content_management_api_key>'
|
|
619
|
+
* })
|
|
620
|
+
*
|
|
621
|
+
* client.getSpace('<space_id>')
|
|
622
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
623
|
+
* .then((environment) => environment.getAssets())
|
|
624
|
+
* .then((response) => console.log(response.items))
|
|
625
|
+
* .catch(console.error)
|
|
626
|
+
* ```
|
|
627
|
+
*/
|
|
628
|
+
getAssets(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/asset.js").Asset, AssetProps<{}>>>;
|
|
629
|
+
/**
|
|
630
|
+
* Gets a collection of published Assets
|
|
631
|
+
* @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
|
|
632
|
+
* @return Promise for a collection of published Assets
|
|
633
|
+
* @example ```javascript
|
|
634
|
+
* const contentful = require('contentful-management')
|
|
635
|
+
*
|
|
636
|
+
* const client = contentful.createClient({
|
|
637
|
+
* accessToken: '<content_management_api_key>'
|
|
638
|
+
* })
|
|
639
|
+
*
|
|
640
|
+
* client.getSpace('<space_id>')
|
|
641
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
642
|
+
* .then((environment) => environment.getPublishedAssets())
|
|
643
|
+
* .then((response) => console.log(response.items))
|
|
644
|
+
* .catch(console.error)
|
|
645
|
+
* ```
|
|
646
|
+
*/
|
|
647
|
+
getPublishedAssets(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/asset.js").Asset, AssetProps<{}>>>;
|
|
648
|
+
/**
|
|
649
|
+
* Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
650
|
+
* @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
|
|
651
|
+
* @return Promise for the newly created Asset
|
|
652
|
+
* @example ```javascript
|
|
653
|
+
* const client = contentful.createClient({
|
|
654
|
+
* accessToken: '<content_management_api_key>'
|
|
655
|
+
* })
|
|
656
|
+
*
|
|
657
|
+
* // Create asset
|
|
658
|
+
* client.getSpace('<space_id>')
|
|
659
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
660
|
+
* .then((environment) => environment.createAsset({
|
|
661
|
+
* fields: {
|
|
662
|
+
* title: {
|
|
663
|
+
* 'en-US': 'Playsam Streamliner'
|
|
664
|
+
* },
|
|
665
|
+
* file: {
|
|
666
|
+
* 'en-US': {
|
|
667
|
+
* contentType: 'image/jpeg',
|
|
668
|
+
* fileName: 'example.jpeg',
|
|
669
|
+
* upload: 'https://example.com/example.jpg'
|
|
670
|
+
* }
|
|
671
|
+
* }
|
|
672
|
+
* }
|
|
673
|
+
* }))
|
|
674
|
+
* .then((asset) => asset.processForLocale("en-US")) // OR asset.processForAllLocales()
|
|
675
|
+
* .then((asset) => console.log(asset))
|
|
676
|
+
* .catch(console.error)
|
|
677
|
+
* ```
|
|
678
|
+
*/
|
|
679
|
+
createAsset(data: CreateAssetProps): Promise<import("./entities/asset.js").Asset>;
|
|
680
|
+
/**
|
|
681
|
+
* Creates a Asset with a custom ID. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
682
|
+
* @param id - Asset ID
|
|
683
|
+
* @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
|
|
684
|
+
* @return Promise for the newly created Asset
|
|
685
|
+
* @example ```javascript
|
|
686
|
+
* const client = contentful.createClient({
|
|
687
|
+
* accessToken: '<content_management_api_key>'
|
|
688
|
+
* })
|
|
689
|
+
*
|
|
690
|
+
* // Create asset
|
|
691
|
+
* client.getSpace('<space_id>')
|
|
692
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
693
|
+
* .then((environment) => environment.createAssetWithId('<asset_id>', {
|
|
694
|
+
* title: {
|
|
695
|
+
* 'en-US': 'Playsam Streamliner'
|
|
696
|
+
* },
|
|
697
|
+
* file: {
|
|
698
|
+
* 'en-US': {
|
|
699
|
+
* contentType: 'image/jpeg',
|
|
700
|
+
* fileName: 'example.jpeg',
|
|
701
|
+
* upload: 'https://example.com/example.jpg'
|
|
702
|
+
* }
|
|
703
|
+
* }
|
|
704
|
+
* }))
|
|
705
|
+
* .then((asset) => asset.process())
|
|
706
|
+
* .then((asset) => console.log(asset))
|
|
707
|
+
* .catch(console.error)
|
|
708
|
+
* ```
|
|
709
|
+
*/
|
|
710
|
+
createAssetWithId(id: string, data: CreateAssetProps): Promise<import("./entities/asset.js").Asset>;
|
|
711
|
+
/**
|
|
712
|
+
* Creates a Asset based on files. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
713
|
+
* @param data - Object representation of the Asset to be created. Note that the field object should have an uploadFrom property on asset creation, which will be removed and replaced with an url property when processing is finished.
|
|
714
|
+
* @param data.fields.file.[LOCALE].file - Can be a string, an ArrayBuffer or a Stream.
|
|
715
|
+
* @return Promise for the newly created Asset
|
|
716
|
+
* @example ```javascript
|
|
717
|
+
* const client = contentful.createClient({
|
|
718
|
+
* accessToken: '<content_management_api_key>'
|
|
719
|
+
* })
|
|
720
|
+
*
|
|
721
|
+
* client.getSpace('<space_id>')
|
|
722
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
723
|
+
* .then((environment) => environment.createAssetFromFiles({
|
|
724
|
+
* fields: {
|
|
725
|
+
* file: {
|
|
726
|
+
* 'en-US': {
|
|
727
|
+
* contentType: 'image/jpeg',
|
|
728
|
+
* fileName: 'filename_english.jpg',
|
|
729
|
+
* file: createReadStream('path/to/filename_english.jpg')
|
|
730
|
+
* },
|
|
731
|
+
* 'de-DE': {
|
|
732
|
+
* contentType: 'image/svg+xml',
|
|
733
|
+
* fileName: 'filename_german.svg',
|
|
734
|
+
* file: '<svg><path fill="red" d="M50 50h150v50H50z"/></svg>'
|
|
735
|
+
* }
|
|
736
|
+
* }
|
|
737
|
+
* }
|
|
738
|
+
* }))
|
|
739
|
+
* .then((asset) => console.log(asset))
|
|
740
|
+
* .catch(console.error)
|
|
741
|
+
* ```
|
|
742
|
+
*/
|
|
743
|
+
createAssetFromFiles(data: AssetFileProp, options?: CreateAssetFromFilesOptions): Promise<import("./entities/asset.js").Asset>;
|
|
744
|
+
/**
|
|
745
|
+
* Creates an asset key for signing asset URLs (Embargoed Assets)
|
|
746
|
+
* @param data Object with request payload
|
|
747
|
+
* @param data.expiresAt number a UNIX timestamp in the future (but not more than 48 hours from time of calling)
|
|
748
|
+
* @return Promise for the newly created AssetKey
|
|
749
|
+
* @example ```javascript
|
|
750
|
+
* const client = contentful.createClient({
|
|
751
|
+
* accessToken: '<content_management_api_key>'
|
|
752
|
+
* })
|
|
753
|
+
*
|
|
754
|
+
* // Create assetKey
|
|
755
|
+
* now = () => Math.floor(Date.now() / 1000)
|
|
756
|
+
* const withExpiryIn1Hour = () => now() + 1 * 60 * 60
|
|
757
|
+
* client.getSpace('<space_id>')
|
|
758
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
759
|
+
* .then((environment) => environment.createAssetKey({ expiresAt: withExpiryIn1Hour() }))
|
|
760
|
+
* .then((policy, secret) => console.log({ policy, secret }))
|
|
761
|
+
* .catch(console.error)
|
|
762
|
+
* ```
|
|
763
|
+
*/
|
|
764
|
+
createAssetKey(payload: CreateAssetKeyProps): Promise<import("./entities/asset-key.js").AssetKey>;
|
|
765
|
+
/**
|
|
766
|
+
* Gets an Upload
|
|
767
|
+
* @param id - Upload ID
|
|
768
|
+
* @return Promise for an Upload
|
|
769
|
+
* @example ```javascript
|
|
770
|
+
* const client = contentful.createClient({
|
|
771
|
+
* accessToken: '<content_management_api_key>'
|
|
772
|
+
* })
|
|
773
|
+
* const uploadStream = createReadStream('path/to/filename_english.jpg')
|
|
774
|
+
*
|
|
775
|
+
* client.getSpace('<space_id>')
|
|
776
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
777
|
+
* .then((environment) => environment.getUpload('<upload-id>')
|
|
778
|
+
* .then((upload) => console.log(upload))
|
|
779
|
+
* .catch(console.error)
|
|
780
|
+
*/
|
|
781
|
+
getUpload(id: string): Promise<{
|
|
782
|
+
delete: () => Promise<void>;
|
|
783
|
+
} & import("./entities/upload.js").UploadProps & {
|
|
784
|
+
toPlainObject(): import("./entities/upload.js").UploadProps;
|
|
785
|
+
}>;
|
|
786
|
+
/**
|
|
787
|
+
* Creates a Upload.
|
|
788
|
+
* @param data - Object with file information.
|
|
789
|
+
* @param data.file - Actual file content. Can be a string, an ArrayBuffer or a Stream.
|
|
790
|
+
* @return Upload object containing information about the uploaded file.
|
|
791
|
+
* @example ```javascript
|
|
792
|
+
* const client = contentful.createClient({
|
|
793
|
+
* accessToken: '<content_management_api_key>'
|
|
794
|
+
* })
|
|
795
|
+
* const uploadStream = createReadStream('path/to/filename_english.jpg')
|
|
796
|
+
*
|
|
797
|
+
* client.getSpace('<space_id>')
|
|
798
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
799
|
+
* .then((environment) => environment.createUpload({file: uploadStream})
|
|
800
|
+
* .then((upload) => console.log(upload))
|
|
801
|
+
* .catch(console.error)
|
|
802
|
+
* ```
|
|
803
|
+
*/
|
|
804
|
+
createUpload: (data: {
|
|
805
|
+
file: string | ArrayBuffer | Stream;
|
|
806
|
+
}) => Promise<{
|
|
807
|
+
delete: () => Promise<void>;
|
|
808
|
+
} & import("./entities/upload.js").UploadProps & {
|
|
809
|
+
toPlainObject(): import("./entities/upload.js").UploadProps;
|
|
810
|
+
}>;
|
|
811
|
+
/**
|
|
812
|
+
* Gets a Locale
|
|
813
|
+
* @param localeId - Locale ID
|
|
814
|
+
* @return Promise for an Locale
|
|
815
|
+
* @example ```javascript
|
|
816
|
+
* const contentful = require('contentful-management')
|
|
817
|
+
*
|
|
818
|
+
* const client = contentful.createClient({
|
|
819
|
+
* accessToken: '<content_management_api_key>'
|
|
820
|
+
* })
|
|
821
|
+
*
|
|
822
|
+
* client.getSpace('<space_id>')
|
|
823
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
824
|
+
* .then((environment) => environment.getLocale('<locale_id>'))
|
|
825
|
+
* .then((locale) => console.log(locale))
|
|
826
|
+
* .catch(console.error)
|
|
827
|
+
* ```
|
|
828
|
+
*/
|
|
829
|
+
getLocale(localeId: string): Promise<import("./entities/locale.js").Locale>;
|
|
830
|
+
/**
|
|
831
|
+
* Gets a collection of Locales
|
|
832
|
+
* @return Promise for a collection of Locales
|
|
833
|
+
* @example ```javascript
|
|
834
|
+
* const contentful = require('contentful-management')
|
|
835
|
+
*
|
|
836
|
+
* const client = contentful.createClient({
|
|
837
|
+
* accessToken: '<content_management_api_key>'
|
|
838
|
+
* })
|
|
839
|
+
*
|
|
840
|
+
* client.getSpace('<space_id>')
|
|
841
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
842
|
+
* .then((environment) => environment.getLocales())
|
|
843
|
+
* .then((response) => console.log(response.items))
|
|
844
|
+
* .catch(console.error)
|
|
845
|
+
* ```
|
|
846
|
+
*/
|
|
847
|
+
getLocales(query?: BasicQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/locale.js").Locale, import("./entities/locale.js").LocaleProps>>;
|
|
848
|
+
/**
|
|
849
|
+
* Creates a Locale
|
|
850
|
+
* @param data - Object representation of the Locale to be created
|
|
851
|
+
* @return Promise for the newly created Locale
|
|
852
|
+
* @example ```javascript
|
|
853
|
+
* const contentful = require('contentful-management')
|
|
854
|
+
*
|
|
855
|
+
* const client = contentful.createClient({
|
|
856
|
+
* accessToken: '<content_management_api_key>'
|
|
857
|
+
* })
|
|
858
|
+
*
|
|
859
|
+
* // Create locale
|
|
860
|
+
* client.getSpace('<space_id>')
|
|
861
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
862
|
+
* .then((environment) => environment.createLocale({
|
|
863
|
+
* name: 'German (Austria)',
|
|
864
|
+
* code: 'de-AT',
|
|
865
|
+
* fallbackCode: 'de-DE',
|
|
866
|
+
* optional: true
|
|
867
|
+
* }))
|
|
868
|
+
* .then((locale) => console.log(locale))
|
|
869
|
+
* .catch(console.error)
|
|
870
|
+
* ```
|
|
871
|
+
*/
|
|
872
|
+
createLocale(data: CreateLocaleProps): Promise<import("./entities/locale.js").Locale>;
|
|
873
|
+
/**
|
|
874
|
+
* Gets an UI Extension
|
|
875
|
+
* @param id - Extension ID
|
|
876
|
+
* @return Promise for an UI Extension
|
|
877
|
+
* @example ```javascript
|
|
878
|
+
* const contentful = require('contentful-management')
|
|
879
|
+
*
|
|
880
|
+
* const client = contentful.createClient({
|
|
881
|
+
* accessToken: '<content_management_api_key>'
|
|
882
|
+
* })
|
|
883
|
+
*
|
|
884
|
+
* client.getSpace('<space_id>')
|
|
885
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
886
|
+
* .then((environment) => environment.getUiExtension('<extension-id>'))
|
|
887
|
+
* .then((extension) => console.log(extension))
|
|
888
|
+
* .catch(console.error)
|
|
889
|
+
* ```
|
|
890
|
+
*/
|
|
891
|
+
getUiExtension(id: string): Promise<import("./entities/extension.js").Extension>;
|
|
892
|
+
/**
|
|
893
|
+
* Gets a collection of UI Extension
|
|
894
|
+
* @return Promise for a collection of UI Extensions
|
|
895
|
+
* @example ```javascript
|
|
896
|
+
* const contentful = require('contentful-management')
|
|
897
|
+
*
|
|
898
|
+
* const client = contentful.createClient({
|
|
899
|
+
* accessToken: '<content_management_api_key>'
|
|
900
|
+
* })
|
|
901
|
+
*
|
|
902
|
+
* client.getSpace('<space_id>')
|
|
903
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
904
|
+
* .then((environment) => environment.getUiExtensions()
|
|
905
|
+
* .then((response) => console.log(response.items))
|
|
906
|
+
* .catch(console.error)
|
|
907
|
+
* ```
|
|
908
|
+
*/
|
|
909
|
+
getUiExtensions(): Promise<import("./common-types.js").Collection<import("./entities/extension.js").Extension, import("./entities/extension.js").ExtensionProps>>;
|
|
910
|
+
/**
|
|
911
|
+
* Creates a UI Extension
|
|
912
|
+
* @param data - Object representation of the UI Extension to be created
|
|
913
|
+
* @return Promise for the newly created UI Extension
|
|
914
|
+
* @example ```javascript
|
|
915
|
+
* const contentful = require('contentful-management')
|
|
916
|
+
*
|
|
917
|
+
* const client = contentful.createClient({
|
|
918
|
+
* accessToken: '<content_management_api_key>'
|
|
919
|
+
* })
|
|
920
|
+
*
|
|
921
|
+
* client.getSpace('<space_id>')
|
|
922
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
923
|
+
* .then((environment) => environment.createUiExtension({
|
|
924
|
+
* extension: {
|
|
925
|
+
* name: 'My awesome extension',
|
|
926
|
+
* src: 'https://example.com/my',
|
|
927
|
+
* fieldTypes: [
|
|
928
|
+
* {
|
|
929
|
+
* type: 'Symbol'
|
|
930
|
+
* },
|
|
931
|
+
* {
|
|
932
|
+
* type: 'Text'
|
|
933
|
+
* }
|
|
934
|
+
* ],
|
|
935
|
+
* sidebar: false
|
|
936
|
+
* }
|
|
937
|
+
* }))
|
|
938
|
+
* .then((extension) => console.log(extension))
|
|
939
|
+
* .catch(console.error)
|
|
940
|
+
* ```
|
|
941
|
+
*/
|
|
942
|
+
createUiExtension(data: CreateExtensionProps): Promise<import("./entities/extension.js").Extension>;
|
|
943
|
+
/**
|
|
944
|
+
* Creates a UI Extension with a custom ID
|
|
945
|
+
* @param id - Extension ID
|
|
946
|
+
* @param data - Object representation of the UI Extension to be created
|
|
947
|
+
* @return Promise for the newly created UI Extension
|
|
948
|
+
* @example ```javascript
|
|
949
|
+
* const contentful = require('contentful-management')
|
|
950
|
+
*
|
|
951
|
+
* const client = contentful.createClient({
|
|
952
|
+
* accessToken: '<content_management_api_key>'
|
|
953
|
+
* })
|
|
954
|
+
*
|
|
955
|
+
* client.getSpace('<space_id>')
|
|
956
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
957
|
+
* .then((environment) => environment.createUiExtensionWithId('<extension_id>', {
|
|
958
|
+
* extension: {
|
|
959
|
+
* name: 'My awesome extension',
|
|
960
|
+
* src: 'https://example.com/my',
|
|
961
|
+
* fieldTypes: [
|
|
962
|
+
* {
|
|
963
|
+
* type: 'Symbol'
|
|
964
|
+
* },
|
|
965
|
+
* {
|
|
966
|
+
* type: 'Text'
|
|
967
|
+
* }
|
|
968
|
+
* ],
|
|
969
|
+
* sidebar: false
|
|
970
|
+
* }
|
|
971
|
+
* }))
|
|
972
|
+
* .then((extension) => console.log(extension))
|
|
973
|
+
* .catch(console.error)
|
|
974
|
+
* ```
|
|
975
|
+
*/
|
|
976
|
+
createUiExtensionWithId(id: string, data: CreateExtensionProps): Promise<import("./entities/extension.js").Extension>;
|
|
977
|
+
/**
|
|
978
|
+
* Creates an App Installation
|
|
979
|
+
* @param appDefinitionId - AppDefinition ID
|
|
980
|
+
* @param data - AppInstallation data
|
|
981
|
+
* @param options.acceptAllTerms - Flag for accepting Apps' Marketplace EULA, Terms, and Privacy policy (need to pass `{acceptAllTerms: true}` to install a marketplace app)
|
|
982
|
+
* @return Promise for an App Installation
|
|
983
|
+
* @example ```javascript
|
|
984
|
+
* const contentful = require('contentful-management')
|
|
985
|
+
*
|
|
986
|
+
* const client = contentful.createClient({
|
|
987
|
+
* accessToken: '<content_management_api_key>'
|
|
988
|
+
* })
|
|
989
|
+
*
|
|
990
|
+
* client.getSpace('<space_id>')
|
|
991
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
992
|
+
* .then((environment) => environment.createAppInstallation('<app_definition_id>', {
|
|
993
|
+
* parameters: {
|
|
994
|
+
* someParameter: someValue
|
|
995
|
+
* }
|
|
996
|
+
* })
|
|
997
|
+
* .then((appInstallation) => console.log(appInstallation))
|
|
998
|
+
* .catch(console.error)
|
|
999
|
+
* ```
|
|
1000
|
+
*/
|
|
1001
|
+
createAppInstallation(appDefinitionId: string, data: CreateAppInstallationProps, { acceptAllTerms }?: {
|
|
1002
|
+
acceptAllTerms?: boolean;
|
|
1003
|
+
}): Promise<import("./entities/app-installation.js").AppInstallation>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Gets an App Installation
|
|
1006
|
+
* @param id - AppDefintion ID
|
|
1007
|
+
* @return Promise for an App Installation
|
|
1008
|
+
* @example ```javascript
|
|
1009
|
+
* const contentful = require('contentful-management')
|
|
1010
|
+
*
|
|
1011
|
+
* const client = contentful.createClient({
|
|
1012
|
+
* accessToken: '<content_management_api_key>'
|
|
1013
|
+
* })
|
|
1014
|
+
*
|
|
1015
|
+
* client.getSpace('<space_id>')
|
|
1016
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1017
|
+
* .then((environment) => environment.getAppInstallation('<app-definition-id>'))
|
|
1018
|
+
* .then((appInstallation) => console.log(appInstallation))
|
|
1019
|
+
* .catch(console.error)
|
|
1020
|
+
* ```
|
|
1021
|
+
*/
|
|
1022
|
+
getAppInstallation(id: string): Promise<import("./entities/app-installation.js").AppInstallation>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Gets a collection of App Installation
|
|
1025
|
+
* @return Promise for a collection of App Installations
|
|
1026
|
+
* @example ```javascript
|
|
1027
|
+
* const contentful = require('contentful-management')
|
|
1028
|
+
*
|
|
1029
|
+
* const client = contentful.createClient({
|
|
1030
|
+
* accessToken: '<content_management_api_key>'
|
|
1031
|
+
* })
|
|
1032
|
+
*
|
|
1033
|
+
* client.getSpace('<space_id>')
|
|
1034
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1035
|
+
* .then((environment) => environment.getAppInstallations()
|
|
1036
|
+
* .then((response) => console.log(response.items))
|
|
1037
|
+
* .catch(console.error)
|
|
1038
|
+
* ```
|
|
1039
|
+
*/
|
|
1040
|
+
getAppInstallations(): Promise<import("./common-types.js").Collection<import("./entities/app-installation.js").AppInstallation, import("./entities/app-installation.js").AppInstallationProps>>;
|
|
1041
|
+
/**
|
|
1042
|
+
* Creates an app action call
|
|
1043
|
+
* @param appDefinitionId - AppDefinition ID
|
|
1044
|
+
* @param appActionId - action ID
|
|
1045
|
+
* @param data - App Action Call data
|
|
1046
|
+
* @return Promise for an App Action Call
|
|
1047
|
+
* @example ```javascript
|
|
1048
|
+
* const contentful = require('contentful-management')
|
|
1049
|
+
*
|
|
1050
|
+
* const client = contentful.createClient({
|
|
1051
|
+
* accessToken: '<content_management_api_key>'
|
|
1052
|
+
* })
|
|
1053
|
+
*
|
|
1054
|
+
* const data = {
|
|
1055
|
+
* headers: {
|
|
1056
|
+
* 'x-my-header': 'some-value'
|
|
1057
|
+
* },
|
|
1058
|
+
* body: {
|
|
1059
|
+
* 'some-body-value': true
|
|
1060
|
+
* }
|
|
1061
|
+
* }
|
|
1062
|
+
*
|
|
1063
|
+
* client.getSpace('<space_id>')
|
|
1064
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1065
|
+
* .then((environment) => environment.createAppActionCall('<app_definition_id>', '<action_id>', data)
|
|
1066
|
+
* .then((appActionCall) => console.log(appActionCall))
|
|
1067
|
+
* .catch(console.error)
|
|
1068
|
+
* ```
|
|
1069
|
+
*/
|
|
1070
|
+
createAppActionCall(appDefinitionId: string, appActionId: string, data: CreateAppActionCallProps): Promise<import("./entities/app-action-call.js").AppActionCall>;
|
|
1071
|
+
/**
|
|
1072
|
+
* Gets the raw response (headers/body) for a completed App Action Call
|
|
1073
|
+
* @param appDefinitionId - AppDefinition ID
|
|
1074
|
+
* @param appActionId - App Action ID
|
|
1075
|
+
* @param callId - App Action Call ID
|
|
1076
|
+
* @return Promise for the raw response object including `response.body` and optional `response.headers`
|
|
1077
|
+
* @example ```javascript
|
|
1078
|
+
* const contentful = require('contentful-management')
|
|
1079
|
+
*
|
|
1080
|
+
* const client = contentful.createClient({
|
|
1081
|
+
* accessToken: '<content_management_api_key>'
|
|
1082
|
+
* })
|
|
1083
|
+
*
|
|
1084
|
+
* client
|
|
1085
|
+
* .getSpace('<space_id>')
|
|
1086
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
1087
|
+
* .then((environment) => environment.getAppActionCallResponse('<app_definition_id>', '<app_action_id>', '<call_id>'))
|
|
1088
|
+
* .then((raw) => console.log(raw.response.body))
|
|
1089
|
+
* .catch(console.error)
|
|
1090
|
+
* ```
|
|
1091
|
+
*/
|
|
1092
|
+
getAppActionCallResponse(appDefinitionId: string, appActionId: string, callId: string): Promise<AppActionCallRawResponseProps>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Creates an app signed request
|
|
1095
|
+
* @param appDefinitionId - AppDefinition ID
|
|
1096
|
+
* @param data - SignedRequest data
|
|
1097
|
+
* @return Promise for a Signed Request
|
|
1098
|
+
* @example ```javascript
|
|
1099
|
+
* const contentful = require('contentful-management')
|
|
1100
|
+
*
|
|
1101
|
+
* const client = contentful.createClient({
|
|
1102
|
+
* accessToken: '<content_management_api_key>'
|
|
1103
|
+
* })
|
|
1104
|
+
*
|
|
1105
|
+
* const data = {
|
|
1106
|
+
* method: 'POST',
|
|
1107
|
+
* path: '/request_path',
|
|
1108
|
+
* body: '{ "key": "data" }',
|
|
1109
|
+
* headers: {
|
|
1110
|
+
* 'x-my-header': 'some-value'
|
|
1111
|
+
* },
|
|
1112
|
+
* }
|
|
1113
|
+
*
|
|
1114
|
+
* client.getSpace('<space_id>')
|
|
1115
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1116
|
+
* .then((environment) => environment.createAppSignedRequest('<app_definition_id>', data)
|
|
1117
|
+
* .then((signedRequest) => console.log(signedRequest))
|
|
1118
|
+
* .catch(console.error)
|
|
1119
|
+
* ```
|
|
1120
|
+
*/
|
|
1121
|
+
createAppSignedRequest(appDefinitionId: string, data: CreateAppSignedRequestProps): Promise<import("./entities/app-signed-request.js").AppSignedRequest>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Creates an app access token
|
|
1124
|
+
* @param appDefinitionId - AppDefinition ID
|
|
1125
|
+
* @param data - Json Web Token
|
|
1126
|
+
* @return Promise for an app access token
|
|
1127
|
+
* @example ```javascript
|
|
1128
|
+
* const contentful = require('contentful-management')
|
|
1129
|
+
* const { sign } = require('jsonwebtoken')
|
|
1130
|
+
*
|
|
1131
|
+
* const signOptions = { algorithm: 'RS256', issuer: '<app_definition_id>', expiresIn: '10m' }
|
|
1132
|
+
*
|
|
1133
|
+
* const client = contentful.createClient({
|
|
1134
|
+
* accessToken: '<content_management_api_key>'
|
|
1135
|
+
* })
|
|
1136
|
+
*
|
|
1137
|
+
* const data = {
|
|
1138
|
+
* jwt: sign({}, '<private_key>', signOptions)
|
|
1139
|
+
* }
|
|
1140
|
+
*
|
|
1141
|
+
* client.getSpace('<space_id>')
|
|
1142
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1143
|
+
* .then((environment) => environment.createAppAccessToken('<app_definition_id>', data)
|
|
1144
|
+
* .then((appAccessToken) => console.log(appAccessToken))
|
|
1145
|
+
* .catch(console.error)
|
|
1146
|
+
* ```
|
|
1147
|
+
*/
|
|
1148
|
+
createAppAccessToken(appDefinitionId: string, data: CreateAppAccessTokenProps): Promise<import("./entities/app-access-token.js").AppAccessToken>;
|
|
1149
|
+
/**
|
|
1150
|
+
* Gets a collection of Functions for a given environment
|
|
1151
|
+
* @param appInstallationId
|
|
1152
|
+
* @param {import('../common-types').AcceptsQueryOptions} query - optional query parameter for filtering functions by action
|
|
1153
|
+
* @return Promise containing wrapped collection of Functions in an environment
|
|
1154
|
+
* @example ```javascript
|
|
1155
|
+
* const contentful = require('contentful-management')
|
|
1156
|
+
*
|
|
1157
|
+
* const client = contentful.createClient({
|
|
1158
|
+
* accessToken: '<content_management_api_key>'
|
|
1159
|
+
* })
|
|
1160
|
+
*
|
|
1161
|
+
* client
|
|
1162
|
+
* .getSpace('<space-id>')
|
|
1163
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1164
|
+
* .then((environment) => environment.getFunctionsForEnvironment('<app-installation-id>', { 'accepts[all]': '<action>' }))
|
|
1165
|
+
* .then((functions) => console.log(functions.items))
|
|
1166
|
+
* .catch(console.error)
|
|
1167
|
+
* ```
|
|
1168
|
+
*/
|
|
1169
|
+
getFunctionsForEnvironment(appInstallationId: string, query?: AcceptsQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/function.js").FunctionProps, import("./entities/function.js").FunctionProps>>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Gets a collection of FunctionLogs for a given app installation id and FunctionId
|
|
1172
|
+
* @param appInstallationId
|
|
1173
|
+
* @param functionId
|
|
1174
|
+
* @param {import('../common-types').CursorBasedParams} query - optional query parameter for pagination (limit, nextPage, prevPage)
|
|
1175
|
+
* @return Promise containing wrapped collection of FunctionLogs
|
|
1176
|
+
* * @example ```javascript
|
|
1177
|
+
* const contentful = require('contentful-management')
|
|
1178
|
+
*
|
|
1179
|
+
* const client = contentful.createClient({
|
|
1180
|
+
* accessToken: '<content_management_api_key>'
|
|
1181
|
+
* })
|
|
1182
|
+
*
|
|
1183
|
+
* client
|
|
1184
|
+
* .getSpace('<space-id>')
|
|
1185
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1186
|
+
* .then((environment) =>
|
|
1187
|
+
* environment.getFunctionLogs(
|
|
1188
|
+
* '<app-installation-id>',
|
|
1189
|
+
* '<function-id>',
|
|
1190
|
+
* {
|
|
1191
|
+
* query: {
|
|
1192
|
+
* // optional limit
|
|
1193
|
+
* limit: 10,
|
|
1194
|
+
* // optional interval query
|
|
1195
|
+
* 'sys.createdAt[gte]': start,
|
|
1196
|
+
* 'sys.createdAt[lt]': end,
|
|
1197
|
+
* // optional cursor based pagination parameters
|
|
1198
|
+
* pagePrev: '<page_prev>',
|
|
1199
|
+
* },
|
|
1200
|
+
* },
|
|
1201
|
+
* )
|
|
1202
|
+
* )
|
|
1203
|
+
* .then((functionLogs) => console.log(functionLog.items))
|
|
1204
|
+
* .catch(console.error)
|
|
1205
|
+
* ```
|
|
1206
|
+
*/
|
|
1207
|
+
getFunctionLogs(appInstallationId: string, functionId: string, query?: CursorBasedParams & CreatedAtIntervalParams): Promise<import("./common-types.js").Collection<import("./entities/function-log.js").FunctionLogProps, import("./entities/function-log.js").FunctionLogProps>>;
|
|
1208
|
+
/**
|
|
1209
|
+
* Gets a FunctionLog by appInstallationId, functionId and logId
|
|
1210
|
+
* @param appInstallationId
|
|
1211
|
+
* @param functionId
|
|
1212
|
+
* @param logId
|
|
1213
|
+
* @return Promise containing a wrapped FunctionLog
|
|
1214
|
+
* @example ```javascript
|
|
1215
|
+
* const contentful = require('contentful-management')
|
|
1216
|
+
*
|
|
1217
|
+
* const client = contentful.createClient({
|
|
1218
|
+
* accessToken: '<content_management_api_key>'
|
|
1219
|
+
* })
|
|
1220
|
+
*
|
|
1221
|
+
* client
|
|
1222
|
+
* .getSpace(<space-id>)
|
|
1223
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1224
|
+
* .then((environment) =>
|
|
1225
|
+
* environment.getFunctionLog(
|
|
1226
|
+
* '<app-installation-id>',
|
|
1227
|
+
* '<function-id>',
|
|
1228
|
+
* '<log-id>'
|
|
1229
|
+
* )
|
|
1230
|
+
* )
|
|
1231
|
+
* .then((functionLog) => console.log(functionLog))
|
|
1232
|
+
* .catch(console.error)
|
|
1233
|
+
* ```
|
|
1234
|
+
*/
|
|
1235
|
+
getFunctionLog(appInstallationId: string, functionId: string, logId: string): Promise<import("./entities/function-log.js").FunctionLogProps>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Gets all snapshots of an entry
|
|
1238
|
+
* @func getEntrySnapshots
|
|
1239
|
+
* @param entryId - Entry ID
|
|
1240
|
+
* @param query - query additional query paramaters
|
|
1241
|
+
* @return Promise for a collection of Entry Snapshots
|
|
1242
|
+
* @example ```javascript
|
|
1243
|
+
* const contentful = require('contentful-management')
|
|
1244
|
+
*
|
|
1245
|
+
* const client = contentful.createClient({
|
|
1246
|
+
* accessToken: '<content_management_api_key>'
|
|
1247
|
+
* })
|
|
1248
|
+
*
|
|
1249
|
+
* client.getSpace('<space_id>')
|
|
1250
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1251
|
+
* .then((environment) => environment.getEntrySnapshots('<entry_id>'))
|
|
1252
|
+
* .then((snapshots) => console.log(snapshots.items))
|
|
1253
|
+
* .catch(console.error)
|
|
1254
|
+
* ```
|
|
1255
|
+
*/
|
|
1256
|
+
getEntrySnapshots(entryId: string, query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/snapshot.js").Snapshot<EntryProps>, import("./entities/snapshot.js").SnapshotProps<EntryProps>>>;
|
|
1257
|
+
/**
|
|
1258
|
+
* Gets all snapshots of a contentType
|
|
1259
|
+
* @func getContentTypeSnapshots
|
|
1260
|
+
* @param contentTypeId - Content Type ID
|
|
1261
|
+
* @param query - query additional query paramaters
|
|
1262
|
+
* @return Promise for a collection of Content Type Snapshots
|
|
1263
|
+
* @example ```javascript
|
|
1264
|
+
* const contentful = require('contentful-management')
|
|
1265
|
+
*
|
|
1266
|
+
* const client = contentful.createClient({
|
|
1267
|
+
* accessToken: '<content_management_api_key>'
|
|
1268
|
+
* })
|
|
1269
|
+
*
|
|
1270
|
+
* client.getSpace('<space_id>')
|
|
1271
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1272
|
+
* .then((environment) => environment.getContentTypeSnapshots('<contentTypeId>'))
|
|
1273
|
+
* .then((snapshots) => console.log(snapshots.items))
|
|
1274
|
+
* .catch(console.error)
|
|
1275
|
+
* ```
|
|
1276
|
+
*/
|
|
1277
|
+
getContentTypeSnapshots(contentTypeId: string, query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/snapshot.js").Snapshot<ContentTypeProps>, import("./entities/snapshot.js").SnapshotProps<ContentTypeProps>>>;
|
|
1278
|
+
createTag(id: string, name: string, visibility?: TagVisibility): Promise<import("./entities/tag.js").Tag>;
|
|
1279
|
+
getTags(query?: BasicQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/tag.js").Tag, import("./entities/tag.js").TagProps>>;
|
|
1280
|
+
getTag(id: string): Promise<import("./entities/tag.js").Tag>;
|
|
1281
|
+
/**
|
|
1282
|
+
* Retrieves a Release by ID
|
|
1283
|
+
* @param releaseId
|
|
1284
|
+
* @returns Promise containing a wrapped Release
|
|
1285
|
+
* @example ```javascript
|
|
1286
|
+
* const contentful = require('contentful-management')
|
|
1287
|
+
*
|
|
1288
|
+
* const client = contentful.createClient({
|
|
1289
|
+
* accessToken: '<content_management_api_key>'
|
|
1290
|
+
* })
|
|
1291
|
+
*
|
|
1292
|
+
* client.getSpace('<space_id>')
|
|
1293
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1294
|
+
* .then((environment) => environment.getRelease('<release_id>'))
|
|
1295
|
+
* .then((release) => console.log(release))
|
|
1296
|
+
* .catch(console.error)
|
|
1297
|
+
* ```
|
|
1298
|
+
*/
|
|
1299
|
+
getRelease(releaseId: string): Promise<import("./entities/release.js").Release>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Gets a Collection of Releases,
|
|
1302
|
+
* @param {ReleaseQueryOptions} query filtering options for the collection result
|
|
1303
|
+
* @returns Promise containing a wrapped Release Collection
|
|
1304
|
+
* @example ```javascript
|
|
1305
|
+
* const contentful = require('contentful-management')
|
|
1306
|
+
*
|
|
1307
|
+
* const client = contentful.createClient({
|
|
1308
|
+
* accessToken: '<content_management_api_key>'
|
|
1309
|
+
* })
|
|
1310
|
+
*
|
|
1311
|
+
* client.getSpace('<space_id>')
|
|
1312
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1313
|
+
* .then((environment) => environment.getReleases({ 'entities.sys.id[in]': '<asset_id>,<entry_id>' }))
|
|
1314
|
+
* .then((releases) => console.log(releases))
|
|
1315
|
+
* .catch(console.error)
|
|
1316
|
+
* ```
|
|
1317
|
+
*/
|
|
1318
|
+
getReleases(query?: ReleaseQueryOptions): Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/release.js").Release, import("./entities/release.js").ReleaseProps>>;
|
|
1319
|
+
/**
|
|
1320
|
+
* Creates a new Release with the entities and title in the payload
|
|
1321
|
+
* @param payload Object containing the payload in order to create a Release
|
|
1322
|
+
* @returns Promise containing a wrapped Release, that has other helper methods within.
|
|
1323
|
+
* @example ```javascript
|
|
1324
|
+
* const contentful = require('contentful-management')
|
|
1325
|
+
*
|
|
1326
|
+
* const client = contentful.createClient({
|
|
1327
|
+
* accessToken: '<content_management_api_key>'
|
|
1328
|
+
* })
|
|
1329
|
+
*
|
|
1330
|
+
* const payload = {
|
|
1331
|
+
* title: 'My Release',
|
|
1332
|
+
* entities: {
|
|
1333
|
+
* sys: { type: 'Array' },
|
|
1334
|
+
* items: [
|
|
1335
|
+
* { sys: { linkType: 'Entry', type: 'Link', id: '<entry_id>' } }
|
|
1336
|
+
* ]
|
|
1337
|
+
* }
|
|
1338
|
+
* }
|
|
1339
|
+
*
|
|
1340
|
+
* client.getSpace('<space_id>')
|
|
1341
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1342
|
+
* .then((environment) => environment.createRelease(payload))
|
|
1343
|
+
* .then((release) => console.log(release))
|
|
1344
|
+
* .catch(console.error)
|
|
1345
|
+
* ```
|
|
1346
|
+
*/
|
|
1347
|
+
createRelease(payload: ReleasePayload): Promise<import("./entities/release.js").Release>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Updates a Release and replaces all the properties.
|
|
1350
|
+
* @param {object} options,
|
|
1351
|
+
* @param options.releaseId the ID of the release
|
|
1352
|
+
* @param options.payload the payload to be updated in the Release
|
|
1353
|
+
* @param options.version Release sys.version that to be updated
|
|
1354
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1355
|
+
*
|
|
1356
|
+
* @example ```javascript
|
|
1357
|
+
* const contentful = require('contentful-management')
|
|
1358
|
+
*
|
|
1359
|
+
* const client = contentful.createClient({
|
|
1360
|
+
* accessToken: '<content_management_api_key>'
|
|
1361
|
+
* })
|
|
1362
|
+
*
|
|
1363
|
+
*
|
|
1364
|
+
* const payload = {
|
|
1365
|
+
* title: "Updated Release title",
|
|
1366
|
+
* entities: {
|
|
1367
|
+
* sys: { type: 'Array' },
|
|
1368
|
+
* items: [
|
|
1369
|
+
* { sys: { linkType: 'Entry', type: 'Link', id: '<entry_id>' } }
|
|
1370
|
+
* ]
|
|
1371
|
+
* }
|
|
1372
|
+
* }
|
|
1373
|
+
*
|
|
1374
|
+
* client.getSpace('<space_id>')
|
|
1375
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1376
|
+
* .then((environment) => environment.updateRelease({ releaseId: '<release_id>', version: 1, payload } ))
|
|
1377
|
+
* .then((release) => console.log(release))
|
|
1378
|
+
* .catch(console.error)
|
|
1379
|
+
* ```
|
|
1380
|
+
*/
|
|
1381
|
+
updateRelease({ releaseId, payload, version, }: {
|
|
1382
|
+
releaseId: string;
|
|
1383
|
+
payload: ReleasePayload;
|
|
1384
|
+
version: number;
|
|
1385
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1386
|
+
/**
|
|
1387
|
+
* Deletes a Release by ID - does not delete any entities.
|
|
1388
|
+
* @param releaseId the ID of the release
|
|
1389
|
+
*
|
|
1390
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1391
|
+
* @example ```javascript
|
|
1392
|
+
* const contentful = require('contentful-management')
|
|
1393
|
+
*
|
|
1394
|
+
* const client = contentful.createClient({
|
|
1395
|
+
* accessToken: '<content_management_api_key>'
|
|
1396
|
+
* })
|
|
1397
|
+
*
|
|
1398
|
+
* client.getSpace('<space_id>')
|
|
1399
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1400
|
+
* .then((environment) => environment.deleteRelease('<release_id>')
|
|
1401
|
+
* .catch(console.error)
|
|
1402
|
+
* ```
|
|
1403
|
+
*/
|
|
1404
|
+
deleteRelease(releaseId: string): Promise<void>;
|
|
1405
|
+
/**
|
|
1406
|
+
* Publishes all Entities contained in a Release.
|
|
1407
|
+
* @param options.releaseId the ID of the release
|
|
1408
|
+
* @param options.version the version of the release that is to be published
|
|
1409
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1410
|
+
*
|
|
1411
|
+
* @example ```javascript
|
|
1412
|
+
* const contentful = require('contentful-management')
|
|
1413
|
+
*
|
|
1414
|
+
* const client = contentful.createClient({
|
|
1415
|
+
* accessToken: '<content_management_api_key>'
|
|
1416
|
+
* })
|
|
1417
|
+
*
|
|
1418
|
+
* client.getSpace('<space_id>')
|
|
1419
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1420
|
+
* .then((environment) => environment.publishRelease({ releaseId: '<release_id>', version: 1 }))
|
|
1421
|
+
* .catch(console.error)
|
|
1422
|
+
* ```
|
|
1423
|
+
*/
|
|
1424
|
+
publishRelease({ releaseId, version }: {
|
|
1425
|
+
releaseId: string;
|
|
1426
|
+
version: number;
|
|
1427
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1428
|
+
/**
|
|
1429
|
+
* Unpublishes all Entities contained in a Release.
|
|
1430
|
+
* @param options.releaseId the ID of the release
|
|
1431
|
+
* @param options.version the version of the release that is to be published
|
|
1432
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1433
|
+
*
|
|
1434
|
+
* @example ```javascript
|
|
1435
|
+
* const contentful = require('contentful-management')
|
|
1436
|
+
*
|
|
1437
|
+
* const client = contentful.createClient({
|
|
1438
|
+
* accessToken: '<content_management_api_key>'
|
|
1439
|
+
* })
|
|
1440
|
+
*
|
|
1441
|
+
* client.getSpace('<space_id>')
|
|
1442
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1443
|
+
* .then((environment) => environment.unpublishRelease({ releaseId: '<release_id>', version: 1 }))
|
|
1444
|
+
* .catch(console.error)
|
|
1445
|
+
* ```
|
|
1446
|
+
*/
|
|
1447
|
+
unpublishRelease({ releaseId, version }: {
|
|
1448
|
+
releaseId: string;
|
|
1449
|
+
version: number;
|
|
1450
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1451
|
+
/**
|
|
1452
|
+
* Validates all Entities contained in a Release against an action (publish or unpublish)
|
|
1453
|
+
* @param options.releaseId the ID of the release
|
|
1454
|
+
* @param options.payload (optional) the type of action to be validated against
|
|
1455
|
+
*
|
|
1456
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1457
|
+
*
|
|
1458
|
+
* @example ```javascript
|
|
1459
|
+
* const contentful = require('contentful-management')
|
|
1460
|
+
*
|
|
1461
|
+
* const client = contentful.createClient({
|
|
1462
|
+
* accessToken: '<content_management_api_key>'
|
|
1463
|
+
* })
|
|
1464
|
+
*
|
|
1465
|
+
* client.getSpace('<space_id>')
|
|
1466
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1467
|
+
* .then((environment) => environment.validateRelease({ releaseId: '<release_id>', payload: { action: 'unpublish' } }))
|
|
1468
|
+
* .catch(console.error)
|
|
1469
|
+
* ```
|
|
1470
|
+
*/
|
|
1471
|
+
validateRelease({ releaseId, payload, }: {
|
|
1472
|
+
releaseId: string;
|
|
1473
|
+
payload?: ReleaseValidatePayload;
|
|
1474
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Archives a Release and prevents new operations (publishing, unpublishing adding new entities etc).
|
|
1477
|
+
* @param options.releaseId the ID of the release
|
|
1478
|
+
* @param options.version the version of the release that is to be archived
|
|
1479
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1480
|
+
*
|
|
1481
|
+
* @example ```javascript
|
|
1482
|
+
* const contentful = require('contentful-management')
|
|
1483
|
+
*
|
|
1484
|
+
* const client = contentful.createClient({
|
|
1485
|
+
* accessToken: '<content_management_api_key>'
|
|
1486
|
+
* })
|
|
1487
|
+
*
|
|
1488
|
+
* client.getSpace('<space_id>')
|
|
1489
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1490
|
+
* .then((environment) => environment.archiveRelease({ releaseId: '<release_id>', version: 1 }))
|
|
1491
|
+
* .catch(console.error)
|
|
1492
|
+
* ```
|
|
1493
|
+
*/
|
|
1494
|
+
archiveRelease({ releaseId, version }: {
|
|
1495
|
+
releaseId: string;
|
|
1496
|
+
version: number;
|
|
1497
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1498
|
+
/**
|
|
1499
|
+
* Unarchives a previously archived Release - this enables the release to be published, unpublished etc.
|
|
1500
|
+
* @param options.releaseId the ID of the release
|
|
1501
|
+
* @param options.version the version of the release that is to be unarchived
|
|
1502
|
+
* @returns Promise containing a wrapped Release, that has helper methods within.
|
|
1503
|
+
*
|
|
1504
|
+
* @example ```javascript
|
|
1505
|
+
* const contentful = require('contentful-management')
|
|
1506
|
+
*
|
|
1507
|
+
* const client = contentful.createClient({
|
|
1508
|
+
* accessToken: '<content_management_api_key>'
|
|
1509
|
+
* })
|
|
1510
|
+
*
|
|
1511
|
+
* client.getSpace('<space_id>')
|
|
1512
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1513
|
+
* .then((environment) => environment.unarchiveRelease({ releaseId: '<release_id>', version: 1 }))
|
|
1514
|
+
* .catch(console.error)
|
|
1515
|
+
* ```
|
|
1516
|
+
*/
|
|
1517
|
+
unarchiveRelease({ releaseId, version }: {
|
|
1518
|
+
releaseId: string;
|
|
1519
|
+
version: number;
|
|
1520
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Retrieves a ReleaseAction by ID
|
|
1523
|
+
* @param params.releaseId The ID of a Release
|
|
1524
|
+
* @param params.actionId The ID of a Release Action
|
|
1525
|
+
* @returns Promise containing a wrapped ReleaseAction
|
|
1526
|
+
* @example ```javascript
|
|
1527
|
+
* const contentful = require('contentful-management')
|
|
1528
|
+
*
|
|
1529
|
+
* const client = contentful.createClient({
|
|
1530
|
+
* accessToken: '<content_management_api_key>'
|
|
1531
|
+
* })
|
|
1532
|
+
*
|
|
1533
|
+
* client.getSpace('<space_id>')
|
|
1534
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1535
|
+
* .then((environment) => environment.getReleaseAction({ releaseId: '<release_id>', actionId: '<action_id>' }))
|
|
1536
|
+
* .then((releaseAction) => console.log(releaseAction))
|
|
1537
|
+
* .catch(console.error)
|
|
1538
|
+
* ```
|
|
1539
|
+
*/
|
|
1540
|
+
getReleaseAction({ actionId, releaseId }: {
|
|
1541
|
+
actionId: string;
|
|
1542
|
+
releaseId: string;
|
|
1543
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Gets a Collection of ReleaseActions
|
|
1546
|
+
* @param {string} params.releaseId ID of the Release to fetch the actions from
|
|
1547
|
+
* @param {ReleaseQueryOptions} params.query filtering options for the collection result
|
|
1548
|
+
* @returns Promise containing a wrapped ReleaseAction Collection
|
|
1549
|
+
*
|
|
1550
|
+
* @example ```javascript
|
|
1551
|
+
* const contentful = require('contentful-management')
|
|
1552
|
+
*
|
|
1553
|
+
* const client = contentful.createClient({
|
|
1554
|
+
* accessToken: '<content_management_api_key>'
|
|
1555
|
+
* })
|
|
1556
|
+
*
|
|
1557
|
+
* client.getSpace('<space_id>')
|
|
1558
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1559
|
+
* .then((environment) => environment.getReleaseActions({ query: { 'sys.id[in]': '<id_1>,<id_2>', 'sys.release.sys.id[in]': '<id1>,<id2>' } }))
|
|
1560
|
+
* .then((releaseActions) => console.log(releaseActions))
|
|
1561
|
+
* .catch(console.error)
|
|
1562
|
+
* ```
|
|
1563
|
+
*/
|
|
1564
|
+
getReleaseActions({ query }: {
|
|
1565
|
+
query?: ReleaseActionQueryOptions;
|
|
1566
|
+
}): Promise<import("./common-types.js").Collection<import("./entities/release-action.js").ReleaseAction<any>, import("./entities/release-action.js").ReleaseActionProps<any>>>;
|
|
1567
|
+
getUIConfig(): Promise<{
|
|
1568
|
+
update: () => Promise</*elided*/ any & import("./entities/ui-config.js").UIConfigProps & {
|
|
1569
|
+
toPlainObject(): import("./entities/ui-config.js").UIConfigProps;
|
|
1570
|
+
}>;
|
|
1571
|
+
} & import("./entities/ui-config.js").UIConfigProps & {
|
|
1572
|
+
toPlainObject(): import("./entities/ui-config.js").UIConfigProps;
|
|
1573
|
+
}>;
|
|
1574
|
+
getUserUIConfig(): Promise<{
|
|
1575
|
+
update: () => Promise</*elided*/ any & import("./entities/user-ui-config.js").UserUIConfigProps & {
|
|
1576
|
+
toPlainObject(): import("./entities/user-ui-config.js").UserUIConfigProps;
|
|
1577
|
+
}>;
|
|
1578
|
+
} & import("./entities/user-ui-config.js").UserUIConfigProps & {
|
|
1579
|
+
toPlainObject(): import("./entities/user-ui-config.js").UserUIConfigProps;
|
|
1580
|
+
}>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Gets a collection of all environment template installations in the environment for a given template
|
|
1583
|
+
* @param environmentTemplateId - Environment template ID to return installations for
|
|
1584
|
+
* @param [options.installationId] - Installation ID to filter for a specific installation
|
|
1585
|
+
* @return Promise for a collection of EnvironmentTemplateInstallations
|
|
1586
|
+
* ```javascript
|
|
1587
|
+
* const contentful = require('contentful-management')
|
|
1588
|
+
*
|
|
1589
|
+
* const client = contentful.createClient({
|
|
1590
|
+
* accessToken: '<content_management_api_key>'
|
|
1591
|
+
* })
|
|
1592
|
+
*
|
|
1593
|
+
* client.getSpace('<space_id>')
|
|
1594
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
1595
|
+
* .then((environment) => environment.getEnvironmentTemplateInstallations('<environment_template_id>'))
|
|
1596
|
+
* .then((installations) => console.log(installations.items))
|
|
1597
|
+
* .catch(console.error)
|
|
1598
|
+
* ```
|
|
1599
|
+
*/
|
|
1600
|
+
getEnvironmentTemplateInstallations(environmentTemplateId: string, { installationId, ...query }?: BasicCursorPaginationOptions & {
|
|
1601
|
+
installationId?: string;
|
|
1602
|
+
}): Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/environment-template-installation.js").EnvironmentTemplateInstallation, import("./entities/environment-template-installation.js").EnvironmentTemplateInstallationProps>>;
|
|
1603
|
+
/**
|
|
1604
|
+
* Gets a collection of all resource types based on native external references app installations in the environment
|
|
1605
|
+
* @param query - BasicCursorPaginationOptions
|
|
1606
|
+
* @return Promise for a collection of ResourceTypes
|
|
1607
|
+
* ```javascript
|
|
1608
|
+
* const contentful = require('contentful-management')
|
|
1609
|
+
*
|
|
1610
|
+
* const client = contentful.createClient({
|
|
1611
|
+
* accessToken: '<content_management_api_key>'
|
|
1612
|
+
* })
|
|
1613
|
+
*
|
|
1614
|
+
* client.getSpace('<space_id>')
|
|
1615
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
1616
|
+
* .then((environment) => environment.getResourceTypes({limit: 10}))
|
|
1617
|
+
* .then((installations) => console.log(installations.items))
|
|
1618
|
+
* .catch(console.error)
|
|
1619
|
+
* ```
|
|
1620
|
+
*/
|
|
1621
|
+
getResourceTypes(query?: BasicCursorPaginationOptions): Promise<import("./common-types.js").CursorPaginatedCollectionProp<import("./entities/resource-type.js").SpaceEnvResourceTypeProps>>;
|
|
1622
|
+
/**
|
|
1623
|
+
* Gets a collection of all resources for a given resource type based on native external references app installations in the environment
|
|
1624
|
+
* @param resourceTypeId - Id of the resourceType to get its resources
|
|
1625
|
+
* @param query - Either LookupQuery options with 'sys.urn[in]' param or a Search query with 'query' param, in both cases you can add pagination options
|
|
1626
|
+
* @return Promise for a collection of Resources for a given resourceTypeId
|
|
1627
|
+
* ```javascript
|
|
1628
|
+
* const contentful = require('contentful-management')
|
|
1629
|
+
*
|
|
1630
|
+
* const client = contentful.createClient({
|
|
1631
|
+
* accessToken: '<content_management_api_key>'
|
|
1632
|
+
* })
|
|
1633
|
+
*
|
|
1634
|
+
* // Search Query
|
|
1635
|
+
* client.getSpace('<space_id>')
|
|
1636
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
1637
|
+
* // <search_query> is a string you want to search for in the external resources
|
|
1638
|
+
* .then((environment) => environment.getResourcesForResourceType('<resource_type_id>', {query: '<search_query>', limit: 10}))
|
|
1639
|
+
* .then((installations) => console.log(installations.items))
|
|
1640
|
+
* .catch(console.error)
|
|
1641
|
+
*
|
|
1642
|
+
* // Lookup query
|
|
1643
|
+
*
|
|
1644
|
+
* client.getSpace('<space_id>')
|
|
1645
|
+
* .then((space) => space.getEnvironment('<environment_id>'))
|
|
1646
|
+
* .then((environment) => environment.getResourcesForResourceType('<resource_type_id>', {'sys.urn[in]': '<resource_urn1>,<resource_urn2>', limit: 10}))
|
|
1647
|
+
* .then((installations) => console.log(installations.items))
|
|
1648
|
+
* .catch(console.error)
|
|
1649
|
+
* ```
|
|
1650
|
+
*/
|
|
1651
|
+
getResourcesForResourceType(resourceTypeId: string, query?: ResourceQueryOptions): Promise<import("./common-types.js").CursorPaginatedCollectionProp<import("./entities/resource.js").ResourceProps>>;
|
|
1652
|
+
/**
|
|
1653
|
+
* Invokes an AI Action.
|
|
1654
|
+
* @param aiActionId - The ID of the AI Action to invoke.
|
|
1655
|
+
* @param payload - The invocation payload.
|
|
1656
|
+
* @returns Promise for an AI Action Invocation.
|
|
1657
|
+
* @example ```javascript
|
|
1658
|
+
* client.getSpace('<space_id>')
|
|
1659
|
+
* .then(space => space.getEnvironment('<environment_id>'))
|
|
1660
|
+
* .then(environment => environment.invokeAiAction('<ai_action_id>', {
|
|
1661
|
+
* variables: [ ... ],
|
|
1662
|
+
* outputFormat: 'RichText'
|
|
1663
|
+
* }))
|
|
1664
|
+
* .then(invocation => console.log(invocation))
|
|
1665
|
+
* .catch(console.error)
|
|
1666
|
+
* ```
|
|
1667
|
+
*/
|
|
1668
|
+
invokeAiAction(aiActionId: string, payload: AiActionInvocationType): Promise<import("./entities/ai-action-invocation.js").AiActionInvocation>;
|
|
1669
|
+
/**
|
|
1670
|
+
* Retrieves an AI Action Invocation.
|
|
1671
|
+
* @param params - Object containing the AI Action ID and the Invocation ID.
|
|
1672
|
+
* @returns Promise for an AI Action Invocation.
|
|
1673
|
+
* @example ```javascript
|
|
1674
|
+
* client.getSpace('<space_id>')
|
|
1675
|
+
* .then(space => space.getEnvironment('<environment_id>'))
|
|
1676
|
+
* .then(environment => environment.getAiActionInvocation({
|
|
1677
|
+
* aiActionId: '<ai_action_id>',
|
|
1678
|
+
* invocationId: '<invocation_id>'
|
|
1679
|
+
* }))
|
|
1680
|
+
* .then(invocation => console.log(invocation))
|
|
1681
|
+
* .catch(console.error)
|
|
1682
|
+
* ```
|
|
1683
|
+
*/
|
|
1684
|
+
getAiActionInvocation({ aiActionId, invocationId, }: {
|
|
1685
|
+
aiActionId: string;
|
|
1686
|
+
invocationId: string;
|
|
1687
|
+
}): Promise<import("./entities/ai-action-invocation.js").AiActionInvocation>;
|
|
1688
|
+
};
|