contentful-management 12.0.0-beta.7 → 12.0.0-beta.8
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 +9 -2
- package/dist/cjs/create-contentful-api.cjs +1 -1
- package/dist/cjs/index.cjs +1 -1
- package/dist/cjs/plain/plain-client.cjs +1 -1
- package/dist/contentful-management.browser.js +3 -3
- package/dist/contentful-management.browser.min.js +1 -1
- package/dist/contentful-management.node.cjs +3 -3
- package/dist/contentful-management.react-native.js +24808 -0
- package/dist/esm/create-contentful-api.js +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/plain/plain-client.js +1 -1
- package/dist/types/adapters/REST/endpoints/access-token.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/ai-action-invocation.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/ai-action.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/api-key.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-access-token.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-action-call.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-action.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-bundle.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-definition.d.ts +2 -2
- package/dist/types/adapters/REST/endpoints/app-details.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-event-subscription.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-installation.d.ts +2 -2
- package/dist/types/adapters/REST/endpoints/app-key.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-signed-request.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-signing-secret.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/app-upload.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/asset-key.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/asset.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/bulk-action.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/comment.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/concept-scheme.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/concept.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/content-type.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/editor-interface.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/entry.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/environment-alias.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/environment-template-installation.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/environment-template.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/environment.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/extension.d.ts +2 -2
- package/dist/types/adapters/REST/endpoints/function-log.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/function.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/http.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/index.d.ts +66 -66
- package/dist/types/adapters/REST/endpoints/locale.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/oauth-application.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/organization-invitation.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/organization-membership.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/organization.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/personal-access-token.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/preview-api-key.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/release-action.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/release.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/resource-provider.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/resource-type.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/resource.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/role.d.ts +2 -2
- package/dist/types/adapters/REST/endpoints/scheduled-action.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/snapshot.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/space-member.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/space-membership.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/space.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/tag.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/task.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/team-membership.d.ts +3 -3
- package/dist/types/adapters/REST/endpoints/team-space-membership.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/team.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/ui-config.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/upload-credentials.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/upload.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/usage.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/user-ui-config.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/user.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/utils.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/webhook.d.ts +3 -3
- package/dist/types/adapters/REST/endpoints/workflow-definition.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/workflow.d.ts +1 -1
- package/dist/types/adapters/REST/endpoints/workflows-changelog.d.ts +1 -1
- package/dist/types/adapters/REST/make-request.d.ts +1 -1
- package/dist/types/adapters/REST/rest-adapter.d.ts +1 -1
- package/dist/types/adapters/REST/types.d.ts +1 -1
- package/dist/types/common-types.d.ts +63 -63
- package/dist/types/common-utils.d.ts +1 -1
- package/dist/types/constants/editor-interface-defaults/controls-defaults.d.ts +1 -1
- package/dist/types/constants/editor-interface-defaults/editors-defaults.d.ts +1 -1
- package/dist/types/constants/editor-interface-defaults/index.d.ts +4 -4
- package/dist/types/constants/editor-interface-defaults/sidebar-defaults.d.ts +1 -1
- package/dist/types/create-adapter.d.ts +2 -2
- package/dist/types/create-app-definition-api.d.ts +10 -10
- package/dist/types/create-contentful-api.d.ts +17 -17
- package/dist/types/create-entry-api.d.ts +13 -13
- package/dist/types/create-environment-api.d.ts +88 -88
- package/dist/types/create-environment-template-api.d.ts +9 -9
- package/dist/types/create-organization-api.d.ts +153 -153
- package/dist/types/create-space-api.d.ts +65 -65
- package/dist/types/create-ui-config-api.d.ts +3 -3
- package/dist/types/create-user-ui-config-api.d.ts +3 -3
- package/dist/types/entities/access-token.d.ts +2 -2
- package/dist/types/entities/ai-action-invocation.d.ts +2 -2
- package/dist/types/entities/ai-action.d.ts +3 -3
- package/dist/types/entities/api-key.d.ts +2 -2
- package/dist/types/entities/app-access-token.d.ts +1 -1
- package/dist/types/entities/app-action-call.d.ts +2 -2
- package/dist/types/entities/app-action.d.ts +3 -3
- package/dist/types/entities/app-bundle.d.ts +2 -2
- package/dist/types/entities/app-definition.d.ts +7 -7
- package/dist/types/entities/app-details.d.ts +1 -1
- package/dist/types/entities/app-event-subscription.d.ts +1 -1
- package/dist/types/entities/app-installation.d.ts +3 -3
- package/dist/types/entities/app-key.d.ts +2 -2
- package/dist/types/entities/app-signed-request.d.ts +1 -1
- package/dist/types/entities/app-signing-secret.d.ts +1 -1
- package/dist/types/entities/app-upload.d.ts +2 -2
- package/dist/types/entities/asset-key.d.ts +1 -1
- package/dist/types/entities/asset.d.ts +2 -2
- package/dist/types/entities/bulk-action.d.ts +2 -2
- package/dist/types/entities/comment.d.ts +2 -2
- package/dist/types/entities/concept-scheme.d.ts +3 -3
- package/dist/types/entities/concept.d.ts +2 -2
- package/dist/types/entities/content-type-fields.d.ts +1 -1
- package/dist/types/entities/content-type.d.ts +5 -5
- package/dist/types/entities/editor-interface.d.ts +3 -3
- package/dist/types/entities/entry.d.ts +4 -4
- package/dist/types/entities/environment-alias.d.ts +2 -2
- package/dist/types/entities/environment-template-installation.d.ts +2 -2
- package/dist/types/entities/environment-template.d.ts +6 -5
- package/dist/types/entities/environment.d.ts +3 -3
- package/dist/types/entities/extension.d.ts +4 -4
- package/dist/types/entities/function-log.d.ts +3 -3
- package/dist/types/entities/function.d.ts +3 -3
- package/dist/types/entities/index.d.ts +62 -62
- package/dist/types/entities/locale.d.ts +2 -2
- package/dist/types/entities/oauth-application.d.ts +2 -2
- package/dist/types/entities/organization-invitation.d.ts +1 -1
- package/dist/types/entities/organization-membership.d.ts +2 -2
- package/dist/types/entities/organization.d.ts +3 -3
- package/dist/types/entities/personal-access-token.d.ts +2 -2
- package/dist/types/entities/preview-api-key.d.ts +2 -2
- package/dist/types/entities/release-action.d.ts +3 -3
- package/dist/types/entities/release.d.ts +4 -4
- package/dist/types/entities/resource-provider.d.ts +2 -2
- package/dist/types/entities/resource-type.d.ts +1 -1
- package/dist/types/entities/resource.d.ts +1 -1
- package/dist/types/entities/role.d.ts +2 -2
- package/dist/types/entities/scheduled-action.d.ts +2 -2
- package/dist/types/entities/snapshot.d.ts +2 -2
- package/dist/types/entities/space-member.d.ts +2 -2
- package/dist/types/entities/space-membership.d.ts +2 -2
- package/dist/types/entities/space.d.ts +3 -3
- package/dist/types/entities/tag.d.ts +2 -2
- package/dist/types/entities/task.d.ts +2 -2
- package/dist/types/entities/team-membership.d.ts +2 -2
- package/dist/types/entities/team-space-membership.d.ts +2 -2
- package/dist/types/entities/team.d.ts +2 -2
- package/dist/types/entities/ui-config.d.ts +1 -1
- package/dist/types/entities/upload-credential.d.ts +1 -1
- package/dist/types/entities/upload.d.ts +1 -1
- package/dist/types/entities/usage.d.ts +2 -2
- package/dist/types/entities/user-ui-config.d.ts +1 -1
- package/dist/types/entities/user.d.ts +2 -2
- package/dist/types/entities/webhook.d.ts +2 -2
- package/dist/types/entities/workflow-definition.d.ts +2 -2
- package/dist/types/entities/workflow.d.ts +2 -2
- package/dist/types/entities/workflows-changelog-entry.d.ts +2 -2
- package/dist/types/export-types.d.ts +70 -70
- package/dist/types/index.d.ts +16 -16
- package/dist/types/methods/bulk-action.d.ts +3 -3
- package/dist/types/methods/content-type.d.ts +2 -2
- package/dist/types/methods/release-action.d.ts +3 -3
- package/dist/types/plain/as-iterator.d.ts +1 -1
- package/dist/types/plain/checks.d.ts +1 -1
- package/dist/types/plain/common-types.d.ts +67 -67
- package/dist/types/plain/entities/ai-action-invocation.d.ts +3 -3
- package/dist/types/plain/entities/ai-action.d.ts +4 -4
- package/dist/types/plain/entities/app-access-token.d.ts +3 -3
- package/dist/types/plain/entities/app-action-call.d.ts +3 -3
- package/dist/types/plain/entities/app-action.d.ts +3 -3
- package/dist/types/plain/entities/app-bundle.d.ts +3 -3
- package/dist/types/plain/entities/app-definition.d.ts +3 -3
- package/dist/types/plain/entities/app-details.d.ts +3 -3
- package/dist/types/plain/entities/app-event-subscription.d.ts +3 -3
- package/dist/types/plain/entities/app-installation.d.ts +4 -4
- package/dist/types/plain/entities/app-key.d.ts +3 -3
- package/dist/types/plain/entities/app-signed-request.d.ts +3 -3
- package/dist/types/plain/entities/app-signing-secret.d.ts +3 -3
- package/dist/types/plain/entities/app-upload.d.ts +3 -3
- package/dist/types/plain/entities/comment.d.ts +3 -3
- package/dist/types/plain/entities/concept-scheme.d.ts +2 -2
- package/dist/types/plain/entities/concept.d.ts +2 -2
- package/dist/types/plain/entities/editor-interface.d.ts +3 -3
- package/dist/types/plain/entities/environment-alias.d.ts +3 -3
- package/dist/types/plain/entities/environment.d.ts +3 -3
- package/dist/types/plain/entities/extension.d.ts +3 -3
- package/dist/types/plain/entities/function-log.d.ts +3 -3
- package/dist/types/plain/entities/function.d.ts +3 -3
- package/dist/types/plain/entities/locale.d.ts +3 -3
- package/dist/types/plain/entities/oauth-application.d.ts +3 -3
- package/dist/types/plain/entities/organization.d.ts +3 -3
- package/dist/types/plain/entities/resource-provider.d.ts +3 -3
- package/dist/types/plain/entities/resource-type.d.ts +4 -4
- package/dist/types/plain/entities/resource.d.ts +3 -3
- package/dist/types/plain/entities/role.d.ts +3 -3
- package/dist/types/plain/entities/space-member.d.ts +3 -3
- package/dist/types/plain/entities/space-membership.d.ts +3 -3
- package/dist/types/plain/entities/space.d.ts +3 -3
- package/dist/types/plain/entities/tag.d.ts +4 -4
- package/dist/types/plain/entities/task.d.ts +3 -3
- package/dist/types/plain/entities/team-membership.d.ts +3 -3
- package/dist/types/plain/entities/team-space-membership.d.ts +3 -3
- package/dist/types/plain/entities/team.d.ts +3 -3
- package/dist/types/plain/entities/ui-config.d.ts +3 -3
- package/dist/types/plain/entities/upload-credential.d.ts +2 -2
- package/dist/types/plain/entities/upload.d.ts +2 -2
- package/dist/types/plain/entities/usage.d.ts +3 -3
- package/dist/types/plain/entities/user-ui-config.d.ts +3 -3
- package/dist/types/plain/entities/user.d.ts +3 -3
- package/dist/types/plain/entities/webhook.d.ts +3 -3
- package/dist/types/plain/entities/workflow-definition.d.ts +3 -3
- package/dist/types/plain/entities/workflow.d.ts +3 -3
- package/dist/types/plain/entities/workflows-changelog.d.ts +3 -3
- package/dist/types/plain/pagination-helper.d.ts +1 -1
- package/dist/types/plain/plain-client.d.ts +4 -4
- package/dist/types/plain/wrappers/wrap.d.ts +1 -1
- package/package.json +4 -2
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
import type { Stream } from 'stream';
|
|
2
|
-
import type { AcceptsQueryOptions, BasicCursorPaginationOptions, CreatedAtIntervalParams, CursorBasedParams, QueryOptions } from './common-types';
|
|
3
|
-
import type { BasicQueryOptions, MakeRequest } from './common-types';
|
|
4
|
-
import type { CreateAppInstallationProps } from './entities/app-installation';
|
|
5
|
-
import type { CreateAppSignedRequestProps } from './entities/app-signed-request';
|
|
6
|
-
import type { CreateAppActionCallProps } from './entities/app-action-call';
|
|
7
|
-
import type { AssetFileProp, AssetProps, CreateAssetFromFilesOptions, CreateAssetProps } from './entities/asset';
|
|
8
|
-
import type { CreateAssetKeyProps } from './entities/asset-key';
|
|
9
|
-
import type { BulkAction, BulkActionPayload, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
|
|
10
|
-
import type { ReleaseActionQueryOptions } from './entities/release-action';
|
|
11
|
-
import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
|
|
12
|
-
import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
|
|
13
|
-
import type { CreateEntryProps, EntryProps, EntryReferenceOptionsProps, EntryReferenceProps } from './entities/entry';
|
|
14
|
-
import type { CreateExtensionProps } from './entities/extension';
|
|
15
|
-
import type { CreateLocaleProps } from './entities/locale';
|
|
16
|
-
import type { TagVisibility } from './entities/tag';
|
|
17
|
-
import type { CreateAppAccessTokenProps } from './entities/app-access-token';
|
|
18
|
-
import type { ResourceQueryOptions } from './entities/resource';
|
|
19
|
-
import type { AiActionInvocationType } from './entities/ai-action-invocation';
|
|
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 } from './entities/app-action-call.js';
|
|
7
|
+
import type { AssetFileProp, AssetProps, CreateAssetFromFilesOptions, CreateAssetProps } from './entities/asset.js';
|
|
8
|
+
import type { CreateAssetKeyProps } from './entities/asset-key.js';
|
|
9
|
+
import type { BulkAction, BulkActionPayload, BulkActionPublishPayload, BulkActionUnpublishPayload, 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, CreateContentTypeProps } from './entities/content-type.js';
|
|
13
|
+
import type { CreateEntryProps, EntryProps, EntryReferenceOptionsProps, 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
20
|
/**
|
|
21
21
|
* @private
|
|
22
22
|
*/
|
|
@@ -66,7 +66,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
66
66
|
* .catch(console.error)
|
|
67
67
|
* ```
|
|
68
68
|
*/
|
|
69
|
-
update: () => Promise<import("./entities/environment").Environment>;
|
|
69
|
+
update: () => Promise<import("./entities/environment.js").Environment>;
|
|
70
70
|
/**
|
|
71
71
|
* Creates SDK Entry object (locally) from entry data
|
|
72
72
|
* @param entryData - Entry Data
|
|
@@ -97,7 +97,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
97
97
|
* });
|
|
98
98
|
* ```
|
|
99
99
|
**/
|
|
100
|
-
getEntryFromData(entryData: EntryProps): import("./entities/entry").Entry;
|
|
100
|
+
getEntryFromData(entryData: EntryProps): import("./entities/entry.js").Entry;
|
|
101
101
|
/**
|
|
102
102
|
* Creates SDK Asset object (locally) from entry data
|
|
103
103
|
* @param assetData - Asset ID
|
|
@@ -128,7 +128,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
128
128
|
* });
|
|
129
129
|
* ```
|
|
130
130
|
*/
|
|
131
|
-
getAssetFromData(assetData: AssetProps): import("./entities/asset").Asset;
|
|
131
|
+
getAssetFromData(assetData: AssetProps): import("./entities/asset.js").Asset;
|
|
132
132
|
/**
|
|
133
133
|
*
|
|
134
134
|
* @description Get a BulkAction by ID.
|
|
@@ -307,7 +307,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
307
307
|
* .catch(console.error)
|
|
308
308
|
* ```
|
|
309
309
|
*/
|
|
310
|
-
getContentType(contentTypeId: string): Promise<import("./entities/content-type").ContentType>;
|
|
310
|
+
getContentType(contentTypeId: string): Promise<import("./entities/content-type.js").ContentType>;
|
|
311
311
|
/**
|
|
312
312
|
* Gets a collection of Content Types
|
|
313
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.
|
|
@@ -326,7 +326,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
326
326
|
* .catch(console.error)
|
|
327
327
|
* ```
|
|
328
328
|
*/
|
|
329
|
-
getContentTypes(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/content-type").ContentType, ContentTypeProps>>;
|
|
329
|
+
getContentTypes(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/content-type.js").ContentType, ContentTypeProps>>;
|
|
330
330
|
/**
|
|
331
331
|
* Creates a Content Type
|
|
332
332
|
* @param data - Object representation of the Content Type to be created
|
|
@@ -356,7 +356,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
356
356
|
* .catch(console.error)
|
|
357
357
|
* ```
|
|
358
358
|
*/
|
|
359
|
-
createContentType(data: CreateContentTypeProps): Promise<import("./entities/content-type").ContentType>;
|
|
359
|
+
createContentType(data: CreateContentTypeProps): Promise<import("./entities/content-type.js").ContentType>;
|
|
360
360
|
/**
|
|
361
361
|
* Creates a Content Type with a custom ID
|
|
362
362
|
* @param contentTypeId - Content Type ID
|
|
@@ -387,7 +387,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
387
387
|
* .catch(console.error)
|
|
388
388
|
* ```
|
|
389
389
|
*/
|
|
390
|
-
createContentTypeWithId(contentTypeId: string, data: CreateContentTypeProps): Promise<import("./entities/content-type").ContentType>;
|
|
390
|
+
createContentTypeWithId(contentTypeId: string, data: CreateContentTypeProps): Promise<import("./entities/content-type.js").ContentType>;
|
|
391
391
|
/**
|
|
392
392
|
* Gets an EditorInterface for a ContentType
|
|
393
393
|
* @param contentTypeId - Content Type ID
|
|
@@ -406,7 +406,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
406
406
|
* .catch(console.error)
|
|
407
407
|
* ```
|
|
408
408
|
*/
|
|
409
|
-
getEditorInterfaceForContentType(contentTypeId: string): Promise<import("./export-types").EditorInterface>;
|
|
409
|
+
getEditorInterfaceForContentType(contentTypeId: string): Promise<import("./export-types.js").EditorInterface>;
|
|
410
410
|
/**
|
|
411
411
|
* Gets all EditorInterfaces
|
|
412
412
|
* @return Promise for a collection of EditorInterface
|
|
@@ -424,7 +424,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
424
424
|
* .catch(console.error)
|
|
425
425
|
* ```
|
|
426
426
|
*/
|
|
427
|
-
getEditorInterfaces(): Promise<import("./common-types").Collection<import("./export-types").EditorInterface, import("./export-types").EditorInterfaceProps>>;
|
|
427
|
+
getEditorInterfaces(): Promise<import("./common-types.js").Collection<import("./export-types.js").EditorInterface, import("./export-types.js").EditorInterfaceProps>>;
|
|
428
428
|
/**
|
|
429
429
|
* Gets an Entry
|
|
430
430
|
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
@@ -446,7 +446,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
446
446
|
* .catch(console.error)
|
|
447
447
|
* ```
|
|
448
448
|
*/
|
|
449
|
-
getEntry(id: string, query?: QueryOptions): Promise<import("./entities/entry").Entry>;
|
|
449
|
+
getEntry(id: string, query?: QueryOptions): Promise<import("./entities/entry.js").Entry>;
|
|
450
450
|
/**
|
|
451
451
|
* Deletes an Entry of this environment
|
|
452
452
|
* @param id - Entry ID
|
|
@@ -486,7 +486,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
486
486
|
* .catch(console.error)
|
|
487
487
|
* ```
|
|
488
488
|
*/
|
|
489
|
-
getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
|
|
489
|
+
getEntries(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/entry.js").Entry, EntryProps<import("./common-types.js").KeyValueMap>>>;
|
|
490
490
|
/**
|
|
491
491
|
* Gets a collection of published Entries
|
|
492
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.
|
|
@@ -505,7 +505,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
505
505
|
* .catch(console.error)
|
|
506
506
|
* ```
|
|
507
507
|
*/
|
|
508
|
-
getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
|
|
508
|
+
getPublishedEntries(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/entry.js").Entry, EntryProps<import("./common-types.js").KeyValueMap>>>;
|
|
509
509
|
/**
|
|
510
510
|
* Creates a Entry
|
|
511
511
|
* @param contentTypeId - The Content Type ID of the newly created Entry
|
|
@@ -531,7 +531,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
531
531
|
* .catch(console.error)
|
|
532
532
|
* ```
|
|
533
533
|
*/
|
|
534
|
-
createEntry(contentTypeId: string, data: Omit<EntryProps, "sys">): Promise<import("./entities/entry").Entry>;
|
|
534
|
+
createEntry(contentTypeId: string, data: Omit<EntryProps, "sys">): Promise<import("./entities/entry.js").Entry>;
|
|
535
535
|
/**
|
|
536
536
|
* Creates a Entry with a custom ID
|
|
537
537
|
* @param contentTypeId - The Content Type of the newly created Entry
|
|
@@ -559,7 +559,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
559
559
|
* .catch(console.error)
|
|
560
560
|
* ```
|
|
561
561
|
*/
|
|
562
|
-
createEntryWithId(contentTypeId: string, id: string, data: CreateEntryProps): Promise<import("./entities/entry").Entry>;
|
|
562
|
+
createEntryWithId(contentTypeId: string, id: string, data: CreateEntryProps): Promise<import("./entities/entry.js").Entry>;
|
|
563
563
|
/**
|
|
564
564
|
* Get entry references
|
|
565
565
|
* @param entryId - Entry ID
|
|
@@ -604,7 +604,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
604
604
|
* .catch(console.error)
|
|
605
605
|
* ```
|
|
606
606
|
*/
|
|
607
|
-
getAsset(id: string, query?: QueryOptions): Promise<import("./entities/asset").Asset>;
|
|
607
|
+
getAsset(id: string, query?: QueryOptions): Promise<import("./entities/asset.js").Asset>;
|
|
608
608
|
/**
|
|
609
609
|
* Gets a collection of Assets
|
|
610
610
|
* Warning: if you are using the select operator, when saving, any field that was not selected will be removed
|
|
@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
625
625
|
* .catch(console.error)
|
|
626
626
|
* ```
|
|
627
627
|
*/
|
|
628
|
-
getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
|
|
628
|
+
getAssets(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/asset.js").Asset, AssetProps>>;
|
|
629
629
|
/**
|
|
630
630
|
* Gets a collection of published Assets
|
|
631
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.
|
|
@@ -644,7 +644,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
644
644
|
* .catch(console.error)
|
|
645
645
|
* ```
|
|
646
646
|
*/
|
|
647
|
-
getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
|
|
647
|
+
getPublishedAssets(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/asset.js").Asset, AssetProps>>;
|
|
648
648
|
/**
|
|
649
649
|
* Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
650
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.
|
|
@@ -676,7 +676,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
676
676
|
* .catch(console.error)
|
|
677
677
|
* ```
|
|
678
678
|
*/
|
|
679
|
-
createAsset(data: CreateAssetProps): Promise<import("./entities/asset").Asset>;
|
|
679
|
+
createAsset(data: CreateAssetProps): Promise<import("./entities/asset.js").Asset>;
|
|
680
680
|
/**
|
|
681
681
|
* Creates a Asset with a custom ID. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
682
682
|
* @param id - Asset ID
|
|
@@ -707,7 +707,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
707
707
|
* .catch(console.error)
|
|
708
708
|
* ```
|
|
709
709
|
*/
|
|
710
|
-
createAssetWithId(id: string, data: CreateAssetProps): Promise<import("./entities/asset").Asset>;
|
|
710
|
+
createAssetWithId(id: string, data: CreateAssetProps): Promise<import("./entities/asset.js").Asset>;
|
|
711
711
|
/**
|
|
712
712
|
* Creates a Asset based on files. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
|
|
713
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.
|
|
@@ -740,7 +740,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
740
740
|
* .catch(console.error)
|
|
741
741
|
* ```
|
|
742
742
|
*/
|
|
743
|
-
createAssetFromFiles(data: AssetFileProp, options?: CreateAssetFromFilesOptions): Promise<import("./entities/asset").Asset>;
|
|
743
|
+
createAssetFromFiles(data: AssetFileProp, options?: CreateAssetFromFilesOptions): Promise<import("./entities/asset.js").Asset>;
|
|
744
744
|
/**
|
|
745
745
|
* Creates an asset key for signing asset URLs (Embargoed Assets)
|
|
746
746
|
* @param data Object with request payload
|
|
@@ -761,7 +761,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
761
761
|
* .catch(console.error)
|
|
762
762
|
* ```
|
|
763
763
|
*/
|
|
764
|
-
createAssetKey(payload: CreateAssetKeyProps): Promise<import("./entities/asset-key").AssetKey>;
|
|
764
|
+
createAssetKey(payload: CreateAssetKeyProps): Promise<import("./entities/asset-key.js").AssetKey>;
|
|
765
765
|
/**
|
|
766
766
|
* Gets an Upload
|
|
767
767
|
* @param id - Upload ID
|
|
@@ -780,8 +780,8 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
780
780
|
*/
|
|
781
781
|
getUpload(id: string): Promise<{
|
|
782
782
|
delete: () => Promise<void>;
|
|
783
|
-
} & import("./export-types").UploadProps & {
|
|
784
|
-
toPlainObject(): import("./export-types").UploadProps;
|
|
783
|
+
} & import("./export-types.js").UploadProps & {
|
|
784
|
+
toPlainObject(): import("./export-types.js").UploadProps;
|
|
785
785
|
}>;
|
|
786
786
|
/**
|
|
787
787
|
* Creates a Upload.
|
|
@@ -805,8 +805,8 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
805
805
|
file: string | ArrayBuffer | Stream;
|
|
806
806
|
}) => Promise<{
|
|
807
807
|
delete: () => Promise<void>;
|
|
808
|
-
} & import("./export-types").UploadProps & {
|
|
809
|
-
toPlainObject(): import("./export-types").UploadProps;
|
|
808
|
+
} & import("./export-types.js").UploadProps & {
|
|
809
|
+
toPlainObject(): import("./export-types.js").UploadProps;
|
|
810
810
|
}>;
|
|
811
811
|
/**
|
|
812
812
|
* Gets a Locale
|
|
@@ -826,7 +826,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
826
826
|
* .catch(console.error)
|
|
827
827
|
* ```
|
|
828
828
|
*/
|
|
829
|
-
getLocale(localeId: string): Promise<import("./entities/locale").Locale>;
|
|
829
|
+
getLocale(localeId: string): Promise<import("./entities/locale.js").Locale>;
|
|
830
830
|
/**
|
|
831
831
|
* Gets a collection of Locales
|
|
832
832
|
* @return Promise for a collection of Locales
|
|
@@ -844,7 +844,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
844
844
|
* .catch(console.error)
|
|
845
845
|
* ```
|
|
846
846
|
*/
|
|
847
|
-
getLocales(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./entities/locale").Locale, import("./entities/locale").LocaleProps>>;
|
|
847
|
+
getLocales(query?: BasicQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/locale.js").Locale, import("./entities/locale.js").LocaleProps>>;
|
|
848
848
|
/**
|
|
849
849
|
* Creates a Locale
|
|
850
850
|
* @param data - Object representation of the Locale to be created
|
|
@@ -869,7 +869,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
869
869
|
* .catch(console.error)
|
|
870
870
|
* ```
|
|
871
871
|
*/
|
|
872
|
-
createLocale(data: CreateLocaleProps): Promise<import("./entities/locale").Locale>;
|
|
872
|
+
createLocale(data: CreateLocaleProps): Promise<import("./entities/locale.js").Locale>;
|
|
873
873
|
/**
|
|
874
874
|
* Gets an UI Extension
|
|
875
875
|
* @param id - Extension ID
|
|
@@ -888,7 +888,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
888
888
|
* .catch(console.error)
|
|
889
889
|
* ```
|
|
890
890
|
*/
|
|
891
|
-
getUiExtension(id: string): Promise<import("./entities/extension").Extension>;
|
|
891
|
+
getUiExtension(id: string): Promise<import("./entities/extension.js").Extension>;
|
|
892
892
|
/**
|
|
893
893
|
* Gets a collection of UI Extension
|
|
894
894
|
* @return Promise for a collection of UI Extensions
|
|
@@ -906,7 +906,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
906
906
|
* .catch(console.error)
|
|
907
907
|
* ```
|
|
908
908
|
*/
|
|
909
|
-
getUiExtensions(): Promise<import("./common-types").Collection<import("./entities/extension").Extension, import("./entities/extension").ExtensionProps>>;
|
|
909
|
+
getUiExtensions(): Promise<import("./common-types.js").Collection<import("./entities/extension.js").Extension, import("./entities/extension.js").ExtensionProps>>;
|
|
910
910
|
/**
|
|
911
911
|
* Creates a UI Extension
|
|
912
912
|
* @param data - Object representation of the UI Extension to be created
|
|
@@ -939,7 +939,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
939
939
|
* .catch(console.error)
|
|
940
940
|
* ```
|
|
941
941
|
*/
|
|
942
|
-
createUiExtension(data: CreateExtensionProps): Promise<import("./entities/extension").Extension>;
|
|
942
|
+
createUiExtension(data: CreateExtensionProps): Promise<import("./entities/extension.js").Extension>;
|
|
943
943
|
/**
|
|
944
944
|
* Creates a UI Extension with a custom ID
|
|
945
945
|
* @param id - Extension ID
|
|
@@ -973,7 +973,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
973
973
|
* .catch(console.error)
|
|
974
974
|
* ```
|
|
975
975
|
*/
|
|
976
|
-
createUiExtensionWithId(id: string, data: CreateExtensionProps): Promise<import("./entities/extension").Extension>;
|
|
976
|
+
createUiExtensionWithId(id: string, data: CreateExtensionProps): Promise<import("./entities/extension.js").Extension>;
|
|
977
977
|
/**
|
|
978
978
|
* Creates an App Installation
|
|
979
979
|
* @param appDefinitionId - AppDefinition ID
|
|
@@ -1000,7 +1000,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1000
1000
|
*/
|
|
1001
1001
|
createAppInstallation(appDefinitionId: string, data: CreateAppInstallationProps, { acceptAllTerms }?: {
|
|
1002
1002
|
acceptAllTerms?: boolean;
|
|
1003
|
-
}): Promise<import("./entities/app-installation").AppInstallation>;
|
|
1003
|
+
}): Promise<import("./entities/app-installation.js").AppInstallation>;
|
|
1004
1004
|
/**
|
|
1005
1005
|
* Gets an App Installation
|
|
1006
1006
|
* @param id - AppDefintion ID
|
|
@@ -1019,7 +1019,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1019
1019
|
* .catch(console.error)
|
|
1020
1020
|
* ```
|
|
1021
1021
|
*/
|
|
1022
|
-
getAppInstallation(id: string): Promise<import("./entities/app-installation").AppInstallation>;
|
|
1022
|
+
getAppInstallation(id: string): Promise<import("./entities/app-installation.js").AppInstallation>;
|
|
1023
1023
|
/**
|
|
1024
1024
|
* Gets a collection of App Installation
|
|
1025
1025
|
* @return Promise for a collection of App Installations
|
|
@@ -1037,7 +1037,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1037
1037
|
* .catch(console.error)
|
|
1038
1038
|
* ```
|
|
1039
1039
|
*/
|
|
1040
|
-
getAppInstallations(): Promise<import("./common-types").Collection<import("./entities/app-installation").AppInstallation, import("./entities/app-installation").AppInstallationProps>>;
|
|
1040
|
+
getAppInstallations(): Promise<import("./common-types.js").Collection<import("./entities/app-installation.js").AppInstallation, import("./entities/app-installation.js").AppInstallationProps>>;
|
|
1041
1041
|
/**
|
|
1042
1042
|
* Creates an app action call
|
|
1043
1043
|
* @param appDefinitionId - AppDefinition ID
|
|
@@ -1067,7 +1067,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1067
1067
|
* .catch(console.error)
|
|
1068
1068
|
* ```
|
|
1069
1069
|
*/
|
|
1070
|
-
createAppActionCall(appDefinitionId: string, appActionId: string, data: CreateAppActionCallProps): Promise<import("./entities/app-action-call").AppActionCall>;
|
|
1070
|
+
createAppActionCall(appDefinitionId: string, appActionId: string, data: CreateAppActionCallProps): Promise<import("./entities/app-action-call.js").AppActionCall>;
|
|
1071
1071
|
/**
|
|
1072
1072
|
* Creates an app signed request
|
|
1073
1073
|
* @param appDefinitionId - AppDefinition ID
|
|
@@ -1096,7 +1096,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1096
1096
|
* .catch(console.error)
|
|
1097
1097
|
* ```
|
|
1098
1098
|
*/
|
|
1099
|
-
createAppSignedRequest(appDefinitionId: string, data: CreateAppSignedRequestProps): Promise<import("./entities/app-signed-request").AppSignedRequest>;
|
|
1099
|
+
createAppSignedRequest(appDefinitionId: string, data: CreateAppSignedRequestProps): Promise<import("./entities/app-signed-request.js").AppSignedRequest>;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* Creates an app access token
|
|
1102
1102
|
* @param appDefinitionId - AppDefinition ID
|
|
@@ -1123,7 +1123,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1123
1123
|
* .catch(console.error)
|
|
1124
1124
|
* ```
|
|
1125
1125
|
*/
|
|
1126
|
-
createAppAccessToken(appDefinitionId: string, data: CreateAppAccessTokenProps): Promise<import("./entities/app-access-token").AppAccessToken>;
|
|
1126
|
+
createAppAccessToken(appDefinitionId: string, data: CreateAppAccessTokenProps): Promise<import("./entities/app-access-token.js").AppAccessToken>;
|
|
1127
1127
|
/**
|
|
1128
1128
|
* Gets a collection of Functions for a given environment
|
|
1129
1129
|
* @param appInstallationId
|
|
@@ -1144,7 +1144,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1144
1144
|
* .catch(console.error)
|
|
1145
1145
|
* ```
|
|
1146
1146
|
*/
|
|
1147
|
-
getFunctionsForEnvironment(appInstallationId: string, query?: AcceptsQueryOptions): Promise<import("./common-types").Collection<import("./entities/function").FunctionProps, import("./entities/function").FunctionProps>>;
|
|
1147
|
+
getFunctionsForEnvironment(appInstallationId: string, query?: AcceptsQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/function.js").FunctionProps, import("./entities/function.js").FunctionProps>>;
|
|
1148
1148
|
/**
|
|
1149
1149
|
* Gets a collection of FunctionLogs for a given app installation id and FunctionId
|
|
1150
1150
|
* @param appInstallationId
|
|
@@ -1182,7 +1182,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1182
1182
|
* .catch(console.error)
|
|
1183
1183
|
* ```
|
|
1184
1184
|
*/
|
|
1185
|
-
getFunctionLogs(appInstallationId: string, functionId: string, query?: CursorBasedParams & CreatedAtIntervalParams): Promise<import("./common-types").Collection<import("./entities/function-log").FunctionLogProps, import("./entities/function-log").FunctionLogProps>>;
|
|
1185
|
+
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>>;
|
|
1186
1186
|
/**
|
|
1187
1187
|
* Gets a FunctionLog by appInstallationId, functionId and logId
|
|
1188
1188
|
* @param appInstallationId
|
|
@@ -1210,7 +1210,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1210
1210
|
* .catch(console.error)
|
|
1211
1211
|
* ```
|
|
1212
1212
|
*/
|
|
1213
|
-
getFunctionLog(appInstallationId: string, functionId: string, logId: string): Promise<import("./entities/function-log").FunctionLogProps>;
|
|
1213
|
+
getFunctionLog(appInstallationId: string, functionId: string, logId: string): Promise<import("./entities/function-log.js").FunctionLogProps>;
|
|
1214
1214
|
/**
|
|
1215
1215
|
* Gets all snapshots of an entry
|
|
1216
1216
|
* @func getEntrySnapshots
|
|
@@ -1231,7 +1231,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1231
1231
|
* .catch(console.error)
|
|
1232
1232
|
* ```
|
|
1233
1233
|
*/
|
|
1234
|
-
getEntrySnapshots(entryId: string, query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Snapshot<EntryProps>, import("./export-types").SnapshotProps<EntryProps>>>;
|
|
1234
|
+
getEntrySnapshots(entryId: string, query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").Snapshot<EntryProps>, import("./export-types.js").SnapshotProps<EntryProps>>>;
|
|
1235
1235
|
/**
|
|
1236
1236
|
* Gets all snapshots of a contentType
|
|
1237
1237
|
* @func getContentTypeSnapshots
|
|
@@ -1252,10 +1252,10 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1252
1252
|
* .catch(console.error)
|
|
1253
1253
|
* ```
|
|
1254
1254
|
*/
|
|
1255
|
-
getContentTypeSnapshots(contentTypeId: string, query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Snapshot<ContentTypeProps>, import("./export-types").SnapshotProps<ContentTypeProps>>>;
|
|
1256
|
-
createTag(id: string, name: string, visibility?: TagVisibility): Promise<import("./entities/tag").Tag>;
|
|
1257
|
-
getTags(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./entities/tag").Tag, import("./entities/tag").TagProps>>;
|
|
1258
|
-
getTag(id: string): Promise<import("./entities/tag").Tag>;
|
|
1255
|
+
getContentTypeSnapshots(contentTypeId: string, query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").Snapshot<ContentTypeProps>, import("./export-types.js").SnapshotProps<ContentTypeProps>>>;
|
|
1256
|
+
createTag(id: string, name: string, visibility?: TagVisibility): Promise<import("./entities/tag.js").Tag>;
|
|
1257
|
+
getTags(query?: BasicQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/tag.js").Tag, import("./entities/tag.js").TagProps>>;
|
|
1258
|
+
getTag(id: string): Promise<import("./entities/tag.js").Tag>;
|
|
1259
1259
|
/**
|
|
1260
1260
|
* Retrieves a Release by ID
|
|
1261
1261
|
* @param releaseId
|
|
@@ -1274,7 +1274,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1274
1274
|
* .catch(console.error)
|
|
1275
1275
|
* ```
|
|
1276
1276
|
*/
|
|
1277
|
-
getRelease(releaseId: string): Promise<import("./entities/release").Release>;
|
|
1277
|
+
getRelease(releaseId: string): Promise<import("./entities/release.js").Release>;
|
|
1278
1278
|
/**
|
|
1279
1279
|
* Gets a Collection of Releases,
|
|
1280
1280
|
* @param {ReleaseQueryOptions} query filtering options for the collection result
|
|
@@ -1293,7 +1293,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1293
1293
|
* .catch(console.error)
|
|
1294
1294
|
* ```
|
|
1295
1295
|
*/
|
|
1296
|
-
getReleases(query?: ReleaseQueryOptions): Promise<import("./common-types").CursorPaginatedCollection<import("./entities/release").Release, import("./entities/release").ReleaseProps>>;
|
|
1296
|
+
getReleases(query?: ReleaseQueryOptions): Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/release.js").Release, import("./entities/release.js").ReleaseProps>>;
|
|
1297
1297
|
/**
|
|
1298
1298
|
* Creates a new Release with the entities and title in the payload
|
|
1299
1299
|
* @param payload Object containing the payload in order to create a Release
|
|
@@ -1322,7 +1322,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1322
1322
|
* .catch(console.error)
|
|
1323
1323
|
* ```
|
|
1324
1324
|
*/
|
|
1325
|
-
createRelease(payload: ReleasePayload): Promise<import("./entities/release").Release>;
|
|
1325
|
+
createRelease(payload: ReleasePayload): Promise<import("./entities/release.js").Release>;
|
|
1326
1326
|
/**
|
|
1327
1327
|
* Updates a Release and replaces all the properties.
|
|
1328
1328
|
* @param {object} options,
|
|
@@ -1360,7 +1360,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1360
1360
|
releaseId: string;
|
|
1361
1361
|
payload: ReleasePayload;
|
|
1362
1362
|
version: number;
|
|
1363
|
-
}): Promise<import("./entities/release").Release>;
|
|
1363
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1364
1364
|
/**
|
|
1365
1365
|
* Deletes a Release by ID - does not delete any entities.
|
|
1366
1366
|
* @param releaseId the ID of the release
|
|
@@ -1402,7 +1402,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1402
1402
|
publishRelease({ releaseId, version }: {
|
|
1403
1403
|
releaseId: string;
|
|
1404
1404
|
version: number;
|
|
1405
|
-
}): Promise<import("./entities/release-action").ReleaseAction<any>>;
|
|
1405
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1406
1406
|
/**
|
|
1407
1407
|
* Unpublishes all Entities contained in a Release.
|
|
1408
1408
|
* @param options.releaseId the ID of the release
|
|
@@ -1425,7 +1425,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1425
1425
|
unpublishRelease({ releaseId, version }: {
|
|
1426
1426
|
releaseId: string;
|
|
1427
1427
|
version: number;
|
|
1428
|
-
}): Promise<import("./entities/release-action").ReleaseAction<any>>;
|
|
1428
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1429
1429
|
/**
|
|
1430
1430
|
* Validates all Entities contained in a Release against an action (publish or unpublish)
|
|
1431
1431
|
* @param options.releaseId the ID of the release
|
|
@@ -1449,7 +1449,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1449
1449
|
validateRelease({ releaseId, payload, }: {
|
|
1450
1450
|
releaseId: string;
|
|
1451
1451
|
payload?: ReleaseValidatePayload;
|
|
1452
|
-
}): Promise<import("./entities/release-action").ReleaseAction<any>>;
|
|
1452
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1453
1453
|
/**
|
|
1454
1454
|
* Archives a Release and prevents new operations (publishing, unpublishing adding new entities etc).
|
|
1455
1455
|
* @param options.releaseId the ID of the release
|
|
@@ -1472,7 +1472,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1472
1472
|
archiveRelease({ releaseId, version }: {
|
|
1473
1473
|
releaseId: string;
|
|
1474
1474
|
version: number;
|
|
1475
|
-
}): Promise<import("./entities/release").Release>;
|
|
1475
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1476
1476
|
/**
|
|
1477
1477
|
* Unarchives a previously archived Release - this enables the release to be published, unpublished etc.
|
|
1478
1478
|
* @param options.releaseId the ID of the release
|
|
@@ -1495,7 +1495,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1495
1495
|
unarchiveRelease({ releaseId, version }: {
|
|
1496
1496
|
releaseId: string;
|
|
1497
1497
|
version: number;
|
|
1498
|
-
}): Promise<import("./entities/release").Release>;
|
|
1498
|
+
}): Promise<import("./entities/release.js").Release>;
|
|
1499
1499
|
/**
|
|
1500
1500
|
* Retrieves a ReleaseAction by ID
|
|
1501
1501
|
* @param params.releaseId The ID of a Release
|
|
@@ -1518,7 +1518,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1518
1518
|
getReleaseAction({ actionId, releaseId }: {
|
|
1519
1519
|
actionId: string;
|
|
1520
1520
|
releaseId: string;
|
|
1521
|
-
}): Promise<import("./entities/release-action").ReleaseAction<any>>;
|
|
1521
|
+
}): Promise<import("./entities/release-action.js").ReleaseAction<any>>;
|
|
1522
1522
|
/**
|
|
1523
1523
|
* Gets a Collection of ReleaseActions
|
|
1524
1524
|
* @param {string} params.releaseId ID of the Release to fetch the actions from
|
|
@@ -1541,20 +1541,20 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1541
1541
|
*/
|
|
1542
1542
|
getReleaseActions({ query }: {
|
|
1543
1543
|
query?: ReleaseActionQueryOptions;
|
|
1544
|
-
}): Promise<import("./common-types").Collection<import("./entities/release-action").ReleaseAction<any>, import("./entities/release-action").ReleaseActionProps<any>>>;
|
|
1544
|
+
}): Promise<import("./common-types.js").Collection<import("./entities/release-action.js").ReleaseAction<any>, import("./entities/release-action.js").ReleaseActionProps<any>>>;
|
|
1545
1545
|
getUIConfig(): Promise<{
|
|
1546
|
-
update: () => Promise</*elided*/ any & import("./entities/ui-config").UIConfigProps & {
|
|
1547
|
-
toPlainObject(): import("./entities/ui-config").UIConfigProps;
|
|
1546
|
+
update: () => Promise</*elided*/ any & import("./entities/ui-config.js").UIConfigProps & {
|
|
1547
|
+
toPlainObject(): import("./entities/ui-config.js").UIConfigProps;
|
|
1548
1548
|
}>;
|
|
1549
|
-
} & import("./entities/ui-config").UIConfigProps & {
|
|
1550
|
-
toPlainObject(): import("./entities/ui-config").UIConfigProps;
|
|
1549
|
+
} & import("./entities/ui-config.js").UIConfigProps & {
|
|
1550
|
+
toPlainObject(): import("./entities/ui-config.js").UIConfigProps;
|
|
1551
1551
|
}>;
|
|
1552
1552
|
getUserUIConfig(): Promise<{
|
|
1553
|
-
update: () => Promise</*elided*/ any & import("./entities/user-ui-config").UserUIConfigProps & {
|
|
1554
|
-
toPlainObject(): import("./entities/user-ui-config").UserUIConfigProps;
|
|
1553
|
+
update: () => Promise</*elided*/ any & import("./entities/user-ui-config.js").UserUIConfigProps & {
|
|
1554
|
+
toPlainObject(): import("./entities/user-ui-config.js").UserUIConfigProps;
|
|
1555
1555
|
}>;
|
|
1556
|
-
} & import("./entities/user-ui-config").UserUIConfigProps & {
|
|
1557
|
-
toPlainObject(): import("./entities/user-ui-config").UserUIConfigProps;
|
|
1556
|
+
} & import("./entities/user-ui-config.js").UserUIConfigProps & {
|
|
1557
|
+
toPlainObject(): import("./entities/user-ui-config.js").UserUIConfigProps;
|
|
1558
1558
|
}>;
|
|
1559
1559
|
/**
|
|
1560
1560
|
* Gets a collection of all environment template installations in the environment for a given template
|
|
@@ -1577,7 +1577,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1577
1577
|
*/
|
|
1578
1578
|
getEnvironmentTemplateInstallations(environmentTemplateId: string, { installationId, ...query }?: BasicCursorPaginationOptions & {
|
|
1579
1579
|
installationId?: string;
|
|
1580
|
-
}): Promise<import("./common-types").CursorPaginatedCollection<import("./entities/environment-template-installation").EnvironmentTemplateInstallation, import("./entities/environment-template-installation").EnvironmentTemplateInstallationProps>>;
|
|
1580
|
+
}): Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/environment-template-installation.js").EnvironmentTemplateInstallation, import("./entities/environment-template-installation.js").EnvironmentTemplateInstallationProps>>;
|
|
1581
1581
|
/**
|
|
1582
1582
|
* Gets a collection of all resource types based on native external references app installations in the environment
|
|
1583
1583
|
* @param query - BasicCursorPaginationOptions
|
|
@@ -1596,7 +1596,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1596
1596
|
* .catch(console.error)
|
|
1597
1597
|
* ```
|
|
1598
1598
|
*/
|
|
1599
|
-
getResourceTypes(query?: BasicCursorPaginationOptions): Promise<import("./common-types").CursorPaginatedCollectionProp<import("./export-types").SpaceEnvResourceTypeProps>>;
|
|
1599
|
+
getResourceTypes(query?: BasicCursorPaginationOptions): Promise<import("./common-types.js").CursorPaginatedCollectionProp<import("./export-types.js").SpaceEnvResourceTypeProps>>;
|
|
1600
1600
|
/**
|
|
1601
1601
|
* Gets a collection of all resources for a given resource type based on native external references app installations in the environment
|
|
1602
1602
|
* @param resourceTypeId - Id of the resourceType to get its resources
|
|
@@ -1626,7 +1626,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1626
1626
|
* .catch(console.error)
|
|
1627
1627
|
* ```
|
|
1628
1628
|
*/
|
|
1629
|
-
getResourcesForResourceType(resourceTypeId: string, query?: ResourceQueryOptions): Promise<import("./common-types").CursorPaginatedCollectionProp<import("./entities/resource").ResourceProps>>;
|
|
1629
|
+
getResourcesForResourceType(resourceTypeId: string, query?: ResourceQueryOptions): Promise<import("./common-types.js").CursorPaginatedCollectionProp<import("./entities/resource.js").ResourceProps>>;
|
|
1630
1630
|
/**
|
|
1631
1631
|
* Invokes an AI Action.
|
|
1632
1632
|
* @param aiActionId - The ID of the AI Action to invoke.
|
|
@@ -1643,7 +1643,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1643
1643
|
* .catch(console.error)
|
|
1644
1644
|
* ```
|
|
1645
1645
|
*/
|
|
1646
|
-
invokeAiAction(aiActionId: string, payload: AiActionInvocationType): Promise<import("./entities/ai-action-invocation").AiActionInvocation>;
|
|
1646
|
+
invokeAiAction(aiActionId: string, payload: AiActionInvocationType): Promise<import("./entities/ai-action-invocation.js").AiActionInvocation>;
|
|
1647
1647
|
/**
|
|
1648
1648
|
* Retrieves an AI Action Invocation.
|
|
1649
1649
|
* @param params - Object containing the AI Action ID and the Invocation ID.
|
|
@@ -1662,5 +1662,5 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1662
1662
|
getAiActionInvocation({ aiActionId, invocationId, }: {
|
|
1663
1663
|
aiActionId: string;
|
|
1664
1664
|
invocationId: string;
|
|
1665
|
-
}): Promise<import("./entities/ai-action-invocation").AiActionInvocation>;
|
|
1665
|
+
}): Promise<import("./entities/ai-action-invocation.js").AiActionInvocation>;
|
|
1666
1666
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type { BasicCursorPaginationOptions, MakeRequest } from './common-types';
|
|
2
|
-
import type { EnvironmentTemplateProps } from './entities/environment-template';
|
|
3
|
-
import type { CreateEnvironmentTemplateInstallationProps, ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation';
|
|
1
|
+
import type { BasicCursorPaginationOptions, MakeRequest } from './common-types.js';
|
|
2
|
+
import type { EnvironmentTemplateProps } from './entities/environment-template.js';
|
|
3
|
+
import type { CreateEnvironmentTemplateInstallationProps, ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation.js';
|
|
4
4
|
export type ContentfulEnvironmentTemplateApi = ReturnType<typeof createEnvironmentTemplateApi>;
|
|
5
5
|
export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, organizationId: string): {
|
|
6
6
|
/**
|
|
@@ -23,7 +23,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
23
23
|
* ).catch(console.error)
|
|
24
24
|
* ```
|
|
25
25
|
*/
|
|
26
|
-
update: () => Promise<import("./entities/environment-template").EnvironmentTemplate>;
|
|
26
|
+
update: () => Promise<import("./entities/environment-template.js").EnvironmentTemplate>;
|
|
27
27
|
/**
|
|
28
28
|
* Updates environment template version data
|
|
29
29
|
* @param version.versionName - Name of the environment template version
|
|
@@ -51,7 +51,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
51
51
|
updateVersion: ({ versionName, versionDescription, }: {
|
|
52
52
|
versionName: string;
|
|
53
53
|
versionDescription: string;
|
|
54
|
-
}) => Promise<import("./entities/environment-template").EnvironmentTemplate>;
|
|
54
|
+
}) => Promise<import("./entities/environment-template.js").EnvironmentTemplate>;
|
|
55
55
|
/**
|
|
56
56
|
* Deletes the environment template
|
|
57
57
|
* @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
|
|
@@ -84,7 +84,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
84
84
|
* .catch(console.error)
|
|
85
85
|
* ```
|
|
86
86
|
*/
|
|
87
|
-
getVersions: () => Promise<import("./common-types").CursorPaginatedCollection<import("./entities/environment-template").EnvironmentTemplate, EnvironmentTemplateProps>>;
|
|
87
|
+
getVersions: () => Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/environment-template.js").EnvironmentTemplate, EnvironmentTemplateProps>>;
|
|
88
88
|
/**
|
|
89
89
|
* Gets a collection of all installations for the environment template
|
|
90
90
|
* @param [installationParams.spaceId] - Space ID to filter installations by space and environment
|
|
@@ -108,7 +108,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
108
108
|
getInstallations: ({ spaceId, environmentId, ...query }?: {
|
|
109
109
|
spaceId?: string;
|
|
110
110
|
environmentId?: string;
|
|
111
|
-
} & BasicCursorPaginationOptions) => Promise<import("./common-types").CursorPaginatedCollection<import("./entities/environment-template-installation").EnvironmentTemplateInstallation, import("./entities/environment-template-installation").EnvironmentTemplateInstallationProps>>;
|
|
111
|
+
} & BasicCursorPaginationOptions) => Promise<import("./common-types.js").CursorPaginatedCollection<import("./entities/environment-template-installation.js").EnvironmentTemplateInstallation, import("./entities/environment-template-installation.js").EnvironmentTemplateInstallationProps>>;
|
|
112
112
|
/**
|
|
113
113
|
* Validates an environment template against a given space and environment
|
|
114
114
|
* @param params.spaceId - Space ID where the template should be installed into
|
|
@@ -138,7 +138,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
138
138
|
spaceId: string;
|
|
139
139
|
environmentId: string;
|
|
140
140
|
version?: number;
|
|
141
|
-
} & ValidateEnvironmentTemplateInstallationProps) => Promise<import("./entities/environment-template-installation").EnvironmentTemplateValidationProps>;
|
|
141
|
+
} & ValidateEnvironmentTemplateInstallationProps) => Promise<import("./entities/environment-template-installation.js").EnvironmentTemplateValidationProps>;
|
|
142
142
|
/**
|
|
143
143
|
* Installs a template against a given space and environment
|
|
144
144
|
* @param params.spaceId - Space ID where the template should be installed into
|
|
@@ -170,7 +170,7 @@ export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, o
|
|
|
170
170
|
spaceId: string;
|
|
171
171
|
environmentId: string;
|
|
172
172
|
installation: CreateEnvironmentTemplateInstallationProps;
|
|
173
|
-
}) => Promise<import("./entities/environment-template-installation").EnvironmentTemplateInstallationProps>;
|
|
173
|
+
}) => Promise<import("./entities/environment-template-installation.js").EnvironmentTemplateInstallationProps>;
|
|
174
174
|
/**
|
|
175
175
|
* Disconnects the template from a given environment
|
|
176
176
|
* @param params.spaceId - Space ID where the template should be installed into
|