contentful-management 12.0.0-beta.8 → 12.0.0-new-beta.1

package/dist/types/entities/organization-membership.d.ts

@@ -1,10 +1,12 @@
-import type { MetaSysProps, DefaultElements, MakeRequest, Link } from '../common-types.js';
+import type { MetaSysProps, DefaultElements, MetaLinkProps, MakeRequest } from '../common-types';
 export type OrganizationMembershipProps = {
     /**
      * System metadata
      */
-    sys: MetaSysProps<'User'> & {
-        user: Link<'User'>;
+    sys: MetaSysProps & {
+        user: {
+            sys: MetaLinkProps;
+        };
     };
     /**
      * Role
@@ -64,4 +66,4 @@ export declare function wrapOrganizationMembership(makeRequest: MakeRequest, dat
 /**
  * @private
  */
-export declare const wrapOrganizationMembershipCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<OrganizationMembershipProps>, organizationId: string) => import("../common-types.js").Collection<OrganizationMembership, OrganizationMembershipProps>;
+export declare const wrapOrganizationMembershipCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<OrganizationMembershipProps>, organizationId: string) => import("..").Collection<OrganizationMembership, OrganizationMembershipProps>;

package/dist/types/entities/organization-membership.js

@@ -0,0 +1,51 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ */
+function createOrganizationMembershipApi(makeRequest, organizationId) {
+    const getParams = (data) => ({
+        organizationMembershipId: data.sys.id,
+        organizationId,
+    });
+    return {
+        update: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OrganizationMembership',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapOrganizationMembership(makeRequest, data, organizationId));
+        },
+        delete: function del() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OrganizationMembership',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {Object} data - Raw organization membership data
+ * @return {OrganizationMembership} Wrapped organization membership data
+ */
+function wrapOrganizationMembership(makeRequest, data, organizationId) {
+    const organizationMembership = toPlainObject(copy(data));
+    const organizationMembershipWithMethods = enhanceWithMethods(organizationMembership, createOrganizationMembershipApi(makeRequest, organizationId));
+    return freezeSys(organizationMembershipWithMethods);
+}
+/**
+ * @private
+ */
+const wrapOrganizationMembershipCollection = wrapCollection(wrapOrganizationMembership);
+
+export { wrapOrganizationMembership, wrapOrganizationMembershipCollection };
+//# sourceMappingURL=organization-membership.js.map

package/dist/types/entities/organization-membership.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organization-membership.js","sources":["../../../lib/entities/organization-membership.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAkEA;;AAEG;AACH,SAAS,+BAA+B,CAAC,WAAwB,EAAE,cAAsB,EAAA;AACvF,IAAA,MAAM,SAAS,GAAG,CAAC,IAAiC,MAAM;AACxD,QAAA,wBAAwB,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE;QACrC,cAAc;AACf,KAAA,CAAC;IAEF,OAAO;AACL,QAAA,MAAM,EAAE,YAAA;AACN,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAiC;AAC/D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,wBAAwB;AACpC,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACtB,gBAAA,OAAO,EAAE,GAAG;AACb,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,0BAA0B,CAAC,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,EAAE,SAAS,GAAG,GAAA;AAClB,YAAA,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAiC;AAC/D,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,wBAAwB;AACpC,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;AACvB,aAAA,CAAC;QACJ,CAAC;KACF;AACH;AAEA;;;;;AAKG;SACa,0BAA0B,CACxC,WAAwB,EACxB,IAAiC,EACjC,cAAsB,EAAA;IAEtB,MAAM,sBAAsB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxD,IAAA,MAAM,iCAAiC,GAAG,kBAAkB,CAC1D,sBAAsB,EACtB,+BAA+B,CAAC,WAAW,EAAE,cAAc,CAAC,CAC7D;AACD,IAAA,OAAO,SAAS,CAAC,iCAAiC,CAAC;AACrD;AAEA;;AAEG;MACU,oCAAoC,GAAG,cAAc,CAAC,0BAA0B;;;;"}

package/dist/types/entities/organization.d.ts

@@ -1,11 +1,11 @@
-import type { ContentfulOrganizationAPI } from '../create-organization-api.js';
-import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types.js';
+import type { ContentfulOrganizationAPI } from '../create-organization-api';
+import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
 export type Organization = DefaultElements<OrganizationProps> & OrganizationProps & ContentfulOrganizationAPI;
 export type OrganizationProps = {
     /**
      * System metadata
      */
-    sys: MetaSysProps<'User'>;
+    sys: MetaSysProps;
     /**
      * Name
      */
@@ -30,4 +30,4 @@ export declare function wrapOrganization(makeRequest: MakeRequest, data: Organiz
  * This method normalizes each organization in a collection.
  * @private
  */
-export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<OrganizationProps>) => import("../common-types.js").Collection<Organization, OrganizationProps>;
+export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<OrganizationProps>) => import("..").Collection<Organization, OrganizationProps>;

package/dist/types/entities/organization.js

@@ -0,0 +1,30 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import createOrganizationApi from '../create-organization-api.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * This method creates the API for the given organization with all the methods for
+ * reading and creating other entities. It also passes down a clone of the
+ * http client with an organization id, so the base path for requests now has the
+ * organization id already set.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - API response for an Organization
+ * @return {Organization}
+ */
+function wrapOrganization(makeRequest, data) {
+    const org = toPlainObject(copy(data));
+    const orgApi = createOrganizationApi(makeRequest);
+    const enhancedOrganization = enhanceWithMethods(org, orgApi);
+    return freezeSys(enhancedOrganization);
+}
+/**
+ * This method normalizes each organization in a collection.
+ * @private
+ */
+const wrapOrganizationCollection = wrapCollection(wrapOrganization);
+
+export { wrapOrganization, wrapOrganizationCollection };
+//# sourceMappingURL=organization.js.map

package/dist/types/entities/organization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organization.js","sources":["../../../lib/entities/organization.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AA4BA;;;;;;;;;AASG;AACG,SAAU,gBAAgB,CAAC,WAAwB,EAAE,IAAuB,EAAA;IAChF,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrC,IAAA,MAAM,MAAM,GAAG,qBAAqB,CAAC,WAAW,CAAC;IACjD,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC;AAC5D,IAAA,OAAO,SAAS,CAAC,oBAAoB,CAAC;AACxC;AAEA;;;AAGG;MACU,0BAA0B,GAAG,cAAc,CAAC,gBAAgB;;;;"}

package/dist/types/entities/personal-access-token.d.ts

@@ -1,6 +1,6 @@
-import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types.js';
+import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
 export type PersonalAccessTokenProps = {
-    sys: MetaSysProps<'User'> & {
+    sys: MetaSysProps & {
         expiresAt?: string;
     };
     name: string;
@@ -48,4 +48,4 @@ export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data:
  * @param data - Raw personal access collection data
  * @return Wrapped personal access token collection data
  */
-export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<PersonalAccessTokenProps>) => import("../common-types.js").Collection<PersonalAccessToken, PersonalAccessTokenProps>;
+export declare const wrapPersonalAccessTokenCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<PersonalAccessTokenProps>) => import("..").Collection<PersonalAccessToken, PersonalAccessTokenProps>;

package/dist/types/entities/personal-access-token.js

@@ -0,0 +1,34 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  personal access token data
+ * @return Wrapped personal access token
+ */
+function wrapPersonalAccessToken(makeRequest, data) {
+    const personalAccessToken = toPlainObject(copy(data));
+    const personalAccessTokenWithMethods = enhanceWithMethods(personalAccessToken, {
+        revoke: function () {
+            return makeRequest({
+                entityType: 'PersonalAccessToken',
+                action: 'revoke',
+                params: { tokenId: data.sys.id },
+            }).then((data) => wrapPersonalAccessToken(makeRequest, data));
+        },
+    });
+    return freezeSys(personalAccessTokenWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw personal access collection data
+ * @return Wrapped personal access token collection data
+ */
+const wrapPersonalAccessTokenCollection = wrapCollection(wrapPersonalAccessToken);
+
+export { wrapPersonalAccessToken, wrapPersonalAccessTokenCollection };
+//# sourceMappingURL=personal-access-token.js.map

package/dist/types/entities/personal-access-token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personal-access-token.js","sources":["../../../lib/entities/personal-access-token.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AA8CA;;;;;AAKG;AACG,SAAU,uBAAuB,CACrC,WAAwB,EACxB,IAA8B,EAAA;IAE9B,MAAM,mBAAmB,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrD,IAAA,MAAM,8BAA8B,GAAG,kBAAkB,CAAC,mBAAmB,EAAE;AAC7E,QAAA,MAAM,EAAE,YAAA;AACN,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,qBAAqB;AACjC,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE;AACjC,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,uBAAuB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC;AACF,KAAA,CAAC;AACF,IAAA,OAAO,SAAS,CAAC,8BAA8B,CAAC;AAClD;AAEA;;;;;AAKG;MACU,iCAAiC,GAAG,cAAc,CAAC,uBAAuB;;;;"}

package/dist/types/entities/preview-api-key.d.ts

@@ -1,6 +1,6 @@
-import type { DefaultElements, MakeRequest, MetaSysProps } from '../common-types.js';
+import type { DefaultElements, MakeRequest, MetaSysProps } from '../common-types';
 export type PreviewApiKeyProps = {
-    sys: MetaSysProps<'User'>;
+    sys: MetaSysProps;
     name: string;
     description: string;
     accessToken: string;
@@ -17,4 +17,4 @@ export declare function wrapPreviewApiKey(_makeRequest: MakeRequest, data: Previ
 /**
  * @private
  */
-export declare const wrapPreviewApiKeyCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<PreviewApiKeyProps>) => import("../common-types.js").Collection<PreviewApiKey, PreviewApiKeyProps>;
+export declare const wrapPreviewApiKeyCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<PreviewApiKeyProps>) => import("..").Collection<PreviewApiKey, PreviewApiKeyProps>;

package/dist/types/entities/preview-api-key.js

@@ -0,0 +1,29 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createPreviewApiKeyApi() {
+    return {};
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ * @return Wrapped preview api key data
+ */
+function wrapPreviewApiKey(_makeRequest, data) {
+    const previewApiKey = toPlainObject(copy(data));
+    const previewApiKeyWithMethods = enhanceWithMethods(previewApiKey, createPreviewApiKeyApi());
+    return freezeSys(previewApiKeyWithMethods);
+}
+/**
+ * @private
+ */
+const wrapPreviewApiKeyCollection = wrapCollection(wrapPreviewApiKey);
+
+export { wrapPreviewApiKey, wrapPreviewApiKeyCollection };
+//# sourceMappingURL=preview-api-key.js.map

package/dist/types/entities/preview-api-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preview-api-key.js","sources":["../../../lib/entities/preview-api-key.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAeA;;AAEG;AACH,SAAS,sBAAsB,GAAA;AAC7B,IAAA,OAAO,EAAE;AACX;AAEA;;;;;AAKG;AACG,SAAU,iBAAiB,CAC/B,YAAyB,EACzB,IAAwB,EAAA;IAExB,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,aAAa,EAAE,sBAAsB,EAAE,CAAC;AAC5F,IAAA,OAAO,SAAS,CAAC,wBAAwB,CAAC;AAC5C;AAEA;;AAEG;MACU,2BAA2B,GAAG,cAAc,CAAC,iBAAiB;;;;"}

package/dist/types/entities/release-action.d.ts

@@ -1,5 +1,5 @@
-import type { DefaultElements, ISO8601Timestamp, Link, MakeRequest } from '../common-types.js';
-import type { AsyncActionProcessingOptions } from '../methods/action.js';
+import type { DefaultElements, ISO8601Timestamp, Link, MakeRequest } from '../common-types';
+import type { AsyncActionProcessingOptions } from '../methods/action';
 type ReleaseActionStatuses = 'created' | 'inProgress' | 'failed' | 'succeeded';
 export type ReleaseActionTypes = 'publish' | 'unpublish' | 'validate';
 export type ReleaseActionSysProps = {
@@ -54,5 +54,5 @@ export declare function wrapReleaseAction(makeRequest: MakeRequest, data: Releas
 /**
  * @private
  */
-export declare const wrapReleaseActionCollection: (makeRequest: MakeRequest, data: import("../common-types.js").CollectionProp<ReleaseActionProps<any>>) => import("../common-types.js").Collection<ReleaseAction<any>, ReleaseActionProps<any>>;
+export declare const wrapReleaseActionCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<ReleaseActionProps<any>>) => import("..").Collection<ReleaseAction<any>, ReleaseActionProps<any>>;
 export {};

package/dist/types/entities/release-action.js

@@ -0,0 +1,53 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import { pollAsyncActionStatus } from '../methods/action.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @private
+ */
+function createReleaseActionApi(makeRequest) {
+    const getParams = (self) => {
+        const action = self.toPlainObject();
+        return {
+            spaceId: action.sys.space.sys.id,
+            environmentId: action.sys.environment.sys.id,
+            releaseId: action.sys.release.sys.id,
+            actionId: action.sys.id,
+        };
+    };
+    return {
+        async get() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'ReleaseAction',
+                action: 'get',
+                params,
+            }).then((releaseAction) => wrapReleaseAction(makeRequest, releaseAction));
+        },
+        /** Waits for a Release Action to complete */
+        async waitProcessing(options) {
+            return pollAsyncActionStatus(async () => this.get(), options);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+function wrapReleaseAction(makeRequest, data) {
+    const releaseAction = toPlainObject(copy(data));
+    const releaseActionWithApiMethods = enhanceWithMethods(releaseAction, createReleaseActionApi(makeRequest));
+    return freezeSys(releaseActionWithApiMethods);
+}
+/**
+ * @private
+ */
+const wrapReleaseActionCollection = wrapCollection(wrapReleaseAction);
+
+export { wrapReleaseAction, wrapReleaseActionCollection };
+//# sourceMappingURL=release-action.js.map

package/dist/types/entities/release-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-action.js","sources":["../../../lib/entities/release-action.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAAA;AAyDA;;AAEG;AACH,SAAS,sBAAsB,CAAC,WAAwB,EAAA;AACtD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAmB,KAAI;AACxC,QAAA,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE;QAEnC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAChC,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;YAC5C,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;AACpC,YAAA,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE;SACxB;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,MAAM,GAAG,GAAA;AACP,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAC9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,eAAe;AAC3B,gBAAA,MAAM,EAAE,KAAK;gBACb,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,KAAK,iBAAiB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAC3E,CAAC;;QAGD,MAAM,cAAc,CAAC,OAAsC,EAAA;AACzD,YAAA,OAAO,qBAAqB,CAAgB,YAAY,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,CAAC;QAC9E,CAAC;KACF;AACH;AAOA;;;;;AAKG;AACG,SAAU,iBAAiB,CAC/B,WAAwB,EACxB,IAAwB,EAAA;IAExB,MAAM,aAAa,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,2BAA2B,GAAG,kBAAkB,CACpD,aAAoB,EACpB,sBAAsB,CAAC,WAAW,CAAC,CACpC;AACD,IAAA,OAAO,SAAS,CAAC,2BAA2B,CAAC;AAC/C;AAEA;;AAEG;MACU,2BAA2B,GAAG,cAAc,CAAC,iBAAiB;;;;"}

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

@@ -1,7 +1,7 @@
-import type { BaseCollection, CursorPaginatedCollection, CursorPaginatedCollectionProp, DefaultElements, ISO8601Timestamp, Link, MakeRequest, MakeRequestPayload } from '../common-types.js';
-import { ScheduledActionReferenceFilters } from '../common-types.js';
-import type { AsyncActionProcessingOptions } from '../methods/action.js';
-import type { ReleaseAction } from './release-action.js';
+import type { BaseCollection, CursorPaginatedCollection, CursorPaginatedCollectionProp, DefaultElements, ISO8601Timestamp, Link, MakeRequest, MakeRequestPayload } from '../common-types';
+import { ScheduledActionReferenceFilters } from '../common-types';
+import type { AsyncActionProcessingOptions } from '../methods/action';
+import type { ReleaseAction } from './release-action';
 /** Entity types supported by the Release API */
 type Entity = 'Entry' | 'Asset';
 type ReleaseStatus = 'active' | 'archived';
@@ -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/types/entities/release.js

@@ -0,0 +1,107 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import '../common-types.js';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapReleaseAction } from './release-action.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @private
+ */
+function createReleaseApi(makeRequest) {
+    const getParams = (self) => {
+        const release = self.toPlainObject();
+        return {
+            spaceId: release.sys.space.sys.id,
+            environmentId: release.sys.environment.sys.id,
+            releaseId: release.sys.id,
+            version: release.sys.version,
+        };
+    };
+    return {
+        async archive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'archive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async unarchive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unarchive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async update(payload) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'update',
+                params,
+                payload,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async delete() {
+            const params = getParams(this);
+            await makeRequest({
+                entityType: 'Release',
+                action: 'delete',
+                params,
+            });
+        },
+        async publish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'publish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async unpublish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unpublish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async validate(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'validate',
+                params,
+                payload: options?.payload,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options?.processingOptions));
+        },
+    };
+}
+/**
+ * Return a Release object enhanced with its own API helper functions.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+function wrapRelease(makeRequest, data) {
+    const release = toPlainObject(copy(data));
+    const releaseWithApiMethods = enhanceWithMethods(release, createReleaseApi(makeRequest));
+    return freezeSys(releaseWithApiMethods);
+}
+/**
+ * @private
+ */
+const wrapReleaseCollection = wrapCursorPaginatedCollection(wrapRelease);
+
+export { wrapRelease, wrapReleaseCollection };
+//# sourceMappingURL=release.js.map

package/dist/types/entities/release.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release.js","sources":["../../../lib/entities/release.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;AAAA;AAoKA;;AAEG;AACH,SAAS,gBAAgB,CAAC,WAAwB,EAAA;AAChD,IAAA,MAAM,SAAS,GAAG,CAAC,IAAa,KAAI;AAClC,QAAA,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,EAAE;QAEpC,OAAO;YACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACjC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;AAC7C,YAAA,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE;AACzB,YAAA,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO;SAC7B;AACH,IAAA,CAAC;IAED,OAAO;AACL,QAAA,MAAM,OAAO,GAAA;AACX,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,SAAS;gBACjB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;AACD,QAAA,MAAM,SAAS,GAAA;AACb,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,WAAW;gBACnB,MAAM;AACP,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,MAAM,CAAC,OAAuB,EAAA;AAClC,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;gBACN,OAAO;AACR,aAAA,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;AACD,QAAA,MAAM,MAAM,GAAA;AACV,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,MAAM,WAAW,CAAC;AAChB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,QAAQ;gBAChB,MAAM;AACP,aAAA,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,CAAC,OAAsC,EAAA;AAClD,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,SAAS;gBACjB,MAAM;aACP;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,SAAS,CAAC,OAAsC,EAAA;AACpD,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,WAAW;gBACnB,MAAM;aACP;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,QAAQ,CAAC,OAAgC,EAAA;AAC7C,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC;AAE9B,YAAA,OAAO,WAAW,CAAC;AACjB,gBAAA,UAAU,EAAE,SAAS;AACrB,gBAAA,MAAM,EAAE,UAAU;gBAClB,MAAM;gBACN,OAAO,EAAE,OAAO,EAAE,OAAO;aAC1B;AACE,iBAAA,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC;AACnD,iBAAA,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACxE,CAAC;KACF;AACH;AAIA;;;;;;AAMG;AACG,SAAU,WAAW,CAAC,WAAwB,EAAE,IAAkB,EAAA;IACtE,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,qBAAqB,GAAG,kBAAkB,CAC9C,OAAc,EACd,gBAAgB,CAAC,WAAW,CAAQ,CACrC;AACD,IAAA,OAAO,SAAS,CAAC,qBAAqB,CAAC;AACzC;AAEA;;AAEG;MACU,qBAAqB,GAGsB,6BAA6B,CAAC,WAAW;;;;"}

package/dist/types/entities/resource-provider.d.ts

@@ -1,12 +1,12 @@
-import type { BasicMetaSysProps, CollectionProp, DefaultElements, Link, MakeRequest } from '../common-types.js';
-import type { ResourceType, UpsertResourceTypeProps } from './resource-type.js';
+import type { BasicMetaSysProps, CollectionProp, DefaultElements, MakeRequest, SysLink } from '../common-types';
+import type { ResourceType, UpsertResourceTypeProps } from './resource-type';
 export type ResourceProviderProps = {
     /**
      * System metadata
      */
-    sys: Omit<BasicMetaSysProps<'ResourceProvider', 'User'>, 'version'> & {
-        organization: Link<'Organization'>;
-        appDefinition: Link<'AppDefinition'>;
+    sys: Omit<BasicMetaSysProps, 'version'> & {
+        organization: SysLink;
+        appDefinition: SysLink;
     };
     /**
      * Resource Provider type, value is 'function'
@@ -15,7 +15,7 @@ export type ResourceProviderProps = {
     /**
      * Link to a Contentful function
      */
-    function: Link<'Function'>;
+    function: SysLink;
 };
 export type UpsertResourceProviderProps = Omit<ResourceProviderProps, 'sys'> & {
     sys: {

package/dist/types/entities/resource-provider.js

@@ -0,0 +1,138 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import entities from './index.js';
+
+/**
+ * @private
+ */
+function createResourceProviderApi(makeRequest) {
+    const { wrapResourceType } = entities.resourceType;
+    return {
+        /**
+         * 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.getResourceProvider())
+         * .then((resourceProvider) => {
+         *    resourceProvider.function.sys.id = '<new_contentful_function_id>'
+         *    return resourceProvider.upsert()
+         * })
+         * .catch(console.error)
+         * ```
+         */
+        upsert: function upsert() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: getUpsertParams(data),
+            }).then((data) => wrapResourceProvider(makeRequest, data));
+        },
+        /**
+         * 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.getResourceProvider())
+         * .then((resourceProvider) => resourceProvider.delete())
+         * .catch(console.error)
+         * ```
+         */
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+        getResourceType: function getResourceType(id) {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'get',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                    resourceTypeId: id,
+                },
+            }).then((data) => wrapResourceType(makeRequest, data));
+        },
+        upsertResourceType: function upsertResourceType(id, data) {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'upsert',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                    resourceTypeId: id,
+                },
+                headers: {},
+                payload: data,
+            }).then((data) => wrapResourceType(makeRequest, data));
+        },
+        getResourceTypes: function getResourceTypes() {
+            return makeRequest({
+                entityType: 'ResourceType',
+                action: 'getMany',
+                params: {
+                    organizationId: this.sys.organization.sys.id,
+                    appDefinitionId: this.sys.appDefinition.sys.id,
+                },
+            }).then((data) => {
+                data.items = data.items.map((item) => wrapResourceType(makeRequest, item));
+                return data;
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param data - raw ResourceProvider Object
+ * @return Object containing the http params for the ResourceProvider request: organizationId and appDefinitionId
+ */
+const getParams = (data) => ({
+    organizationId: data.sys.organization.sys.id,
+    appDefinitionId: data.sys.appDefinition.sys.id,
+});
+/**
+ * @private
+ * @param data - raw ResourceProvider Object
+ * @return UpsertResourceProviderProps
+ */
+const getUpsertParams = (data) => ({
+    sys: { id: data.sys.id },
+    type: data.type,
+    function: data.function,
+});
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Resource Provider data
+ * @return Wrapped Resource Provider data
+ */
+function wrapResourceProvider(makeRequest, data) {
+    const resourceProvider = toPlainObject(copy(data));
+    const ResourceProviderWithMethods = enhanceWithMethods(resourceProvider, createResourceProviderApi(makeRequest));
+    return freezeSys(ResourceProviderWithMethods);
+}
+
+export { wrapResourceProvider };
+//# sourceMappingURL=resource-provider.js.map