contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/typings/plain/entities/app-action-call.d.ts

@@ -1,147 +0,0 @@
-import type { GetAppActionCallDetailsParams, GetAppActionCallParams, GetAppActionCallParamsWithId, CreateWithResponseParams, CreateWithResultParams } from '../../common-types';
-import type { AppActionCallProps, AppActionCallResponse, AppActionCallRawResponseProps, CreateAppActionCallProps } from '../../entities/app-action-call';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type AppActionCallPlainClientAPI = {
-    /**
-     * Calls (triggers) an App Action
-     * @param params entity IDs to identify the App Action to call
-     * @param payload the payload to be sent to the App Action
-     * @returns basic metadata about the App Action Call
-     * @throws if the request fails, or the App Action is not found
-     * @example
-     * ```javascript
-     * await client.appActionCall.create(
-     *   {
-     *     spaceId: "<space_id>",
-     *     environmentId: "<environment_id>",
-     *     appDefinitionId: "<app_definition_id>",
-     *     appActionId: "<app_action_id>",
-     *   },
-     *   {
-     *     parameters: { // ... },
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetAppActionCallParams>, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
-    /**
-     * Fetches the details of an App Action Call
-     * @param params entity IDs to identify the App Action Call
-     * @returns detailed metadata about the App Action Call
-     * @throws if the request fails, or the App Action is not found
-     * @example
-     * ```javascript
-     * const appActionCall = await client.appActionCall.getCallDetails({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     *   appActionId: "<app_action_id>",
-     * });
-     * ```
-     */
-    getCallDetails(params: OptionalDefaults<GetAppActionCallDetailsParams>): Promise<AppActionCallResponse>;
-    /**
-     * Calls (triggers) an App Action
-     * @param params entity IDs to identify the App Action to call
-     * @param payload the payload to be sent to the App Action
-     * @returns detailed metadata about the App Action Call
-     * @throws if the request fails, or the App Action is not found
-     * @example
-     * ```javascript
-     * const appActionCall = await client.appActionCall.createWithResponse(
-     *   {
-     *     spaceId: "<space_id>",
-     *     environmentId: "<environment_id>",
-     *     appDefinitionId: "<app_definition_id>",
-     *     appActionId: "<app_action_id>",
-     *   },
-     *   {
-     *     parameters: { // ... },
-     *   }
-     * );
-     * ```
-     */
-    createWithResponse(params: OptionalDefaults<CreateWithResponseParams>, payload: CreateAppActionCallProps): Promise<AppActionCallResponse>;
-    /**
-     * Fetches a structured App Action Call by id.
-     *
-     * Returns the RFC-aligned shape for an app action invocation including
-     * `status` ("processing" | "succeeded" | "failed"), and either
-     * `result` (on success) or `error` (on failure).
-     *
-     * @param params Entity IDs to identify the App Action Call
-     * @returns A structured `AppActionCall` object with `status`, `result` or `error`
-     * @throws if the request fails, or the App Action Call is not found
-     * @example
-     * ```javascript
-     * const call = await client.appActionCall.get({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     *   appActionId: "<app_action_id>",
-     *   callId: "<call_id>",
-     * });
-     * if (call.status === 'succeeded') {
-     *   console.log(call.result);
-     * } else if (call.status === 'failed') {
-     *   console.error(call.error);
-     * }
-     * ```
-     */
-    get(params: OptionalDefaults<GetAppActionCallParamsWithId>): Promise<AppActionCallProps>;
-    /**
-     * Calls (triggers) an App Action and resolves with the structured result.
-     *
-     * This method abstracts away polling. It creates an app action call and then
-     * polls the structured call route until `status` becomes either
-     * `"succeeded"` (returns with `result`) or `"failed"` (returns with `error`).
-     * If the call does not complete within the default retry policy, it rejects.
-     *
-     * @param params Entity IDs to identify the App Action to call
-     * @param payload Parameters to send to the App Action
-     * @returns A completed structured `AppActionCall` with `status`, `result` or `error`
-     * @throws if the request fails, or the call does not complete in time
-     * @example
-     * ```javascript
-     * const call = await client.appActionCall.createWithResult(
-     *   {
-     *     spaceId: "<space_id>",
-     *     environmentId: "<environment_id>",
-     *     appDefinitionId: "<app_definition_id>",
-     *     appActionId: "<app_action_id>",
-     *   },
-     *   {
-     *     parameters: { // your inputs },
-     *   }
-     * );
-     * if (call.status === 'succeeded') {
-     *   console.log(call.result);
-     * } else {
-     *   console.error(call.error);
-     * }
-     * ```
-     */
-    createWithResult(params: OptionalDefaults<CreateWithResultParams>, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
-    /**
-     * Fetches the raw response (headers/body) for a completed App Action Call.
-     *
-     * Use this when you need access to the unparsed executor response. For most
-     * use cases, prefer the structured call via `get` or `createWithResult`.
-     *
-     * @param params Entity IDs to identify the App Action Call
-     * @returns The raw response including serialized `body` and optional `headers`
-     * @throws if the request fails, or the App Action Call is not found
-     * @example
-     * ```javascript
-     * const raw = await client.appActionCall.getResponse({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     *   appActionId: "<app_action_id>",
-     *   callId: "<call_id>",
-     * });
-     * console.log(raw.response.body);
-     * ```
-     */
-    getResponse(params: OptionalDefaults<GetAppActionCallParamsWithId>): Promise<AppActionCallRawResponseProps>;
-};

package/dist/typings/plain/entities/app-action.d.ts

@@ -1,157 +0,0 @@
-import type { CollectionProp, GetAppActionParams, GetAppActionsForEnvParams, GetAppDefinitionParams, QueryParams } from '../../common-types';
-import type { AppActionProps, CreateAppActionProps } from '../../entities/app-action';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type AppActionPlainClientAPI = {
-    /**
-     * Fetches the App Action
-     * @param params entity IDs to identify the App Action
-     * @returns the App Action
-     * @throws if the request fails, or the App Action is not found
-     * @example
-     * ```javascript
-     * const appAction = await client.appAction.get({
-     *   organizationId: "<org_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     *   appActionId: "<app_action_id>",
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetAppActionParams>): Promise<AppActionProps>;
-    /**
-     * Fetches all App Actions for the given App
-     * @param params entity IDs to identify the App
-     * @returns an object containing an array of App Actions
-     * @throws if the request fails, or the App is not found
-     * @example
-     * ```javascript
-     * const appActions = await client.appAction.getMany({
-     *   organizationId: "<org_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetAppDefinitionParams & QueryParams>): Promise<CollectionProp<AppActionProps>>;
-    /**
-     * Fetches all App Actions for the given environment
-     * @param params entity IDs to identify the Environment
-     * @returns an object containing an array of App Actions
-     * @throws if the request fails, or the Environment is not found
-     * @example
-     * ```javascript
-     * const appActions = await client.appAction.getManyForEnvironment({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     * });
-     * ```
-     */
-    getManyForEnvironment(params: OptionalDefaults<GetAppActionsForEnvParams & QueryParams>): Promise<CollectionProp<AppActionProps>>;
-    /**
-     * Deletes the App Action
-     * @param params entity IDs to identify the App Action to delete
-     * @returns void
-     * @throws if the request fails, or the App Action is not found
-     * @example
-     * ```javascript
-     * await client.appAction.delete({
-     *   organizationId: "<org_id>",
-     *   appDefinitionId: "<app_definition_id>",
-     *   appActionId: "<app_action_id>",
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetAppActionParams>): Promise<void>;
-    /**
-     * Creates an App Action
-     * @param params entity IDs to scope where to create the App Action
-     * @param payload the App Action details
-     * @returns the created App Action and its metadata
-     * @throws if the request fails, an entity is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * // app action that targets an endpoint url
-     * const appAction = await client.appAction.create(
-     *   {
-     *     organizationId: "<org_id>",
-     *     appDefinitionId: "<app_definition_id>",
-     *     appActionId: "<app_action_id>",
-     *   },
-     *   {
-     *     category: "Notification.v1.0",
-     *     url: "https://www.somewhere-else.com/action",
-     *     description: "sends a notification",
-     *     name: "My Notification",
-     *   }
-     * );
-     *
-     * // app action that invokes a Contentful Function
-     * const functionAppAction = await client.appAction.create(
-     *  {
-     *    organizationId: '<org_id>',
-     *    appDefinitionId: '<app_definition_id>',
-     *    appActionId: '<app_action_id>',
-     *  },
-     *  {
-     *   type: "function-invocation",
-     *   function: {
-     *     sys: {
-     *       type: "Link",
-     *       linkType: "Function",
-     *       id: '<function_id>'
-     *     }
-     *   },
-     *   category: "Notification.v1.0",
-     *   description: "sends a notification",
-     *   name: "Notification (Function Example)",
-     * }
-     *);
-     * ```
-     */
-    create(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppActionProps): Promise<AppActionProps>;
-    /**
-     * Updates an App Action
-     * @param params entity IDs to identify the App Action
-     * @param payload the App Action update
-     * @returns the updated App Action and its metadata
-     * @throws if the request fails, the App Action is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * // app action that targets an endpoint url
-     * const appAction = await client.appAction.update(
-     *   {
-     *     organizationId: "<org_id>",
-     *     appDefinitionId: "<app_definition_id>",
-     *     appActionId: "<app_action_id>",
-     *   },
-     *   {
-     *     category: "Notification.v1.0",
-     *     url: "https://www.somewhere-else.com/action",
-     *     description: "sends a notification",
-     *     name: "My Notification",
-     *   }
-     * );
-     *
-     * // app action that invokes a Contentful Function
-     * const functionAppAction = await client.appAction.update(
-     *  {
-     *    organizationId: '<org_id>',
-     *    appDefinitionId: '<app_definition_id>',
-     *    appActionId: '<app_action_id>',
-     *  },
-     *  {
-     *   type: "function-invocation",
-     *   function: {
-     *     sys: {
-     *       type: "Link",
-     *       linkType: "Function",
-     *       id: '<function_id>'
-     *     }
-     *   },
-     *   category: "Notification.v1.0",
-     *   description: "sends a notification",
-     *   name: "Notification (Function Example)",
-     * }
-     *);
-     * ```
-     */
-    update(params: OptionalDefaults<GetAppActionParams>, payload: CreateAppActionProps): Promise<AppActionProps>;
-};

package/dist/typings/plain/entities/app-bundle.d.ts

@@ -1,67 +0,0 @@
-import type { CollectionProp, GetAppBundleParams, GetAppDefinitionParams, QueryParams } from '../../common-types';
-import type { AppBundleProps, CreateAppBundleProps } from '../../entities/app-bundle';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type AppBundlePlainClientAPI = {
-    /**
-     * Fetches the App Bundle
-     * @param params entity IDs to identify the App Bundle
-     * @returns the App Bundle
-     * @throws if the request fails, or the App Bundle is not found
-     * @example
-     * ```javascript
-     * const appBundle = await client.appBundle.get({
-     *   appDefinitionId: '<app_definition_id>',
-     *   appBundleId: '<app_bundle_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetAppBundleParams>): Promise<AppBundleProps>;
-    /**
-     * Fetches all App Bundles for the given App
-     * @param params entity IDs to identify the App
-     * @returns an object containing an array of App Bundles
-     * @throws if the request fails, or the App is not found
-     * @example
-     * ```javascript
-     * const results = await client.appBundle.getMany({
-     *   organizationId: '<organization_id>',
-     *   appDefinitionId: '<app_definition_id>',
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetAppDefinitionParams & QueryParams>): Promise<CollectionProp<AppBundleProps>>;
-    /**
-     * Deletes the App Bundle
-     * @param params entity IDs to identify the App Bundle
-     * @throws if the request fails, or the App Bundle is not found
-     * @example
-     * ```javascript
-     * await client.appBundle.delete({
-     *   appDefinitionId: '<app_definition_id>',
-     *   appBundleId: '<app_bundle_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetAppBundleParams>): Promise<void>;
-    /**
-     * Creates an App Bundle
-     * @param params entity IDs to scope where to create the App Bundle
-     * @param payload the App Bundle details
-     * @returns the created App Bundle and its metadata
-     * @throws if the request fails, the associated App is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const appBundle = await client.appBundle.create(
-     *   {
-     *     appDefinitionId: '<app_definition_id>',
-     *     appBundleId: '<app_bundle_id>',
-     *   },
-     *   {
-     *     appUploadId: '<app_upload_id>',
-     *     comment: 'a bundle comment',
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppBundleProps): Promise<AppBundleProps>;
-};

package/dist/typings/plain/entities/app-definition.d.ts

@@ -1,100 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { CollectionProp, GetAppDefinitionParams, GetOrganizationParams, QueryParams } from '../../common-types';
-import type { AppDefinitionProps, AppInstallationsForOrganizationProps, CreateAppDefinitionProps } from '../../entities/app-definition';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type AppDefinitionPlainClientAPI = {
-    /**
-     * Fetch an App Definition
-     * @param params entity IDs to identify the App Definition
-     * @returns the App Definition config
-     * @throws if the request fails, or the App Definition is not found
-     * @example
-     * ```javascript
-     * const appDefinition = await client.appDefinition.get({
-     *   organizationId: '<organization_id>',
-     *   appDefinitionId: '<app_definition_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetOrganizationParams & {
-        appDefinitionId: string;
-    } & QueryParams>): Promise<AppDefinitionProps>;
-    /**
-     * Fetch all App Definitions for the given Organization
-     * @param params entity IDs to identify the Organization from which to fetch App Definitions
-     * @returns an object containing an array of App Definitions
-     * @throws if the request fails, or the Organization is not found
-     * @example
-     * ```javascript
-     * const results = await client.appDefinition.getMany({
-     *   organizationId: '<organization_id>',
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AppDefinitionProps>>;
-    /**
-     * Create an App Definition
-     * @param params entity IDs to identify the Organization where the App Definition will be created
-     * @param rawData the new App Definition
-     * @returns the new App Definition
-     * @throws if the request fails, the Organization is not found, or the update payload is malformed
-     * @example
-     * ```javascript
-     * const appDefinition = await client.appDefinition.create(
-     *   {
-     *     organizationId: '<organization_id>',
-     *   },
-     *   {
-     *     name: "Hello world!",
-     *     parameters: {},
-     *     src: "https://example.com/app.html",
-     *     locations: [
-     *       {
-     *         location: "entry-sidebar",
-     *       },
-     *     ],
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetOrganizationParams>, rawData: CreateAppDefinitionProps): Promise<AppDefinitionProps>;
-    /**
-     * Update an App Definition
-     * @param params entity IDs to identify the App Definition
-     * @param rawData the updated App Definition config
-     * @returns the updated App Definition config
-     * @throws if the request fails, the App Definition is not found, or the update payload is malformed
-     * @example
-     * ```javascript
-     * const updatedAppDefinition = await client.appDefinition.update(
-     *   {
-     *     organizationId: '<organization_id>',
-     *     appDefinitionId: '<app_definition_id>',
-     *   },
-     *   {
-     *     ...currentAppDefinition,
-     *     name: "New App Definition name",
-     *   }
-     * );
-     * ```
-     */
-    update(params: OptionalDefaults<GetAppDefinitionParams>, rawData: AppDefinitionProps, headers?: RawAxiosRequestHeaders): Promise<AppDefinitionProps>;
-    /**
-     * Delete an App Definition
-     * @param params entity IDs to identify the App Definition
-     * @throws if the request fails, or the App Definition is not found
-     * @example
-     * ```javascript
-     * await client.appDefinition.delete({
-     *   organizationId: '<organization_id>',
-     *   appDefinitionId: '<app_definition_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetAppDefinitionParams>): Promise<any>;
-    /**
-     * @deprecated
-     * Please use please use appInstallations.getForOrganization instead
-     */
-    getInstallationsForOrg(params: OptionalDefaults<GetAppDefinitionParams>): Promise<AppInstallationsForOrganizationProps>;
-};

package/dist/typings/plain/entities/app-details.d.ts

@@ -1,56 +0,0 @@
-import type { GetAppDefinitionParams } from '../../common-types';
-import type { AppDetailsProps, CreateAppDetailsProps } from '../../entities/app-details';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type AppDetailsPlainClientAPI = {
-    /**
-     * Creates or updates an App Detail
-     * @param params entity IDs to identify the App Definition or App Details
-     * @param payload the App Detail upsert
-     * @returns the updated App Detail and its metadata
-     * @throws if the request fails, an entity is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const appDetails = await client.appDetails.upsert(
-     *   {
-     *     spaceId: '<space_id>',
-     *     environmentId: '<environment_id>',
-     *     appDefinitionId: '<app_definition_id>',
-     *   },
-     *   {
-     *     icon: {
-     *       type: 'base64',
-     *       value: 'base-64-value'
-     *     }
-     *   }
-     * );
-     * ```
-     */
-    upsert(params: OptionalDefaults<GetAppDefinitionParams>, payload: CreateAppDetailsProps): Promise<AppDetailsProps>;
-    /**
-     * Fetches the App Detail
-     * @param params entity IDs to identify the App Detail
-     * @returns the App Detail
-     * @throws if the request fails, or the App Detail is not found
-     * @example
-     * ```javascript
-     * const appDetails = await client.appDetails.get({
-     *   organizationId: '<organization_id>',
-     *   appDefinitionId: '<app_definition_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetAppDefinitionParams>): Promise<AppDetailsProps>;
-    /**
-     * Fetches the App Detail
-     * @param params entity IDs to identify the App Detail
-     * @throws if the request fails, or the App Detail is not found
-     * @example
-     * ```javascript
-     * await client.appDetails.delete({
-     *   organizationId: '<organization_id>',
-     *   appDefinitionId: '<app_definition_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetAppDefinitionParams>): Promise<void>;
-};

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

@@ -1,75 +0,0 @@
-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>;
-};