contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/typings/plain/entities/webhook.d.ts

@@ -1,186 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { CollectionProp, GetSpaceParams, GetWebhookCallDetailsUrl, GetWebhookParams, QueryParams } from '../../common-types';
-import type { CreateWebhooksProps, UpsertWebhookSigningSecretPayload, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, WebhookProps, WebhookRetryPolicyPayload, WebhookRetryPolicyProps, WebhookSigningSecretProps } from '../../entities/webhook';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type WebhookPlainClientAPI = {
-    /**
-     * Fetches the Webhook
-     * @param params entity IDs to identify the Webhook
-     * @returns the Webhook
-     * @throws if the request fails, or the Webhook is not found
-     * @example
-     * ```javascript
-     * const webhook = await client.webhook.get({
-     *   spaceId: '<space_id>',
-     *   webhookDefinitionId: '<webhook_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetWebhookParams>): Promise<WebhookProps>;
-    /**
-     * Fetches all Webhooks for the given Space
-     * @param params entity IDs to identify the Space
-     * @returns an object containing an array of Webhooks
-     * @throws if the request fails, or the Space is not found
-     * @example
-     * ```javascript
-     * const results = await client.webhook.getMany({
-     *   spaceId: '<space_id>',
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<WebhookProps>>;
-    /**
-     * Creates a Webhook
-     * @param params entity IDs to identify the Space to create the Webhook in
-     * @param rawData the Webhook
-     * @returns the created Webhook and its metadata
-     * @throws if the request fails, the Space is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const webhook = await client.webhook.create(
-     *   {
-     *     spaceId: '<space_id>',
-     *   },
-     *   {
-     *     name: 'My webhook',
-     *     url: 'https://www.example.com/test',
-     *     topics: ['Entry.create', 'ContentType.create', '*.publish', 'Asset.*'],
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetSpaceParams>, rawData: CreateWebhooksProps, headers?: RawAxiosRequestHeaders): Promise<WebhookProps>;
-    /**
-     * Creates the Webhook
-     * @param params entity IDs to identify the Webhook to update
-     * @param rawData the new Webhook configuration
-     * @returns the updated Webhook and its metadata
-     * @throws if the request fails, the Webhook is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const webhook = await client.webhook.update(
-     *   {
-     *     spaceId: '<space_id>',
-     *     webhookDefinitionId: '<webhook_definition_id>',
-     *   },
-     *   {
-     *     ...currentWebhook,
-     *     name: 'New webhook name',
-     *   }
-     * );
-     * ```
-     */
-    update(params: OptionalDefaults<GetWebhookParams>, rawData: CreateWebhooksProps): Promise<WebhookProps>;
-    /**
-     * Deletes the Webhook
-     * @param params entity IDs to identify the Webhook to delete
-     * @throws if the request fails, or the Webhook is not found
-     * @example
-     * ```javascript
-     * await client.webhook.delete({
-     *   spaceId: '<space_id>',
-     *   webhookDefinitionId: '<webhook_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetWebhookParams>): Promise<any>;
-    /**
-     * Fetches an overview of recently successful webhook calls
-     * @param params entity IDs to identify the Webhook
-     * @returns an object containing the Webhook and the health overview of recent calls
-     * @throws if the request fails, or the Webhook is not found
-     * @example
-     * ```javascript
-     * const webhookHealth = await client.webhook.getHealthStatus({
-     *   spaceId: '<space_id>',
-     *   webhookDefinitionId: '<webhook_id>',
-     * });
-     * ```
-     */
-    getHealthStatus(params: OptionalDefaults<GetWebhookParams>): Promise<WebhookHealthProps>;
-    /**
-     * Fetches the details a specific Webhook call
-     * @param params entity IDs to identify the Webhook call
-     * @returns details about the outgoing Webhook request and response
-     * @throws if the request fails, or the Webhook call is not found
-     * @example
-     * ```javascript
-     * const webhookCall = await client.webhook.getCallDetails({
-     *   spaceId: '<space_id>',
-     *   webhookDefinitionId: '<webhook_id>',
-     *   callId: '<call_id>',
-     * });
-     * ```
-     */
-    getCallDetails(params: OptionalDefaults<GetWebhookCallDetailsUrl>): Promise<WebhookCallDetailsProps>;
-    /**
-     * Fetches the details the most recent calls for a given Webhook
-     * @param params entity IDs to identify the Webhook
-     * @returns a list of the most recent webhook calls made, their status, possible errors, and the target URL
-     * @throws if the request fails, or the Webhook is not found
-     * @example
-     * ```javascript
-     * const results = await client.webhook.getManyCallDetails({
-     *   spaceId: '<space_id>',
-     *   webhookDefinitionId: '<webhook_id>',
-     * });
-     * ```
-     */
-    getManyCallDetails(params: OptionalDefaults<GetWebhookParams & QueryParams>): Promise<CollectionProp<WebhookCallOverviewProps>>;
-    /**
-     * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
-     */
-    getRetryPolicy(params: OptionalDefaults<GetSpaceParams>): Promise<WebhookRetryPolicyProps>;
-    /**
-     * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
-     */
-    upsertRetryPolicy(params: OptionalDefaults<GetSpaceParams>, rawData: WebhookRetryPolicyPayload): Promise<WebhookRetryPolicyProps>;
-    /**
-     * @deprecated The EAP for this feature has ended. This method will be removed in the next major version.
-     */
-    deleteRetryPolicy(params: OptionalDefaults<GetSpaceParams>): Promise<void>;
-    /**
-     * Fetch the redacted webhook signing secret for a given Space
-     * @param params entity IDs to identify the Space which the signing secret belongs to
-     * @returns the last 4 characters of the redacted signing secret
-     * @throws if the request fails, the Space is not found, or the signing secret does not exist
-     * @example
-     * ```javascript
-     * const signingSecret = await client.webhook.getSigningSecret({
-     *   spaceId: '<space_id>',
-     * });
-     */
-    getSigningSecret(params: OptionalDefaults<GetSpaceParams>): Promise<WebhookSigningSecretProps>;
-    /**
-     * Creates or updates the webhook signing secret for a given Space
-     * @param params entity IDs to identify the Space which the signing secret belongs to
-     * @param rawData (optional) the updated 64 character signing secret value if the secret already exists
-     * @returns the last 4 characters of the created or updated signing secret
-     * @throws if the request fails, the Space is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const crypto = require('crypto')
-     *
-     * const signingSecret = await client.webhook.upsertSigningSecret({
-     *   spaceId: '<space_id>',
-     * },
-     * {
-     *   value: crypto.randomBytes(32).toString("hex"),
-     * });
-     * ```
-     */
-    upsertSigningSecret(params: OptionalDefaults<GetSpaceParams>, rawData: UpsertWebhookSigningSecretPayload): Promise<WebhookSigningSecretProps>;
-    /**
-     * Removes the webhook signing secret for a given Space
-     * @param params entity IDs to identify the Space which the signing secret belongs to
-     * @throws if the request fails, the Space is not found, or the signing secret does not exist
-     * @example
-     * ```javascript
-     * await client.webhook.deleteSigningSecret({
-     *  spaceId: '<space_id>',
-     * });
-     * ```
-     */
-    deleteSigningSecret(params: OptionalDefaults<GetSpaceParams>): Promise<void>;
-};

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

@@ -1,90 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetWorkflowDefinitionParams, GetSpaceEnvironmentParams, CollectionProp } from '../../common-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-import type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, UpdateWorkflowDefinitionParams, UpdateWorkflowDefinitionProps, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from '../../entities/workflow-definition';
-export type WorkflowDefinitionPlainClientAPI = {
-    /**
-     * Fetch a Workflow Definition
-     * @param params entity IDs to identify the Workflow Definition
-     * @returns the Workflow Definition
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const workflowDefinition = await client.workflowDefinition.get({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowDefinitionId: '<workflow_definition_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetWorkflowDefinitionParams>, headers?: RawAxiosRequestHeaders): Promise<WorkflowDefinitionProps>;
-    /**
-     * Query Workflow Definitions with certain filters
-     * @param params entity IDs to identify the Space/Environment, optional query parameters to filter returned Workflow Definitions
-     * @returns an object containing the list of Workflow Definitions
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const workflowDefinitions = await client.workflowDefinition.getMany({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * });
-     * ```
-     * */
-    getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-        query?: WorkflowDefinitionQueryOptions;
-    }>, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<WorkflowDefinitionProps>>;
-    /**
-     * Create a new Workflow Definition
-     * @param params entity IDs to identify the Space/Environment to create the Workflow Definition in
-     * @param rawData the new Workflow Definition
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const workflowDefinition = await client.workflowDefinition.create({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     * }, workflowDefinitionProps);
-     * ```
-     */
-    create(params: OptionalDefaults<CreateWorkflowDefinitionParams>, rawData: CreateWorkflowDefinitionProps, headers?: RawAxiosRequestHeaders): Promise<WorkflowDefinitionProps>;
-    /**
-     * Update a Workflow Definition
-     * @param params entity IDs to identify the Space/Environment and Workflow Definition
-     * @param rawData the updated Workflow Definition
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const updatedWorkflowDefinition = await client.workflowDefinition.update({
-     *  spaceId: '<space_id>',
-     *  environmentId: '<environment_id>',
-     *  workflowDefinitionId: '<workflow_definition_id>',
-     * }, {
-     *   ...workflowDefinition,
-     *   steps: [
-     *     ...workflowDefinition.steps,
-     *     newStep,
-     *   ]
-     * });
-     * ```
-     */
-    update(params: OptionalDefaults<UpdateWorkflowDefinitionParams>, rawData: UpdateWorkflowDefinitionProps, headers?: RawAxiosRequestHeaders): Promise<WorkflowDefinitionProps>;
-    /**
-     * Delete a Workflow Definition
-     * @param params entity IDs to identify the Space/Environment and Workflow Definition version
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * await client.workflowDefinition.delete({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowDefinitionId: '<workflow_definition_id>',
-     *   version: 1
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<DeleteWorkflowDefinitionParams>, headers?: RawAxiosRequestHeaders): Promise<any>;
-};

package/dist/typings/plain/entities/workflow.d.ts

@@ -1,118 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetSpaceEnvironmentParams, CollectionProp, GetWorkflowParams } from '../../common-types';
-import type { CreateWorkflowParams, UpdateWorkflowParams, CompleteWorkflowParams, WorkflowQueryOptions, WorkflowProps, CreateWorkflowProps, UpdateWorkflowProps, DeleteWorkflowParams } from '../../entities/workflow';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type WorkflowPlainClientAPI = {
-    /**
-     * Get Workflow by ID
-     * @param params entity IDs to identify the Space/Environment
-     * @returns an object containing the Workflow
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const workflow = await client.workflow.get({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowId: '<workflow_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetWorkflowParams>, headers?: RawAxiosRequestHeaders): Promise<WorkflowProps>;
-    /**
-     * Query Workflows with certain filters
-     * @param params entity IDs to identify the Space/Environment, optional query parameters to filter returned Workflows
-     * @returns an object containing the list of Workflows
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const workflows = await client.workflow.getMany({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   query: {
-     *     limit: 10
-     *   }
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-        query?: WorkflowQueryOptions;
-    }>, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<WorkflowProps>>;
-    /**
-     * Start a Workflow
-     * @param params entity IDs to identify the Space/Environment
-     * @param rawData the Workflow configuration, including the entity to start the Workflow on and the Workflow Definition to use
-     * @returns the created Workflow
-     * @throws if the request fails
-     * @example
-     * ```javascript
-     * const workflow = await client.workflow.create({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     * }, {
-     *   entity: {
-     *     sys: {
-     *       type: 'Link',
-     *       linkType: 'Entry',
-     *       id: '<entry_id>'
-     *     }
-     *   },
-     *   workflowDefinition: {
-     *     sys: {
-     *       type: 'Link',
-     *       linkType: 'WorkflowDefinition',
-     *       id: <workflow_definition_id>
-     *     }
-     *   }
-     * });
-     * ```
-     */
-    create(params: OptionalDefaults<CreateWorkflowParams>, rawData: CreateWorkflowProps, headers?: RawAxiosRequestHeaders): Promise<WorkflowProps>;
-    /**
-     * Update a Workflow (i.e. move to another step)
-     * @param params entity IDs to identify the Space/Environment and Workflow
-     * @param rawData the step to move to
-     * @returns the updated Workflow
-     * @throws if the request fails
-     * @example
-     * ```javascript
-     * const workflow = await client.workflow.update({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowId: '<workflow_id>',
-     * }, {
-     *   stepId: '<step_id>'
-     *   sys: {
-     *        version: <current_version>
-     * }});
-     * ```
-     */
-    update(params: OptionalDefaults<UpdateWorkflowParams>, rawData: UpdateWorkflowProps, headers?: RawAxiosRequestHeaders): Promise<WorkflowProps>;
-    /**
-     * Delete a Workflow
-     * @param params entity IDs to identify the Space/Environment and Workflow
-     * @throws if the request fails
-     * @example
-     * ```javascript
-     * await client.workflow.delete({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowId: '<workflow_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<DeleteWorkflowParams>, headers?: RawAxiosRequestHeaders): Promise<void>;
-    /**
-     * Complete a Workflow, allowing a new one to be created for the same entry
-     * @param params entity IDs to identify the Space/Environment and Workflow
-     * @throws if the request fails
-     * @example
-     * ```javascript
-     * await client.workflow.complete({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   workflowId: '<workflow_id>',
-     * });
-     * ```
-     */
-    complete(params: OptionalDefaults<CompleteWorkflowParams>, headers?: RawAxiosRequestHeaders): Promise<void>;
-};

package/dist/typings/plain/entities/workflows-changelog.d.ts

@@ -1,26 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetSpaceEnvironmentParams, CollectionProp } from '../../common-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-import type { WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions } from '../../entities/workflows-changelog-entry';
-export type WorkflowsChangelogPlainClientAPI = {
-    /**
-     * Query records in the Workflows Changelog with certain filters
-     * @param params entity IDs to identify the Space/Environment, query options to identify the entry for which the Workflow was executed, and optional filtering and pagination parameters
-     * @returns an object containing the array of Workflow Changelogs
-     * @throws if the request fails, or the Space/Environment is not found
-     * @example
-     * ```javascript
-     * const records = await client.workflowsChangelog.getMany({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   query: {
-     *     'entity.sys.linkType': 'entry',
-     *     'entity.sys.id': '<entry_id>',
-     *   }
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & {
-        query: WorkflowsChangelogQueryOptions;
-    }>, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<WorkflowsChangelogEntryProps>>;
-};

package/dist/typings/plain/pagination-helper.d.ts

@@ -1,22 +0,0 @@
-import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, PaginationQueryOptions } from '../common-types';
-export type OffsetBasedParams = {
-    query?: PaginationQueryOptions;
-};
-export type CursorBasedParams = {
-    query?: BasicCursorPaginationOptions;
-};
-type ExpectedParams = OffsetBasedParams | CursorBasedParams;
-/**
- * `sys.type` tends to cause type clashes downstream because it more commonly types less strict
- * as 'string'. Because we don't rely on it for this functionality, we are fine with omitting it.
- */
-type IterableCollection<T> = Omit<CollectionProp<T> | CursorPaginatedCollectionProp<T>, 'sys'>;
-export type FetchFn<P extends ExpectedParams, T = unknown> = (params: P) => Promise<IterableCollection<T>>;
-type ParamsType<P extends ExpectedParams, T extends FetchFn<P>> = T extends (params: infer P) => unknown ? P : never;
-/**
- * Parameters for endpoint methods that can be paginated are inconsistent, `fetchAll` will only
- * work with the more common version of supplying the limit, skip, and pageNext parameters via a distinct `query` property in the
- * parameters.
- */
-export declare function fetchAll<Params extends ExpectedParams, Entity, F extends FetchFn<Params, Entity>>(fetchFn: FetchFn<Params, Entity>, params: ParamsType<Params, F>): Promise<Entity[]>;
-export {};

package/dist/typings/plain/plain-client.d.ts

@@ -1,8 +0,0 @@
-import type { MakeRequest } from '../common-types';
-import type { PlainClientAPI } from './common-types';
-import type { DefaultParams } from './wrappers/wrap';
-export type { DefaultParams } from './wrappers/wrap';
-/**
- * @private
- */
-export declare const createPlainClient: (makeRequest: MakeRequest, defaults: DefaultParams | undefined) => PlainClientAPI;

package/dist/typings/plain/wrappers/wrap.d.ts

@@ -1,32 +0,0 @@
-import type { MakeRequest, MRActions, MRReturn } from '../../common-types';
-export type DefaultParams = {
-    spaceId?: string;
-    environmentId?: string;
-    organizationId?: string;
-    releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
-    releaseId?: string;
-};
-/**
- * @private
- */
-type UnionOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> : never;
-/**
- * @private
- */
-export type OptionalDefaults<T> = UnionOmit<T, keyof DefaultParams> & Partial<Pick<T, Extract<keyof T, keyof DefaultParams>>>;
-/**
- * @private
- */
-export type WrapParams = {
-    makeRequest: MakeRequest;
-    defaults?: DefaultParams;
-};
-/**
- * @private
- */
-export type WrapFn<ET extends keyof MRActions, Action extends keyof MRActions[ET], Params = 'params' extends keyof MRActions[ET][Action] ? MRActions[ET][Action]['params'] : undefined, Payload = 'payload' extends keyof MRActions[ET][Action] ? MRActions[ET][Action]['payload'] : undefined, Headers = 'headers' extends keyof MRActions[ET][Action] ? MRActions[ET][Action]['headers'] : undefined, Return = MRReturn<ET, Action>> = Params extends undefined ? () => Return : Payload extends undefined ? (params: Params) => Return : Headers extends undefined ? (params: Params, payload: Payload) => Return : (params: Params, payload: Payload, headers: Headers) => Return;
-/**
- * @private
- */
-export declare const wrap: <ET extends keyof MRActions, Action extends keyof MRActions[ET]>({ makeRequest, defaults }: WrapParams, entityType: ET, action: Action) => WrapFn<ET, Action>;
-export {};

package/types.d.ts

@@ -1 +0,0 @@
-export * from './dist/typings/export-types'