contentful-management 11.64.0 → 11.66.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/dist/contentful-management.browser.js +600 -80
  2. package/dist/contentful-management.browser.js.map +1 -1
  3. package/dist/contentful-management.browser.min.js +1 -1
  4. package/dist/contentful-management.node.js +592 -80
  5. package/dist/contentful-management.node.js.map +1 -1
  6. package/dist/contentful-management.node.min.js +1 -1
  7. package/dist/es-modules/adapters/REST/endpoints/index.js +10 -0
  8. package/dist/es-modules/adapters/REST/endpoints/semantic-duplicates.js +6 -0
  9. package/dist/es-modules/adapters/REST/endpoints/semantic-recommendations.js +6 -0
  10. package/dist/es-modules/adapters/REST/endpoints/semantic-reference-suggestions.js +6 -0
  11. package/dist/es-modules/adapters/REST/endpoints/semantic-search.js +6 -0
  12. package/dist/es-modules/adapters/REST/endpoints/vectorization-status.js +11 -0
  13. package/dist/es-modules/create-environment-api.js +183 -0
  14. package/dist/es-modules/create-organization-api.js +51 -0
  15. package/dist/es-modules/entities/index.js +10 -0
  16. package/dist/es-modules/entities/semantic-duplicates.js +6 -0
  17. package/dist/es-modules/entities/semantic-recommendations.js +6 -0
  18. package/dist/es-modules/entities/semantic-reference-suggestions.js +6 -0
  19. package/dist/es-modules/entities/semantic-search.js +6 -0
  20. package/dist/es-modules/entities/vectorization-status.js +14 -0
  21. package/dist/es-modules/plain/entities/semantic-duplicates.js +1 -0
  22. package/dist/es-modules/plain/entities/semantic-recommendations.js +1 -0
  23. package/dist/es-modules/plain/entities/semantic-reference-suggestions.js +1 -0
  24. package/dist/es-modules/plain/entities/semantic-search.js +1 -0
  25. package/dist/es-modules/plain/entities/vectorization-status.js +1 -0
  26. package/dist/es-modules/plain/plain-client.js +18 -0
  27. package/dist/typings/adapters/REST/endpoints/index.d.ts +10 -0
  28. package/dist/typings/adapters/REST/endpoints/semantic-duplicates.d.ts +2 -0
  29. package/dist/typings/adapters/REST/endpoints/semantic-recommendations.d.ts +2 -0
  30. package/dist/typings/adapters/REST/endpoints/semantic-reference-suggestions.d.ts +2 -0
  31. package/dist/typings/adapters/REST/endpoints/semantic-search.d.ts +2 -0
  32. package/dist/typings/adapters/REST/endpoints/vectorization-status.d.ts +3 -0
  33. package/dist/typings/common-types.d.ts +71 -0
  34. package/dist/typings/create-environment-api.d.ts +103 -0
  35. package/dist/typings/create-organization-api.d.ts +28 -0
  36. package/dist/typings/entities/index.d.ts +10 -0
  37. package/dist/typings/entities/resource.d.ts +2 -0
  38. package/dist/typings/entities/semantic-duplicates.d.ts +25 -0
  39. package/dist/typings/entities/semantic-recommendations.d.ts +23 -0
  40. package/dist/typings/entities/semantic-reference-suggestions.d.ts +24 -0
  41. package/dist/typings/entities/semantic-search.d.ts +23 -0
  42. package/dist/typings/entities/vectorization-status.d.ts +32 -0
  43. package/dist/typings/export-types.d.ts +5 -0
  44. package/dist/typings/plain/common-types.d.ts +12 -0
  45. package/dist/typings/plain/entities/semantic-duplicates.d.ts +14 -0
  46. package/dist/typings/plain/entities/semantic-recommendations.d.ts +14 -0
  47. package/dist/typings/plain/entities/semantic-reference-suggestions.d.ts +14 -0
  48. package/dist/typings/plain/entities/semantic-search.d.ts +14 -0
  49. package/dist/typings/plain/entities/vectorization-status.d.ts +21 -0
  50. package/package.json +1 -1
@@ -64,6 +64,11 @@ import type { CreateOAuthApplicationProps, OAuthApplicationProps, UpdateOAuthApp
64
64
  import type { FunctionLogProps } from './entities/function-log';
65
65
  import type { AiActionProps, AiActionQueryOptions, CreateAiActionProps } from './entities/ai-action';
66
66
  import type { AiActionInvocationProps, AiActionInvocationType } from './entities/ai-action-invocation';
67
+ import type { UpdateVectorizationStatusProps, VectorizationStatusProps } from './entities/vectorization-status';
68
+ import type { GetSemanticDuplicatesProps, SemanticDuplicatesProps } from './entities/semantic-duplicates';
69
+ import type { GetSemanticRecommendationsProps, SemanticRecommendationsProps } from './entities/semantic-recommendations';
70
+ import type { GetSemanticReferenceSuggestionsProps, SemanticReferenceSuggestionsProps } from './entities/semantic-reference-suggestions';
71
+ import type { GetSemanticSearchProps, SemanticSearchProps } from './entities/semantic-search';
67
72
  export interface DefaultElements<TPlainObject extends object = object> {
68
73
  toPlainObject(): TPlainObject;
69
74
  }
@@ -297,6 +302,7 @@ type MRInternal<UA extends boolean> = {
297
302
  (opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>;
298
303
  (opts: MROpts<'Asset', 'getManyWithCursor', UA>): MRReturn<'Asset', 'getManyWithCursor'>;
299
304
  (opts: MROpts<'Asset', 'getPublished', UA>): MRReturn<'Asset', 'getPublished'>;
305
+ (opts: MROpts<'Asset', 'getPublishedWithCursor', UA>): MRReturn<'Asset', 'getPublishedWithCursor'>;
300
306
  (opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>;
301
307
  (opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>;
302
308
  (opts: MROpts<'Asset', 'delete', UA>): MRReturn<'Asset', 'delete'>;
@@ -399,6 +405,7 @@ type MRInternal<UA extends boolean> = {
399
405
  (opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>;
400
406
  (opts: MROpts<'Entry', 'getManyWithCursor', UA>): MRReturn<'Entry', 'getManyWithCursor'>;
401
407
  (opts: MROpts<'Entry', 'getPublished', UA>): MRReturn<'Entry', 'getPublished'>;
408
+ (opts: MROpts<'Entry', 'getPublishedWithCursor', UA>): MRReturn<'Entry', 'getPublishedWithCursor'>;
402
409
  (opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>;
403
410
  (opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>;
404
411
  (opts: MROpts<'Entry', 'update', UA>): MRReturn<'Entry', 'update'>;
@@ -563,6 +570,12 @@ type MRInternal<UA extends boolean> = {
563
570
  (opts: MROpts<'User', 'getManyForOrganization', UA>): MRReturn<'User', 'getManyForOrganization'>;
564
571
  (opts: MROpts<'UserUIConfig', 'get', UA>): MRReturn<'UserUIConfig', 'update'>;
565
572
  (opts: MROpts<'UserUIConfig', 'update', UA>): MRReturn<'UserUIConfig', 'update'>;
573
+ (opts: MROpts<'VectorizationStatus', 'get', UA>): MRReturn<'VectorizationStatus', 'get'>;
574
+ (opts: MROpts<'VectorizationStatus', 'update', UA>): MRReturn<'VectorizationStatus', 'update'>;
575
+ (opts: MROpts<'SemanticDuplicates', 'get', UA>): MRReturn<'SemanticDuplicates', 'get'>;
576
+ (opts: MROpts<'SemanticRecommendations', 'get', UA>): MRReturn<'SemanticRecommendations', 'get'>;
577
+ (opts: MROpts<'SemanticReferenceSuggestions', 'get', UA>): MRReturn<'SemanticReferenceSuggestions', 'get'>;
578
+ (opts: MROpts<'SemanticSearch', 'get', UA>): MRReturn<'SemanticSearch', 'get'>;
566
579
  (opts: MROpts<'Webhook', 'get', UA>): MRReturn<'Webhook', 'get'>;
567
580
  (opts: MROpts<'Webhook', 'getMany', UA>): MRReturn<'Webhook', 'getMany'>;
568
581
  (opts: MROpts<'Webhook', 'getCallDetails', UA>): MRReturn<'Webhook', 'getCallDetails'>;
@@ -1063,6 +1076,11 @@ export type MRActions = {
1063
1076
  headers?: RawAxiosRequestHeaders;
1064
1077
  return: CollectionProp<AssetProps>;
1065
1078
  };
1079
+ getPublishedWithCursor: {
1080
+ params: GetSpaceEnvironmentParams & CursorBasedParams;
1081
+ headers?: RawAxiosRequestHeaders;
1082
+ return: CursorPaginatedCollectionProp<AssetProps>;
1083
+ };
1066
1084
  getMany: {
1067
1085
  params: GetSpaceEnvironmentParams & QueryParams & {
1068
1086
  releaseId?: string;
@@ -1567,6 +1585,10 @@ export type MRActions = {
1567
1585
  params: GetSpaceEnvironmentParams & QueryParams;
1568
1586
  return: CollectionProp<EntryProps<any>>;
1569
1587
  };
1588
+ getPublishedWithCursor: {
1589
+ params: GetSpaceEnvironmentParams & CursorBasedParams;
1590
+ return: CursorPaginatedCollectionProp<EntryProps<any>>;
1591
+ };
1570
1592
  getMany: {
1571
1593
  params: GetSpaceEnvironmentParams & QueryParams & {
1572
1594
  releaseId?: string;
@@ -2152,6 +2174,38 @@ export type MRActions = {
2152
2174
  return: any;
2153
2175
  };
2154
2176
  };
2177
+ SemanticDuplicates: {
2178
+ get: {
2179
+ params: GetSpaceEnvironmentParams;
2180
+ headers?: RawAxiosRequestHeaders;
2181
+ payload: GetSemanticDuplicatesProps;
2182
+ return: SemanticDuplicatesProps;
2183
+ };
2184
+ };
2185
+ SemanticRecommendations: {
2186
+ get: {
2187
+ params: GetSpaceEnvironmentParams;
2188
+ headers?: RawAxiosRequestHeaders;
2189
+ payload: GetSemanticRecommendationsProps;
2190
+ return: SemanticRecommendationsProps;
2191
+ };
2192
+ };
2193
+ SemanticReferenceSuggestions: {
2194
+ get: {
2195
+ params: GetSpaceEnvironmentParams;
2196
+ headers?: RawAxiosRequestHeaders;
2197
+ payload: GetSemanticReferenceSuggestionsProps;
2198
+ return: SemanticReferenceSuggestionsProps;
2199
+ };
2200
+ };
2201
+ SemanticSearch: {
2202
+ get: {
2203
+ params: GetSpaceEnvironmentParams;
2204
+ headers?: RawAxiosRequestHeaders;
2205
+ payload: GetSemanticSearchProps;
2206
+ return: SemanticSearchProps;
2207
+ };
2208
+ };
2155
2209
  Snapshot: {
2156
2210
  getManyForEntry: {
2157
2211
  params: GetSnapshotForEntryParams & QueryParams;
@@ -2499,6 +2553,19 @@ export type MRActions = {
2499
2553
  return: UserUIConfigProps;
2500
2554
  };
2501
2555
  };
2556
+ VectorizationStatus: {
2557
+ get: {
2558
+ params: GetOrganizationParams;
2559
+ headers?: RawAxiosRequestHeaders;
2560
+ return: VectorizationStatusProps;
2561
+ };
2562
+ update: {
2563
+ params: GetOrganizationParams;
2564
+ headers?: RawAxiosRequestHeaders;
2565
+ payload: UpdateVectorizationStatusProps;
2566
+ return: VectorizationStatusProps;
2567
+ };
2568
+ };
2502
2569
  Webhook: {
2503
2570
  get: {
2504
2571
  params: GetWebhookParams;
@@ -2969,4 +3036,8 @@ export declare enum ScheduledActionReferenceFilters {
2969
3036
  export type ReleaseEnvironmentParams = GetSpaceEnvironmentParams & {
2970
3037
  releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
2971
3038
  };
3039
+ export type SemanticRequestFilter = {
3040
+ entityType?: 'Entry';
3041
+ contentTypeIds?: string[];
3042
+ };
2972
3043
  export {};
@@ -17,6 +17,10 @@ import type { TagVisibility } from './entities/tag';
17
17
  import type { CreateAppAccessTokenProps } from './entities/app-access-token';
18
18
  import type { ResourceQueryOptions } from './entities/resource';
19
19
  import type { AiActionInvocationType } from './entities/ai-action-invocation';
20
+ import type { GetSemanticDuplicatesProps } from './entities/semantic-duplicates';
21
+ import type { GetSemanticRecommendationsProps } from './entities/semantic-recommendations';
22
+ import type { GetSemanticReferenceSuggestionsProps } from './entities/semantic-reference-suggestions';
23
+ import type { GetSemanticSearchProps } from './entities/semantic-search';
20
24
  /**
21
25
  * @private
22
26
  */
@@ -546,6 +550,25 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
546
550
  * ```
547
551
  */
548
552
  getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
553
+ /**
554
+ * Gets a collection of published Entries with cursor based pagination
555
+ * @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.
556
+ * @return Promise for a collection of published Entries
557
+ * @example ```javascript
558
+ * const contentful = require('contentful-management')
559
+ *
560
+ * const client = contentful.createClient({
561
+ * accessToken: '<content_management_api_key>'
562
+ * })
563
+ *
564
+ * client.getSpace('<space_id>')
565
+ * .then((space) => space.getEnvironment('<environment-id>'))
566
+ * .then((environment) => environment.getPublishedEntriesWithCursor())
567
+ * .then((response) => console.log(response.items))
568
+ * .catch(console.error)
569
+ * ```
570
+ */
571
+ getPublishedEntriesWithCursor(query?: BasicCursorPaginationOptions): Promise<import("./common-types").CursorPaginatedCollection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
549
572
  /**
550
573
  * Creates a Entry
551
574
  * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -706,6 +729,25 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
706
729
  * ```
707
730
  */
708
731
  getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
732
+ /**
733
+ * Gets a collection of published Assets with cursor based pagination
734
+ * @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.
735
+ * @return Promise for a collection of published Assets
736
+ * @example ```javascript
737
+ * const contentful = require('contentful-management')
738
+ *
739
+ * const client = contentful.createClient({
740
+ * accessToken: '<content_management_api_key>'
741
+ * })
742
+ *
743
+ * client.getSpace('<space_id>')
744
+ * .then((space) => space.getEnvironment('<environment-id>'))
745
+ * .then((environment) => environment.getPublishedAssetsWithCursor())
746
+ * .then((response) => console.log(response.items))
747
+ * .catch(console.error)
748
+ * ```
749
+ */
750
+ getPublishedAssetsWithCursor(query?: BasicCursorPaginationOptions): Promise<import("./common-types").CursorPaginatedCollection<import("./entities/asset").Asset, AssetProps<{}>>>;
709
751
  /**
710
752
  * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
711
753
  * @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.
@@ -1746,4 +1788,65 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
1746
1788
  aiActionId: string;
1747
1789
  invocationId: string;
1748
1790
  }): Promise<import("./entities/ai-action-invocation").AiActionInvocation>;
1791
+ /**
1792
+ * Retrieves Semantic Duplicates for the given entity ID
1793
+ * @param payload - Object containing the entityId and optional filters
1794
+ * @return Promise for Semantic Duplicates
1795
+ * @example ```javascript
1796
+ * client.getSpace('<space_id>')
1797
+ * .then(space => space.getEnvironment('<environment_id>'))
1798
+ * .then(environment => environment.getSemanticDuplicates({
1799
+ * entityId: '<entity_id>',
1800
+ * filters: {
1801
+ * contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
1802
+ * }
1803
+ * })
1804
+ */
1805
+ getSemanticDuplicates(payload: GetSemanticDuplicatesProps): Promise<import("./entities/semantic-duplicates").SemanticDuplicates>;
1806
+ /**
1807
+ * Retrieves Semantic Recommendations for the given entity ID
1808
+ * @param payload - Object containing the entityId and optional filters
1809
+ * @return Promise for Semantic Recommendations
1810
+ * @example ```javascript
1811
+ * client.getSpace('<space_id>')
1812
+ * .then(space => space.getEnvironment('<environment_id>'))
1813
+ * .then(environment => environment.getSemanticRecommendations({
1814
+ * entityId: '<entity_id>',
1815
+ * filters: {
1816
+ * contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
1817
+ * }
1818
+ * })
1819
+ */
1820
+ getSemanticRecommendations(payload: GetSemanticRecommendationsProps): Promise<import("./entities/semantic-recommendations").SemanticRecommendations>;
1821
+ /**
1822
+ * Retrieves Semantic Reference Suggestions for the given entity ID and its reference field ID
1823
+ * @param payload - Object containing the entityId and optional filters
1824
+ * @return Promise for Semantic Reference Suggestions
1825
+ * @example ```javascript
1826
+ * client.getSpace('<space_id>')
1827
+ * .then(space => space.getEnvironment('<environment_id>'))
1828
+ * .then(environment => environment.getSemanticRecommendations({
1829
+ * entityId: '<entity_id>',
1830
+ * referenceFieldId: '<reference_field_id>',
1831
+ * filters: {
1832
+ * contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
1833
+ * }
1834
+ * })
1835
+ */
1836
+ getSemanticReferenceSuggestions(payload: GetSemanticReferenceSuggestionsProps): Promise<import("./entities/semantic-reference-suggestions").SemanticReferenceSuggestions>;
1837
+ /**
1838
+ * Retrieves Semantic Search results for the given query
1839
+ * @param payload - Object containing the search query and optional filters
1840
+ * @return Promise for Semantic Search results
1841
+ * @example ```javascript
1842
+ * client.getSpace('<space_id>')
1843
+ * .then(space => space.getEnvironment('<environment_id>'))
1844
+ * .then(environment => environment.getSemanticSearch({
1845
+ * query: '<search_query>',
1846
+ * filters: {
1847
+ * contentTypeIds: ['<content_type_id1>', '<content_type_id2>'],
1848
+ * }
1849
+ * })
1850
+ */
1851
+ getSemanticSearch(payload: GetSemanticSearchProps): Promise<import("./entities/semantic-search").SemanticSearch>;
1749
1852
  };
@@ -9,6 +9,7 @@ import type { CreateAppSigningSecretProps } from './entities/app-signing-secret'
9
9
  import type { CreateAppEventSubscriptionProps } from './entities/app-event-subscription';
10
10
  import type { CreateAppKeyProps } from './entities/app-key';
11
11
  import type { CreateAppDetailsProps } from './entities/app-details';
12
+ import type { UpdateVectorizationStatusProps } from './entities/vectorization-status';
12
13
  /**
13
14
  * @private
14
15
  */
@@ -1177,4 +1178,31 @@ export default function createOrganizationApi(makeRequest: MakeRequest): {
1177
1178
  * const functions = await org.getFunctions('<app_definition_id>', { 'accepts[all]': '<action>' })
1178
1179
  */
1179
1180
  getFunctions(appDefinitionId: string, query?: AcceptsQueryOptions): Promise<import("./common-types").Collection<import("./export-types").FunctionProps, import("./export-types").FunctionProps>>;
1181
+ /**
1182
+ * Gets the vectorization status for the organization
1183
+ * @returns Promise for a VectorizationStatus
1184
+ * @example ```javascript
1185
+ * const contentful = require('contentful-management')
1186
+ * const client = contentful.createClient({
1187
+ * accessToken: '<content_management_api_key>'
1188
+ * })
1189
+ * const org = await client.getOrganization('<org_id>')
1190
+ * const vectorizationStatus = await org.getVectorizationStatus()
1191
+ */
1192
+ getVectorizationStatus(): Promise<import("./entities/vectorization-status").VectorizationStatus>;
1193
+ /**
1194
+ * Updates the vectorization status for the organization
1195
+ * @returns Promise for a VectorizationStatus
1196
+ * @example ```javascript
1197
+ * const contentful = require('contentful-management')
1198
+ * const client = contentful.createClient({
1199
+ * accessToken: '<content_management_api_key>'
1200
+ * })
1201
+ * const org = await client.getOrganization('<org_id>')
1202
+ * const updatedVectorizationStatus = await org.updateVectorizationStatus([
1203
+ * { spaceId: '<space_id1>', enabled: true },
1204
+ * { spaceId: '<space_id2>', enabled: false }
1205
+ * ])
1206
+ */
1207
+ updateVectorizationStatus(data: UpdateVectorizationStatusProps): Promise<import("./entities/vectorization-status").VectorizationStatus>;
1180
1208
  };
@@ -39,6 +39,10 @@ import * as release from './release';
39
39
  import * as releaseAction from './release-action';
40
40
  import * as role from './role';
41
41
  import * as scheduledAction from './scheduled-action';
42
+ import * as semanticDuplicates from './semantic-duplicates';
43
+ import * as semanticRecommendations from './semantic-recommendations';
44
+ import * as semanticReferenceSuggestions from './semantic-reference-suggestions';
45
+ import * as semanticSearch from './semantic-search';
42
46
  import * as snapshot from './snapshot';
43
47
  import * as space from './space';
44
48
  import * as spaceMember from './space-member';
@@ -53,6 +57,7 @@ import * as upload from './upload';
53
57
  import * as usage from './usage';
54
58
  import * as user from './user';
55
59
  import * as userUIConfig from './user-ui-config';
60
+ import * as vectorizationStatus from './vectorization-status';
56
61
  import * as webhook from './webhook';
57
62
  import * as workflowDefinition from './workflow-definition';
58
63
  import * as concept from './concept';
@@ -107,6 +112,10 @@ declare const _default: {
107
112
  resource: typeof resource;
108
113
  role: typeof role;
109
114
  scheduledAction: typeof scheduledAction;
115
+ semanticDuplicates: typeof semanticDuplicates;
116
+ semanticRecommendations: typeof semanticRecommendations;
117
+ semanticReferenceSuggestions: typeof semanticReferenceSuggestions;
118
+ semanticSearch: typeof semanticSearch;
110
119
  snapshot: typeof snapshot;
111
120
  space: typeof space;
112
121
  spaceMember: typeof spaceMember;
@@ -121,6 +130,7 @@ declare const _default: {
121
130
  usage: typeof usage;
122
131
  user: typeof user;
123
132
  userUIConfig: typeof userUIConfig;
133
+ vectorizationStatus: typeof vectorizationStatus;
124
134
  webhook: typeof webhook;
125
135
  workflowDefinition: typeof workflowDefinition;
126
136
  };
@@ -3,10 +3,12 @@ export type ResourceQueryOptions = LookupQueryOptions | SearchQueryOptions;
3
3
  type LookupQueryOptions = {
4
4
  'sys.urn[in]': string;
5
5
  locale?: string;
6
+ referencingEntryId?: string;
6
7
  } & BasicCursorPaginationOptions;
7
8
  type SearchQueryOptions = {
8
9
  query: string;
9
10
  locale?: string;
11
+ referencingEntryId?: string;
10
12
  } & BasicCursorPaginationOptions;
11
13
  export type ResourceProps = {
12
14
  sys: {
@@ -0,0 +1,25 @@
1
+ import type { DefaultElements, Link, MakeRequest, SemanticRequestFilter } from '../common-types';
2
+ export type DuplicateLabel = 'high' | 'medium' | 'low';
3
+ export type GetSemanticDuplicatesProps = {
4
+ entityId: string;
5
+ filter?: SemanticRequestFilter;
6
+ };
7
+ export type SemanticDuplicatesResult = {
8
+ sys: {
9
+ type: 'SemanticDuplicatesResult';
10
+ entity: Link<'Entry'>;
11
+ space: Link<'Space'>;
12
+ environment: Link<'Environment'>;
13
+ };
14
+ label: DuplicateLabel;
15
+ };
16
+ export type SemanticDuplicatesProps = {
17
+ sys: {
18
+ type: 'Array';
19
+ correlationId?: string;
20
+ };
21
+ items: SemanticDuplicatesResult[];
22
+ };
23
+ export interface SemanticDuplicates extends SemanticDuplicatesProps, DefaultElements<SemanticDuplicatesProps> {
24
+ }
25
+ export declare function wrapSemanticDuplicates(_makeRequest: MakeRequest, data: SemanticDuplicatesProps): SemanticDuplicates;
@@ -0,0 +1,23 @@
1
+ import type { DefaultElements, Link, MakeRequest, SemanticRequestFilter } from '../common-types';
2
+ export type GetSemanticRecommendationsProps = {
3
+ entityId: string;
4
+ filter?: SemanticRequestFilter;
5
+ };
6
+ export type SemanticRecommendationsResult = {
7
+ sys: {
8
+ type: 'SemanticRecommendationsResult';
9
+ entity: Link<'Entry'>;
10
+ space: Link<'Space'>;
11
+ environment: Link<'Environment'>;
12
+ };
13
+ };
14
+ export type SemanticRecommendationsProps = {
15
+ sys: {
16
+ type: 'Array';
17
+ correlationId?: string;
18
+ };
19
+ items: SemanticRecommendationsResult[];
20
+ };
21
+ export interface SemanticRecommendations extends SemanticRecommendationsProps, DefaultElements<SemanticRecommendationsProps> {
22
+ }
23
+ export declare function wrapSemanticRecommendations(_makeRequest: MakeRequest, data: SemanticRecommendationsProps): SemanticRecommendations;
@@ -0,0 +1,24 @@
1
+ import type { DefaultElements, Link, MakeRequest, SemanticRequestFilter } from '../common-types';
2
+ export type GetSemanticReferenceSuggestionsProps = {
3
+ entityId: string;
4
+ referenceFieldId: string;
5
+ filter?: SemanticRequestFilter;
6
+ };
7
+ export type SemanticReferenceSuggestionsResult = {
8
+ sys: {
9
+ type: 'SemanticReferenceSuggestionsResult';
10
+ entity: Link<'Entry'>;
11
+ space: Link<'Space'>;
12
+ environment: Link<'Environment'>;
13
+ };
14
+ };
15
+ export type SemanticReferenceSuggestionsProps = {
16
+ sys: {
17
+ type: 'Array';
18
+ correlationId?: string;
19
+ };
20
+ items: SemanticReferenceSuggestionsResult[];
21
+ };
22
+ export interface SemanticReferenceSuggestions extends SemanticReferenceSuggestionsProps, DefaultElements<SemanticReferenceSuggestionsProps> {
23
+ }
24
+ export declare function wrapSemanticReferenceSuggestions(_makeRequest: MakeRequest, data: SemanticReferenceSuggestionsProps): SemanticReferenceSuggestions;
@@ -0,0 +1,23 @@
1
+ import type { DefaultElements, Link, MakeRequest, SemanticRequestFilter } from '../common-types';
2
+ export type GetSemanticSearchProps = {
3
+ query: string;
4
+ filter?: SemanticRequestFilter;
5
+ };
6
+ export type SemanticSearchResult = {
7
+ sys: {
8
+ type: 'SemanticSearchResult';
9
+ entity: Link<'Entry'>;
10
+ space: Link<'Space'>;
11
+ environment: Link<'Environment'>;
12
+ };
13
+ };
14
+ export type SemanticSearchProps = {
15
+ sys: {
16
+ type: 'Array';
17
+ correlationId?: string;
18
+ };
19
+ items: SemanticSearchResult[];
20
+ };
21
+ export interface SemanticSearch extends SemanticSearchProps, DefaultElements<SemanticSearchProps> {
22
+ }
23
+ export declare function wrapSemanticSearch(_makeRequest: MakeRequest, data: SemanticSearchProps): SemanticSearch;
@@ -0,0 +1,32 @@
1
+ import type { DefaultElements, Link, MakeRequest } from '../common-types';
2
+ export declare enum EmbeddingSetStatus {
3
+ ACTIVE = "ACTIVE",
4
+ PENDING = "PENDING",
5
+ ERROR = "ERROR",
6
+ DISABLED = "DISABLED",
7
+ DELETING = "DELETING"
8
+ }
9
+ export type SpaceVectorizationStatus = {
10
+ sys: {
11
+ space: Link<'Space'>;
12
+ status: EmbeddingSetStatus;
13
+ type: 'VectorizationStatus';
14
+ createdAt: string;
15
+ updatedAt: string;
16
+ disabledAt?: string;
17
+ };
18
+ };
19
+ export type VectorizationStatusProps = {
20
+ sys: {
21
+ type: 'Array';
22
+ correlationId?: string;
23
+ };
24
+ items: SpaceVectorizationStatus[];
25
+ };
26
+ export type UpdateVectorizationStatusProps = {
27
+ spaceId: string;
28
+ enabled: boolean;
29
+ }[];
30
+ export interface VectorizationStatus extends VectorizationStatusProps, DefaultElements<VectorizationStatusProps> {
31
+ }
32
+ export declare function wrapVectorizationStatus(_makeRequest: MakeRequest, data: VectorizationStatusProps): VectorizationStatus;
@@ -65,6 +65,11 @@ export type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/co
65
65
  export type { ResourceProps, ResourceQueryOptions } from './entities/resource';
66
66
  export type { ResourceProvider, ResourceProviderProps, UpsertResourceProviderProps, } from './entities/resource-provider';
67
67
  export type { ResourceType, ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps, } from './entities/resource-type';
68
+ export type { VectorizationStatusProps, VectorizationStatus } from './entities/vectorization-status';
69
+ export type { SemanticDuplicatesProps, SemanticDuplicates } from './entities/semantic-duplicates';
70
+ export type { SemanticRecommendationsProps, SemanticRecommendations, } from './entities/semantic-recommendations';
71
+ export type { SemanticReferenceSuggestionsProps, SemanticReferenceSuggestions, } from './entities/semantic-reference-suggestions';
72
+ export type { SemanticSearchProps, SemanticSearch } from './entities/semantic-search';
68
73
  export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters';
69
74
  export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
70
75
  export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
@@ -67,6 +67,11 @@ import type { OAuthApplicationPlainClientAPI } from './entities/oauth-applicatio
67
67
  import type { FunctionLogPlainClientAPI } from './entities/function-log';
68
68
  import type { AiActionPlainClientAPI } from './entities/ai-action';
69
69
  import type { AiActionInvocationPlainClientAPI } from './entities/ai-action-invocation';
70
+ import type { VectorizationStatusPlainClientAPI } from './entities/vectorization-status';
71
+ import type { SemanticDuplicatesPlainClientAPI } from './entities/semantic-duplicates';
72
+ import type { SemanticRecommendationsPlainClientAPI } from './entities/semantic-recommendations';
73
+ import type { SemanticReferenceSuggestionsPlainClientAPI } from './entities/semantic-reference-suggestions';
74
+ import type { SemanticSearchPlainClientAPI } from './entities/semantic-search';
70
75
  export type PlainClientAPI = {
71
76
  raw: {
72
77
  getDefaultParams(): DefaultParams | undefined;
@@ -170,6 +175,7 @@ export type PlainClientAPI = {
170
175
  user: UserPlainClientAPI;
171
176
  entry: {
172
177
  getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
178
+ getPublishedWithCursor<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & CursorBasedParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EntryProps<T>>>;
173
179
  getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
174
180
  releaseId?: string;
175
181
  }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
@@ -222,6 +228,7 @@ export type PlainClientAPI = {
222
228
  };
223
229
  asset: {
224
230
  getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
231
+ getPublishedWithCursor(params: OptionalDefaults<GetSpaceEnvironmentParams & CursorBasedParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<AssetProps>>;
225
232
  getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
226
233
  releaseId?: string;
227
234
  }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
@@ -468,4 +475,9 @@ export type PlainClientAPI = {
468
475
  workflow: WorkflowPlainClientAPI;
469
476
  workflowsChangelog: WorkflowsChangelogPlainClientAPI;
470
477
  oauthApplication: OAuthApplicationPlainClientAPI;
478
+ vectorizationStatus: VectorizationStatusPlainClientAPI;
479
+ semanticSearch: SemanticSearchPlainClientAPI;
480
+ semanticDuplicates: SemanticDuplicatesPlainClientAPI;
481
+ semanticRecommendations: SemanticRecommendationsPlainClientAPI;
482
+ semanticReferenceSuggestions: SemanticReferenceSuggestionsPlainClientAPI;
471
483
  };
@@ -0,0 +1,14 @@
1
+ import type { GetSemanticDuplicatesProps, SemanticDuplicatesProps } from '../../entities/semantic-duplicates';
2
+ import type { OptionalDefaults } from '../wrappers/wrap';
3
+ import type { GetSpaceEnvironmentParams } from '../../common-types';
4
+ import type { RawAxiosRequestHeaders } from 'axios';
5
+ export type SemanticDuplicatesPlainClientAPI = {
6
+ /**
7
+ * Retrieves Semantic Duplicates for the given entity ID.
8
+ * @param params Parameters for getting the space and environment IDs.
9
+ * @param payload Payload containing entity ID and optional filters.
10
+ * @param headers Optional headers for the request.
11
+ * @returns A promise that resolves to Semantic Duplicates.
12
+ */
13
+ get(params: OptionalDefaults<GetSpaceEnvironmentParams>, payload: GetSemanticDuplicatesProps, headers?: Partial<RawAxiosRequestHeaders>): Promise<SemanticDuplicatesProps>;
14
+ };
@@ -0,0 +1,14 @@
1
+ import type { GetSemanticRecommendationsProps, SemanticRecommendationsProps } from '../../entities/semantic-recommendations';
2
+ import type { OptionalDefaults } from '../wrappers/wrap';
3
+ import type { GetSpaceEnvironmentParams } from '../../common-types';
4
+ import type { RawAxiosRequestHeaders } from 'axios';
5
+ export type SemanticRecommendationsPlainClientAPI = {
6
+ /**
7
+ * Retrieves Semantic Recommendations for the given entity ID.
8
+ * @param params Parameters for getting the space and environment IDs.
9
+ * @param payload Payload containing entity ID and optional filters.
10
+ * @param headers Optional headers for the request.
11
+ * @returns A promise that resolves to Semantic Recommendations.
12
+ */
13
+ get(params: OptionalDefaults<GetSpaceEnvironmentParams>, payload: GetSemanticRecommendationsProps, headers?: Partial<RawAxiosRequestHeaders>): Promise<SemanticRecommendationsProps>;
14
+ };
@@ -0,0 +1,14 @@
1
+ import type { GetSemanticReferenceSuggestionsProps, SemanticReferenceSuggestionsProps } from '../../entities/semantic-reference-suggestions';
2
+ import type { OptionalDefaults } from '../wrappers/wrap';
3
+ import type { GetSpaceEnvironmentParams } from '../../common-types';
4
+ import type { RawAxiosRequestHeaders } from 'axios';
5
+ export type SemanticReferenceSuggestionsPlainClientAPI = {
6
+ /**
7
+ * Retrieves Semantic Reference Suggestions for the given entity ID and its reference field ID.
8
+ * @param params Parameters for getting the space and environment IDs.
9
+ * @param payload Payload containing entity ID, reference field ID and optional filters.
10
+ * @param headers Optional headers for the request.
11
+ * @returns A promise that resolves to Semantic Reference Suggestions.
12
+ */
13
+ get(params: OptionalDefaults<GetSpaceEnvironmentParams>, payload: GetSemanticReferenceSuggestionsProps, headers?: Partial<RawAxiosRequestHeaders>): Promise<SemanticReferenceSuggestionsProps>;
14
+ };
@@ -0,0 +1,14 @@
1
+ import type { GetSemanticSearchProps, SemanticSearchProps } from '../../entities/semantic-search';
2
+ import type { OptionalDefaults } from '../wrappers/wrap';
3
+ import type { GetSpaceEnvironmentParams } from '../../common-types';
4
+ import type { RawAxiosRequestHeaders } from 'axios';
5
+ export type SemanticSearchPlainClientAPI = {
6
+ /**
7
+ * Retrieves Semantic Search results for the given query.
8
+ * @param params Parameters for getting the space and environment IDs.
9
+ * @param payload Payload containing query and optional filters.
10
+ * @param headers Optional headers for the request.
11
+ * @returns A promise that resolves to Semantic Search results.
12
+ */
13
+ get(params: OptionalDefaults<GetSpaceEnvironmentParams>, payload: GetSemanticSearchProps, headers?: Partial<RawAxiosRequestHeaders>): Promise<SemanticSearchProps>;
14
+ };
@@ -0,0 +1,21 @@
1
+ import type { UpdateVectorizationStatusProps, VectorizationStatusProps } from '../../entities/vectorization-status';
2
+ import type { OptionalDefaults } from '../wrappers/wrap';
3
+ import type { GetOrganizationParams } from '../../common-types';
4
+ import type { RawAxiosRequestHeaders } from 'axios';
5
+ export type VectorizationStatusPlainClientAPI = {
6
+ /**
7
+ * Fetches the vectorization status for all spaces in an organization.
8
+ * @param params Parameters for getting the organization.
9
+ * @param headers Optional headers for the request.
10
+ * @returns A promise that resolves to the vectorization status of spaces.
11
+ */
12
+ get(params: OptionalDefaults<GetOrganizationParams>, headers?: Partial<RawAxiosRequestHeaders>): Promise<VectorizationStatusProps>;
13
+ /**
14
+ * Updates the vectorization status for spaces within an organization.
15
+ * @param params Parameters for getting the organization.
16
+ * @param payload Payload containing the update information.
17
+ * @param headers Optional headers for the request.
18
+ * @returns A promise that resolves to the vectorization status of spaces.
19
+ */
20
+ update(params: OptionalDefaults<GetOrganizationParams>, payload: UpdateVectorizationStatusProps, headers?: Partial<RawAxiosRequestHeaders>): Promise<VectorizationStatusProps>;
21
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "contentful-management",
3
- "version": "11.64.0",
3
+ "version": "11.66.0",
4
4
  "description": "Client for Contentful's Content Management API",
5
5
  "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
6
6
  "main": "./dist/contentful-management.node.js",