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

package/dist/types/adapters/REST/endpoints/environment.js

@@ -0,0 +1,45 @@
+import copy from 'fast-copy';
+import { get as get$1, put, del as del$1, post } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}`);
+};
+const getMany = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/environments`, {
+        params: params.query,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}`, data, {
+        headers: {
+            ...headers,
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}`);
+};
+const create = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return post(http, `/spaces/${params.spaceId}/environments`, data, {
+        headers,
+    });
+};
+const createWithId = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}`, data, {
+        headers: {
+            ...headers,
+            ...(params.sourceEnvironmentId
+                ? {
+                    'X-Contentful-Source-Environment': params.sourceEnvironmentId,
+                }
+                : {}),
+        },
+    });
+};
+
+export { create, createWithId, del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/extension.js

@@ -0,0 +1,38 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+import { normalizeSelect } from './utils.js';
+
+const getBaseUrl = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/extensions`;
+const getExtensionUrl = (params) => getBaseUrl(params) + `/${params.extensionId}`;
+const get = (http, params) => {
+    return get$1(http, getExtensionUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: normalizeSelect(params.query),
+    });
+};
+const create = (http, params, rawData, headers) => {
+    return post(http, getBaseUrl(params), rawData, { headers });
+};
+const createWithId = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    return put(http, getExtensionUrl(params), data, { headers });
+};
+const update = async (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    return put(http, getExtensionUrl(params), data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getExtensionUrl(params));
+};
+
+export { create, createWithId, del, get, getExtensionUrl, getMany, update };

package/dist/types/adapters/REST/endpoints/function-log.js

@@ -0,0 +1,24 @@
+import { get as get$1 } from './raw.js';
+
+const FunctionLogAlphaHeaders = {
+    'x-contentful-enable-alpha-feature': 'function-logs',
+};
+const baseURL = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions/${params.functionId}/logs`;
+const getURL = (params) => `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions/${params.functionId}/logs/${params.logId}`;
+const get = (http, params) => {
+    return get$1(http, getURL(params), {
+        headers: {
+            ...FunctionLogAlphaHeaders,
+        },
+    });
+};
+const getMany = (http, params) => {
+    return get$1(http, baseURL(params), {
+        params: params.query,
+        headers: {
+            ...FunctionLogAlphaHeaders,
+        },
+    });
+};
+
+export { get, getMany };

package/dist/types/adapters/REST/endpoints/function.js

@@ -0,0 +1,21 @@
+import { get as get$1 } from './raw.js';
+
+// Base URL
+const getManyUrl = (params) => `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/functions`;
+const getFunctionUrl = (params) => `${getManyUrl(params)}/${params.functionId}`;
+const getFunctionsEnvURL = (params) => {
+    return `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions`;
+};
+const get = (http, params) => {
+    return get$1(http, getFunctionUrl(params));
+};
+const getMany = (http, params) => {
+    return get$1(http, getManyUrl(params), { params: params.query });
+};
+const getManyForEnvironment = (http, params) => {
+    return get$1(http, getFunctionsEnvURL(params), {
+        params: params.query,
+    });
+};
+
+export { get, getMany, getManyForEnvironment };

package/dist/types/adapters/REST/endpoints/http.js

@@ -0,0 +1,22 @@
+import { get as get$1, post as post$1, put as put$1, patch as patch$1, del as del$1, http } from './raw.js';
+
+const get = (http, { url, config }) => {
+    return get$1(http, url, config);
+};
+const post = (http, { url, config }, payload) => {
+    return post$1(http, url, payload, config);
+};
+const put = (http, { url, config }, payload) => {
+    return put$1(http, url, payload, config);
+};
+const patch = (http, { url, config }, payload) => {
+    return patch$1(http, url, payload, config);
+};
+const del = (http, { url, config }) => {
+    return del$1(http, url, config);
+};
+const request = (http$1, { url, config }) => {
+    return http(http$1, url, config);
+};
+
+export { del, get, patch, post, put, request };

package/dist/{esm/entities → types/adapters/REST/endpoints}/index.js

@@ -1,22 +1,25 @@
 import * as aiAction from './ai-action.js';
 import * as aiActionInvocation from './ai-action-invocation.js';
+import * as accessToken from './access-token.js';
 import * as apiKey from './api-key.js';
+import * as appAccessToken from './app-access-token.js';
 import * as appAction from './app-action.js';
 import * as appActionCall from './app-action-call.js';
 import * as appBundle from './app-bundle.js';
 import * as appDefinition from './app-definition.js';
 import * as appDetails from './app-details.js';
+import * as appEventSubscription from './app-event-subscription.js';
 import * as appInstallation from './app-installation.js';
+import * as appKey from './app-key.js';
 import * as appSignedRequest from './app-signed-request.js';
 import * as appSigningSecret from './app-signing-secret.js';
-import * as appEventSubscription from './app-event-subscription.js';
-import * as appKey from './app-key.js';
-import * as appAccessToken from './app-access-token.js';
 import * as appUpload from './app-upload.js';
 import * as asset from './asset.js';
 import * as assetKey from './asset-key.js';
 import * as bulkAction from './bulk-action.js';
 import * as comment from './comment.js';
+import * as concept from './concept.js';
+import * as conceptScheme from './concept-scheme.js';
 import * as contentType from './content-type.js';
 import * as editorInterface from './editor-interface.js';
 import * as entry from './entry.js';
@@ -27,16 +30,19 @@ import * as environmentTemplateInstallation from './environment-template-install
 import * as extension from './extension.js';
 import * as _function from './function.js';
 import * as functionLog from './function-log.js';
+import * as http from './http.js';
 import * as locale from './locale.js';
-import * as oauthApplication from './oauth-application.js';
 import * as organization from './organization.js';
 import * as organizationInvitation from './organization-invitation.js';
 import * as organizationMembership from './organization-membership.js';
+import * as oauthApplication from './oauth-application.js';
 import * as personalAccessToken from './personal-access-token.js';
-import * as accessToken from './access-token.js';
 import * as previewApiKey from './preview-api-key.js';
 import * as release from './release.js';
 import * as releaseAction from './release-action.js';
+import * as resource from './resource.js';
+import * as resourceProvider from './resource-provider.js';
+import * as resourceType from './resource-type.js';
 import * as role from './role.js';
 import * as scheduledAction from './scheduled-action.js';
 import * as snapshot from './snapshot.js';
@@ -50,80 +56,82 @@ import * as teamMembership from './team-membership.js';
 import * as teamSpaceMembership from './team-space-membership.js';
 import * as uiConfig from './ui-config.js';
 import * as upload from './upload.js';
+import * as uploadCredentials from './upload-credentials.js';
 import * as usage from './usage.js';
 import * as user from './user.js';
 import * as userUiConfig from './user-ui-config.js';
 import * as webhook from './webhook.js';
+import * as workflow from './workflow.js';
 import * as workflowDefinition from './workflow-definition.js';
-import * as concept from './concept.js';
-import * as conceptScheme from './concept-scheme.js';
-import * as resourceProvider from './resource-provider.js';
-import * as resourceType from './resource-type.js';
-import * as resource from './resource.js';
+import * as workflowsChangelog from './workflows-changelog.js';
 
-var entities = {
-    aiAction,
-    aiActionInvocation,
-    accessToken,
-    appAction,
-    appActionCall,
-    appBundle,
-    apiKey,
-    appDefinition,
-    appInstallation,
-    appUpload,
-    appDetails,
-    appSignedRequest,
-    appSigningSecret,
-    appEventSubscription,
-    appKey,
-    appAccessToken,
-    asset,
-    assetKey,
-    bulkAction,
-    comment,
-    concept,
-    conceptScheme,
-    contentType,
-    editorInterface,
-    entry,
-    environment,
-    environmentAlias,
-    environmentTemplate,
-    environmentTemplateInstallation,
-    extension,
-    func: _function,
-    functionLog,
-    locale,
-    oauthApplication,
-    organization,
-    organizationInvitation,
-    organizationMembership,
-    personalAccessToken,
-    previewApiKey,
-    release,
-    releaseAction,
-    resourceProvider,
-    resourceType,
-    resource,
-    role,
-    scheduledAction,
-    snapshot,
-    space,
-    spaceMember,
-    spaceMembership,
-    tag,
-    task,
-    team,
-    teamMembership,
-    teamSpaceMembership,
-    uiConfig,
-    upload,
-    usage,
-    user,
-    userUIConfig: userUiConfig,
-    webhook,
-    workflowDefinition,
+var endpoints = {
+    AiAction: aiAction,
+    AiActionInvocation: aiActionInvocation,
+    ApiKey: apiKey,
+    AppAction: appAction,
+    AppActionCall: appActionCall,
+    AppBundle: appBundle,
+    AppDefinition: appDefinition,
+    AppInstallation: appInstallation,
+    AppUpload: appUpload,
+    AppSignedRequest: appSignedRequest,
+    AppSigningSecret: appSigningSecret,
+    AppEventSubscription: appEventSubscription,
+    AppKey: appKey,
+    AppAccessToken: appAccessToken,
+    AppDetails: appDetails,
+    Asset: asset,
+    AssetKey: assetKey,
+    BulkAction: bulkAction,
+    Comment: comment,
+    Concept: concept,
+    ConceptScheme: conceptScheme,
+    ContentType: contentType,
+    EditorInterface: editorInterface,
+    Entry: entry,
+    Environment: environment,
+    EnvironmentAlias: environmentAlias,
+    EnvironmentTemplate: environmentTemplate,
+    EnvironmentTemplateInstallation: environmentTemplateInstallation,
+    Extension: extension,
+    Function: _function,
+    FunctionLog: functionLog,
+    Http: http,
+    Locale: locale,
+    Organization: organization,
+    OrganizationInvitation: organizationInvitation,
+    OrganizationMembership: organizationMembership,
+    OAuthApplication: oauthApplication,
+    PersonalAccessToken: personalAccessToken,
+    AccessToken: accessToken,
+    PreviewApiKey: previewApiKey,
+    Release: release,
+    ReleaseAction: releaseAction,
+    Resource: resource,
+    ResourceProvider: resourceProvider,
+    ResourceType: resourceType,
+    Role: role,
+    ScheduledAction: scheduledAction,
+    Snapshot: snapshot,
+    Space: space,
+    SpaceMember: spaceMember,
+    SpaceMembership: spaceMembership,
+    Tag: tag,
+    Task: task,
+    Team: team,
+    TeamMembership: teamMembership,
+    TeamSpaceMembership: teamSpaceMembership,
+    UIConfig: uiConfig,
+    Upload: upload,
+    UploadCredential: uploadCredentials,
+    Usage: usage,
+    User: user,
+    UserUIConfig: userUiConfig,
+    Webhook: webhook,
+    WorkflowDefinition: workflowDefinition,
+    Workflow: workflow,
+    WorkflowsChangelog: workflowsChangelog,
 };
 
-export { entities as default };
+export { endpoints as default };

package/dist/types/adapters/REST/endpoints/locale.js

@@ -0,0 +1,33 @@
+import copy from 'fast-copy';
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+import { normalizeSelect } from './utils.js';
+
+const get = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/locales/${params.localeId}`);
+};
+const getMany = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/locales`, {
+        params: normalizeSelect(params.query),
+    });
+};
+const create = (http, params, data, headers) => {
+    return post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/locales`, data, {
+        headers,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    delete data.default; // we should not send this back
+    return put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/locales/${params.localeId}`, data, {
+        headers: {
+            ...headers,
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/locales/${params.localeId}`);
+};
+
+export { create, del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/oauth-application.js

@@ -0,0 +1,141 @@
+import { get as get$1, post, put, del as del$1 } from './raw.js';
+
+/**
+ * Retrieves details of a specific OAuth application. by its unique user ID and oauth application ID.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {Object} params - Parameters for the request.
+ * @param {string} params.userId - The unique user ID of the user.
+ * @param {string} params.oauthApplicationId - The unique application ID of the OAuth application.
+ * @returns {Promise<OAuthApplicationProps>} A Promise that resolves with the retrieved OAuth Application.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *   accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.get({userId: 'TestUserId', oauthApplicationId: 'TestOAuthAppId'})
+ *  .then(oauthApplication => console.log(oauthApplication))
+ *  .catch(console.error)
+ * ```
+ */
+const get = (http, params) => {
+    return get$1(http, `/users/${params.userId}/oauth_applications/${params.oauthApplicationId}`);
+};
+/**
+ * Retrieves a list of OAuth applications associated with the current user.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {Object} params - Parameters for the request.
+ * @param {string} params.userId - The unique user ID of the user.
+ * @param {QueryParams} params - Query parameters to filter and customize the request.
+ * @returns {Promise<CursorPaginatedCollectionProp<OAuthApplicationProps>>} A Promise that resolves with a collection of oauth application properties.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.getManyForUser({userId: 'TestUserId'})
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const getManyForUser = (http, params) => {
+    return get$1(http, `/users/${params.userId}/oauth_applications`, {
+        params: params.query,
+    });
+};
+/**
+ * Creates a new OAuth application for current authenticated user.
+ *
+ * @param {AxiosInstance} http - Axios instance for making the HTTP request.
+ * @param {Object} params - Parameters for the request.
+ * @param {string} params.userId - The unique user ID of the user.
+ * @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.
+ * @returns {Promise<OAuthApplicationProps>} A Promise that resolves with the created oauth application.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>',
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.create(
+ *  {userId: 'TestUserId'},
+ *  {name: 'Test-Name', description: 'Test-Desc', scopes: ['content_management_manage'], redirectUri: 'https://redirect.uri.com', confidential: true}
+ *  )
+ *  .then(oauthApplication => console.log(oauthApplication))
+ *  .catch(console.error)
+ * ```
+ */
+const create = (http, params, rawData, headers) => {
+    return post(http, `/users/${params.userId}/oauth_applications`, rawData, {
+        headers,
+    });
+};
+/**
+ * Updates details of a specific OAuth application.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {Object} params - The parameters for updating oauth application.
+ * @param {string} params.userId - The unique user ID of the user.
+ * @param {string} params.oauthApplicationId - The unique application ID of the OAuth application.
+ * @returns {Promise<OAuthApplicationProps>} A Promise that resolves with the updated oauth application.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.update(
+ * {userId: 'TestUserId', oauthApplicationId: 'TestOAuthAppId'},
+ * {name: 'Test-Name', description: 'Test-Desc', scope: ['content_management_manage'], redirectUri: 'https://redirect.uri.com', confidential: true}
+ * )
+ *  .then(oauthApplication => console.log(oauthApplication))
+ *  .catch(console.error)
+ * ```
+ */
+const update = (http, params, rawData, headers) => {
+    return put(http, `/users/${params.userId}/oauth_applications/${params.oauthApplicationId}`, rawData, {
+        headers,
+    });
+};
+/**
+ * Deletes a specific OAuth application.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {Object} params - The parameters for deleting oauth application.
+ * @param {string} params.userId - The unique user ID of the user.
+ * @param {string} params.oauthApplicationId - The unique application ID of the OAuth application.
+ * @returns {Promise<void>}
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.del({userId: 'TestUserId', oauthApplicationId: 'TestOAuthAppId'}) })
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const del = (http, params) => {
+    return del$1(http, `/users/${params.userId}/oauth_applications/${params.oauthApplicationId}`);
+};
+
+export { create, del, get, getManyForUser, update };

package/dist/types/adapters/REST/endpoints/organization-invitation.js

@@ -0,0 +1,26 @@
+import { post, get as get$1 } from './raw.js';
+
+const OrganizationUserManagementAlphaHeaders = {
+    'x-contentful-enable-alpha-feature': 'organization-user-management-api',
+};
+const InvitationAlphaHeaders = {
+    'x-contentful-enable-alpha-feature': 'pending-org-membership',
+};
+const create = (http, params, data, headers) => {
+    return post(http, `/organizations/${params.organizationId}/invitations`, data, {
+        headers: {
+            ...InvitationAlphaHeaders,
+            ...headers,
+        },
+    });
+};
+const get = (http, params, headers) => {
+    return get$1(http, `/organizations/${params.organizationId}/invitations/${params.invitationId}`, {
+        headers: {
+            ...OrganizationUserManagementAlphaHeaders,
+            ...headers,
+        },
+    });
+};
+
+export { create, get };

package/dist/types/adapters/REST/endpoints/organization-membership.js

@@ -0,0 +1,29 @@
+import copy from 'fast-copy';
+import { get as get$1, put, del as del$1 } from './raw.js';
+
+const getBaseUrl = (params) => `/organizations/${params.organizationId}/organization_memberships`;
+const getEntityUrl = (params) => `${getBaseUrl(params)}/${params.organizationMembershipId}`;
+const get = (http, params) => {
+    return get$1(http, getEntityUrl(params));
+};
+const getMany = (http, params) => {
+    return get$1(http, getBaseUrl(params), {
+        params: params.query,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    delete data.sys;
+    const { role } = data;
+    return put(http, getEntityUrl(params), { role }, {
+        headers: {
+            ...headers,
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+        },
+    });
+};
+const del = (http, params) => {
+    return del$1(http, getEntityUrl(params));
+};
+
+export { del, get, getMany, update };

package/dist/types/adapters/REST/endpoints/organization.js

@@ -0,0 +1,25 @@
+import { get as get$1 } from './raw.js';
+
+const getMany = (http, params) => {
+    return get$1(http, `/organizations`, {
+        params: params?.query,
+    });
+};
+const get = (http, params) => {
+    return getMany(http, { query: { limit: 100 } }).then((data) => {
+        const org = data.items.find((org) => org.sys.id === params.organizationId);
+        if (!org) {
+            const error = new Error(`No organization was found with the ID ${params.organizationId} instead got ${JSON.stringify(data)}`);
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            error.status = 404;
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            error.statusText = 'Not Found';
+            return Promise.reject(error);
+        }
+        return org;
+    });
+};
+
+export { get, getMany };

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

@@ -0,0 +1,32 @@
+import { get as get$1, post, put } from './raw.js';
+
+/**
+ * @deprecated use `access-token.get` instead `personal-access-token.get`
+ */
+const get = (http, params) => {
+    return get$1(http, `/users/me/access_tokens/${params.tokenId}`);
+};
+/**
+ * @deprecated use `access-token.getMany` instead `personal-access-token.getMany`
+ */
+const getMany = (http, params) => {
+    return get$1(http, '/users/me/access_tokens', {
+        params: params.query,
+    });
+};
+/**
+ * @deprecated use `access-token.createPersonalAccessToken` instead. `personal-access-token.create`
+ */
+const create = (http, _params, rawData, headers) => {
+    return post(http, '/users/me/access_tokens', rawData, {
+        headers,
+    });
+};
+/**
+ * @deprecated use `access-token.rovoke` instead. `personal-access-token.revoke`
+ */
+const revoke = (http, params) => {
+    return put(http, `/users/me/access_tokens/${params.tokenId}/revoked`, null);
+};
+
+export { create, get, getMany, revoke };

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

@@ -0,0 +1,12 @@
+import { get as get$1 } from './raw.js';
+
+const get = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/preview_api_keys/${params.previewApiKeyId}`);
+};
+const getMany = (http, params) => {
+    return get$1(http, `/spaces/${params.spaceId}/preview_api_keys`, {
+        params: params.query,
+    });
+};
+
+export { get, getMany };