contentful-management 12.0.0-new-beta.3 → 12.0.0-new-beta.4

package/dist/types/plain/entities/app-event-subscription.d.ts

@@ -0,0 +1,75 @@
+import type { GetAppDefinitionParams } from '../../common-types';
+import type { AppEventSubscriptionProps, CreateAppEventSubscriptionProps } from '../../entities/app-event-subscription';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type AppEventSubscriptionPlainClientAPI = {
+    /**
+     * Creates or updates an App Event Subscription
+     * @param params entity IDs to identify the App that the Event Subscription belongs to
+     * @param payload the new or updated Event Subscription
+     * @returns the App Event Subscription and its metadata
+     * @throws if the request fails, the App or Event Subscription is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * // app event subscription that targets an endpoint url
+     * const eventSubscription = await client.appEventSubscription.upsert({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   targetUrl: `<target_url>`,
+     *   topics: ['<Topic>'],
+     * })
+     *
+     * // app event subscription that targets a function and have a filter function
+     * const eventSubscription = await client.appEventSubscription.upsert({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   functions: {
+     *     handler: {
+     *       sys: {
+     *         type: 'Link',
+     *         linkType: 'Function',
+     *         id: '<function_id>',
+     *       },
+     *     },
+     *     filter: {
+     *       sys: {
+     *         type: 'Link',
+     *         linkType: 'Function',
+     *         id: '<function_id>',
+     *       },
+     *     },
+     *   },
+     *   topics: ['<Topic>'],
+     * })
+     * ```
+     */
+    upsert(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppEventSubscriptionProps): Promise<AppEventSubscriptionProps>;
+    /**
+     * Fetches the current App Event Subscription for the given App
+     * @param params entity IDs to identify the App that the Event Subscription belongs to
+     * @returns the App Event Subscription
+     * @throws if the request fails, or the App or the Event Subscription is not found
+     * @example
+     * ```javascript
+     * const eventSubscription = await client.appEventSubscription.get({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * })
+     * ```
+     */
+    get(params: OptionalDefaults<GetAppDefinitionParams>): Promise<AppEventSubscriptionProps>;
+    /**
+     * Removes the current App Event Subscription for the given App
+     * @param params entity IDs to identify the App that the Event Subscription belongs to
+     * @throws if the request fails, or the App or the Event Subscription is not found
+     * @example
+     * ```javascript
+     * await client.appEventSubscription.delete({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * })
+     * ```
+     */
+    delete(params: OptionalDefaults<GetAppDefinitionParams>): Promise<void>;
+};

package/dist/types/plain/entities/app-installation.d.ts

@@ -0,0 +1,87 @@
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { CollectionProp, GetAppDefinitionParams, GetAppInstallationParams, GetSpaceEnvironmentParams, PaginationQueryParams, SpaceQueryParams } from '../../common-types';
+import type { AppInstallationsForOrganizationProps } from '../../entities/app-definition';
+import type { AppInstallationProps, CreateAppInstallationProps } from '../../entities/app-installation';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type AppInstallationPlainClientAPI = {
+    /**
+     * Fetches the App Installation
+     * @param params entity IDs to identify the App Installation
+     * @returns the App Installation
+     * @throws if the request fails, or the App Installation is not found
+     * @example
+     * ```javascript
+     * const appInstallation = await client.appInstallation.get({
+     *   spaceId: '<space_id>',
+     *   environmentId: '<environment_id>',
+     *   appDefinitionId: '<app_definition_id>'
+     * });
+     * ```
+     */
+    get(params: OptionalDefaults<GetAppInstallationParams>): Promise<AppInstallationProps>;
+    /**
+     * Fetches all App Installations for the given App
+     * @param params entity IDs to identify the App
+     * @returns an object containing an array of App Installations
+     * @throws if the request fails, or the App is not found
+     * @example
+     * ```javascript
+     * const results = await client.appInstallation.getMany({
+     *   organizationId: "<org_id>",
+     *   appDefinitionId: "<app_definition_id>",
+     * });
+     * ```
+     */
+    getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & PaginationQueryParams>): Promise<CollectionProp<AppInstallationProps>>;
+    /**
+     * Fetches all App Installations for the given Organization
+     * @param params entity IDs to identify the Organization
+     * @returns an object containing an array of App Installations
+     * @throws if the request fails, or the Organization is not found
+     * @example
+     * ```javascript
+     * const results = await client.appInstallation.getForOrganization({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * });
+     * ```
+     */
+    getForOrganization(params: OptionalDefaults<GetAppDefinitionParams & SpaceQueryParams>): Promise<AppInstallationsForOrganizationProps>;
+    /**
+     * Creates or updates an App Installation
+     * @param params entity IDs to identify the App Installation to update, or the App to install
+     * @param rawData the App Installation
+     * @returns the created or updated App Installation and its metadata
+     * @throws if the request fails, the App or App Installation is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * const appInstallation = await client.appInstallation.upsert(
+     *   {
+     *     spaceId: '<space_id>',
+     *     environmentId: '<environment_id>',
+     *     appDefinitionId: '<app_definition_id>',
+     *   },
+     *   {
+     *     parameters: {
+     *       // freeform parameters
+     *     },
+     *   }
+     * );
+     * ```
+     */
+    upsert(params: OptionalDefaults<GetAppInstallationParams>, rawData: CreateAppInstallationProps, headers?: RawAxiosRequestHeaders): Promise<AppInstallationProps>;
+    /**
+     * Uninstalls the App
+     * @param params entity IDs to identify the App to uninstall
+     * @throws if the request fails, or the App Installation is not found
+     * @example
+     * ```javascript
+     * await client.appInstallation.delete({
+     *   spaceId: '<space_id>',
+     *   environmentId: '<environment_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * });
+     * ```
+     */
+    delete(params: OptionalDefaults<GetAppInstallationParams>): Promise<any>;
+};

package/dist/types/plain/entities/app-key.d.ts

@@ -0,0 +1,91 @@
+import type { CollectionProp, GetAppDefinitionParams, QueryParams } from '../../common-types';
+import type { AppKeyProps, CreateAppKeyProps } from '../../entities/app-key';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type AppKeyPlainClientAPI = {
+    /**
+     * Creates an App Key
+     * @param params entity IDs to identify the App that the Key belongs to
+     * @param payload options for Key creation, see example for details
+     * @returns the App Key and its metadata
+     * @throws if the request fails, the App or Key is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * // create an App Key by generating a new private key
+     * const key = await client.appKey.create({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   generate: true
+     * })
+     *
+     * // create an App Key by specifying an existing private key
+     * const keyFromExistingJWK = await client.appKey.create({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   jwk: '<jwk>'
+     * })
+     * ```
+     */
+    create(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppKeyProps): Promise<AppKeyProps>;
+    /**
+     * Fetches the App Key with the given fingerprint
+     * @param params entity IDs to identify the App Key
+     * @returns the App Key
+     * @throws if the request fails, or the App or the Key is not found
+     * @example
+     * ```javascript
+     * const key = await client.appKey.get({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     *   fingerprint: '<fingerprint>',
+     * })
+     * ```
+     */
+    get(params: OptionalDefaults<GetAppDefinitionParams> & {
+        fingerprint: string;
+    }): Promise<AppKeyProps>;
+    /**
+     * Fetches all Keys for the given App
+     * @param params entity IDs to identify the App
+     * @param payload optional pagination query, see example for details
+     * @returns the App Keys
+     * @throws if the request fails, or the App is not found
+     * @example
+     * ```javascript
+     * // with default pagination
+     * const keys = await client.appKey.getMany({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * })
+     *
+     * // with explicit pagination
+     * const paginatedKeys = await client.appKey.getMany({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   query: {
+     *     skip: '<skip>',
+     *     limit: '<limit>',
+     *   }
+     * })
+     * ```
+     */
+    getMany(params: OptionalDefaults<GetAppDefinitionParams> & QueryParams): Promise<CollectionProp<AppKeyProps>>;
+    /**
+     * Removes the App Key with the given fingerprint
+     * @param params entity IDs to identify the App Key
+     * @throws if the request fails, or the App or the Key is not found
+     * @example
+     * ```javascript
+     * await client.appKey.delete({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     *   fingerprint: '<fingerprint>',
+     * })
+     * ```
+     */
+    delete(params: OptionalDefaults<GetAppDefinitionParams> & {
+        fingerprint: string;
+    }): Promise<void>;
+};

package/dist/types/plain/entities/app-signed-request.d.ts

@@ -0,0 +1,34 @@
+import type { GetAppInstallationParams } from '../../common-types';
+import type { AppSignedRequestProps, CreateAppSignedRequestProps } from '../../entities/app-signed-request';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type AppSignedRequestPlainClientAPI = {
+    /**
+     * Creates a Signed Request for an App
+     * @param params entity IDs to identify the App to make a signed request to
+     * @param payload the Signed Request payload
+     * @returns metadata about the Signed Request
+     * @throws if the request fails, the App is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * const signedRequest = await client.appSignedRequest.create(
+     *   {
+     *     spaceId: '<space_id>',
+     *     organizationId: '<organization_id>',
+     *     appDefinitionId: '<app_definition_id>',
+     *   },
+     *   {
+     *     method: 'POST',
+     *     path: 'https://your-app-backend.com/event-handler',
+     *     headers: {
+     *       'Content-Type': 'application/json',
+     *       'X-some-header': 'some-value',
+     *     },
+     *     body: JSON.stringify({
+     *       // ...
+     *     }),
+     *   }
+     * );
+     * ```
+     */
+    create(params: OptionalDefaults<GetAppInstallationParams>, payload: CreateAppSignedRequestProps): Promise<AppSignedRequestProps>;
+};

package/dist/types/plain/entities/app-signing-secret.d.ts

@@ -0,0 +1,49 @@
+import type { GetAppDefinitionParams } from '../../common-types';
+import type { AppSigningSecretProps, CreateAppSigningSecretProps } from '../../entities/app-signing-secret';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type AppSigningSecretPlainClientAPI = {
+    /**
+     * Creates or updates an App Signing Secret
+     * @param params entity IDs to identify the App that the Signing Secret belongs to
+     * @param payload the new or updated Signing Secret
+     * @returns the App Signing Secret and its metadata
+     * @throws if the request fails, the App or Signing Secret is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * const signingSecret = await client.appSigningSecret.upsert({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * }, {
+     *   value: '<value>'
+     * })
+     * ```
+     */
+    upsert(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppSigningSecretProps): Promise<AppSigningSecretProps>;
+    /**
+     * Fetches the current App Signing Secret for the given App
+     * @param params entity IDs to identify the App that the Signing Secret belongs to
+     * @returns the App Signing Secret
+     * @throws if the request fails, or the App or the Signing Secret is not found
+     * @example
+     * ```javascript
+     * const signingSecret = await client.appSigningSecret.get({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * })
+     * ```
+     */
+    get(params: OptionalDefaults<GetAppDefinitionParams>): Promise<AppSigningSecretProps>;
+    /**
+     * Removes the current App Signing Secret for the given App
+     * @param params entity IDs to identify the App that the Signing Secret belongs to
+     * @throws if the request fails, or the App or the Signing Secret is not found
+     * @example
+     * ```javascript
+     * await client.appSigningSecret.delete({
+     *   organizationId: '<organization_id>',
+     *   appDefinitionId: '<app_definition_id>',
+     * })
+     * ```
+     */
+    delete(params: OptionalDefaults<GetAppDefinitionParams>): Promise<void>;
+};

package/dist/types/plain/entities/app-upload.d.ts

@@ -0,0 +1,55 @@
+import type { GetAppUploadParams, GetOrganizationParams } from '../../common-types';
+import type { AppUploadProps } from '../../entities/app-upload';
+import type { OptionalDefaults } from '../wrappers/wrap';
+import type Stream from 'stream';
+export type AppUploadPlainClientAPI = {
+    /**
+     * Fetches the App Upload
+     * @param params entity IDs to identify the App Upload
+     * @returns the App Upload
+     * @throws if the request fails, or the App Upload is not found
+     * @example
+     * ```javascript
+     * const appUpload = await client.appUpload.get({
+     *   organizationId: '<organization_id>',
+     *   appUploadId: '<app_upload_id>',
+     * });
+     * ```
+     */
+    get(params: OptionalDefaults<GetAppUploadParams>): Promise<AppUploadProps>;
+    /**
+     * Deletes the App Upload
+     * @param params entity IDs to identify the App Upload
+     * @throws if the request fails, or the App Upload is not found
+     * @example
+     * ```javascript
+     * await client.appUpload.delete({
+     *   organizationId: '<organization_id>',
+     *   appUploadId: '<app_upload_id>',
+     * });
+     * ```
+     */
+    delete(params: OptionalDefaults<GetAppUploadParams>): Promise<void>;
+    /**
+     * Creates an App Upload
+     * @param params entity IDs to identify the Organization to upload the App to
+     * @param payload the App Upload
+     * @returns the App Upload
+     * @throws if the request fails, or the Organization is not found
+     * @example
+     * ```javascript
+     * const file = fs.readFileSync('<path_to_file>');
+     * const appUpload = await client.appUpload.create(
+     *   {
+     *     organizationId: '<organization_id>',
+     *   },
+     *   {
+     *     file: new ArrayBuffer(file.length),
+     *   }
+     * );
+     * ```
+     */
+    create(params: OptionalDefaults<GetOrganizationParams>, payload: {
+        file: string | ArrayBuffer | Stream;
+    }): Promise<AppUploadProps>;
+};

package/dist/types/plain/entities/comment.d.ts

@@ -0,0 +1,198 @@
+import type { RawAxiosRequestHeaders } from 'axios';
+import type { CollectionProp, GetCommentParams, QueryParams } from '../../common-types';
+import type { CommentProps, CreateCommentParams, CreateCommentProps, DeleteCommentParams, GetManyCommentsParams, PlainTextBodyFormat, RichTextBodyFormat, RichTextCommentBodyPayload, RichTextCommentProps, UpdateCommentParams, UpdateCommentProps } from '../../entities/comment';
+import type { OptionalDefaults } from '../wrappers/wrap';
+export type CommentPlainClientAPI = {
+    /** Fetches a plain text comment
+     *
+     * @param params Space ID, Comment ID, Entry ID, Environment ID
+     * @returns the plain text comment
+     * @throws if the request fails, or the comment is not found
+     * @example
+     * ```javascript
+     * const comment = await client.comment.get({
+     *   spaceId: '<space_id>',
+     *   commentId: '<comment_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'plain-text',
+     * });
+     * ```
+     * */
+    get(params: OptionalDefaults<GetCommentParams> & PlainTextBodyFormat): Promise<CommentProps>;
+    /** Fetches a rich text comment
+     *
+     * @param params Space ID, Comment ID, Entry ID, Environment ID
+     * @returns the rich text comment
+     * @throws if the request fails, or the comment is not found
+     * @example
+     * ```javascript
+     * const comment = await client.comment.get({
+     *   spaceId: '<space_id>',
+     *   commentId: '<comment_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'rich-text',
+     * });
+     * ```
+     * */
+    get(params: OptionalDefaults<GetCommentParams> & RichTextBodyFormat): Promise<RichTextCommentProps>;
+    /** Fetches all plain text comments on an entry
+     *
+     * @param params Space ID, Entry ID, Environment ID, and query parameters
+     * @returns a collection of plain text comments
+     * @throws if the request fails or the comments are not found
+     * @example
+     * ```javascript
+     * const comments = await client.comment.getMany({
+     *   spaceId: '<space_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'plain-text',
+     *   query: {
+     *    limit: 100,
+     *   }
+     * });
+     * ```
+     * */
+    getMany(params: OptionalDefaults<GetManyCommentsParams & PlainTextBodyFormat & QueryParams>): Promise<CollectionProp<CommentProps>>;
+    /** Fetches all rich text comments on an entry
+     *
+     * @param params Space ID, Entry ID, Environment ID, and query parameters
+     * @returns a collection of rich text comments
+     * @throws if the request fails or the comments are not found
+     * @example
+     * ```javascript
+     * const comments = await client.comment.getMany({
+     *   spaceId: '<space_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'rich-text',
+     *   query: {
+     *    limit: 100,
+     *   }
+     * });
+     * ```
+     * */
+    getMany(params: OptionalDefaults<GetManyCommentsParams & QueryParams & RichTextBodyFormat>): Promise<CollectionProp<RichTextCommentProps>>;
+    /** Creates a plain text comment
+     *
+     * @param params
+     * @returns a plain text comment
+     * @throws if the request fails, the entry is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * const comment = await client.comment.create(
+     *   {
+     *     spaceId: '<space_id>',
+     *     entryId: '<entry_id>',
+     *     environmentId: '<environment_id>',
+     *     bodyFormat: 'plain-text',
+     *   },
+     *   {
+     *     body: 'Looks good to me!',
+     *     status: 'active',
+     *   }
+     * );
+     * ```
+     */
+    create(params: OptionalDefaults<CreateCommentParams>, rawData: CreateCommentProps, headers?: RawAxiosRequestHeaders): Promise<CommentProps>;
+    /** Creates a rich text comment
+     *
+     * @param params
+     * @returns a rich text comment
+     * @throws if the request fails, the entry is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * const comment = await client.comment.create(
+     *   {
+     *     spaceId: '<space_id>',
+     *     entryId: '<entry_id>',
+     *     environmentId: '<environment_id>',
+     *     bodyFormat: 'rich-text',
+     *   },
+     *   {
+     *     body: 'Looks good to me!',
+     *     status: 'active',
+     *   }
+     * );
+     * ```
+     */
+    create(params: OptionalDefaults<CreateCommentParams>, rawData: RichTextCommentBodyPayload, headers?: RawAxiosRequestHeaders): Promise<RichTextCommentProps>;
+    /** Updates a plain text comment
+     *
+     * @param params
+     * @returns a plain text comment
+     * @throws if the request fails, the comment is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * let comment = await client.comment.get({
+     *   spaceId: '<space_id>',
+     *   commentId: '<comment_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'plain-text',
+     * });
+     *
+     * comment = await client.comment.update(
+     *   {
+     *     spaceId: '<space_id>',
+     *     commentId: '<comment_id>',
+     *     entryId: '<entry_id>',
+     *     environmentId: '<environment_id>',
+     *   },
+     *   {
+     *     ...comment,
+     *     text: 'This is a new comment.',
+     *   }
+     * );
+     * ```
+     */
+    update(params: OptionalDefaults<UpdateCommentParams>, rawData: UpdateCommentProps, headers?: RawAxiosRequestHeaders): Promise<CommentProps>;
+    /** Updates a plain text comment
+     *
+     * @param params
+     * @returns a rich text comment
+     * @throws if the request fails, the comment is not found, or the payload is malformed
+     * @example
+     * ```javascript
+     * let comment = await client.comment.get({
+     *   spaceId: '<space_id>',
+     *   commentId: '<comment_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     *   bodyFormat: 'rich-text',
+     * });
+     *
+     * comment = await client.comment.update(
+     *   {
+     *     spaceId: '<space_id>',
+     *     commentId: '<comment_id>',
+     *     entryId: '<entry_id>',
+     *     environmentId: '<environment_id>',
+     *   },
+     *   {
+     *     ...comment,
+     *     text: 'This is a new comment.',
+     *   }
+     * );
+     * ```
+     */
+    update(params: OptionalDefaults<UpdateCommentParams>, rawData: Omit<UpdateCommentProps, 'body'> & RichTextCommentBodyPayload, headers?: RawAxiosRequestHeaders): Promise<RichTextCommentProps>;
+    /** Deletes a comment
+     *
+     * @param params
+     * @returns void
+     * @throws if the request fails, or the comment is not found
+     * @example
+     * ```javascript
+     * await client.comment.delete({
+     *   spaceId: '<space_id>',
+     *   commentId: '<comment_id>',
+     *   entryId: '<entry_id>',
+     *   environmentId: '<environment_id>',
+     * });
+     * ```
+     */
+    delete(params: OptionalDefaults<DeleteCommentParams>): Promise<void>;
+};