contentful-management 11.58.1 → 11.59.0-canary.1

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

@@ -1,6 +1,6 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
 import type { OpPatch } from 'json-patch';
-import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
+import type { BasicCursorPaginationOptions, CollectionProp, CreateReleaseAssetParams, CreateReleaseEntryParams, CreateWithFilesReleaseAssetParams, CreateWithIdReleaseAssetParams, CreateWithIdReleaseEntryParams, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetManyReleaseAssetParams, GetManyReleaseEntryParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseAssetParams, GetReleaseEntryParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, Link, PatchReleaseEntryParams, ProcessForAllLocalesReleaseAssetParams, ProcessForLocaleReleaseAssetParams, QueryParams, ReleaseEnvironmentParams, UpdateReleaseAssetParams, UpdateReleaseEntryParams } from '../common-types';
 import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
 import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
 import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
@@ -14,7 +14,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 { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
 import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
 import type { SnapshotProps } from '../entities/snapshot';
@@ -162,16 +162,21 @@ export type PlainClientAPI = {
     user: UserPlainClientAPI;
     entry: {
         getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
-        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
+        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
+            releaseId?: string;
+        }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
         get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
+            releaseId?: string;
         }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
+            releaseId?: string;
         }>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
             version?: number;
+            releaseId?: string;
         }>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
@@ -192,10 +197,12 @@ export type PlainClientAPI = {
         }>): Promise<EntryProps<T>>;
         create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             contentTypeId: string;
+            releaseId?: string;
         }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
         createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
             contentTypeId: string;
+            releaseId?: string;
         }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
         references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             entryId: string;
@@ -204,12 +211,16 @@ export type PlainClientAPI = {
     };
     asset: {
         getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
-        getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
+        getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
+            releaseId?: string;
+        }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
         get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             assetId: string;
+            releaseId?: string;
         } & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
         update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             assetId: string;
+            releaseId?: string;
         }>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
         delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             assetId: string;
@@ -228,13 +239,22 @@ export type PlainClientAPI = {
         unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             assetId: string;
         }>): Promise<AssetProps>;
-        create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
+        create(params: OptionalDefaults<GetSpaceEnvironmentParams & {
+            releaseId?: string;
+        }>, rawData: CreateAssetProps): Promise<AssetProps>;
         createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
             assetId: string;
+            releaseId?: string;
         }>, rawData: CreateAssetProps): Promise<AssetProps>;
-        createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
-        processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
-        processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
+        createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams & {
+            releaseId?: string;
+        }>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
+        processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams & {
+            releaseId?: string;
+        }>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
+        processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams & {
+            releaseId?: string;
+        }>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
     };
     appUpload: AppUploadPlainClientAPI;
     assetKey: {
@@ -266,17 +286,67 @@ export type PlainClientAPI = {
     };
     usage: UsagePlainClientAPI;
     release: {
+        asset: {
+            get(params: OptionalDefaults<GetReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            getMany(params: OptionalDefaults<GetManyReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps<{
+                release: Link<'Release'>;
+            }>>>;
+            update(params: OptionalDefaults<UpdateReleaseAssetParams & QueryParams>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            create(params: OptionalDefaults<CreateReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            createWithId(params: OptionalDefaults<CreateWithIdReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            createFromFiles(params: OptionalDefaults<CreateWithFilesReleaseAssetParams & QueryParams>, data: Omit<AssetFileProp, 'sys'>, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            processForLocale(params: OptionalDefaults<ProcessForLocaleReleaseAssetParams>, asset: AssetProps<{
+                release: Link<'Release'>;
+            }>, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            processForAllLocales(params: OptionalDefaults<ProcessForAllLocalesReleaseAssetParams>, asset: AssetProps<{
+                release: Link<'Release'>;
+            }>, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+        };
+        entry: {
+            get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>;
+            getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>>;
+            update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>;
+            patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>;
+            create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>;
+            createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
+            }>>;
+        };
         archive(params: OptionalDefaults<GetReleaseParams & {
             version: number;
         }>): Promise<ReleaseProps>;
         get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
-        query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
+        query(params: OptionalDefaults<ReleaseEnvironmentParams> & {
             query?: ReleaseQueryOptions;
         }): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
-        create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
+        create(params: OptionalDefaults<ReleaseEnvironmentParams>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
         update(params: OptionalDefaults<GetReleaseParams & {
             version: number;
-        }>, data: ReleasePayload): Promise<ReleaseProps>;
+        }>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
         delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
         publish(params: OptionalDefaults<GetReleaseParams & {
             version: number;

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

@@ -3,6 +3,8 @@ export type DefaultParams = {
     spaceId?: string;
     environmentId?: string;
     organizationId?: string;
+    releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
+    releaseId?: string;
 };
 /**
  * @private

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.58.1",
+  "version": "11.59.0-canary.1",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",
@@ -142,6 +142,10 @@
         "name": "beta",
         "channel": "beta",
         "prerelease": true
+      },
+      {
+        "name": "canary",
+        "prerelease": true
       }
     ],
     "plugins": [