contentful-management 11.59.0 → 11.60.1

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

@@ -28,7 +28,7 @@ import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } f
 import type { OrganizationMembershipProps } from './entities/organization-membership';
 import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from './entities/personal-access-token';
 import type { PreviewApiKeyProps } from './entities/preview-api-key';
-import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
+import type { ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
 import type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
 import type { CreateRoleProps, RoleProps } from './entities/role';
 import type { ScheduledActionProps } from './entities/scheduled-action';
@@ -159,6 +159,7 @@ export interface EntityMetaSysProps extends MetaSysProps {
     fieldStatus?: {
         '*': Record<string, 'draft' | 'changed' | 'published'>;
     };
+    release?: Link<'Release'>;
 }
 export interface EntryMetaSysProps extends EntityMetaSysProps {
     contentType: SysLink;
@@ -454,6 +455,20 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
     (opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
     (opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
+    (opts: MROpts<'ReleaseAsset', 'get', UA>): MRReturn<'ReleaseAsset', 'get'>;
+    (opts: MROpts<'ReleaseAsset', 'getMany', UA>): MRReturn<'ReleaseAsset', 'getMany'>;
+    (opts: MROpts<'ReleaseAsset', 'update', UA>): MRReturn<'ReleaseAsset', 'update'>;
+    (opts: MROpts<'ReleaseAsset', 'create', UA>): MRReturn<'ReleaseAsset', 'create'>;
+    (opts: MROpts<'ReleaseAsset', 'createWithId', UA>): MRReturn<'ReleaseAsset', 'createWithId'>;
+    (opts: MROpts<'ReleaseAsset', 'createFromFiles', UA>): MRReturn<'ReleaseAsset', 'createFromFiles'>;
+    (opts: MROpts<'ReleaseAsset', 'processForAllLocales', UA>): MRReturn<'ReleaseAsset', 'processForAllLocales'>;
+    (opts: MROpts<'ReleaseAsset', 'processForLocale', UA>): MRReturn<'ReleaseAsset', 'processForLocale'>;
+    (opts: MROpts<'ReleaseEntry', 'get', UA>): MRReturn<'ReleaseEntry', 'get'>;
+    (opts: MROpts<'ReleaseEntry', 'getMany', UA>): MRReturn<'ReleaseEntry', 'getMany'>;
+    (opts: MROpts<'ReleaseEntry', 'update', UA>): MRReturn<'ReleaseEntry', 'update'>;
+    (opts: MROpts<'ReleaseEntry', 'patch', UA>): MRReturn<'ReleaseEntry', 'patch'>;
+    (opts: MROpts<'ReleaseEntry', 'create', UA>): MRReturn<'ReleaseEntry', 'create'>;
+    (opts: MROpts<'ReleaseEntry', 'createWithId', UA>): MRReturn<'ReleaseEntry', 'createWithId'>;
     (opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>;
     (opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>;
     (opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>;
@@ -1041,13 +1056,16 @@ export type MRActions = {
             return: CollectionProp<AssetProps>;
         };
         getMany: {
-            params: GetSpaceEnvironmentParams & QueryParams;
+            params: GetSpaceEnvironmentParams & QueryParams & {
+                releaseId?: string;
+            };
             headers?: RawAxiosRequestHeaders;
             return: CollectionProp<AssetProps>;
         };
         get: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             } & QueryParams;
             headers?: RawAxiosRequestHeaders;
             return: AssetProps;
@@ -1055,6 +1073,7 @@ export type MRActions = {
         update: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             };
             payload: AssetProps;
             headers?: RawAxiosRequestHeaders;
@@ -1092,13 +1111,16 @@ export type MRActions = {
             return: AssetProps;
         };
         create: {
-            params: GetSpaceEnvironmentParams;
+            params: GetSpaceEnvironmentParams & {
+                releaseId?: string;
+            };
             payload: CreateAssetProps;
             return: AssetProps;
         };
         createWithId: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             };
             payload: CreateAssetProps;
             return: AssetProps;
@@ -1106,6 +1128,7 @@ export type MRActions = {
         createFromFiles: {
             params: GetSpaceEnvironmentParams & {
                 uploadTimeout?: number;
+                releaseId?: string;
             };
             payload: Omit<AssetFileProp, 'sys'>;
             return: AssetProps;
@@ -1505,12 +1528,15 @@ export type MRActions = {
             return: CollectionProp<EntryProps<any>>;
         };
         getMany: {
-            params: GetSpaceEnvironmentParams & QueryParams;
+            params: GetSpaceEnvironmentParams & QueryParams & {
+                releaseId?: string;
+            };
             return: CollectionProp<EntryProps<any>>;
         };
         get: {
             params: GetSpaceEnvironmentParams & {
                 entryId: string;
+                releaseId?: string;
             } & QueryParams;
             return: EntryProps<any>;
         };
@@ -1518,6 +1544,7 @@ export type MRActions = {
             params: GetSpaceEnvironmentParams & {
                 entryId: string;
                 version: number;
+                releaseId?: string;
             };
             payload: OpPatch[];
             headers?: RawAxiosRequestHeaders;
@@ -1526,6 +1553,7 @@ export type MRActions = {
         update: {
             params: GetSpaceEnvironmentParams & {
                 entryId: string;
+                releaseId?: string;
             };
             payload: EntryProps<any>;
             headers?: RawAxiosRequestHeaders;
@@ -1565,6 +1593,7 @@ export type MRActions = {
         create: {
             params: GetSpaceEnvironmentParams & {
                 contentTypeId: string;
+                releaseId?: string;
             };
             payload: CreateEntryProps<any>;
             return: EntryProps<any>;
@@ -1573,6 +1602,7 @@ export type MRActions = {
             params: GetSpaceEnvironmentParams & {
                 entryId: string;
                 contentTypeId: string;
+                releaseId?: string;
             };
             payload: CreateEntryProps<any>;
             return: EntryProps<any>;
@@ -1825,21 +1855,21 @@ export type MRActions = {
             return: ReleaseProps;
         };
         query: {
-            params: GetSpaceEnvironmentParams & {
+            params: ReleaseEnvironmentParams & {
                 query?: ReleaseQueryOptions;
             };
             return: CollectionProp<ReleaseProps>;
         };
         create: {
-            params: GetSpaceEnvironmentParams;
-            payload: ReleasePayload;
+            params: ReleaseEnvironmentParams;
+            payload: ReleasePayload | ReleasePayloadV2;
             return: ReleaseProps;
         };
         update: {
             params: GetReleaseParams & {
                 version: number;
             };
-            payload: ReleasePayload;
+            payload: ReleasePayload | ReleasePayloadV2;
             return: ReleaseProps;
         };
         delete: {
@@ -1870,6 +1900,116 @@ export type MRActions = {
             return: ReleaseActionProps<'validate'>;
         };
     };
+    ReleaseAsset: {
+        get: {
+            params: GetReleaseAssetParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        getMany: {
+            params: GetManyReleaseAssetParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: CollectionProp<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+        };
+        update: {
+            params: UpdateReleaseAssetParams & QueryParams;
+            payload: AssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        create: {
+            params: CreateReleaseAssetParams & QueryParams;
+            payload: CreateAssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        createWithId: {
+            params: CreateWithIdReleaseAssetParams & QueryParams;
+            payload: CreateAssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        createFromFiles: {
+            params: CreateWithFilesReleaseAssetParams & QueryParams;
+            payload: Omit<AssetFileProp, 'sys'>;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        processForAllLocales: {
+            params: ProcessForAllLocalesReleaseAssetParams;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        processForLocale: {
+            params: ProcessForLocaleReleaseAssetParams;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+    };
+    ReleaseEntry: {
+        get: {
+            params: GetReleaseEntryParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: EntryProps<any, {
+                release: Link<'Release'>;
+            }>;
+        };
+        getMany: {
+            params: GetManyReleaseEntryParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: CollectionProp<EntryProps<any, {
+                release: Link<'Release'>;
+            }>>;
+        };
+        update: {
+            params: UpdateReleaseEntryParams & QueryParams;
+            payload: EntryProps<any>;
+            headers?: RawAxiosRequestHeaders;
+            return: EntryProps<any, {
+                release: Link<'Release'>;
+            }>;
+        };
+        patch: {
+            params: PatchReleaseEntryParams & QueryParams;
+            payload: OpPatch[];
+            headers?: RawAxiosRequestHeaders;
+            return: EntryProps<any, {
+                release: Link<'Release'>;
+            }>;
+        };
+        create: {
+            params: CreateReleaseEntryParams & QueryParams;
+            payload: CreateEntryProps<any>;
+            headers?: RawAxiosRequestHeaders;
+            return: EntryProps<any, {
+                release: Link<'Release'>;
+            }>;
+        };
+        createWithId: {
+            params: CreateReleaseEntryParams & {
+                entryId: string;
+            } & QueryParams;
+            payload: CreateEntryProps<any>;
+            headers?: RawAxiosRequestHeaders;
+            return: EntryProps<any, {
+                release: Link<'Release'>;
+            }>;
+        };
+    };
     ReleaseAction: {
         get: {
             params: GetReleaseParams & {
@@ -2571,8 +2711,68 @@ export type GetFunctionLogParams = GetManyFunctionLogParams & {
 export type GetOrganizationParams = {
     organizationId: string;
 };
-export type GetReleaseParams = GetSpaceEnvironmentParams & {
+export type GetReleaseParams = ReleaseEnvironmentParams & {
+    releaseId: string;
+};
+export type GetReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type GetManyReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+};
+export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    entryId: string;
+};
+export type CreateReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+};
+export type CreateWithIdReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type CreateWithFilesReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    uploadTimeout?: number;
+};
+export type UpdateReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type ProcessForLocaleReleaseAssetParams = GetSpaceEnvironmentParams & {
+    asset: AssetProps<{
+        release: Link<'Release'>;
+    }>;
+    locale: string;
+    options?: AssetProcessingForLocale;
+};
+export type ProcessForAllLocalesReleaseAssetParams = GetSpaceEnvironmentParams & {
+    asset: AssetProps<{
+        release: Link<'Release'>;
+    }>;
+    options?: AssetProcessingForLocale;
+};
+export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+};
+export type UpdateReleaseEntryParams = GetSpaceEnvironmentParams & {
     releaseId: string;
+    entryId: string;
+};
+export type PatchReleaseEntryParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    entryId: string;
+    version: number;
+};
+export type CreateReleaseEntryParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    contentTypeId: string;
+};
+export type CreateWithIdReleaseEntryParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    entryId: string;
+    contentTypeId: string;
 };
 export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
     contentTypeId: string;
@@ -2720,4 +2920,7 @@ export type GetUserParams = {
 export declare enum ScheduledActionReferenceFilters {
     contentTypeAnnotationNotIn = "sys.contentType.metadata.annotations.ContentType[nin]"
 }
+export type ReleaseEnvironmentParams = GetSpaceEnvironmentParams & {
+    releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
+};
 export {};

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

@@ -327,5 +327,5 @@ export default function createEntryApi(makeRequest: MakeRequest): {
     /**
      * Recursively collects references of an entry and their descendants
      */
-    references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap>>>;
+    references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
 };

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

@@ -486,7 +486,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
+    getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
     /**
      * Gets a collection of published Entries
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -505,7 +505,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
+    getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
     /**
      * Creates a Entry
      * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
+    getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Gets a collection of published Assets
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -644,7 +644,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
+    getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.

package/dist/typings/entities/asset.d.ts

@@ -1,7 +1,7 @@
 import type { Stream } from 'stream';
 import type { MetaSysProps, DefaultElements, EntityMetaSysProps, MetadataProps, MakeRequest } from '../common-types';
-export type AssetProps = {
-    sys: EntityMetaSysProps;
+export type AssetProps<S = {}> = {
+    sys: EntityMetaSysProps & S;
     fields: {
         /** Title for this asset */
         title: {
@@ -274,5 +274,5 @@ export declare function wrapAsset(makeRequest: MakeRequest, data: AssetProps): A
 /**
  * @private
  */
-export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps>) => import("../common-types").Collection<Asset, AssetProps>;
+export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps<{}>>) => import("../common-types").Collection<Asset, AssetProps<{}>>;
 export {};

package/dist/typings/entities/entry.d.ts

@@ -1,8 +1,8 @@
 import type { CollectionProp, DefaultElements, EntryMetaSysProps, KeyValueMap, MakeRequest, MetadataProps } from '../common-types';
 import type { ContentfulEntryApi } from '../create-entry-api';
 import type { AssetProps } from './asset';
-export type EntryProps<T = KeyValueMap> = {
-    sys: EntryMetaSysProps;
+export type EntryProps<T = KeyValueMap, S = unknown> = {
+    sys: EntryMetaSysProps & S;
     metadata?: MetadataProps;
     fields: T;
 };
@@ -50,4 +50,4 @@ export declare function wrapEntry(makeRequest: MakeRequest, data: EntryProps): E
  * Data is also mixed in with link getters if links exist and includes were requested
  * @private
  */
-export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap>>;
+export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap, unknown>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap, unknown>>;

package/dist/typings/entities/release.d.ts

@@ -18,6 +18,8 @@ export interface ReleaseQueryOptions {
     'sys.createdBy.sys.id[in]'?: string;
     /** Comma-separated filter (inclusion) by Release status (active, archived) */
     'sys.status[in]'?: ReleaseStatus;
+    /** Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases. */
+    'sys.schemaVersion'?: 'Release.v1' | 'Release.v2';
     /** Comma-separated filter (exclusion) by Release status (active, archived) */
     'sys.status[nin]'?: ReleaseStatus;
     /** Find releases using full text phrase and term matching */
@@ -55,6 +57,7 @@ export type ReleaseSysProps = {
     createdAt: ISO8601Timestamp;
     updatedAt: ISO8601Timestamp;
     lastAction?: Link<'ReleaseAction'>;
+    schemaVersion?: 'Release.v2';
 };
 export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
 export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
@@ -72,11 +75,25 @@ export interface ReleaseProps {
     metadata?: ReleaseMetadata;
 }
 export interface ReleasePayload extends MakeRequestPayload {
+    sys?: {
+        type: 'Release';
+        schemaVersion?: 'Release.v1' | undefined;
+    };
     title: string;
     entities: BaseCollection<Link<Entity>>;
 }
+export interface ReleasePayloadV2 extends MakeRequestPayload {
+    sys?: {
+        type: 'Release';
+        schemaVersion: 'Release.v2';
+    };
+    title: string;
+    entities: BaseCollection<{
+        entity: Link<Entity>;
+    } & ReleaseValidatePayload>;
+}
 export interface ReleaseValidatePayload {
-    action?: 'publish';
+    action?: 'publish' | 'unpublish';
 }
 export interface ReleaseValidateOptions {
     payload?: ReleaseValidatePayload;

package/dist/typings/export-types.d.ts

@@ -37,7 +37,7 @@ export type { CreateOrganizationInvitationProps, OrganizationInvitation, Organiz
 export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
 export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
 export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
-export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
+export type { Release, ReleaseMetadata, ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
 export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
 export type { CreateRoleProps, Role, RoleProps } from './entities/role';
 export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';