contentful-management 12.0.0-beta.1 → 12.0.0-beta.10

package/dist/types/create-app-definition-api.js

@@ -0,0 +1,251 @@
+import { wrapAppBundle, wrapAppBundleCollection } from './entities/app-bundle.js';
+import { wrapResourceProvider } from './entities/resource-provider.js';
+import { wrapAppDefinition } from './entities/app-definition.js';
+
+/**
+ * @private
+ */
+function createAppDefinitionApi(makeRequest) {
+    const getParams = (data) => ({
+        appDefinitionId: data.sys.id,
+        organizationId: data.sys.organization.sys.id,
+    });
+    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.name = 'New App Definition name'
+         *   return appDefinition.update()
+         * })
+         * .then((appDefinition) => console.log(`App Definition ${appDefinition.sys.id} updated.`))
+         * .catch(console.error)
+         * ```
+         */
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppDefinition',
+                action: 'update',
+                params: getParams(data),
+                headers: {},
+                payload: data,
+            }).then((data) => wrapAppDefinition(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.delete())
+         * .then(() => console.log(`App Definition deleted.`))
+         * .catch(console.error)
+         * ```
+         */
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppDefinition',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+        /**
+         * Gets an app bundle
+         * @param id - AppBundle ID
+         * @return Promise for an AppBundle
+         * @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.getAppBundle('<app_upload_id>'))
+         * .then((appBundle) => console.log(appBundle))
+         * .catch(console.error)
+         * ```
+         */
+        getAppBundle(id) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppBundle',
+                action: 'get',
+                params: {
+                    appBundleId: id,
+                    appDefinitionId: raw.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                },
+            }).then((data) => wrapAppBundle(makeRequest, data));
+        },
+        /**
+         * Gets a collection of AppBundles
+         * @return Promise for a collection of AppBundles
+         * @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.getAppBundles())
+         * .then((response) => console.log(response.items))
+         * .catch(console.error)
+         * ```
+         */
+        getAppBundles(query = {}) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppBundle',
+                action: 'getMany',
+                params: { organizationId: raw.sys.organization.sys.id, appDefinitionId: raw.sys.id, query },
+            }).then((data) => wrapAppBundleCollection(makeRequest, data));
+        },
+        /**
+         * Creates an app bundle
+         * @param Object representation of the App Bundle to be created
+         * @return Promise for the newly created AppBundle
+         * @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.createAppBundle('<app_upload_id>'))
+         * .then((appBundle) => console.log(appBundle))
+         * .catch(console.error)
+         * ```
+         */
+        createAppBundle(data) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppBundle',
+                action: 'create',
+                params: {
+                    appDefinitionId: raw.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                },
+                payload: data,
+            }).then((data) => wrapAppBundle(makeRequest, data));
+        },
+        /**
+         * Gets a list of App Installations across an org for given organization and App Definition
+         * If a spaceId is provided in the query object, it will return the App Installations for that specific space.
+         * @return Promise for the newly created AppBundle
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         * client.getAppDefinition('<organization_id>', '<app_definition_id>')
+         * .then((appDefinition) => appDefinition.getInstallationsForOrg(
+         *   { spaceId: '<space_id>' } // optional
+         * ))
+         * .then((appInstallationsForOrg) => console.log(appInstallationsForOrg.items))
+         * .catch(console.error)
+         * ```
+         */
+        getInstallationsForOrg(query = {}) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppDefinition',
+                action: 'getInstallationsForOrg',
+                params: {
+                    appDefinitionId: raw.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                    query,
+                },
+            });
+        },
+        /**
+         * Creates or updates a resource provider
+         * @param data representation of the ResourceProvider
+         * @return Promise for the newly created or updated ResourceProvider
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * // You need a valid AppDefinition with an activated AppBundle that has a contentful function configured
+         * client.getOrganization('<org_id>')
+         * .then((org) => org.getAppDefinition('<app_def_id>'))
+         * .then((appDefinition) => appDefinition.upsertResourceProvider({
+         *    sys: {
+         *      id: '<resource_provider_id>'
+         *    },
+         *    type: 'function',
+         *    function: {
+         *      sys: {
+         *        id: '<contentful_function_id>',
+         *        type: 'Link'
+         *        linkType: 'Function'
+         *      }
+         *    }
+         * }))
+         * .then((resourceProvider) => console.log(resourceProvider))
+         * .catch(console.error)
+         * ```
+         */
+        upsertResourceProvider(data) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'upsert',
+                params: {
+                    appDefinitionId: raw.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                },
+                payload: data,
+            }).then((payload) => wrapResourceProvider(makeRequest, payload));
+        },
+        /**
+         * Gets a Resource Provider
+         * @return Promise for a Resource Provider
+         * @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) => console.log(resourceProvider))
+         * .catch(console.error)
+         * ```
+         */
+        getResourceProvider() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'ResourceProvider',
+                action: 'get',
+                params: {
+                    appDefinitionId: raw.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                },
+            }).then((payload) => wrapResourceProvider(makeRequest, payload));
+        },
+    };
+}
+
+export { createAppDefinitionApi as default };

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

@@ -1,13 +1,13 @@
-import type { Collection, MakeRequest, PaginationQueryParams, QueryOptions, QueryParams, GetAppDefinitionParams, CursorPaginatedCollection, GetEnvironmentTemplateParams, BasicCursorPaginationOptions, GetOAuthApplicationParams, GetUserParams } from './common-types';
-import type { Organization, OrganizationProps } from './entities/organization';
-import type { CreatePersonalAccessTokenProps } from './entities/personal-access-token';
-import type { Space, SpaceProps } from './entities/space';
-import type { AppDefinition } from './entities/app-definition';
-import type { UsageQuery } from './entities/usage';
-import type { UserProps } from './entities/user';
-import type { CreateEnvironmentTemplateProps, EnvironmentTemplate, EnvironmentTemplateProps } from './entities/environment-template';
+import type { Collection, MakeRequest, PaginationQueryParams, QueryOptions, QueryParams, GetAppDefinitionParams, CursorPaginatedCollection, GetEnvironmentTemplateParams, BasicCursorPaginationOptions, GetOAuthApplicationParams, GetUserParams } from './common-types.js';
+import { type Organization, type OrganizationProps } from './entities/organization.js';
+import { type CreatePersonalAccessTokenProps } from './entities/personal-access-token.js';
+import { type Space, type SpaceProps } from './entities/space.js';
+import { type AppDefinition } from './entities/app-definition.js';
+import { type UsageQuery } from './entities/usage.js';
+import { type UserProps } from './entities/user.js';
+import { type CreateEnvironmentTemplateProps, type EnvironmentTemplate, type EnvironmentTemplateProps } from './entities/environment-template.js';
 import type { RawAxiosRequestConfig } from 'axios';
-import type { CreateOAuthApplicationProps, OAuthApplication, OAuthApplicationProps } from './export-types';
+import type { CreateOAuthApplicationProps, OAuthApplication, OAuthApplicationProps } from './export-types.js';
 export type ClientAPI = ReturnType<typeof createClientApi>;
 type CreateSpaceProps = Omit<SpaceProps, 'sys'> & {
     defaultLocale?: string;
@@ -35,6 +35,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      */
     getEnvironmentTemplates: (organizationId: string, query?: BasicCursorPaginationOptions & {
         select?: string;
+        forTemplatedSpaces?: boolean;
     }) => Promise<CursorPaginatedCollection<EnvironmentTemplate, EnvironmentTemplateProps>>;
     /**
      * Gets the lasted version environment template if params.version is not specified
@@ -280,7 +281,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    createPersonalAccessToken: (data: CreatePersonalAccessTokenProps) => Promise<import("./export-types").PersonalAccessToken>;
+    createPersonalAccessToken: (data: CreatePersonalAccessTokenProps) => Promise<import("./export-types.js").PersonalAccessToken>;
     /**
      * @deprecated - use getAccessToken instead
      *
@@ -299,7 +300,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPersonalAccessToken: (tokenId: string) => Promise<import("./export-types").PersonalAccessToken>;
+    getPersonalAccessToken: (tokenId: string) => Promise<import("./export-types.js").PersonalAccessToken>;
     /**
      * @deprecated - use getAccessTokens instead
      *
@@ -317,7 +318,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPersonalAccessTokens: () => Promise<Collection<import("./export-types").PersonalAccessToken, import("./export-types").PersonalAccessTokenProps>>;
+    getPersonalAccessTokens: () => Promise<Collection<import("./export-types.js").PersonalAccessToken, import("./export-types.js").PersonalAccessTokenProps>>;
     /**
      * Gets a users access token
      * @param data - users access token config
@@ -334,7 +335,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAccessToken: (tokenId: string) => Promise<import("./export-types").AccessToken>;
+    getAccessToken: (tokenId: string) => Promise<import("./export-types.js").AccessToken>;
     /**
      * Gets all user access tokens
      * @return Promise for a Token
@@ -350,7 +351,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAccessTokens: () => Promise<Collection<import("./export-types").AccessToken, import("./export-types").AccessTokenProp>>;
+    getAccessTokens: () => Promise<Collection<import("./export-types.js").AccessToken, import("./export-types.js").AccessTokenProp>>;
     /**
      * Retrieves a list of redacted versions of access tokens for an organization, accessible to owners or administrators of an organization.
      *
@@ -367,7 +368,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationAccessTokens: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./export-types").AccessToken, import("./export-types").AccessTokenProp>>;
+    getOrganizationAccessTokens: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./export-types.js").AccessToken, import("./export-types.js").AccessTokenProp>>;
     /**
      * Get organization usage grouped by {@link UsageMetricEnum metric}
      *
@@ -392,7 +393,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getOrganizationUsage: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./export-types").Usage, import("./export-types").UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>>;
+    getOrganizationUsage: (organizationId: string, query?: QueryOptions) => Promise<Collection<import("./export-types.js").Usage, import("./export-types.js").UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>>;
     /**
      * Get organization usage grouped by space and metric
      *
@@ -418,7 +419,7 @@ export default function createClientApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getSpaceUsage: (organizationId: string, query?: UsageQuery) => Promise<Collection<import("./export-types").Usage, import("./export-types").UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>>;
+    getSpaceUsage: (organizationId: string, query?: UsageQuery) => Promise<Collection<import("./export-types.js").Usage, import("./export-types.js").UsageProps<"SpacePeriodicUsage" | "OrganizationPeriodicUsage">>>;
     /**
      * Make a custom request to the Contentful management API's /spaces endpoint
      * @param opts - axios request options (https://github.com/mzabriskie/axios)