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

package/dist/types/adapters/REST/endpoints/access-token.js

@@ -0,0 +1,130 @@
+import { get as get$1, post, put } from './raw.js';
+
+/**
+ * Retrieves an access token by its unique token ID for the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {Object} params - Parameters for the request.
+ * @param {string} params.tokenId - The unique token ID of the access token to retrieve.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the retrieved access token information.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *   accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.get({tokenId: 'TestTokenTd'})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const get = (http, params) => {
+    return get$1(http, `/users/me/access_tokens/${params.tokenId}`);
+};
+/**
+ * Retrieves multiple access tokens associated with the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {QueryParams} params - Query parameters to filter and customize the request.
+ * @returns {Promise<CollectionProp<AccessTokenProps>>} A Promise that resolves with a collection of access token properties.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.getMany()
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const getMany = (http, params) => {
+    return get$1(http, '/users/me/access_tokens', {
+        params: params.query,
+    });
+};
+/**
+ * Creates a personal access token for the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - Axios instance for making the HTTP request.
+ * @param {Object} _params - Unused parameters (can be an empty object).
+ * @param {CreatePersonalAccessTokenProps} rawData - Data for creating the personal access token.
+ * @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the created personal access token.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>',
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.createPersonalAccessToken({name: 'Test-Name', scope: ['content_management_manage'], expiresIn: 777596.92})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const createPersonalAccessToken = (http, _params, rawData, headers) => {
+    return post(http, '/users/me/access_tokens', rawData, {
+        headers,
+    });
+};
+/**
+ * Revokes an access token associated with the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {Object} params - The parameters for revoking the access token.
+ * @param {string} params.tokenId - The unique identifier of the access token to revoke.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the updated access token information after revocation.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.revoke({tokenId: 'TestTokenTd'})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const revoke = (http, params) => {
+    return put(http, `/users/me/access_tokens/${params.tokenId}/revoked`, null);
+};
+/**
+ * Retrieves a list of redacted versions of access tokens for an organization, accessible to owners or administrators of an organization.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {GetOrganizationParams & QueryParams} params - Parameters for the request, including organization ID and query parameters.
+ * @param {string} params.organizationId - The unique identifier of the organization.
+ * @returns {Promise<CollectionProp<AccessTokenProps>>} A promise that resolves to a collection of access tokens.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.getManyForOrganization({organizationId: 'OrgId'})
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const getManyForOrganization = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/access_tokens`, {
+        params: params.query,
+    });
+};
+
+export { createPersonalAccessToken, get, getMany, getManyForOrganization, revoke };

package/dist/types/adapters/REST/endpoints/ai-action-invocation.js

@@ -0,0 +1,7 @@
+import { get as get$1 } from './raw.js';
+
+const get = (http, params, headers) => {
+    return get$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invocations/${params.invocationId}`, { headers });
+};
+
+export { get };

package/dist/types/adapters/REST/endpoints/ai-action.js

@@ -0,0 +1,48 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+
+const get = (http, params, headers) => {
+    return get$1(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {
+        headers,
+    });
+};
+const getMany = (http, params, headers) => {
+    return get$1(http, `/spaces/${params.spaceId}/ai/actions`, {
+        params: params.query,
+        headers,
+    });
+};
+const create = (http, params, data, headers) => {
+    return post(http, `/spaces/${params.spaceId}/ai/actions`, data, { headers });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    const { sys, ...payload } = data;
+    return put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, payload, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params, headers) => {
+    return del$1(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, { headers });
+};
+const publish = (http, params, rawData, headers) => {
+    return put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, null, {
+        headers: {
+            'X-Contentful-Version': params.version,
+            ...headers,
+        },
+    });
+};
+const unpublish = (http, params, headers) => {
+    return del$1(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, {
+        headers,
+    });
+};
+const invoke = (http, params, data, headers) => {
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invoke`, data, { headers });
+};
+
+export { create, del, get, getMany, invoke, publish, unpublish, update };

package/dist/types/adapters/REST/endpoints/api-key.js

@@ -0,0 +1,43 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`);
+};
+const getMany = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/api_keys`, {
+        params: params.query,
+    });
+};
+const create = (http, params, data, headers) => {
+    return post(http, `/spaces/${params.spaceId}/api_keys`, data, { headers });
+};
+const createWithId = (http, params, data, headers) => {
+    return put(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {
+        headers,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    if ('accessToken' in data) {
+        delete data.accessToken;
+    }
+    if ('preview_api_key' in data) {
+        delete data.preview_api_key;
+    }
+    if ('policies' in data) {
+        delete data.policies;
+    }
+    delete data.sys;
+    return put(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`);
+};
+
+export { create, createWithId, del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/app-access-token.js

@@ -0,0 +1,7 @@
+import { post } from './raw.js';
+
+const create = (http, params, data) => {
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/access_tokens`, undefined, { headers: { Authorization: `Bearer ${data.jwt}` } });
+};
+
+export { create };

package/dist/types/adapters/REST/endpoints/app-action-call.js

@@ -0,0 +1,60 @@
+import { post, get } from './raw.js';
+import { isSuccessful, shouldRePoll, waitFor } from '../../../common-utils.js';
+
+const create = (http, params, data) => {
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/actions/${params.appActionId}/calls`, data);
+};
+const getCallDetails = (http, params) => {
+    return get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/actions/${params.appActionId}/calls/${params.callId}`);
+};
+const APP_ACTION_CALL_RETRY_INTERVAL = 2000;
+const APP_ACTION_CALL_RETRIES = 15;
+async function callAppActionResult(http, params, { callId, }) {
+    let checkCount = 1;
+    const retryInterval = params.retryInterval || APP_ACTION_CALL_RETRY_INTERVAL;
+    const retries = params.retries || APP_ACTION_CALL_RETRIES;
+    return new Promise((resolve, reject) => {
+        const poll = async () => {
+            try {
+                const result = await getCallDetails(http, { ...params, callId: callId });
+                // The lambda failed or returned a 404, so we shouldn't re-poll anymore
+                if (result?.response?.statusCode && !isSuccessful(result?.response?.statusCode)) {
+                    const error = new Error('App action not found or lambda fails');
+                    reject(error);
+                }
+                else if (isSuccessful(result.statusCode)) {
+                    resolve(result);
+                }
+                // The logs are not ready yet. Continue waiting for them
+                else if (shouldRePoll(result.statusCode) && checkCount < retries) {
+                    checkCount++;
+                    await waitFor(retryInterval);
+                    poll();
+                }
+                // If the response status code is not successful and is not a status code that should be repolled, reject with an error immediately
+                else {
+                    const error = new Error('The app action response is taking longer than expected to process.');
+                    reject(error);
+                }
+            }
+            catch (error) {
+                checkCount++;
+                if (checkCount > retries) {
+                    reject(new Error('The app action response is taking longer than expected to process.'));
+                    return;
+                }
+                // If `appActionCalls.getCallDetails` throws, we re-poll as it might mean that the lambda result is not available in the webhook logs yet
+                await waitFor(retryInterval);
+                poll();
+            }
+        };
+        poll();
+    });
+}
+const createWithResponse = async (http, params, data) => {
+    const createResponse = await post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/actions/${params.appActionId}/calls`, data);
+    const callId = createResponse.sys.id;
+    return callAppActionResult(http, params, { callId });
+};
+
+export { create, createWithResponse, getCallDetails };

package/dist/types/adapters/REST/endpoints/app-action.js

@@ -0,0 +1,35 @@
+import { get as get$1, del as del$1, post, put } from './raw.js';
+import { normalizeSelect } from './utils.js';
+
+const getBaseUrl = (params) => `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/actions`;
+const getAppActionUrl = (params) => `${getBaseUrl(params)}/${params.appActionId}`;
+const getAppActionsEnvUrl = (params) => {
+    if (params.environmentId) {
+        return `/spaces/${params.spaceId}/environments/${params.environmentId}/actions`;
+    }
+    return `/spaces/${params.spaceId}/actions`;
+};
+const get = (http, params) => {
+    return get$1(http, getAppActionUrl(params));
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getManyForEnvironment = (http, params) => {
+    return get$1(http, getAppActionsEnvUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getAppActionUrl(params));
+};
+const create = (http, params, data) => {
+    return post(http, getBaseUrl(params), data);
+};
+const update = (http, params, data) => {
+    return put(http, getAppActionUrl(params), data);
+};
+
+export { create, del, get, getMany, getManyForEnvironment, update };

package/dist/types/adapters/REST/endpoints/app-bundle.js

@@ -0,0 +1,34 @@
+import { get as get$1, del as del$1, post } from './raw.js';
+import { normalizeSelect } from './utils.js';
+
+const getBaseUrl = (params) => `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/app_bundles`;
+const getAppBundleUrl = (params) => `${getBaseUrl(params)}/${params.appBundleId}`;
+const get = (http, params) => {
+    return get$1(http, getAppBundleUrl(params));
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getAppBundleUrl(params));
+};
+const create = (http, params, payload) => {
+    const { appUploadId, comment, actions, functions } = payload;
+    const data = {
+        upload: {
+            sys: {
+                type: 'Link',
+                linkType: 'AppUpload',
+                id: appUploadId,
+            },
+        },
+        comment,
+        actions,
+        functions,
+    };
+    return post(http, getBaseUrl(params), data);
+};
+
+export { create, del, get, getMany };

package/dist/types/adapters/REST/endpoints/app-definition.js

@@ -0,0 +1,44 @@
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+import copy from 'fast-copy';
+import { normalizeSelect, normalizeSpaceId } from './utils.js';
+
+const getBaseUrl = (params) => `/organizations/${params.organizationId}/app_definitions`;
+const getAppDefinitionUrl = (params) => getBaseUrl(params) + `/${params.appDefinitionId}`;
+const getBaseUrlForOrgInstallations = (params) => `/app_definitions/${params.appDefinitionId}/app_installations`;
+const get = (http, params) => {
+    return get$1(http, getAppDefinitionUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: params.query,
+    });
+};
+const create = (http, params, rawData) => {
+    const data = copy(rawData);
+    return post(http, getBaseUrl(params), data);
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getAppDefinitionUrl(params), data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getAppDefinitionUrl(params));
+};
+const getInstallationsForOrg = (http, params) => {
+    return get$1(http, getBaseUrlForOrgInstallations(params), {
+        params: {
+            ...normalizeSpaceId(normalizeSelect(params.query)),
+            'sys.organization.sys.id[in]': params.organizationId,
+        },
+    });
+};
+
+export { create, del, get, getAppDefinitionUrl, getInstallationsForOrg, getMany, update };

package/dist/types/adapters/REST/endpoints/app-details.js

@@ -0,0 +1,13 @@
+import { get as get$1, put, del as del$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/details`);
+};
+const upsert = (http, params, data) => {
+    return put(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/details`, data);
+};
+const del = (http, params) => {
+    return del$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/details`);
+};
+
+export { del, get, upsert };

package/dist/types/adapters/REST/endpoints/app-event-subscription.js

@@ -0,0 +1,13 @@
+import { get as get$1, put, del as del$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/event_subscription`);
+};
+const upsert = (http, params, data) => {
+    return put(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/event_subscription`, data);
+};
+const del = (http, params) => {
+    return del$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/event_subscription`);
+};
+
+export { del, get, upsert };

package/dist/types/adapters/REST/endpoints/app-installation.js

@@ -0,0 +1,41 @@
+import { get as get$1, put, del as del$1 } from './raw.js';
+import { normalizeSelect, normalizeSpaceId } from './utils.js';
+import copy from 'fast-copy';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations`;
+const getBaseUrlForOrgInstallations = (params) => `/app_definitions/${params.appDefinitionId}/app_installations`;
+const getAppInstallationUrl = (params) => getBaseUrl(params) + `/${params.appDefinitionId}`;
+const get = (http, params) => {
+    return get$1(http, getAppInstallationUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const upsert = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return put(http, getAppInstallationUrl(params), data, {
+        headers: {
+            ...headers,
+            ...(params.acceptAllTerms && {
+                'X-Contentful-Marketplace': 'i-accept-end-user-license-agreement,i-accept-marketplace-terms-of-service,i-accept-privacy-policy',
+            }),
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getAppInstallationUrl(params));
+};
+const getForOrganization = (http, params) => {
+    return get$1(http, getBaseUrlForOrgInstallations(params), {
+        params: {
+            ...normalizeSpaceId(normalizeSelect(params.query)),
+            'sys.organization.sys.id[in]': params.organizationId,
+        },
+    });
+};
+
+export { del, get, getAppInstallationUrl, getForOrganization, getMany, upsert };

package/dist/types/adapters/REST/endpoints/app-key.js

@@ -0,0 +1,16 @@
+import { get as get$1, post, del as del$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/keys/${params.fingerprint}`);
+};
+const getMany = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/keys`);
+};
+const create = (http, params, data) => {
+    return post(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/keys`, data);
+};
+const del = (http, params) => {
+    return del$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/keys/${params.fingerprint}`);
+};
+
+export { create, del, get, getMany };

package/dist/types/adapters/REST/endpoints/app-signed-request.js

@@ -0,0 +1,7 @@
+import { post } from './raw.js';
+
+const create = (http, params, data) => {
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/signed_requests`, data);
+};
+
+export { create };

package/dist/types/adapters/REST/endpoints/app-signing-secret.js

@@ -0,0 +1,13 @@
+import { get as get$1, put, del as del$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/signing_secret`);
+};
+const upsert = (http, params, data) => {
+    return put(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/signing_secret`, data);
+};
+const del = (http, params) => {
+    return del$1(http, `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/signing_secret`);
+};
+
+export { del, get, upsert };

package/dist/types/adapters/REST/endpoints/app-upload.js

@@ -0,0 +1,24 @@
+import { get as get$1, del as del$1, post } from './raw.js';
+import { getUploadHttpClient } from '../../../upload-http-client.js';
+
+const getBaseUrl = (params) => `/organizations/${params.organizationId}/app_uploads`;
+const getAppUploadUrl = (params) => `${getBaseUrl(params)}/${params.appUploadId}`;
+const get = (http, params) => {
+    const httpUpload = getUploadHttpClient(http);
+    return get$1(httpUpload, getAppUploadUrl(params));
+};
+const del = (http, params) => {
+    const httpUpload = getUploadHttpClient(http);
+    return del$1(httpUpload, getAppUploadUrl(params));
+};
+const create = (http, params, payload) => {
+    const httpUpload = getUploadHttpClient(http);
+    const { file } = payload;
+    return post(httpUpload, getBaseUrl(params), file, {
+        headers: {
+            'Content-Type': 'application/octet-stream',
+        },
+    });
+};
+
+export { create, del, get };

package/dist/types/adapters/REST/endpoints/asset-key.js

@@ -0,0 +1,31 @@
+import { post } from './raw.js';
+
+const ASSET_KEY_MAX_LIFETIME = 48 * 60 * 60;
+class ValidationError extends Error {
+    constructor(name, message) {
+        super(`Invalid "${name}" provided, ` + message);
+        this.name = 'ValidationError';
+    }
+}
+const validateTimestamp = (name, timestamp, options) => {
+    options = options || {};
+    if (typeof timestamp !== 'number') {
+        throw new ValidationError(name, `only numeric values are allowed for timestamps, provided type was "${typeof timestamp}"`);
+    }
+    if (options.maximum && timestamp > options.maximum) {
+        throw new ValidationError(name, `value (${timestamp}) cannot be further in the future than expected maximum (${options.maximum})`);
+    }
+    if (options.now && timestamp < options.now) {
+        throw new ValidationError(name, `value (${timestamp}) cannot be in the past, current time was ${options.now}`);
+    }
+};
+const create = (http, params, data) => {
+    const expiresAt = data.expiresAt;
+    const now = Math.floor(Date.now() / 1000);
+    const currentMaxLifetime = now + ASSET_KEY_MAX_LIFETIME;
+    validateTimestamp('expiresAt', expiresAt, { maximum: currentMaxLifetime, now });
+    const postParams = { expiresAt };
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/asset_keys`, postParams);
+};
+
+export { ValidationError, create };