contentful-management 11.64.0-new-beta.5 → 11.65.0

package/dist/typings/common-utils.d.ts

@@ -0,0 +1,11 @@
+import type { BasicCursorPaginationOptions, Collection, CollectionProp, CursorBasedParams, CursorPaginatedCollection, CursorPaginatedCollectionProp, MakeRequest } from './common-types';
+/**
+ * @private
+ */
+export declare const wrapCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CollectionProp<T>, ...rest: Rest) => Collection<R, T>;
+export declare const wrapCursorPaginatedCollection: <R, T, Rest extends any[]>(fn: (makeRequest: MakeRequest, entity: T, ...rest: Rest) => R) => (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<T>, ...rest: Rest) => CursorPaginatedCollection<R, T>;
+export declare function isSuccessful(statusCode: number): boolean;
+export declare function shouldRePoll(statusCode: number): boolean;
+export declare function waitFor(ms?: number): Promise<unknown>;
+export declare function normalizeCursorPaginationParameters(query: BasicCursorPaginationOptions): CursorBasedParams;
+export declare function normalizeCursorPaginationResponse<T>(data: CursorPaginatedCollectionProp<T>): CursorPaginatedCollectionProp<T>;

package/dist/typings/contentful-management.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Contentful Management API SDK. Allows you to create instances of a client
+ * with access to the Contentful Content Management API.
+ * @packageDocumentation
+ */
+import type { RestAdapterParams } from './adapters/REST/rest-adapter';
+import type { XOR } from './common-types';
+import type { AdapterParams } from './create-adapter';
+import type { ClientAPI } from './create-contentful-api';
+import type { PlainClientAPI } from './plain/common-types';
+import type { DefaultParams } from './plain/plain-client';
+import * as editorInterfaceDefaults from './constants/editor-interface-defaults';
+import { ScheduledActionStatus } from './entities/scheduled-action';
+export type { ClientAPI } from './create-contentful-api';
+export { asIterator } from './plain/as-iterator';
+export { fetchAll } from './plain/pagination-helper';
+export { isDraft, isPublished, isUpdated } from './plain/checks';
+export type { PlainClientAPI } from './plain/common-types';
+export { createClient };
+export { RestAdapter } from './adapters/REST/rest-adapter';
+export type { RestAdapterParams } from './adapters/REST/rest-adapter';
+export { makeRequest } from './adapters/REST/make-request';
+export { editorInterfaceDefaults };
+export type PlainClientDefaultParams = DefaultParams;
+export * from './export-types';
+export { ScheduledActionStatus };
+interface UserAgentParams {
+    /**
+     * Application name and version e.g myApp/version
+     */
+    application?: string;
+    /**
+     * Integration name and version e.g react/version
+     */
+    integration?: string;
+    feature?: string;
+}
+/**
+ * @deprecated
+ */
+export type ClientParams = RestAdapterParams & UserAgentParams;
+export type ClientOptions = UserAgentParams & XOR<RestAdapterParams, AdapterParams>;
+/**
+ * Create a client instance
+ * @param params - Client initialization parameters
+ *
+ * ```javascript
+ * const client = contentfulManagement.createClient({
+ *  accessToken: 'myAccessToken'
+ * })
+ * ```
+ */
+declare function createClient(params: ClientOptions): ClientAPI;
+declare function createClient(params: ClientOptions, opts: {
+    type: 'plain';
+    defaults?: DefaultParams;
+}): PlainClientAPI;
+/**
+ * @deprecated The `alphaFeatures` option is no longer supported. Please use the function without this option.
+ */
+declare function createClient(params: ClientOptions, opts: {
+    type?: 'plain';
+    alphaFeatures: string[];
+    defaults?: DefaultParams;
+}): ClientAPI | PlainClientAPI;

package/dist/typings/create-app-definition-api.d.ts

@@ -0,0 +1,169 @@
+import type { MakeRequest, QueryOptions, SpaceQueryOptions } from './common-types';
+import type { CreateAppBundleProps } from './entities/app-bundle';
+import type { UpsertResourceProviderProps } from './entities/resource-provider';
+/**
+ * @private
+ */
+export type ContentfulAppDefinitionAPI = ReturnType<typeof createAppDefinitionApi>;
+/**
+ * @private
+ */
+export default function createAppDefinitionApi(makeRequest: MakeRequest): {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => {
+     *   appDefinition.name = 'New App Definition name'
+     *   return appDefinition.update()
+     * })
+     * .then((appDefinition) => console.log(`App Definition ${appDefinition.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update: () => Promise<import("./entities/app-definition").AppDefinition>;
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.delete())
+     * .then(() => console.log(`App Definition deleted.`))
+     * .catch(console.error)
+     * ```
+     */
+    delete: () => Promise<any>;
+    /**
+     * Gets an app bundle
+     * @param id - AppBundle ID
+     * @return Promise for an AppBundle
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.getAppBundle('<app_upload_id>'))
+     * .then((appBundle) => console.log(appBundle))
+     * .catch(console.error)
+     * ```
+     */
+    getAppBundle(id: string): Promise<import("./entities/app-bundle").AppBundle>;
+    /**
+     * Gets a collection of AppBundles
+     * @return Promise for a collection of AppBundles
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.getAppBundles())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getAppBundles(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/app-bundle").AppBundle, import("./entities/app-bundle").AppBundleProps>>;
+    /**
+     * Creates an app bundle
+     * @param Object representation of the App Bundle to be created
+     * @return Promise for the newly created AppBundle
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.createAppBundle('<app_upload_id>'))
+     * .then((appBundle) => console.log(appBundle))
+     * .catch(console.error)
+     * ```
+     */
+    createAppBundle(data: CreateAppBundleProps): Promise<import("./entities/app-bundle").AppBundle>;
+    /**
+     * Gets a list of App Installations across an org for given organization and App Definition
+     * If a spaceId is provided in the query object, it will return the App Installations for that specific space.
+     * @return Promise for the newly created AppBundle
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * client.getAppDefinition('<organization_id>', '<app_definition_id>')
+     * .then((appDefinition) => appDefinition.getInstallationsForOrg(
+     *   { spaceId: '<space_id>' } // optional
+     * ))
+     * .then((appInstallationsForOrg) => console.log(appInstallationsForOrg.items))
+     * .catch(console.error)
+     * ```
+     */
+    getInstallationsForOrg(query?: SpaceQueryOptions): Promise<import("./entities/app-definition").AppInstallationsForOrganizationProps>;
+    /**
+     * Creates or updates a resource provider
+     * @param data representation of the ResourceProvider
+     * @return Promise for the newly created or updated ResourceProvider
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * // You need a valid AppDefinition with an activated AppBundle that has a contentful function configured
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.upsertResourceProvider({
+     *    sys: {
+     *      id: '<resource_provider_id>'
+     *    },
+     *    type: 'function',
+     *    function: {
+     *      sys: {
+     *        id: '<contentful_function_id>',
+     *        type: 'Link'
+     *        linkType: 'Function'
+     *      }
+     *    }
+     * }))
+     * .then((resourceProvider) => console.log(resourceProvider))
+     * .catch(console.error)
+     * ```
+     */
+    upsertResourceProvider(data: UpsertResourceProviderProps): Promise<import("./entities/resource-provider").ResourceProvider>;
+    /**
+     * Gets a Resource Provider
+     * @return Promise for a Resource Provider
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.getResourceProvider())
+     * .then((resourceProvider) => console.log(resourceProvider))
+     * .catch(console.error)
+     * ```
+     */
+    getResourceProvider(): Promise<import("./entities/resource-provider").ResourceProvider>;
+};

package/dist/typings/create-entry-api.d.ts

@@ -0,0 +1,331 @@
+import type { OpPatch } from 'json-patch';
+import type { MakeRequest } from './common-types';
+import type { CreateCommentProps } from './entities/comment';
+import type { Entry, EntryProps, EntryReferenceOptionsProps } from './entities/entry';
+import type { CreateTaskProps } from './entities/task';
+/**
+ * @private
+ */
+export type ContentfulEntryApi = ReturnType<typeof createEntryApi>;
+/**
+ * @private
+ */
+export default function createEntryApi(makeRequest: MakeRequest): {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => {
+     *   entry.fields.title['en-US'] = 'New entry title'
+     *   return entry.update()
+     * })
+     * .then((entry) => console.log(`Entry ${entry.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update: () => Promise<Entry>;
+    /**
+     * Sends an JSON patch to the server with any changes made to the object's properties
+     * @return Object returned from the server with updated changes.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.patch([
+     *   {
+     *     op: 'replace',
+     *     path: '/fields/title/en-US',
+     *     value: 'New entry title'
+     *   }
+     * ]))
+     * .then((entry) => console.log(`Entry ${entry.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    patch: (ops: OpPatch[]) => Promise<Entry>;
+    /**
+     * Deletes this object on the server.
+     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.delete())
+     * .then(() => console.log(`Entry deleted.`))
+     * .catch(console.error)
+     * ```
+     */
+    delete: () => Promise<any>;
+    /**
+     * Publishes the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.publish())
+     * .then((entry) => console.log(`Entry ${entry.sys.id} published.`))
+     * .catch(console.error)
+     * ```
+     */
+    publish: () => Promise<Entry>;
+    /**
+     * Unpublishes the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.unpublish())
+     * .then((entry) => console.log(`Entry ${entry.sys.id} unpublished.`))
+     * .catch(console.error)
+     * ```
+     */
+    unpublish: () => Promise<Entry>;
+    /**
+     * Archives the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.archive())
+     * .then((entry) => console.log(`Entry ${entry.sys.id} archived.`))
+     * .catch(console.error)
+     * ```
+     */
+    archive: () => Promise<Entry>;
+    /**
+     * Unarchives the object
+     * @return Object returned from the server with updated metadata.
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.unarchive())
+     * .then((entry) => console.log(`Entry ${entry.sys.id} unarchived.`))
+     * .catch(console.error)
+     * ```
+     */
+    unarchive: () => Promise<Entry>;
+    /**
+     * Gets all snapshots of an entry
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.getSnapshots())
+     * .then((snapshots) => console.log(snapshots.items))
+     * .catch(console.error)
+     * ```
+     */
+    getSnapshots: (query?: {}) => Promise<import("./common-types").Collection<import("./export-types").Snapshot<EntryProps>, import("./export-types").SnapshotProps<EntryProps>>>;
+    /**
+     * Gets a snapshot of an entry
+     * @param snapshotId - Id of the snapshot
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment_id>'))
+     * .then((environment) => environment.getEntry('<entry_id>'))
+     * .then((entry) => entry.getSnapshot('<snapshot_id>'))
+     * .then((snapshot) => console.log(snapshot))
+     * .catch(console.error)
+     * ```
+     */
+    getSnapshot: (snapshotId: string) => Promise<import("./export-types").Snapshot<EntryProps>>;
+    /**
+     * Creates a new comment for an entry
+     * @param data Object representation of the Comment to be created
+     * @returns Promise for the newly created Comment
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.createComment({
+     *   body: 'Something left to do'
+     * }))
+     * .then((comment) => console.log(comment))
+     * .catch(console.error)
+     * ```
+     */
+    createComment: (data: CreateCommentProps) => Promise<import("./entities/comment").Comment | import("./entities/comment").RichTextComment>;
+    /**
+     * Gets all comments of an entry
+     * @returns
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.getComments())
+     * .then((comments) => console.log(comments))
+     * .catch(console.error)
+     * ```
+     */
+    getComments: () => Promise<import("./common-types").Collection<import("./entities/comment").Comment | import("./entities/comment").RichTextComment, import("./entities/comment").CommentProps | import("./entities/comment").RichTextCommentProps>>;
+    /**
+     * Gets a comment of an entry
+     * @returns
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.getComment(`<comment-id>`))
+     * .then((comment) => console.log(comment))
+     * .catch(console.error)
+     * ```
+     */
+    getComment: (id: string) => Promise<import("./entities/comment").Comment | import("./entities/comment").RichTextComment>;
+    /**
+     * Creates a new task for an entry
+     * @param data Object representation of the Task to be created
+     * @returns Promise for the newly created Task
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.createTask({
+     *   body: 'Something left to do',
+     *   assignedTo: '<user-id>',
+     *   status: 'active'
+     * }))
+     * .then((task) => console.log(task))
+     * .catch(console.error)
+     * ```
+     */
+    createTask: (data: CreateTaskProps) => Promise<import("./entities/task").Task>;
+    /**
+     * Gets all tasks of an entry
+     * @returns
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.getTasks())
+     * .then((tasks) => console.log(tasks))
+     * .catch(console.error)
+     * ```
+     */
+    getTasks: (query?: {}) => Promise<import("./common-types").Collection<import("./entities/task").Task, import("./entities/task").TaskProps>>;
+    /**
+     * Gets a task of an entry
+     * @returns
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getEntry('<entry-id>'))
+     * .then((entry) => entry.getTask(`<task-id>`))
+     * .then((task) => console.log(task))
+     * .catch(console.error)
+     * ```
+     */
+    getTask: (id: string) => Promise<import("./entities/task").Task>;
+    /**
+     * Checks if the entry is published. A published entry might have unpublished changes
+     */
+    isPublished: () => boolean;
+    /**
+     * Checks if the entry is updated. This means the entry was previously published but has unpublished changes.
+     */
+    isUpdated: () => boolean;
+    /**
+     * Checks if the entry is in draft mode. This means it is not published.
+     */
+    isDraft: () => boolean;
+    /**
+     * Checks if entry is archived. This means it's not exposed to the Delivery/Preview APIs.
+     */
+    isArchived: () => boolean;
+    /**
+     * Recursively collects references of an entry and their descendants
+     */
+    references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
+};