contentful-management 12.0.0-new-beta.3 → 12.0.0-new-beta.5

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

@@ -0,0 +1 @@
+{"version":3,"file":"organization-invitation.js","sources":["../../../lib/entities/organization-invitation.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAuBA;;;;;AAKG;AACG,SAAU,0BAA0B,CACxC,YAAyB,EACzB,IAAiC,EAAA;IAEjC,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5C,IAAA,OAAO,SAAS,CAAC,UAAU,CAAC;AAC9B;;;;"}

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

@@ -0,0 +1,69 @@
+import type { MetaSysProps, DefaultElements, MetaLinkProps, MakeRequest } from '../common-types';
+export type OrganizationMembershipProps = {
+    /**
+     * System metadata
+     */
+    sys: MetaSysProps & {
+        user: {
+            sys: MetaLinkProps;
+        };
+    };
+    /**
+     * Role
+     */
+    role: string;
+    /**
+     * status
+     */
+    status: boolean;
+};
+export interface OrganizationMembership extends OrganizationMembershipProps, DefaultElements<OrganizationMembershipProps> {
+    /**
+     * 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('organization_id')
+     * .then(org => org.getOrganizationMembership('organizationMembership_id'))
+     * .then((organizationMembership) => {
+     *  organizationMembership.role = 'member';
+     *  organizationMembership.update();
+     * })
+     * .catch(console.error)
+     */
+    update(): Promise<OrganizationMembership>;
+    /**
+     * Deletes this object on the server.
+     * @example```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getOrganization('organization_id')
+     * .then(org => org.getOrganizationMembership('organizationMembership_id'))
+     * .then((organizationMembership) => {
+     *  organizationMembership.delete();
+     * })
+     * .catch(console.error)
+     * ```
+     */
+    delete(): Promise<void>;
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {Object} data - Raw organization membership data
+ * @return {OrganizationMembership} Wrapped organization membership data
+ */
+export declare function wrapOrganizationMembership(makeRequest: MakeRequest, data: OrganizationMembershipProps, organizationId: string): OrganizationMembership;
+/**
+ * @private
+ */
+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

@@ -0,0 +1,33 @@
+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;
+    /**
+     * Name
+     */
+    name: string;
+};
+/**
+ * @deprecated Use `OrganizationProps` instead.
+ */
+export type OrganizationProp = OrganizationProps;
+/**
+ * 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}
+ */
+export declare function wrapOrganization(makeRequest: MakeRequest, data: OrganizationProps): Organization;
+/**
+ * This method normalizes each organization in a collection.
+ * @private
+ */
+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

@@ -0,0 +1,51 @@
+import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
+export type PersonalAccessTokenProps = {
+    sys: MetaSysProps & {
+        expiresAt?: string;
+    };
+    name: string;
+    scopes: 'content_management_manage'[];
+    revokedAt: null | string;
+    token?: string;
+};
+/**
+ * @deprecated Use `PersonalAccessTokenProps` instead.
+ */
+export type PersonalAccessTokenProp = PersonalAccessTokenProps;
+export type CreatePersonalAccessTokenProps = Pick<PersonalAccessToken, 'name' | 'scopes'> & {
+    expiresIn?: number;
+};
+export interface PersonalAccessToken extends PersonalAccessTokenProps, DefaultElements<PersonalAccessTokenProps> {
+    /**
+     * Revokes a personal access token
+     * @return Object the revoked personal access token
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *  accessToken: <content_management_api_key>
+     * })
+     *
+     * client.getPersonalAccessToken('<token-id>')
+     *  .then((personalAccessToken) => {
+     *    return personalAccessToken.revoke()
+     *  })
+     *  .catch(console.error)
+     * ```
+     */
+    revoke(): Promise<PersonalAccessToken>;
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  personal access token data
+ * @return Wrapped personal access token
+ */
+export declare function wrapPersonalAccessToken(makeRequest: MakeRequest, data: PersonalAccessTokenProps): PersonalAccessToken;
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw personal access collection data
+ * @return Wrapped personal access token collection data
+ */
+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

@@ -0,0 +1,20 @@
+import type { DefaultElements, MakeRequest, MetaSysProps } from '../common-types';
+export type PreviewApiKeyProps = {
+    sys: MetaSysProps;
+    name: string;
+    description: string;
+    accessToken: string;
+};
+export interface PreviewApiKey extends PreviewApiKeyProps, DefaultElements<PreviewApiKeyProps> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ * @return Wrapped preview api key data
+ */
+export declare function wrapPreviewApiKey(_makeRequest: MakeRequest, data: PreviewApiKeyProps): PreviewApiKey;
+/**
+ * @private
+ */
+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

@@ -0,0 +1,58 @@
+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 = {
+    id: string;
+    type: 'ReleaseAction';
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    release: Link<'Release'>;
+    status: ReleaseActionStatuses;
+    createdBy: Link<'User'>;
+    createdAt: ISO8601Timestamp;
+    updatedBy: Link<'User'>;
+    updatedAt: ISO8601Timestamp;
+};
+/** The object returned by the Releases API */
+export interface ReleaseActionProps<T extends ReleaseActionTypes = any> {
+    action: T;
+    sys: ReleaseActionSysProps;
+}
+export interface ReleaseActionQueryOptions {
+    /** Find Release Actions by using a comma-separated list of Ids */
+    'sys.id[in]'?: string;
+    'sys.release.sys.id[in]'?: string;
+    'sys.status[in]'?: string;
+    'sys.status[nin]'?: string;
+    action?: ReleaseActionTypes;
+    /** Get unique results by this field. Currently supports `sys.release.sys.id` */
+    uniqueBy?: string;
+    /** @default -sys.updatedAt */
+    order?: string;
+    /**
+     * Limit of how many records are returned in the query result
+     * @default 100
+     * */
+    limit?: number;
+}
+export interface ReleaseActionApiMethods {
+    /** Performs a new GET request and returns the wrapper Release */
+    get(): ReleaseAction;
+    /** Waits until the Release Action has either succeeded or failed */
+    waitProcessing(options?: AsyncActionProcessingOptions): ReleaseAction;
+}
+export interface ReleaseAction<T extends ReleaseActionTypes = any> extends ReleaseActionProps<T>, ReleaseActionApiMethods, DefaultElements<ReleaseActionProps<T>> {
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+export declare function wrapReleaseAction(makeRequest: MakeRequest, data: ReleaseActionProps): ReleaseAction;
+/**
+ * @private
+ */
+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

@@ -0,0 +1,142 @@
+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';
+export interface ReleaseQueryOptions {
+    /** Find releases filtered by the Entity type (Asset, Entry) */
+    'entities.sys.linkType'?: string;
+    /** Find releases containing the specified, comma-separated entities. Requires `entities.sys.linkType` */
+    'entities.sys.id[in]'?: string;
+    /** Comma-separated list of ids to exclude from the query */
+    'sys.id[nin]'?: string;
+    /** Comma-separated  list of Ids to find (inclusion)  */
+    'sys.id[in]'?: string;
+    /** Comma-separated list of user Ids to find releases by creator  */
+    '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 */
+    'title[match]'?: string;
+    /** Filter by empty Releases (exists=false) or Releases with items (exists=true) */
+    'entities[exists]'?: boolean;
+    /** If present, will return results based on a pagination cursor */
+    pageNext?: string;
+    /**
+     * Limit how many records are returned in the result
+     * @default 100
+     * */
+    limit?: number;
+    /**
+     * Order releases
+     *  Supported values include
+     *  - `title`, `-title`
+     *  - `sys.updatedAt`, `-sys.updatedAt`
+     *  - `sys.createdAt`, `-sys.createdAt`
+     * @default -sys.updatedAt
+     * */
+    order?: string;
+}
+export type ReleaseSysProps = {
+    id: string;
+    type: 'Release';
+    version: number;
+    status: ReleaseStatus;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    archivedBy?: Link<'User'>;
+    archivedAt?: ISO8601Timestamp;
+    createdBy: Link<'User'> | Link<'AppDefinition'>;
+    updatedBy: Link<'User'> | Link<'AppDefinition'>;
+    createdAt: ISO8601Timestamp;
+    updatedAt: ISO8601Timestamp;
+    lastAction?: Link<'ReleaseAction'>;
+    schemaVersion?: 'Release.v2';
+};
+export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
+export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
+export type ReleaseMetadata = {
+    withReferences: {
+        entity: Link<'Entry'>;
+        filter: Record<ReleaseReferenceFilters, string[]>;
+    }[];
+};
+/** The object returned by the Releases API */
+export interface ReleaseProps {
+    title: string;
+    sys: ReleaseSysProps;
+    entities: BaseCollection<Link<Entity>>;
+    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' | 'unpublish';
+}
+export interface ReleaseValidateOptions {
+    payload?: ReleaseValidatePayload;
+    processingOptions?: AsyncActionProcessingOptions;
+}
+export interface ReleaseApiMethods {
+    /**
+     * Archives a release and locks any actions such as adding new entities or publishing/unpublishing.
+     * This operation increases the sys.version property
+     * @throws {BadRequest} if the release is already archived
+     * */
+    archive(): Promise<Release>;
+    /**
+     * Unarchives an `archived` release and unlocks operations on the Release. This operation increases the sys.version property
+     * @throws {BadRequest} if the release is not archived
+     * */
+    unarchive(): Promise<Release>;
+    /** Updates a Release and returns the updated Release object */
+    update(payload: ReleasePayload): Promise<Release>;
+    /** Deletes a Release and all ReleaseActions linked to it (non-reversible) */
+    delete(): Promise<void>;
+    /** Publishes a Release and waits until the asynchronous action is completed */
+    publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<'publish'>>;
+    /** Unpublishes a Release and waits until the asynchronous action is completed */
+    unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<'unpublish'>>;
+    /** Validates a Release and waits until the asynchronous action is completed */
+    validate({ payload, options, }?: {
+        payload?: ReleaseValidatePayload;
+        options?: AsyncActionProcessingOptions;
+    }): Promise<ReleaseAction<'validate'>>;
+}
+export interface Release extends ReleaseProps, ReleaseApiMethods, DefaultElements<ReleaseProps> {
+}
+/**
+ * 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
+ */
+export declare function wrapRelease(makeRequest: MakeRequest, data: ReleaseProps): Release;
+/**
+ * @private
+ */
+export declare const wrapReleaseCollection: (makeRequest: MakeRequest, data: CursorPaginatedCollectionProp<ReleaseProps>) => CursorPaginatedCollection<Release, ReleaseProps>;
+export {};