contentful-management 11.64.0 → 11.66.0

package/dist/es-modules/adapters/REST/endpoints/index.js

@@ -47,6 +47,10 @@ import * as ResourceProvider from './resource-provider';
 import * as ResourceType from './resource-type';
 import * as Role from './role';
 import * as ScheduledAction from './scheduled-action';
+import * as SemanticDuplicates from './semantic-duplicates';
+import * as SemanticRecommendations from './semantic-recommendations';
+import * as SemanticReferenceSuggestions from './semantic-reference-suggestions';
+import * as SemanticSearch from './semantic-search';
 import * as Snapshot from './snapshot';
 import * as Space from './space';
 import * as SpaceMember from './space-member';
@@ -62,6 +66,7 @@ import * as UploadCredential from './upload-credentials';
 import * as Usage from './usage';
 import * as User from './user';
 import * as UserUIConfig from './user-ui-config';
+import * as VectorizationStatus from './vectorization-status';
 import * as Webhook from './webhook';
 import * as Workflow from './workflow';
 import * as WorkflowDefinition from './workflow-definition';
@@ -116,6 +121,10 @@ export default {
   ResourceType,
   Role,
   ScheduledAction,
+  SemanticDuplicates,
+  SemanticRecommendations,
+  SemanticReferenceSuggestions,
+  SemanticSearch,
   Snapshot,
   Space,
   SpaceMember,
@@ -131,6 +140,7 @@ export default {
   Usage,
   User,
   UserUIConfig,
+  VectorizationStatus,
   Webhook,
   WorkflowDefinition,
   Workflow,

package/dist/es-modules/adapters/REST/endpoints/semantic-duplicates.js

@@ -0,0 +1,6 @@
+import * as raw from './raw';
+export const get = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/semantic/duplicates`, data, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/semantic-recommendations.js

@@ -0,0 +1,6 @@
+import * as raw from './raw';
+export const get = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/semantic/recommendations`, data, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/semantic-reference-suggestions.js

@@ -0,0 +1,6 @@
+import * as raw from './raw';
+export const get = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/semantic/reference-suggestions`, data, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/semantic-search.js

@@ -0,0 +1,6 @@
+import * as raw from './raw';
+export const get = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/semantic/search`, data, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/vectorization-status.js

@@ -0,0 +1,11 @@
+import * as raw from './raw';
+export const get = (http, params, headers) => {
+  return raw.get(http, `/organizations/${params.organizationId}/semantic/vectorization-status`, {
+    headers
+  });
+};
+export const update = (http, params, data, headers) => {
+  return raw.post(http, `/organizations/${params.organizationId}/semantic/vectorization-status`, data, {
+    headers
+  });
+};

package/dist/es-modules/create-environment-api.js

@@ -91,6 +91,18 @@ export default function createEnvironmentApi(makeRequest) {
   const {
     wrapResourceCollection
   } = entities.resource;
+  const {
+    wrapSemanticDuplicates
+  } = entities.semanticDuplicates;
+  const {
+    wrapSemanticRecommendations
+  } = entities.semanticRecommendations;
+  const {
+    wrapSemanticReferenceSuggestions
+  } = entities.semanticReferenceSuggestions;
+  const {
+    wrapSemanticSearch
+  } = entities.semanticSearch;
   return {
     /**
      * Deletes the environment
@@ -830,6 +842,39 @@ export default function createEnvironmentApi(makeRequest) {
         }
       }).then(data => wrapEntryCollection(makeRequest, data));
     },
+    /**
+     * Gets a collection of published Entries with cursor based pagination
+     * @param query - Object with cursor pagination parameters. Check the <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/cursor-pagination">REST API reference</a> for more details.
+     * @return Promise for a collection of published Entries
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getPublishedEntriesWithCursor())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getPublishedEntriesWithCursor(query = {}) {
+      const raw = this.toPlainObject();
+      const normalizedQueryParams = normalizeCursorPaginationParameters(query);
+      return makeRequest({
+        entityType: 'Entry',
+        action: 'getPublished',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          query: createRequestConfig({
+            query: normalizedQueryParams
+          }).params
+        }
+      }).then(data => wrapEntryTypeCursorPaginatedCollection(makeRequest, normalizeCursorPaginationResponse(data)));
+    },
     /**
      * Creates a Entry
      * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -1081,6 +1126,39 @@ export default function createEnvironmentApi(makeRequest) {
         }
       }).then(data => wrapAssetCollection(makeRequest, data));
     },
+    /**
+     * Gets a collection of published Assets with cursor based pagination
+     * @param query - Object with cursor pagination parameters. Check the <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/cursor-pagination">REST API reference</a> for more details.
+     * @return Promise for a collection of published Assets
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getPublishedAssetsWithCursor())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getPublishedAssetsWithCursor(query = {}) {
+      const raw = this.toPlainObject();
+      const normalizedQueryParams = normalizeCursorPaginationParameters(query);
+      return makeRequest({
+        entityType: 'Asset',
+        action: 'getPublished',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          query: createRequestConfig({
+            query: normalizedQueryParams
+          }).params
+        }
+      }).then(data => wrapAssetTypeCursorPaginatedCollection(makeRequest, normalizeCursorPaginationResponse(data)));
+    },
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
@@ -2662,6 +2740,111 @@ export default function createEnvironmentApi(makeRequest) {
           invocationId
         }
       }).then(data => wrapAiActionInvocation(makeRequest, data));
+    },
+    /**
+     * Retrieves Semantic Duplicates for the given entity ID
+     * @param payload - Object containing the entityId and optional filters
+     * @return Promise for Semantic Duplicates
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getSemanticDuplicates({
+     *      entityId: '<entity_id>',
+     *      filters: {
+     *        contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
+     *      }
+     *    })
+     */
+    getSemanticDuplicates(payload) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'SemanticDuplicates',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id
+        },
+        payload
+      }).then(data => wrapSemanticDuplicates(makeRequest, data));
+    },
+    /**
+     * Retrieves Semantic Recommendations for the given entity ID
+     * @param payload - Object containing the entityId and optional filters
+     * @return Promise for Semantic Recommendations
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getSemanticRecommendations({
+     *      entityId: '<entity_id>',
+     *      filters: {
+     *        contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
+     *      }
+     *    })
+     */
+    getSemanticRecommendations(payload) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'SemanticRecommendations',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id
+        },
+        payload
+      }).then(data => wrapSemanticRecommendations(makeRequest, data));
+    },
+    /**
+     * Retrieves Semantic Reference Suggestions for the given entity ID and its reference field ID
+     * @param payload - Object containing the entityId and optional filters
+     * @return Promise for Semantic Reference Suggestions
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getSemanticRecommendations({
+     *      entityId: '<entity_id>',
+     *      referenceFieldId: '<reference_field_id>',
+     *      filters: {
+     *        contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
+     *      }
+     *    })
+     */
+    getSemanticReferenceSuggestions(payload) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'SemanticReferenceSuggestions',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id
+        },
+        payload
+      }).then(data => wrapSemanticReferenceSuggestions(makeRequest, data));
+    },
+    /**
+     * Retrieves Semantic Search results for the given query
+     * @param payload - Object containing the search query and optional filters
+     * @return Promise for Semantic Search results
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getSemanticSearch({
+     *      query: '<search_query>',
+     *      filters: {
+     *        contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
+     *      }
+     *    })
+     */
+    getSemanticSearch(payload) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'SemanticSearch',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id
+        },
+        payload
+      }).then(data => wrapSemanticSearch(makeRequest, data));
     }
   };
 }

package/dist/es-modules/create-organization-api.js

@@ -78,6 +78,9 @@ export default function createOrganizationApi(makeRequest) {
   const {
     wrapSpaceCollection
   } = entities.space;
+  const {
+    wrapVectorizationStatus
+  } = entities.vectorizationStatus;
   return {
     /**
      * Gets a collection of spaces in the organization
@@ -1301,6 +1304,54 @@ export default function createOrganizationApi(makeRequest) {
           query
         }
       }).then(payload => wrapFunctionCollection(makeRequest, payload));
+    },
+    /**
+     * Gets the vectorization status for the organization
+     * @returns Promise for a VectorizationStatus
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * const org = await client.getOrganization('<org_id>')
+     * const vectorizationStatus = await org.getVectorizationStatus()
+     */
+    getVectorizationStatus() {
+      const raw = this.toPlainObject();
+      const organizationId = raw.sys.id;
+      return makeRequest({
+        entityType: 'VectorizationStatus',
+        action: 'get',
+        params: {
+          organizationId
+        }
+      }).then(payload => wrapVectorizationStatus(makeRequest, payload));
+    },
+    /**
+     * Updates the vectorization status for the organization
+     * @returns Promise for a VectorizationStatus
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * const org = await client.getOrganization('<org_id>')
+     * const updatedVectorizationStatus = await org.updateVectorizationStatus([
+     *  { spaceId: '<space_id1>', enabled: true },
+     *  { spaceId: '<space_id2>', enabled: false }
+     * ])
+     */
+    updateVectorizationStatus(data) {
+      const raw = this.toPlainObject();
+      const organizationId = raw.sys.id;
+      return makeRequest({
+        entityType: 'VectorizationStatus',
+        action: 'update',
+        params: {
+          organizationId
+        },
+        payload: data
+      }).then(payload => wrapVectorizationStatus(makeRequest, payload));
     }
   };
 }

package/dist/es-modules/entities/index.js

@@ -39,6 +39,10 @@ import * as release from './release';
 import * as releaseAction from './release-action';
 import * as role from './role';
 import * as scheduledAction from './scheduled-action';
+import * as semanticDuplicates from './semantic-duplicates';
+import * as semanticRecommendations from './semantic-recommendations';
+import * as semanticReferenceSuggestions from './semantic-reference-suggestions';
+import * as semanticSearch from './semantic-search';
 import * as snapshot from './snapshot';
 import * as space from './space';
 import * as spaceMember from './space-member';
@@ -53,6 +57,7 @@ import * as upload from './upload';
 import * as usage from './usage';
 import * as user from './user';
 import * as userUIConfig from './user-ui-config';
+import * as vectorizationStatus from './vectorization-status';
 import * as webhook from './webhook';
 import * as workflowDefinition from './workflow-definition';
 import * as concept from './concept';
@@ -107,6 +112,10 @@ export default {
   resource,
   role,
   scheduledAction,
+  semanticDuplicates,
+  semanticRecommendations,
+  semanticReferenceSuggestions,
+  semanticSearch,
   snapshot,
   space,
   spaceMember,
@@ -121,6 +130,7 @@ export default {
   usage,
   user,
   userUIConfig,
+  vectorizationStatus,
   webhook,
   workflowDefinition
 };

package/dist/es-modules/entities/semantic-duplicates.js

@@ -0,0 +1,6 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+export function wrapSemanticDuplicates(_makeRequest, data) {
+  const result = toPlainObject(copy(data));
+  return freezeSys(result);
+}

package/dist/es-modules/entities/semantic-recommendations.js

@@ -0,0 +1,6 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+export function wrapSemanticRecommendations(_makeRequest, data) {
+  const result = toPlainObject(copy(data));
+  return freezeSys(result);
+}

package/dist/es-modules/entities/semantic-reference-suggestions.js

@@ -0,0 +1,6 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+export function wrapSemanticReferenceSuggestions(_makeRequest, data) {
+  const result = toPlainObject(copy(data));
+  return freezeSys(result);
+}

package/dist/es-modules/entities/semantic-search.js

@@ -0,0 +1,6 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+export function wrapSemanticSearch(_makeRequest, data) {
+  const result = toPlainObject(copy(data));
+  return freezeSys(result);
+}

package/dist/es-modules/entities/vectorization-status.js

@@ -0,0 +1,14 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+export let EmbeddingSetStatus = /*#__PURE__*/function (EmbeddingSetStatus) {
+  EmbeddingSetStatus["ACTIVE"] = "ACTIVE";
+  EmbeddingSetStatus["PENDING"] = "PENDING";
+  EmbeddingSetStatus["ERROR"] = "ERROR";
+  EmbeddingSetStatus["DISABLED"] = "DISABLED";
+  EmbeddingSetStatus["DELETING"] = "DELETING";
+  return EmbeddingSetStatus;
+}({});
+export function wrapVectorizationStatus(_makeRequest, data) {
+  const vectorizationStatus = toPlainObject(copy(data));
+  return freezeSys(vectorizationStatus);
+}

package/dist/es-modules/plain/entities/semantic-duplicates.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/semantic-recommendations.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/semantic-reference-suggestions.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/semantic-search.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/vectorization-status.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/plain-client.js

@@ -254,6 +254,7 @@ export const createPlainClient = (makeRequest, defaults) => {
     },
     entry: {
       getPublished: wrap(wrapParams, 'Entry', 'getPublished'),
+      getPublishedWithCursor: wrap(wrapParams, 'Entry', 'getPublishedWithCursor'),
       getMany: wrap(wrapParams, 'Entry', 'getMany'),
       getManyWithCursor: wrap(wrapParams, 'Entry', 'getManyWithCursor'),
       get: wrap(wrapParams, 'Entry', 'get'),
@@ -270,6 +271,7 @@ export const createPlainClient = (makeRequest, defaults) => {
     },
     asset: {
       getPublished: wrap(wrapParams, 'Asset', 'getPublished'),
+      getPublishedWithCursor: wrap(wrapParams, 'Asset', 'getPublishedWithCursor'),
       getMany: wrap(wrapParams, 'Asset', 'getMany'),
       getManyWithCursor: wrap(wrapParams, 'Asset', 'getManyWithCursor'),
       get: wrap(wrapParams, 'Asset', 'get'),
@@ -518,6 +520,18 @@ export const createPlainClient = (makeRequest, defaults) => {
       delete: wrap(wrapParams, 'OAuthApplication', 'delete'),
       create: wrap(wrapParams, 'OAuthApplication', 'create')
     },
+    semanticDuplicates: {
+      get: wrap(wrapParams, 'SemanticDuplicates', 'get')
+    },
+    semanticRecommendations: {
+      get: wrap(wrapParams, 'SemanticRecommendations', 'get')
+    },
+    semanticReferenceSuggestions: {
+      get: wrap(wrapParams, 'SemanticReferenceSuggestions', 'get')
+    },
+    semanticSearch: {
+      get: wrap(wrapParams, 'SemanticSearch', 'get')
+    },
     spaceMember: {
       get: wrap(wrapParams, 'SpaceMember', 'get'),
       getMany: wrap(wrapParams, 'SpaceMember', 'getMany')
@@ -565,6 +579,10 @@ export const createPlainClient = (makeRequest, defaults) => {
       get: wrap(wrapParams, 'UserUIConfig', 'get'),
       update: wrap(wrapParams, 'UserUIConfig', 'update')
     },
+    vectorizationStatus: {
+      get: wrap(wrapParams, 'VectorizationStatus', 'get'),
+      update: wrap(wrapParams, 'VectorizationStatus', 'update')
+    },
     workflowDefinition: {
       get: wrap(wrapParams, 'WorkflowDefinition', 'get'),
       getMany: wrap(wrapParams, 'WorkflowDefinition', 'getMany'),

package/dist/typings/adapters/REST/endpoints/index.d.ts

@@ -47,6 +47,10 @@ import * as ResourceProvider from './resource-provider';
 import * as ResourceType from './resource-type';
 import * as Role from './role';
 import * as ScheduledAction from './scheduled-action';
+import * as SemanticDuplicates from './semantic-duplicates';
+import * as SemanticRecommendations from './semantic-recommendations';
+import * as SemanticReferenceSuggestions from './semantic-reference-suggestions';
+import * as SemanticSearch from './semantic-search';
 import * as Snapshot from './snapshot';
 import * as Space from './space';
 import * as SpaceMember from './space-member';
@@ -62,6 +66,7 @@ import * as UploadCredential from './upload-credentials';
 import * as Usage from './usage';
 import * as User from './user';
 import * as UserUIConfig from './user-ui-config';
+import * as VectorizationStatus from './vectorization-status';
 import * as Webhook from './webhook';
 import * as Workflow from './workflow';
 import * as WorkflowDefinition from './workflow-definition';
@@ -116,6 +121,10 @@ declare const _default: {
     ResourceType: typeof ResourceType;
     Role: typeof Role;
     ScheduledAction: typeof ScheduledAction;
+    SemanticDuplicates: typeof SemanticDuplicates;
+    SemanticRecommendations: typeof SemanticRecommendations;
+    SemanticReferenceSuggestions: typeof SemanticReferenceSuggestions;
+    SemanticSearch: typeof SemanticSearch;
     Snapshot: typeof Snapshot;
     Space: typeof Space;
     SpaceMember: typeof SpaceMember;
@@ -131,6 +140,7 @@ declare const _default: {
     Usage: typeof Usage;
     User: typeof User;
     UserUIConfig: typeof UserUIConfig;
+    VectorizationStatus: typeof VectorizationStatus;
     Webhook: typeof Webhook;
     WorkflowDefinition: typeof WorkflowDefinition;
     Workflow: typeof Workflow;

package/dist/typings/adapters/REST/endpoints/semantic-duplicates.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'SemanticDuplicates', 'get'>;

package/dist/typings/adapters/REST/endpoints/semantic-recommendations.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'SemanticRecommendations', 'get'>;

package/dist/typings/adapters/REST/endpoints/semantic-reference-suggestions.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'SemanticReferenceSuggestions', 'get'>;

package/dist/typings/adapters/REST/endpoints/semantic-search.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'SemanticSearch', 'get'>;

package/dist/typings/adapters/REST/endpoints/vectorization-status.d.ts

@@ -0,0 +1,3 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'VectorizationStatus', 'get'>;
+export declare const update: RestEndpoint<'VectorizationStatus', 'update'>;