contentful-management 11.37.0 → 11.38.0

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.
@@ -46,7 +46,7 @@ function createClient(params, opts = {}) {
46
46
  const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
47
47
  const userAgent = getUserAgentHeader(
48
48
  // @ts-expect-error
49
- `${sdkMain}/${"11.37.0"}`, params.application, params.integration, params.feature);
49
+ `${sdkMain}/${"11.38.0"}`, params.application, params.integration, params.feature);
50
50
  const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
51
51
  userAgent
52
52
  }));
@@ -1,3 +1,3 @@
1
1
  export * from './common-types';
2
2
  export * from './plain/common-types';
3
- export { WorkflowStepPermissionType, WorkflowStepPermissionAction, WorkflowStepPermissionEffect } from './entities/workflow-definition';
3
+ export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType } from './entities/workflow-definition';
@@ -7,6 +7,7 @@ export type SpaceProps = {
7
7
  id: string;
8
8
  };
9
9
  };
10
+ archivedAt?: string;
10
11
  };
11
12
  name: string;
12
13
  };
@@ -10,8 +10,8 @@ export type UploadCredentialProps = {
10
10
  };
11
11
  export interface UploadCredential extends UploadCredentialProps, DefaultElements<UploadCredentialProps> {
12
12
  /**
13
- * Deletes this object on the server.
14
- * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
13
+ * creates the upload credentials.
14
+ * @return upload credentials for file uploads
15
15
  * @example
16
16
  * const contentful = require('contentful-management')
17
17
  *
@@ -19,12 +19,18 @@ export interface UploadCredential extends UploadCredentialProps, DefaultElements
19
19
  * accessToken: '<content_management_api_key>'
20
20
  * })
21
21
  *
22
- * client.getSpace('<space_id>')
23
- * .then((space) => space.getEnvironment('<environment_id>'))
24
- * .then((environment) => environment.getUpload('<upload_id>'))
25
- * .then((upload) => upload.delete())
26
- * .then((upload) => console.log(`upload ${upload.sys.id} updated.`))
27
- * .catch(console.error)
22
+ * try {
23
+ * const space = await client.getSpace('<space_id>')
24
+ * const environment = await space.getEnvironment('<environment_id>')
25
+ *
26
+ * const upload = await client.uploadCredential.create({
27
+ * spaceId: space.sys.id,
28
+ * environmentId: environment.sys.id
29
+ * })
30
+ * } catch (error) {
31
+ * console.error(error)
32
+ * }
33
+ *
28
34
  */
29
35
  create(): Promise<UploadCredentialProps>;
30
36
  }
@@ -1,26 +1,25 @@
1
1
  export * from './common-types';
2
- export * from './plain/common-types';
2
+ export type { AccessToken, AccessTokenProps as AccessTokenProp, CreatePersonalAccessTokenProps as CreatePATProps, } from './entities/access-token';
3
3
  export type { ApiKey, ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
4
+ export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token';
4
5
  export type { AppAction, AppActionCategoryProps, AppActionCategoryType, AppActionParameterDefinition, AppActionProps, AppActionType, CreateAppActionProps, } from './entities/app-action';
5
6
  export type { AppActionCall, AppActionCallProps, CreateAppActionCallProps, } from './entities/app-action-call';
6
7
  export type { AppBundle, AppBundleFile, AppBundleProps, CreateAppBundleProps, } from './entities/app-bundle';
7
8
  export type { AppDefinition, AppDefinitionProps, AppLocation, CreateAppDefinitionProps, EntryFieldLocation, NavigationItem, PageLocation, SimpleLocation, } from './entities/app-definition';
8
9
  export type { AppDetails, AppDetailsProps, AppIcon, CreateAppDetailsProps, IconType, } from './entities/app-details';
10
+ export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription';
9
11
  export type { AppInstallation, AppInstallationProps, CreateAppInstallationProps, } from './entities/app-installation';
12
+ export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key';
10
13
  export type { AppSignedRequest, AppSignedRequestProps, CreateAppSignedRequestProps, } from './entities/app-signed-request';
11
14
  export type { AppSigningSecret, AppSigningSecretProps, CreateAppSigningSecretProps, } from './entities/app-signing-secret';
12
- export type { AppEventSubscription, AppEventSubscriptionProps, CreateAppEventSubscriptionProps, } from './entities/app-event-subscription';
13
- export type { AppKey, AppKeyProps, CreateAppKeyProps } from './entities/app-key';
14
- export type { AppAccessToken, AppAccessTokenProps, CreateAppAccessTokenProps, } from './entities/app-access-token';
15
15
  export type { AppUpload, AppUploadProps } from './entities/app-upload';
16
16
  export type { Asset, AssetFileProp, AssetProps, CreateAssetProps } from './entities/asset';
17
17
  export type { AssetKey, AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
18
18
  export type { BulkAction, BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionStatus, BulkActionType, BulkActionUnpublishPayload, BulkActionValidatePayload, } from './entities/bulk-action';
19
- export type { RichTextCommentDocument, RichTextCommentProps, Comment, CommentProps, CreateCommentProps, UpdateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, } from './entities/comment';
19
+ export type { Comment, CommentProps, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, RichTextCommentDocument, RichTextCommentProps, UpdateCommentProps, } from './entities/comment';
20
20
  export type { AnnotationAssignment, ContentType, ContentTypeMetadata, ContentTypeProps, CreateContentTypeProps, } from './entities/content-type';
21
21
  export type { ContentFields, ContentTypeFieldValidation, ContentfulEntryResource, ExternalResource, } from './entities/content-type-fields';
22
22
  export type { Control, Editor, EditorInterface, EditorInterfaceProps, EditorLayoutItem, FieldGroupItem, FieldItem, GroupControl, SidebarItem, } from './entities/editor-interface';
23
- export type { FunctionProps } from './entities/function';
24
23
  export type { CreateEntryProps, Entry, EntryProps, WithResourceName } from './entities/entry';
25
24
  export type { CreateEnvironmentProps, Environment, EnvironmentProps } from './entities/environment';
26
25
  export type { CreateEnvironmentAliasProps, EnvironmentAlias, EnvironmentAliasProps, } from './entities/environment-alias';
@@ -28,14 +27,14 @@ export type { ContentTypeTemplateProps, CreateEnvironmentTemplateProps, EditorIn
28
27
  export type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallation, EnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationStatus, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps, ValidationFinding, } from './entities/environment-template-installation';
29
28
  export type { CreateExtensionProps as CreateUIExtensionProps, Extension as UIExtension, ExtensionProps as UIExtensionProps, } from './entities/extension';
30
29
  export type { FieldType } from './entities/field-type';
30
+ export type { FunctionProps } from './entities/function';
31
31
  export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale';
32
32
  export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization';
33
33
  export type { CreateOrganizationInvitationProps, OrganizationInvitation, OrganizationInvitationProps, } from './entities/organization-invitation';
34
34
  export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
35
35
  export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
36
- export type { CreatePersonalAccessTokenProps as CreatePATProps, AccessToken, AccessTokenProps as AccessTokenProp, } from './entities/access-token';
37
36
  export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
38
- export type { Release, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseSysProps, ReleaseValidateOptions, ReleaseMetadata, ReleaseReferenceFilters, } from './entities/release';
37
+ export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
39
38
  export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
40
39
  export type { CreateRoleProps, Role, RoleProps } from './entities/role';
41
40
  export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';
@@ -50,17 +49,19 @@ export type { CreateTeamMembershipProps, TeamMembership, TeamMembershipProps, }
50
49
  export type { CreateTeamSpaceMembershipProps, TeamSpaceMembership, TeamSpaceMembershipProps, } from './entities/team-space-membership';
51
50
  export type { UIConfig, UIConfigProps } from './entities/ui-config';
52
51
  export type { Upload, UploadProps } from './entities/upload';
52
+ export type { UploadCredential, UploadCredentialProps } from './entities/upload-credential';
53
53
  export type { Usage, UsageProps } from './entities/usage';
54
54
  export type { User, UserProps } from './entities/user';
55
55
  export type { UserUIConfig, UserUIConfigProps } from './entities/user-ui-config';
56
- export type { CreateWebhooksProps, UpdateWebhookProps, WebhookCallRequest, WebhookFilter, WebhookProps, WebHooks, WebhookTransformation, UpsertWebhookSigningSecretPayload, WebhookSigningSecretProps, } from './entities/webhook';
57
- export type { WorkflowDefinition, WorkflowDefinitionSysProps, WorkflowDefinitionProps, CreateWorkflowDefinitionProps, UpdateWorkflowDefinitionProps, CreateWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, DeleteWorkflowDefinitionParams, WorkflowStepProps, UpdateWorkflowStepProps, CreateWorkflowStepProps, WorkflowDefinitionQueryOptions, WorkflowDefinitionValidationLink, WorkflowStepAction, WorkflowStepActionType, WorkflowStepPermission, WorkflowStepPermissionActors, WorkflowStepEmailActionRecipient, WorkflowStepEmailAction, WorkflowStepTaskAction, WorkflowStepAppAction, } from './entities/workflow-definition';
58
- export { WorkflowStepPermissionType, WorkflowStepPermissionAction, WorkflowStepPermissionEffect, } from './entities/workflow-definition';
59
- export type { DefinedParameters, FreeFormParameters, ParameterDefinition, ParameterOption, ParameterType, InstallationParameterType, } from './entities/widget-parameters';
60
- export type { CreateWorkflowProps, UpdateWorkflowProps, DeleteWorkflowParams, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
61
- export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
56
+ export type { CreateWebhooksProps, UpdateWebhookProps, UpsertWebhookSigningSecretPayload, WebHooks, WebhookCallRequest, WebhookFilter, WebhookProps, WebhookSigningSecretProps, WebhookTransformation, } from './entities/webhook';
57
+ export type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, CreateWorkflowStepProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, UpdateWorkflowStepProps, WorkflowDefinition, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions, WorkflowDefinitionSysProps, WorkflowDefinitionValidationLink, WorkflowStepAction, WorkflowStepActionType, WorkflowStepAppAction, WorkflowStepEmailAction, WorkflowStepEmailActionRecipient, WorkflowStepPermission, WorkflowStepPermissionActors, WorkflowStepProps, WorkflowStepTaskAction, } from './entities/workflow-definition';
58
+ export * from './plain/common-types';
59
+ export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType, } from './entities/workflow-definition';
62
60
  export type { ConceptProps, CreateConceptProps } from './entities/concept';
63
61
  export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
62
+ export type { ResourceProps, ResourceQueryOptions } from './entities/resource';
64
63
  export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider';
65
64
  export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type';
66
- export type { ResourceProps, ResourceQueryOptions } from './entities/resource';
65
+ export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters';
66
+ export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
67
+ export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "contentful-management",
3
- "version": "11.37.0",
3
+ "version": "11.38.0",
4
4
  "description": "Client for Contentful's Content Management API",
5
5
  "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
6
6
  "main": "./dist/contentful-management.node.js",