contentful-management 12.0.0-beta.8 → 12.0.0-beta.9

package/dist/types/create-environment-template-api.d.ts

@@ -1,6 +1,6 @@
 import type { BasicCursorPaginationOptions, MakeRequest } from './common-types.js';
-import type { EnvironmentTemplateProps } from './entities/environment-template.js';
-import type { CreateEnvironmentTemplateInstallationProps, ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation.js';
+import { type EnvironmentTemplateProps } from './entities/environment-template.js';
+import { type CreateEnvironmentTemplateInstallationProps, type ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation.js';
 export type ContentfulEnvironmentTemplateApi = ReturnType<typeof createEnvironmentTemplateApi>;
 export declare function createEnvironmentTemplateApi(makeRequest: MakeRequest, organizationId: string): {
     /**

package/dist/types/create-environment-template-api.js

@@ -0,0 +1,268 @@
+import { createRequestConfig } from 'contentful-sdk-core';
+import { wrapEnvironmentTemplate, wrapEnvironmentTemplateCollection } from './entities/environment-template.js';
+import { wrapEnvironmentTemplateInstallationCollection } from './entities/environment-template-installation.js';
+
+function createEnvironmentTemplateApi(makeRequest, organizationId) {
+    return {
+        /**
+         * Updates a environment template
+         * @return Promise for new version of the template
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => {
+         *   environmentTemplate.name = 'New name'
+         *   return environmentTemplate.update()
+         * })
+         * .then((environmentTemplate) =>
+         *   console.log(`Environment template ${environmentTemplate.sys.id} renamed.`)
+         * ).catch(console.error)
+         * ```
+         */
+        update: function updateEnvironmentTemplate() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'update',
+                params: { organizationId, environmentTemplateId: raw.sys.id },
+                payload: raw,
+            }).then((data) => wrapEnvironmentTemplate(makeRequest, data, organizationId));
+        },
+        /**
+         * Updates environment template version data
+         * @param version.versionName - Name of the environment template version
+         * @param version.versionDescription - Description of the environment template version
+         * @return Promise for an updated EnvironmentTemplate
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => {
+         *   return environmentTemplate.updateVersion({
+         *     versionName: 'New Name',
+         *     versionDescription: 'New Description',
+         *   })
+         * })
+         * .then((environmentTemplate) =>
+         *   console.log(`Environment template version ${environmentTemplate.sys.id} renamed.`)
+         * ).catch(console.error)
+         * ```
+         */
+        updateVersion: function updateEnvironmentTemplateVersion({ versionName, versionDescription, }) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'versionUpdate',
+                params: { organizationId, environmentTemplateId: raw.sys.id, version: raw.sys.version },
+                payload: { versionName, versionDescription },
+            }).then((data) => wrapEnvironmentTemplate(makeRequest, data, organizationId));
+        },
+        /**
+         * Deletes the environment template
+         * @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.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         *   .then((environmentTemplate) => environmentTemplate.delete())
+         *   .then(() => console.log('Environment template deleted.'))
+         *   .catch(console.error)
+         * ```
+         */
+        delete: function deleteEnvironmentTemplate() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'delete',
+                params: { organizationId, environmentTemplateId: raw.sys.id },
+            });
+        },
+        /**
+         * Gets a collection of all versions for the environment template
+         * @return Promise for a EnvironmentTemplate
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => environmentTemplate.getVersions())
+         * .then((environmentTemplateVersions) => console.log(environmentTemplateVersions.items))
+         * .catch(console.error)
+         * ```
+         */
+        getVersions: function getEnvironmentTemplateVersions() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'versions',
+                params: {
+                    organizationId,
+                    environmentTemplateId: raw.sys.id,
+                },
+            }).then((data) => wrapEnvironmentTemplateCollection(makeRequest, data, organizationId));
+        },
+        /**
+         * Gets a collection of all installations for the environment template
+         * @param [installationParams.spaceId] - Space ID to filter installations by space and environment
+         * @param [installationParams.environmentId] - Environment ID to filter installations by space and environment
+         * @return Promise for a collection of EnvironmentTemplateInstallations
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => environmentTemplate.getInstallations())
+         * .then((environmentTemplateInstallations) =>
+         *   console.log(environmentTemplateInstallations.items)
+         * )
+         * .catch(console.error)
+         * ```
+         */
+        getInstallations: function getEnvironmentTemplateInstallations({ spaceId, environmentId, ...query } = {}) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplateInstallation',
+                action: 'getMany',
+                params: {
+                    organizationId,
+                    environmentTemplateId: raw.sys.id,
+                    query: { ...createRequestConfig({ query }).params },
+                    spaceId,
+                    environmentId,
+                },
+            }).then((data) => wrapEnvironmentTemplateInstallationCollection(makeRequest, data));
+        },
+        /**
+         * Validates an environment template against a given space and environment
+         * @param params.spaceId - Space ID where the template should be installed into
+         * @param params.environmentId - Environment ID where the template should be installed into
+         * @param [params.version] - Version of the template
+         * @param [params.installation.takeover] - Already existing Content types to takeover in the target environment
+         * @param [params.changeSet] - Change set which should be applied
+         * @return Promise for a EnvironmentTemplateValidation
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => environmentTemplate.validate({
+         *   spaceId: '<space_id>',
+         *   environmentId: '<environment_id>',
+         *   version: <version>,
+         * }))
+         * .then((validationResult) => console.log(validationResult))
+         * .catch(console.error)
+         * ```
+         */
+        validate: function validateEnvironmentTemplate({ spaceId, environmentId, version, takeover, changeSet, }) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'validate',
+                params: {
+                    spaceId,
+                    version,
+                    environmentId,
+                    environmentTemplateId: raw.sys.id,
+                },
+                payload: {
+                    ...(takeover && { takeover }),
+                    ...(changeSet && { changeSet }),
+                },
+            });
+        },
+        /**
+         * Installs a template against a given space and environment
+         * @param params.spaceId - Space ID where the template should be installed into
+         * @param params.environmentId - Environment ID where the template should be installed into
+         * @param params.installation.version- Template version which should be installed
+         * @param [params.installation.takeover] - Already existing Content types tp takeover in the target environment
+         * @param [params.changeSet] - Change set which should be applied
+         * @return Promise for a EnvironmentTemplateInstallation
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then((environmentTemplate) => environmentTemplate.validate({
+         *   spaceId: '<space_id>',
+         *   environmentId: '<environment_id>',
+         *   installation: {
+         *     version: <version>,
+         *   }
+         * }))
+         * .then((installation) => console.log(installation))
+         * .catch(console.error)
+         * ```
+         */
+        install: function installEnvironmentTemplate({ spaceId, environmentId, installation, }) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'install',
+                params: {
+                    spaceId,
+                    environmentId,
+                    environmentTemplateId: raw.sys.id,
+                },
+                payload: installation,
+            });
+        },
+        /**
+         * Disconnects the template from a given environment
+         * @param params.spaceId - Space ID where the template should be installed into
+         * @param params.environmentId - Environment ID where the template should be installed into
+         * @return Promise for the disconnection with no data
+         * ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getEnvironmentTemplate('<organization_id>', '<environment_template_id>')
+         * .then(environmentTemplate) => environmentTemplate.disconnected())
+         * .then(() => console.log('Template disconnected'))
+         * .catch(console.error)
+         * ```
+         */
+        disconnect: function disconnectEnvironmentTemplate({ spaceId, environmentId, }) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentTemplate',
+                action: 'disconnect',
+                params: {
+                    spaceId,
+                    environmentId,
+                    environmentTemplateId: raw.sys.id,
+                },
+            });
+        },
+    };
+}
+
+export { createEnvironmentTemplateApi };

package/dist/types/create-organization-api.d.ts

@@ -1,14 +1,14 @@
 import type { Stream } from 'stream';
-import type { CreateTeamMembershipProps } from './entities/team-membership.js';
-import type { CreateTeamProps } from './entities/team.js';
-import type { CreateOrganizationInvitationProps } from './entities/organization-invitation.js';
+import { type CreateTeamMembershipProps } from './entities/team-membership.js';
+import { type CreateTeamProps } from './entities/team.js';
+import { type CreateOrganizationInvitationProps } from './entities/organization-invitation.js';
 import type { AcceptsQueryOptions, BasicQueryOptions, MakeRequest, QueryOptions, QueryParams } from './common-types.js';
-import type { CreateAppDefinitionProps } from './entities/app-definition.js';
-import type { CreateAppActionProps } from './entities/app-action.js';
-import type { CreateAppSigningSecretProps } from './entities/app-signing-secret.js';
-import type { CreateAppEventSubscriptionProps } from './entities/app-event-subscription.js';
-import type { CreateAppKeyProps } from './entities/app-key.js';
-import type { CreateAppDetailsProps } from './entities/app-details.js';
+import { type CreateAppDefinitionProps } from './entities/app-definition.js';
+import { type CreateAppActionProps } from './entities/app-action.js';
+import { type CreateAppSigningSecretProps } from './entities/app-signing-secret.js';
+import { type CreateAppEventSubscriptionProps } from './entities/app-event-subscription.js';
+import { type CreateAppKeyProps } from './entities/app-key.js';
+import { type CreateAppDetailsProps } from './entities/app-details.js';
 /**
  * @private
  */
@@ -36,7 +36,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getSpaces(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").Space, import("./export-types.js").SpaceProps>>;
+    getSpaces(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/space.js").Space, import("./entities/space.js").SpaceProps>>;
     /**
      * Gets a User
      * @return Promise for a User
@@ -52,8 +52,8 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getUser(id: string): Promise<import("./export-types.js").UserProps & {
-        toPlainObject(): import("./export-types.js").UserProps;
+    getUser(id: string): Promise<import("./entities/user.js").UserProps & {
+        toPlainObject(): import("./entities/user.js").UserProps;
     }>;
     /**
      * Gets a collection of Users in organization
@@ -71,9 +71,9 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getUsers(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").UserProps & {
-        toPlainObject(): import("./export-types.js").UserProps;
-    }, import("./export-types.js").UserProps>>;
+    getUsers(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/user.js").UserProps & {
+        toPlainObject(): import("./entities/user.js").UserProps;
+    }, import("./entities/user.js").UserProps>>;
     /**
      * Gets an Organization Membership
      * @param id - Organization Membership ID
@@ -90,7 +90,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationMembership(id: string): Promise<import("./export-types.js").OrganizationMembership>;
+    getOrganizationMembership(id: string): Promise<import("./entities/organization-membership.js").OrganizationMembership>;
     /**
      * Gets a collection of Organization Memberships
      * @param  params - 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.
@@ -107,7 +107,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationMemberships(params?: QueryParams): Promise<import("./common-types.js").Collection<import("./export-types.js").OrganizationMembership, import("./export-types.js").OrganizationMembershipProps>>;
+    getOrganizationMemberships(params?: QueryParams): Promise<import("./common-types.js").Collection<import("./entities/organization-membership.js").OrganizationMembership, import("./entities/organization-membership.js").OrganizationMembershipProps>>;
     /**
      * Creates a Team
      * @param data representation of the Team to be created
@@ -231,7 +231,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
     getTeamSpaceMemberships(opts?: {
         teamId?: string;
         query?: QueryOptions;
-    }): Promise<import("./common-types.js").Collection<import("./export-types.js").TeamSpaceMembership, import("./export-types.js").TeamSpaceMembershipProps>>;
+    }): Promise<import("./common-types.js").Collection<import("./entities/team-space-membership.js").TeamSpaceMembership, import("./entities/team-space-membership.js").TeamSpaceMembershipProps>>;
     /**
      * Get a Team Space Membership with given teamSpaceMembershipId
      * @return Promise for a Team Space Membership
@@ -247,7 +247,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)]
      * ```
      */
-    getTeamSpaceMembership(teamSpaceMembershipId: string): Promise<import("./export-types.js").TeamSpaceMembership>;
+    getTeamSpaceMembership(teamSpaceMembershipId: string): Promise<import("./entities/team-space-membership.js").TeamSpaceMembership>;
     /**
      * Gets an Space Membership in Organization
      * @param id - Organiztion Space Membership ID
@@ -264,7 +264,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationSpaceMembership(id: string): Promise<import("./export-types.js").SpaceMembership>;
+    getOrganizationSpaceMembership(id: string): Promise<import("./entities/space-membership.js").SpaceMembership>;
     /**
      * Gets a collection Space Memberships in organization
      * @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.
@@ -281,7 +281,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationSpaceMemberships(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").SpaceMembership, import("./export-types.js").SpaceMembershipProps>>;
+    getOrganizationSpaceMemberships(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/space-membership.js").SpaceMembership, import("./entities/space-membership.js").SpaceMembershipProps>>;
     /**
      * Gets an Invitation in Organization
      * @return Promise for a OrganizationInvitation in an organization
@@ -334,7 +334,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getRoles(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").Role, import("./export-types.js").RoleProps>>;
+    getRoles(query?: QueryOptions): Promise<import("./common-types.js").Collection<import("./entities/role.js").Role, import("./entities/role.js").RoleProps>>;
     /**
      * Creates an app definition
      * @param Object representation of the App Definition to be created
@@ -403,7 +403,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAppUpload(appUploadId: string): Promise<import("./export-types.js").AppUpload>;
+    getAppUpload(appUploadId: string): Promise<import("./entities/app-upload.js").AppUpload>;
     /**
      * Creates an app upload
      * @return Promise for an App Upload
@@ -419,7 +419,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    createAppUpload(file: string | ArrayBuffer | Stream): Promise<import("./export-types.js").AppUpload>;
+    createAppUpload(file: string | ArrayBuffer | Stream): Promise<import("./entities/app-upload.js").AppUpload>;
     /**
      * Creates or updates an app signing secret
      * @return Promise for an App SigningSecret
@@ -1126,7 +1126,7 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * const org = await client.getOrganization('<org_id>')
      * const functions = await org.getFunction('<app_definition_id>', '<function_id>')
      */
-    getFunction(appDefinitionId: string, functionId: string): Promise<import("./export-types.js").FunctionProps>;
+    getFunction(appDefinitionId: string, functionId: string): Promise<import("./entities/function.js").FunctionProps>;
     /**
      * Gets a collection of app functions.
      * @param appDefinitionId
@@ -1140,5 +1140,5 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
      * const org = await client.getOrganization('<org_id>')
      * const functions = await org.getFunctions('<app_definition_id>', { 'accepts[all]': '<action>' })
      */
-    getFunctions(appDefinitionId: string, query?: AcceptsQueryOptions): Promise<import("./common-types.js").Collection<import("./export-types.js").FunctionProps, import("./export-types.js").FunctionProps>>;
+    getFunctions(appDefinitionId: string, query?: AcceptsQueryOptions): Promise<import("./common-types.js").Collection<import("./entities/function.js").FunctionProps, import("./entities/function.js").FunctionProps>>;
 };