@wix/data 1.0.143 → 1.0.145

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.
@@ -1,3 +1,47 @@
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
1
45
  /** An external database connection defines a connection between an external database and a Wix site or project. */
2
46
  interface ExternalDatabaseConnection {
3
47
  /**
@@ -415,62 +459,100 @@ interface UpdateExternalDatabaseConnection {
415
459
  capabilities?: Capabilities;
416
460
  }
417
461
 
418
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
419
- interface HttpClient {
420
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
421
- fetchWithAuth: typeof fetch;
422
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
462
+ declare function getExternalDatabaseConnection$1(httpClient: HttpClient): GetExternalDatabaseConnectionSignature;
463
+ interface GetExternalDatabaseConnectionSignature {
464
+ /**
465
+ * Retrieves an external database connection by name.
466
+ * @param - Name of the external database connection to retrieve.
467
+ * @returns Details of the external database connection requested.
468
+ */
469
+ (name: string): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
423
470
  }
424
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
425
- type HttpResponse<T = any> = {
426
- data: T;
427
- status: number;
428
- statusText: string;
429
- headers: any;
430
- request?: any;
431
- };
432
- type RequestOptions<_TResponse = any, Data = any> = {
433
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
434
- url: string;
435
- data?: Data;
436
- params?: URLSearchParams;
437
- } & APIMetadata;
438
- type APIMetadata = {
439
- methodFqn?: string;
440
- entityFqdn?: string;
441
- packageName?: string;
442
- };
443
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
444
- type EventDefinition<Payload = unknown, Type extends string = string> = {
445
- __type: 'event-definition';
446
- type: Type;
447
- isDomainEvent?: boolean;
448
- transformations?: (envelope: unknown) => Payload;
449
- __payload: Payload;
450
- };
451
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
452
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
453
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
454
-
455
- declare global {
456
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
457
- interface SymbolConstructor {
458
- readonly observable: symbol;
459
- }
471
+ declare function listExternalDatabaseConnections$1(httpClient: HttpClient): ListExternalDatabaseConnectionsSignature;
472
+ interface ListExternalDatabaseConnectionsSignature {
473
+ /**
474
+ * Retrieves a list of all external database collections associated with the site or project.
475
+ */
476
+ (options?: ListExternalDatabaseConnectionsOptions | undefined): Promise<ListExternalDatabaseConnectionsResponse & ListExternalDatabaseConnectionsResponseNonNullableFields>;
477
+ }
478
+ declare function createExternalDatabaseConnection$1(httpClient: HttpClient): CreateExternalDatabaseConnectionSignature;
479
+ interface CreateExternalDatabaseConnectionSignature {
480
+ /**
481
+ * Creates a new external database connection.
482
+ *
483
+ * The `externalDatabaseConnection` parameter must include a `name`, `endpoint`, and `configuration` details for the external database.
484
+ * If any of these are missing, the external database connection isn't created.
485
+ * @param - External database connection details.
486
+ * @param - Options for creating an external database connection.
487
+ * @returns Details of external database connection created.
488
+ */
489
+ (externalDatabaseConnection: ExternalDatabaseConnection, options: CreateExternalDatabaseConnectionOptions): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
460
490
  }
491
+ declare function updateExternalDatabaseConnection$1(httpClient: HttpClient): UpdateExternalDatabaseConnectionSignature;
492
+ interface UpdateExternalDatabaseConnectionSignature {
493
+ /**
494
+ * Updates an external database connection.
495
+ *
496
+ * An external database collection name must be provided in `name`.
497
+ * If an existing external database connection is found with the same name, that connection's details are updated.
498
+ * If no external database connection has that name, the request fails.
499
+ *
500
+ * > **Note:** After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.
501
+ * @param - Name of the external database connection.
502
+ * An external database connection may connect to one or more external data collections or tables.
503
+ * These are represented as `connectionName/dataCollectionId`.
504
+ * @param - Options for updating an external database connection.
505
+ * @param - Updated external database connection details. The existing connection is replaced with this version.
506
+ * @returns Updated external database connection details.
507
+ */
508
+ (name: string, externalDatabaseConnection: UpdateExternalDatabaseConnection): Promise<ExternalDatabaseConnection & ExternalDatabaseConnectionNonNullableFields>;
509
+ }
510
+ declare function deleteExternalDatabaseConnection$1(httpClient: HttpClient): DeleteExternalDatabaseConnectionSignature;
511
+ interface DeleteExternalDatabaseConnectionSignature {
512
+ /**
513
+ * Deletes an external database connection.
514
+ *
515
+ * > **Note:** Once an external database connection is deleted, it can't be restored. To reconnect the database you need to create a new external database connection.
516
+ * @param - Name of the external database connection to delete.
517
+ */
518
+ (name: string): Promise<void>;
519
+ }
520
+ declare const onExternalDatabaseConnectionCreated$1: EventDefinition<ExternalDatabaseConnectionCreatedEnvelope, "wix.data.v1.external_database_connection_created">;
521
+ declare const onExternalDatabaseConnectionUpdated$1: EventDefinition<ExternalDatabaseConnectionUpdatedEnvelope, "wix.data.v1.external_database_connection_updated">;
522
+ declare const onExternalDatabaseConnectionDeleted$1: EventDefinition<ExternalDatabaseConnectionDeletedEnvelope, "wix.data.v1.external_database_connection_deleted">;
461
523
 
462
524
  declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
463
525
 
464
526
  declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
465
527
 
466
- declare const getExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<typeof publicGetExternalDatabaseConnection>>;
467
- declare const listExternalDatabaseConnections: ReturnType<typeof createRESTModule$3<typeof publicListExternalDatabaseConnections>>;
468
- declare const createExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<typeof publicCreateExternalDatabaseConnection>>;
469
- declare const updateExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<typeof publicUpdateExternalDatabaseConnection>>;
470
- declare const deleteExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<typeof publicDeleteExternalDatabaseConnection>>;
471
- declare const onExternalDatabaseConnectionCreated: ReturnType<typeof createEventModule$2<typeof publicOnExternalDatabaseConnectionCreated>>;
472
- declare const onExternalDatabaseConnectionUpdated: ReturnType<typeof createEventModule$2<typeof publicOnExternalDatabaseConnectionUpdated>>;
473
- declare const onExternalDatabaseConnectionDeleted: ReturnType<typeof createEventModule$2<typeof publicOnExternalDatabaseConnectionDeleted>>;
528
+ type _publicGetExternalDatabaseConnectionType = typeof getExternalDatabaseConnection$1;
529
+ declare const getExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<_publicGetExternalDatabaseConnectionType>>;
530
+ type _publicListExternalDatabaseConnectionsType = typeof listExternalDatabaseConnections$1;
531
+ declare const listExternalDatabaseConnections: ReturnType<typeof createRESTModule$3<_publicListExternalDatabaseConnectionsType>>;
532
+ type _publicCreateExternalDatabaseConnectionType = typeof createExternalDatabaseConnection$1;
533
+ declare const createExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<_publicCreateExternalDatabaseConnectionType>>;
534
+ type _publicUpdateExternalDatabaseConnectionType = typeof updateExternalDatabaseConnection$1;
535
+ declare const updateExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<_publicUpdateExternalDatabaseConnectionType>>;
536
+ type _publicDeleteExternalDatabaseConnectionType = typeof deleteExternalDatabaseConnection$1;
537
+ declare const deleteExternalDatabaseConnection: ReturnType<typeof createRESTModule$3<_publicDeleteExternalDatabaseConnectionType>>;
538
+
539
+ type _publicOnExternalDatabaseConnectionCreatedType = typeof onExternalDatabaseConnectionCreated$1;
540
+ /**
541
+ * Triggered when an external database connection is created.
542
+ */
543
+ declare const onExternalDatabaseConnectionCreated: ReturnType<typeof createEventModule$2<_publicOnExternalDatabaseConnectionCreatedType>>;
544
+
545
+ type _publicOnExternalDatabaseConnectionUpdatedType = typeof onExternalDatabaseConnectionUpdated$1;
546
+ /**
547
+ * Triggered when an external database connection is updated.
548
+ */
549
+ declare const onExternalDatabaseConnectionUpdated: ReturnType<typeof createEventModule$2<_publicOnExternalDatabaseConnectionUpdatedType>>;
550
+
551
+ type _publicOnExternalDatabaseConnectionDeletedType = typeof onExternalDatabaseConnectionDeleted$1;
552
+ /**
553
+ * Triggered when an external database connection is deleted.
554
+ */
555
+ declare const onExternalDatabaseConnectionDeleted: ReturnType<typeof createEventModule$2<_publicOnExternalDatabaseConnectionDeletedType>>;
474
556
 
475
557
  type context$3_Capabilities = Capabilities;
476
558
  type context$3_CauseOfFailure = CauseOfFailure;
@@ -506,6 +588,14 @@ type context$3_UpdateExternalDatabaseConnection = UpdateExternalDatabaseConnecti
506
588
  type context$3_UpdateExternalDatabaseConnectionRequest = UpdateExternalDatabaseConnectionRequest;
507
589
  type context$3_UpdateExternalDatabaseConnectionResponse = UpdateExternalDatabaseConnectionResponse;
508
590
  type context$3_UpdateExternalDatabaseConnectionResponseNonNullableFields = UpdateExternalDatabaseConnectionResponseNonNullableFields;
591
+ type context$3__publicCreateExternalDatabaseConnectionType = _publicCreateExternalDatabaseConnectionType;
592
+ type context$3__publicDeleteExternalDatabaseConnectionType = _publicDeleteExternalDatabaseConnectionType;
593
+ type context$3__publicGetExternalDatabaseConnectionType = _publicGetExternalDatabaseConnectionType;
594
+ type context$3__publicListExternalDatabaseConnectionsType = _publicListExternalDatabaseConnectionsType;
595
+ type context$3__publicOnExternalDatabaseConnectionCreatedType = _publicOnExternalDatabaseConnectionCreatedType;
596
+ type context$3__publicOnExternalDatabaseConnectionDeletedType = _publicOnExternalDatabaseConnectionDeletedType;
597
+ type context$3__publicOnExternalDatabaseConnectionUpdatedType = _publicOnExternalDatabaseConnectionUpdatedType;
598
+ type context$3__publicUpdateExternalDatabaseConnectionType = _publicUpdateExternalDatabaseConnectionType;
509
599
  declare const context$3_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
510
600
  declare const context$3_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
511
601
  declare const context$3_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
@@ -515,7 +605,7 @@ declare const context$3_onExternalDatabaseConnectionDeleted: typeof onExternalDa
515
605
  declare const context$3_onExternalDatabaseConnectionUpdated: typeof onExternalDatabaseConnectionUpdated;
516
606
  declare const context$3_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
517
607
  declare namespace context$3 {
518
- export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type context$3_Capabilities as Capabilities, context$3_CauseOfFailure as CauseOfFailure, context$3_CollectionsFound as CollectionsFound, type context$3_ConnectionStatus as ConnectionStatus, context$3_ConnectionType as ConnectionType, type context$3_CreateExternalDatabaseConnectionOptions as CreateExternalDatabaseConnectionOptions, type context$3_CreateExternalDatabaseConnectionRequest as CreateExternalDatabaseConnectionRequest, type context$3_CreateExternalDatabaseConnectionResponse as CreateExternalDatabaseConnectionResponse, type context$3_CreateExternalDatabaseConnectionResponseNonNullableFields as CreateExternalDatabaseConnectionResponseNonNullableFields, type context$3_DeleteExternalDatabaseConnectionRequest as DeleteExternalDatabaseConnectionRequest, type context$3_DeleteExternalDatabaseConnectionResponse as DeleteExternalDatabaseConnectionResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type context$3_ExternalDatabaseConnection as ExternalDatabaseConnection, type context$3_ExternalDatabaseConnectionCreatedEnvelope as ExternalDatabaseConnectionCreatedEnvelope, type context$3_ExternalDatabaseConnectionDeletedEnvelope as ExternalDatabaseConnectionDeletedEnvelope, type context$3_ExternalDatabaseConnectionNonNullableFields as ExternalDatabaseConnectionNonNullableFields, type context$3_ExternalDatabaseConnectionUpdatedEnvelope as ExternalDatabaseConnectionUpdatedEnvelope, context$3_FieldType as FieldType, type context$3_GetExternalDatabaseConnectionRequest as GetExternalDatabaseConnectionRequest, type context$3_GetExternalDatabaseConnectionResponse as GetExternalDatabaseConnectionResponse, type context$3_GetExternalDatabaseConnectionResponseNonNullableFields as GetExternalDatabaseConnectionResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$3_ListExternalDatabaseConnectionsOptions as ListExternalDatabaseConnectionsOptions, type context$3_ListExternalDatabaseConnectionsRequest as ListExternalDatabaseConnectionsRequest, type context$3_ListExternalDatabaseConnectionsResponse as ListExternalDatabaseConnectionsResponse, type context$3_ListExternalDatabaseConnectionsResponseNonNullableFields as ListExternalDatabaseConnectionsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type Paging$3 as Paging, type PagingMetadata$1 as PagingMetadata, context$3_ProtocolVersion as ProtocolVersion, type RestoreInfo$2 as RestoreInfo, type context$3_UpdateExternalDatabaseConnection as UpdateExternalDatabaseConnection, type context$3_UpdateExternalDatabaseConnectionRequest as UpdateExternalDatabaseConnectionRequest, type context$3_UpdateExternalDatabaseConnectionResponse as UpdateExternalDatabaseConnectionResponse, type context$3_UpdateExternalDatabaseConnectionResponseNonNullableFields as UpdateExternalDatabaseConnectionResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, context$3_createExternalDatabaseConnection as createExternalDatabaseConnection, context$3_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, context$3_getExternalDatabaseConnection as getExternalDatabaseConnection, context$3_listExternalDatabaseConnections as listExternalDatabaseConnections, context$3_onExternalDatabaseConnectionCreated as onExternalDatabaseConnectionCreated, context$3_onExternalDatabaseConnectionDeleted as onExternalDatabaseConnectionDeleted, context$3_onExternalDatabaseConnectionUpdated as onExternalDatabaseConnectionUpdated, context$3_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
608
+ export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type context$3_Capabilities as Capabilities, context$3_CauseOfFailure as CauseOfFailure, context$3_CollectionsFound as CollectionsFound, type context$3_ConnectionStatus as ConnectionStatus, context$3_ConnectionType as ConnectionType, type context$3_CreateExternalDatabaseConnectionOptions as CreateExternalDatabaseConnectionOptions, type context$3_CreateExternalDatabaseConnectionRequest as CreateExternalDatabaseConnectionRequest, type context$3_CreateExternalDatabaseConnectionResponse as CreateExternalDatabaseConnectionResponse, type context$3_CreateExternalDatabaseConnectionResponseNonNullableFields as CreateExternalDatabaseConnectionResponseNonNullableFields, type context$3_DeleteExternalDatabaseConnectionRequest as DeleteExternalDatabaseConnectionRequest, type context$3_DeleteExternalDatabaseConnectionResponse as DeleteExternalDatabaseConnectionResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type context$3_ExternalDatabaseConnection as ExternalDatabaseConnection, type context$3_ExternalDatabaseConnectionCreatedEnvelope as ExternalDatabaseConnectionCreatedEnvelope, type context$3_ExternalDatabaseConnectionDeletedEnvelope as ExternalDatabaseConnectionDeletedEnvelope, type context$3_ExternalDatabaseConnectionNonNullableFields as ExternalDatabaseConnectionNonNullableFields, type context$3_ExternalDatabaseConnectionUpdatedEnvelope as ExternalDatabaseConnectionUpdatedEnvelope, context$3_FieldType as FieldType, type context$3_GetExternalDatabaseConnectionRequest as GetExternalDatabaseConnectionRequest, type context$3_GetExternalDatabaseConnectionResponse as GetExternalDatabaseConnectionResponse, type context$3_GetExternalDatabaseConnectionResponseNonNullableFields as GetExternalDatabaseConnectionResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$3_ListExternalDatabaseConnectionsOptions as ListExternalDatabaseConnectionsOptions, type context$3_ListExternalDatabaseConnectionsRequest as ListExternalDatabaseConnectionsRequest, type context$3_ListExternalDatabaseConnectionsResponse as ListExternalDatabaseConnectionsResponse, type context$3_ListExternalDatabaseConnectionsResponseNonNullableFields as ListExternalDatabaseConnectionsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type Paging$3 as Paging, type PagingMetadata$1 as PagingMetadata, context$3_ProtocolVersion as ProtocolVersion, type RestoreInfo$2 as RestoreInfo, type context$3_UpdateExternalDatabaseConnection as UpdateExternalDatabaseConnection, type context$3_UpdateExternalDatabaseConnectionRequest as UpdateExternalDatabaseConnectionRequest, type context$3_UpdateExternalDatabaseConnectionResponse as UpdateExternalDatabaseConnectionResponse, type context$3_UpdateExternalDatabaseConnectionResponseNonNullableFields as UpdateExternalDatabaseConnectionResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, type context$3__publicCreateExternalDatabaseConnectionType as _publicCreateExternalDatabaseConnectionType, type context$3__publicDeleteExternalDatabaseConnectionType as _publicDeleteExternalDatabaseConnectionType, type context$3__publicGetExternalDatabaseConnectionType as _publicGetExternalDatabaseConnectionType, type context$3__publicListExternalDatabaseConnectionsType as _publicListExternalDatabaseConnectionsType, type context$3__publicOnExternalDatabaseConnectionCreatedType as _publicOnExternalDatabaseConnectionCreatedType, type context$3__publicOnExternalDatabaseConnectionDeletedType as _publicOnExternalDatabaseConnectionDeletedType, type context$3__publicOnExternalDatabaseConnectionUpdatedType as _publicOnExternalDatabaseConnectionUpdatedType, type context$3__publicUpdateExternalDatabaseConnectionType as _publicUpdateExternalDatabaseConnectionType, context$3_createExternalDatabaseConnection as createExternalDatabaseConnection, context$3_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, context$3_getExternalDatabaseConnection as getExternalDatabaseConnection, context$3_listExternalDatabaseConnections as listExternalDatabaseConnections, context$3_onExternalDatabaseConnectionCreated as onExternalDatabaseConnectionCreated, context$3_onExternalDatabaseConnectionDeleted as onExternalDatabaseConnectionDeleted, context$3_onExternalDatabaseConnectionUpdated as onExternalDatabaseConnectionUpdated, onExternalDatabaseConnectionCreated$1 as publicOnExternalDatabaseConnectionCreated, onExternalDatabaseConnectionDeleted$1 as publicOnExternalDatabaseConnectionDeleted, onExternalDatabaseConnectionUpdated$1 as publicOnExternalDatabaseConnectionUpdated, context$3_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
519
609
  }
520
610
 
521
611
  /** A data collection determines the structure of data to be stored in a database. */
@@ -976,7 +1066,10 @@ declare enum Role {
976
1066
  ANYONE = "ANYONE"
977
1067
  }
978
1068
  interface Plugin extends PluginOptionsOneOf {
979
- /** Options for the Publish plugin. */
1069
+ /**
1070
+ * Options for the Publish plugin.
1071
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
1072
+ */
980
1073
  publishOptions?: PublishPluginOptions$1;
981
1074
  /** Options for the Single Item plugin. */
982
1075
  singleItemOptions?: SingleItemPluginOptions;
@@ -1001,7 +1094,10 @@ interface Plugin extends PluginOptionsOneOf {
1001
1094
  }
1002
1095
  /** @oneof */
1003
1096
  interface PluginOptionsOneOf {
1004
- /** Options for the Publish plugin. */
1097
+ /**
1098
+ * Options for the Publish plugin.
1099
+ * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
1100
+ */
1005
1101
  publishOptions?: PublishPluginOptions$1;
1006
1102
  /** Options for the Single Item plugin. */
1007
1103
  singleItemOptions?: SingleItemPluginOptions;
@@ -1819,20 +1915,115 @@ interface ListDataCollectionsOptions {
1819
1915
  consistentRead?: boolean;
1820
1916
  }
1821
1917
 
1918
+ declare function createDataCollection$1(httpClient: HttpClient): CreateDataCollectionSignature;
1919
+ interface CreateDataCollectionSignature {
1920
+ /**
1921
+ * Creates a new data collection.
1922
+ *
1923
+ * The request body must include an ID, details for at least 1 field, and a permissions object. If any of these are missing, the collection isn't created.
1924
+ * @param - Collection details.
1925
+ * @param - Options for creating a data collection.
1926
+ * @returns Details of collection created.
1927
+ */
1928
+ (collection: DataCollection): Promise<DataCollection & DataCollectionNonNullableFields>;
1929
+ }
1930
+ declare function getDataCollection$1(httpClient: HttpClient): GetDataCollectionSignature;
1931
+ interface GetDataCollectionSignature {
1932
+ /**
1933
+ * Retrieves a data collection by ID.
1934
+ * @param - ID of the collection to retrieve.
1935
+ * @param - Options for retrieving a data collection.
1936
+ * @returns Details of the collection requested.
1937
+ */
1938
+ (dataCollectionId: string, options?: GetDataCollectionOptions | undefined): Promise<DataCollection & DataCollectionNonNullableFields>;
1939
+ }
1940
+ declare function listDataCollections$1(httpClient: HttpClient): ListDataCollectionsSignature;
1941
+ interface ListDataCollectionsSignature {
1942
+ /**
1943
+ * Retrieves a list of all data collections associated with the site or project.
1944
+ *
1945
+ * By default, the list is ordered by ID in ascending order.
1946
+ * @param - Options for retrieving a list of data collections.
1947
+ */
1948
+ (options?: ListDataCollectionsOptions | undefined): Promise<ListDataCollectionsResponse & ListDataCollectionsResponseNonNullableFields>;
1949
+ }
1950
+ declare function updateDataCollection$1(httpClient: HttpClient): UpdateDataCollectionSignature;
1951
+ interface UpdateDataCollectionSignature {
1952
+ /**
1953
+ * Updates a data collection.
1954
+ *
1955
+ * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
1956
+ * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
1957
+ * Otherwise, the request fails.
1958
+ *
1959
+ * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
1960
+ *
1961
+ * > **Note:**
1962
+ * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
1963
+ * > aren't included in the updated collection details, their values are lost.
1964
+ * @param - Updated collection details. The existing collection is replaced with this version.
1965
+ * @param - Options for updating a data collection.
1966
+ * @returns Updated collection details.
1967
+ */
1968
+ (collection: DataCollection): Promise<DataCollection & DataCollectionNonNullableFields>;
1969
+ }
1970
+ declare function deleteDataCollection$1(httpClient: HttpClient): DeleteDataCollectionSignature;
1971
+ interface DeleteDataCollectionSignature {
1972
+ /**
1973
+ * Deletes a data collection.
1974
+ *
1975
+ * > **Note:**
1976
+ * > Once a collection is deleted, it can't be restored.
1977
+ * @param - ID of the collection to delete.
1978
+ */
1979
+ (dataCollectionId: string): Promise<void>;
1980
+ }
1981
+ declare const onDataCollectionClonedEvent$1: EventDefinition<DataCollectionClonedEnvelope, "wix.data.v2.data_collection_data_collection_cloned_event">;
1982
+ declare const onDataCollectionChangedEvent$1: EventDefinition<DataCollectionChangedEnvelope, "wix.data.v2.data_collection_data_collection_changed_event">;
1983
+ declare const onDataCollectionCreated$1: EventDefinition<DataCollectionCreatedEnvelope, "wix.data.v2.data_collection_created">;
1984
+ declare const onDataCollectionUpdated$1: EventDefinition<DataCollectionUpdatedEnvelope, "wix.data.v2.data_collection_updated">;
1985
+ declare const onDataCollectionDeleted$1: EventDefinition<DataCollectionDeletedEnvelope, "wix.data.v2.data_collection_deleted">;
1986
+
1822
1987
  declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1823
1988
 
1824
1989
  declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1825
1990
 
1826
- declare const createDataCollection: ReturnType<typeof createRESTModule$2<typeof publicCreateDataCollection>>;
1827
- declare const getDataCollection: ReturnType<typeof createRESTModule$2<typeof publicGetDataCollection>>;
1828
- declare const listDataCollections: ReturnType<typeof createRESTModule$2<typeof publicListDataCollections>>;
1829
- declare const updateDataCollection: ReturnType<typeof createRESTModule$2<typeof publicUpdateDataCollection>>;
1830
- declare const deleteDataCollection: ReturnType<typeof createRESTModule$2<typeof publicDeleteDataCollection>>;
1831
- declare const onDataCollectionClonedEvent: ReturnType<typeof createEventModule$1<typeof publicOnDataCollectionClonedEvent>>;
1832
- declare const onDataCollectionChangedEvent: ReturnType<typeof createEventModule$1<typeof publicOnDataCollectionChangedEvent>>;
1833
- declare const onDataCollectionCreated: ReturnType<typeof createEventModule$1<typeof publicOnDataCollectionCreated>>;
1834
- declare const onDataCollectionUpdated: ReturnType<typeof createEventModule$1<typeof publicOnDataCollectionUpdated>>;
1835
- declare const onDataCollectionDeleted: ReturnType<typeof createEventModule$1<typeof publicOnDataCollectionDeleted>>;
1991
+ type _publicCreateDataCollectionType = typeof createDataCollection$1;
1992
+ declare const createDataCollection: ReturnType<typeof createRESTModule$2<_publicCreateDataCollectionType>>;
1993
+ type _publicGetDataCollectionType = typeof getDataCollection$1;
1994
+ declare const getDataCollection: ReturnType<typeof createRESTModule$2<_publicGetDataCollectionType>>;
1995
+ type _publicListDataCollectionsType = typeof listDataCollections$1;
1996
+ declare const listDataCollections: ReturnType<typeof createRESTModule$2<_publicListDataCollectionsType>>;
1997
+ type _publicUpdateDataCollectionType = typeof updateDataCollection$1;
1998
+ declare const updateDataCollection: ReturnType<typeof createRESTModule$2<_publicUpdateDataCollectionType>>;
1999
+ type _publicDeleteDataCollectionType = typeof deleteDataCollection$1;
2000
+ declare const deleteDataCollection: ReturnType<typeof createRESTModule$2<_publicDeleteDataCollectionType>>;
2001
+
2002
+ type _publicOnDataCollectionClonedEventType = typeof onDataCollectionClonedEvent$1;
2003
+ /**
2004
+ * Event triggered when collection is cloned from other instance
2005
+ * CREATED event will be also triggered along with this action
2006
+ */
2007
+ declare const onDataCollectionClonedEvent: ReturnType<typeof createEventModule$1<_publicOnDataCollectionClonedEventType>>;
2008
+
2009
+ type _publicOnDataCollectionChangedEventType = typeof onDataCollectionChangedEvent$1;
2010
+ /**
2011
+ * Event triggered when collection is changed, describing some of changes
2012
+ * UPDATED event will be also triggered along with this action
2013
+ */
2014
+ declare const onDataCollectionChangedEvent: ReturnType<typeof createEventModule$1<_publicOnDataCollectionChangedEventType>>;
2015
+
2016
+ type _publicOnDataCollectionCreatedType = typeof onDataCollectionCreated$1;
2017
+ /** */
2018
+ declare const onDataCollectionCreated: ReturnType<typeof createEventModule$1<_publicOnDataCollectionCreatedType>>;
2019
+
2020
+ type _publicOnDataCollectionUpdatedType = typeof onDataCollectionUpdated$1;
2021
+ /** */
2022
+ declare const onDataCollectionUpdated: ReturnType<typeof createEventModule$1<_publicOnDataCollectionUpdatedType>>;
2023
+
2024
+ type _publicOnDataCollectionDeletedType = typeof onDataCollectionDeleted$1;
2025
+ /** */
2026
+ declare const onDataCollectionDeleted: ReturnType<typeof createEventModule$1<_publicOnDataCollectionDeletedType>>;
1836
2027
 
1837
2028
  type context$2_AccessLevel = AccessLevel;
1838
2029
  declare const context$2_AccessLevel: typeof AccessLevel;
@@ -1942,6 +2133,16 @@ type context$2_UrlizedOnlyPattern = UrlizedOnlyPattern;
1942
2133
  type context$2_UrlizedPluginOptions = UrlizedPluginOptions;
1943
2134
  type context$2__Array = _Array;
1944
2135
  type context$2__Object = _Object;
2136
+ type context$2__publicCreateDataCollectionType = _publicCreateDataCollectionType;
2137
+ type context$2__publicDeleteDataCollectionType = _publicDeleteDataCollectionType;
2138
+ type context$2__publicGetDataCollectionType = _publicGetDataCollectionType;
2139
+ type context$2__publicListDataCollectionsType = _publicListDataCollectionsType;
2140
+ type context$2__publicOnDataCollectionChangedEventType = _publicOnDataCollectionChangedEventType;
2141
+ type context$2__publicOnDataCollectionClonedEventType = _publicOnDataCollectionClonedEventType;
2142
+ type context$2__publicOnDataCollectionCreatedType = _publicOnDataCollectionCreatedType;
2143
+ type context$2__publicOnDataCollectionDeletedType = _publicOnDataCollectionDeletedType;
2144
+ type context$2__publicOnDataCollectionUpdatedType = _publicOnDataCollectionUpdatedType;
2145
+ type context$2__publicUpdateDataCollectionType = _publicUpdateDataCollectionType;
1945
2146
  declare const context$2_createDataCollection: typeof createDataCollection;
1946
2147
  declare const context$2_deleteDataCollection: typeof deleteDataCollection;
1947
2148
  declare const context$2_getDataCollection: typeof getDataCollection;
@@ -1953,7 +2154,7 @@ declare const context$2_onDataCollectionDeleted: typeof onDataCollectionDeleted;
1953
2154
  declare const context$2_onDataCollectionUpdated: typeof onDataCollectionUpdated;
1954
2155
  declare const context$2_updateDataCollection: typeof updateDataCollection;
1955
2156
  declare namespace context$2 {
1956
- export { context$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type context$2_AllowedDataPermissions as AllowedDataPermissions, type context$2_ArraySizeRange as ArraySizeRange, type BaseEventMetadata$1 as BaseEventMetadata, type context$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type context$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type context$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type context$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type context$2_Calculator as Calculator, type context$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type context$2_CmsOptions as CmsOptions, type context$2_CollectionCapabilities as CollectionCapabilities, context$2_CollectionOperation as CollectionOperation, context$2_CollectionType as CollectionType, type context$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type context$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type context$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type context$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type context$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type context$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type context$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type context$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type context$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type context$2_DataCollection as DataCollection, type context$2_DataCollectionChangedEnvelope as DataCollectionChangedEnvelope, type context$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$2_DataCollectionClonedEnvelope as DataCollectionClonedEnvelope, type context$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$2_DataCollectionCreatedEnvelope as DataCollectionCreatedEnvelope, type context$2_DataCollectionDeletedEnvelope as DataCollectionDeletedEnvelope, type context$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, type context$2_DataCollectionUpdatedEnvelope as DataCollectionUpdatedEnvelope, context$2_DataOperation as DataOperation, type context$2_DataPermissions as DataPermissions, type context$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type context$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type context$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type context$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type context$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type context$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, context$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type Failure$1 as Failure, type Field$1 as Field, type context$2_FieldCapabilities as FieldCapabilities, type context$2_FieldPlugin as FieldPlugin, type context$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, context$2_FieldPluginType as FieldPluginType, type context$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type context$2_FieldsPattern as FieldsPattern, context$2_Format as Format, type context$2_GetDataCollectionOptions as GetDataCollectionOptions, type context$2_GetDataCollectionRequest as GetDataCollectionRequest, type context$2_GetDataCollectionResponse as GetDataCollectionResponse, type context$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type context$2_IndexField as IndexField, type context$2_IndexLimits as IndexLimits, context$2_IndexStatus as IndexStatus, type context$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type context$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type context$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type context$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$2_MultiReference as MultiReference, type context$2_MultilingualOptions as MultilingualOptions, type context$2_NumberRange as NumberRange, type context$2_ObjectField as ObjectField, Order$1 as Order, type context$2_PageLink as PageLink, type context$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, context$2_PagingMode as PagingMode, type context$2_Permissions as Permissions, type context$2_Plugin as Plugin, type context$2_PluginCmsOptions as PluginCmsOptions, type context$2_PluginOptionsOneOf as PluginOptionsOneOf, context$2_PluginType as PluginType, type context$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, context$2_QueryOperator as QueryOperator, type context$2_Reference as Reference, type context$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, context$2_Role as Role, type context$2_SingleItemPluginOptions as SingleItemPluginOptions, type context$2_SiteSort as SiteSort, type context$2_SnapshotCollection as SnapshotCollection, type context$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type context$2_StringLengthRange as StringLengthRange, context$2_Type as Type, type context$2_TypeMetadata as TypeMetadata, type context$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type context$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type context$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type context$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type context$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type context$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type context$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type context$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type context$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type context$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type context$2__Array as _Array, type context$2__Object as _Object, context$2_createDataCollection as createDataCollection, context$2_deleteDataCollection as deleteDataCollection, context$2_getDataCollection as getDataCollection, context$2_listDataCollections as listDataCollections, context$2_onDataCollectionChangedEvent as onDataCollectionChangedEvent, context$2_onDataCollectionClonedEvent as onDataCollectionClonedEvent, context$2_onDataCollectionCreated as onDataCollectionCreated, context$2_onDataCollectionDeleted as onDataCollectionDeleted, context$2_onDataCollectionUpdated as onDataCollectionUpdated, context$2_updateDataCollection as updateDataCollection };
2157
+ export { context$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type context$2_AllowedDataPermissions as AllowedDataPermissions, type context$2_ArraySizeRange as ArraySizeRange, type BaseEventMetadata$1 as BaseEventMetadata, type context$2_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type context$2_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type context$2_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type context$2_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type context$2_Calculator as Calculator, type context$2_CalculatorPatternOneOf as CalculatorPatternOneOf, type context$2_CmsOptions as CmsOptions, type context$2_CollectionCapabilities as CollectionCapabilities, context$2_CollectionOperation as CollectionOperation, context$2_CollectionType as CollectionType, type context$2_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type context$2_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type context$2_CreateDataCollectionRequest as CreateDataCollectionRequest, type context$2_CreateDataCollectionResponse as CreateDataCollectionResponse, type context$2_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type context$2_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type context$2_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type context$2_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type context$2_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type context$2_DataCollection as DataCollection, type context$2_DataCollectionChangedEnvelope as DataCollectionChangedEnvelope, type context$2_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$2_DataCollectionClonedEnvelope as DataCollectionClonedEnvelope, type context$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$2_DataCollectionCreatedEnvelope as DataCollectionCreatedEnvelope, type context$2_DataCollectionDeletedEnvelope as DataCollectionDeletedEnvelope, type context$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, type context$2_DataCollectionUpdatedEnvelope as DataCollectionUpdatedEnvelope, context$2_DataOperation as DataOperation, type context$2_DataPermissions as DataPermissions, type context$2_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type context$2_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type context$2_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type context$2_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type context$2_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type context$2_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, context$2_Direction as Direction, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type Failure$1 as Failure, type Field$1 as Field, type context$2_FieldCapabilities as FieldCapabilities, type context$2_FieldPlugin as FieldPlugin, type context$2_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, context$2_FieldPluginType as FieldPluginType, type context$2_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type FieldUpdate$1 as FieldUpdate, type context$2_FieldsPattern as FieldsPattern, context$2_Format as Format, type context$2_GetDataCollectionOptions as GetDataCollectionOptions, type context$2_GetDataCollectionRequest as GetDataCollectionRequest, type context$2_GetDataCollectionResponse as GetDataCollectionResponse, type context$2_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Index$1 as Index, type context$2_IndexField as IndexField, type context$2_IndexLimits as IndexLimits, context$2_IndexStatus as IndexStatus, type context$2_ListDataCollectionsOptions as ListDataCollectionsOptions, type context$2_ListDataCollectionsRequest as ListDataCollectionsRequest, type context$2_ListDataCollectionsResponse as ListDataCollectionsResponse, type context$2_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type context$2_MultiReference as MultiReference, type context$2_MultilingualOptions as MultilingualOptions, type context$2_NumberRange as NumberRange, type context$2_ObjectField as ObjectField, Order$1 as Order, type context$2_PageLink as PageLink, type context$2_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$2 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, context$2_PagingMode as PagingMode, type context$2_Permissions as Permissions, type context$2_Plugin as Plugin, type context$2_PluginCmsOptions as PluginCmsOptions, type context$2_PluginOptionsOneOf as PluginOptionsOneOf, context$2_PluginType as PluginType, type context$2_PluginUpdate as PluginUpdate, type PublishPluginOptions$1 as PublishPluginOptions, context$2_QueryOperator as QueryOperator, type context$2_Reference as Reference, type context$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, context$2_Role as Role, type context$2_SingleItemPluginOptions as SingleItemPluginOptions, type context$2_SiteSort as SiteSort, type context$2_SnapshotCollection as SnapshotCollection, type context$2_Sort as Sort, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Status$1 as Status, type context$2_StringLengthRange as StringLengthRange, context$2_Type as Type, type context$2_TypeMetadata as TypeMetadata, type context$2_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type context$2_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type context$2_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type context$2_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type context$2_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type context$2_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type context$2_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type context$2_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type context$2_UrlizedOnlyPattern as UrlizedOnlyPattern, type context$2_UrlizedPluginOptions as UrlizedPluginOptions, WebhookIdentityType$1 as WebhookIdentityType, type context$2__Array as _Array, type context$2__Object as _Object, type context$2__publicCreateDataCollectionType as _publicCreateDataCollectionType, type context$2__publicDeleteDataCollectionType as _publicDeleteDataCollectionType, type context$2__publicGetDataCollectionType as _publicGetDataCollectionType, type context$2__publicListDataCollectionsType as _publicListDataCollectionsType, type context$2__publicOnDataCollectionChangedEventType as _publicOnDataCollectionChangedEventType, type context$2__publicOnDataCollectionClonedEventType as _publicOnDataCollectionClonedEventType, type context$2__publicOnDataCollectionCreatedType as _publicOnDataCollectionCreatedType, type context$2__publicOnDataCollectionDeletedType as _publicOnDataCollectionDeletedType, type context$2__publicOnDataCollectionUpdatedType as _publicOnDataCollectionUpdatedType, type context$2__publicUpdateDataCollectionType as _publicUpdateDataCollectionType, context$2_createDataCollection as createDataCollection, context$2_deleteDataCollection as deleteDataCollection, context$2_getDataCollection as getDataCollection, context$2_listDataCollections as listDataCollections, context$2_onDataCollectionChangedEvent as onDataCollectionChangedEvent, context$2_onDataCollectionClonedEvent as onDataCollectionClonedEvent, context$2_onDataCollectionCreated as onDataCollectionCreated, context$2_onDataCollectionDeleted as onDataCollectionDeleted, context$2_onDataCollectionUpdated as onDataCollectionUpdated, onDataCollectionChangedEvent$1 as publicOnDataCollectionChangedEvent, onDataCollectionClonedEvent$1 as publicOnDataCollectionClonedEvent, onDataCollectionCreated$1 as publicOnDataCollectionCreated, onDataCollectionDeleted$1 as publicOnDataCollectionDeleted, onDataCollectionUpdated$1 as publicOnDataCollectionUpdated, context$2_updateDataCollection as updateDataCollection };
1957
2158
  }
1958
2159
 
1959
2160
  interface DataItem {
@@ -2046,6 +2247,12 @@ interface RemoveFromArray {
2046
2247
  value?: any;
2047
2248
  }
2048
2249
  interface DataPublishPluginOptions {
2250
+ /**
2251
+ * Whether to include draft items.
2252
+ * When `true`, the response includes both published and draft items. Default: `false`.
2253
+ *
2254
+ * **Note:** This option is only relevant for [data collections](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) that use the Publish plugin.
2255
+ */
2049
2256
  includeDraftItems?: boolean;
2050
2257
  }
2051
2258
  interface PatchDataItemResponse {
@@ -3502,34 +3709,390 @@ interface ReplaceDataItemReferencesOptions {
3502
3709
  newReferencedItemIds?: string[];
3503
3710
  }
3504
3711
 
3712
+ declare function insertDataItem$1(httpClient: HttpClient): InsertDataItemSignature;
3713
+ interface InsertDataItemSignature {
3714
+ /**
3715
+ * Adds an item to a collection.
3716
+ *
3717
+ *
3718
+ * An item can only be inserted into an existing connection.
3719
+ * You can create a new collection using the Data Collections API.
3720
+ *
3721
+ * When an item is inserted into a collection, the item's ID is automatically assigned a random value.
3722
+ * You can optionally provide a custom ID in `dataItem.id` when inserting the item.
3723
+ * If you specify an ID that already exists in the collection, the insertion will fail.
3724
+ *
3725
+ * If `options.dataItem.data` is empty, a new item is created with no data fields.
3726
+ * @param - Options for adding an item to a collection.
3727
+ */
3728
+ (options: InsertDataItemOptions): Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
3729
+ }
3730
+ declare function updateDataItem$1(httpClient: HttpClient): UpdateDataItemSignature;
3731
+ interface UpdateDataItemSignature {
3732
+ /**
3733
+ * Updates an item in a collection.
3734
+ *
3735
+ *
3736
+ * This function replaces the data item's existing data with the payload provided in `options.dataItem.data` in the request.
3737
+ *
3738
+ * To update an item, you need to specify an item ID and a collection ID.
3739
+ * If an item is found in the specified collection with the specified ID, that item is updated.
3740
+ * If the collection doesn't contain an item with that ID, the request fails.
3741
+ *
3742
+ * When an item is updated, its `data._updatedDate` field is changed to the current date and time.
3743
+ *
3744
+ * > **Note:**
3745
+ * > After an item is updated, it only contains the fields included in the `options.dataItem.data` payload in the `updateDataItem()` call.
3746
+ * > If the existing item has fields with values and those fields aren't included in the updated item, their values are lost.
3747
+ * @param - Data item ID.
3748
+ * @param - Options for updating an item in a collection.
3749
+ */
3750
+ (_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
3751
+ }
3752
+ declare function saveDataItem$1(httpClient: HttpClient): SaveDataItemSignature;
3753
+ interface SaveDataItemSignature {
3754
+ /**
3755
+ * Inserts or updates an item in a collection.
3756
+ *
3757
+ *
3758
+ * The `saveDataItem()` function inserts or updates the specified item, depending on whether it already exists in the collection.
3759
+ *
3760
+ * + If you don't provide an ID, a new item is created.
3761
+ *
3762
+ * + If you provide an ID that does not exist in the collection, a new item is created with that ID.
3763
+ *
3764
+ * + If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `data._updatedDate` field is changed to the current date and time.
3765
+ *
3766
+ * > **Note:** When you provide an item with an ID that already exists in the collection, the payload you provide in `options.dataItem.data` replaces the existing item with that ID.
3767
+ * > This means that the item's previous fields and values are lost.
3768
+ * @param - Options for saving an item in a collection.
3769
+ */
3770
+ (options: SaveDataItemOptions): Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
3771
+ }
3772
+ declare function getDataItem$1(httpClient: HttpClient): GetDataItemSignature;
3773
+ interface GetDataItemSignature {
3774
+ /**
3775
+ * Retrieves an item from a collection.
3776
+ *
3777
+ *
3778
+ * > **Note**: When calling `getDataItem()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3779
+ * @param - ID of the data item to retrieve.
3780
+ * @param - Options for retrieving an item from a collection.
3781
+ * @returns Retrieved item.
3782
+ */
3783
+ (dataItemId: string, options?: GetDataItemOptions | undefined): Promise<DataItem & DataItemNonNullableFields>;
3784
+ }
3785
+ declare function removeDataItem$1(httpClient: HttpClient): RemoveDataItemSignature;
3786
+ interface RemoveDataItemSignature {
3787
+ /**
3788
+ * Removes an item from a collection.
3789
+ *
3790
+ *
3791
+ * If any items in other collections reference the removed item in reference or multi-reference fields, those fields are cleared.
3792
+ *
3793
+ * > **Note:**
3794
+ * > Once an item has been removed from a collection, it can't be restored.
3795
+ * @param - ID of the item to remove.
3796
+ * @param - Options for removing an item from a collection.
3797
+ */
3798
+ (dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
3799
+ }
3800
+ declare function truncateDataItems$1(httpClient: HttpClient): TruncateDataItemsSignature;
3801
+ interface TruncateDataItemsSignature {
3802
+ /**
3803
+ * Removes all items from a collection.
3804
+ *
3805
+ *
3806
+ * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.
3807
+ *
3808
+ * > **Note:**
3809
+ * > Once items have been removed from a collection, they can't be restored.
3810
+ * @param - Options for truncating data items from a collection.
3811
+ */
3812
+ (options: TruncateDataItemsOptions): Promise<void>;
3813
+ }
3814
+ declare function queryDataItems$1(httpClient: HttpClient): QueryDataItemsSignature;
3815
+ interface QueryDataItemsSignature {
3816
+ /**
3817
+ * Creates a query to retrieve items from a database collection.
3818
+ *
3819
+ * The `queryDataItems()` function builds a query to retrieve data items from a collection and returns a `DataItemsQueryBuilder` object.
3820
+ *
3821
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
3822
+ *
3823
+ * You can refine the query by chaining `DataItemsQueryBuilder` functions onto the query. `DataItemsQueryBuilder` functions enable you to sort, filter, and control the results that `queryDataItems()` returns.
3824
+ *
3825
+ * The `queryDataItems()` function runs with the following `DataItemsQueryBuilder` defaults that you can override:
3826
+ *
3827
+ * + `skip`: 0
3828
+ * + `limit`: 50
3829
+ * + `descending`: by `_createdDate`
3830
+ *
3831
+ * The functions that are chained to `queryDataItems()` are applied in the order they are called. For example, if you sort on an `age` field in ascending order and then on a `name` field in descending order, the results are sorted first by the age of the items and then, if there are multiple results with the same age, the items are sorted by name in descending order, per age value.
3832
+ *
3833
+ * If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To get the data from referenced items, specify them in the `options.includeReferencedItems` parameter.
3834
+ *
3835
+ * > **Note**: When calling `queryDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3836
+ *
3837
+ *
3838
+ * @param - Options for querying data items.
3839
+ */
3840
+ (options: QueryDataItemsOptions): DataItemsQueryBuilder;
3841
+ }
3842
+ declare function aggregateDataItems$1(httpClient: HttpClient): AggregateDataItemsSignature;
3843
+ interface AggregateDataItemsSignature {
3844
+ /**
3845
+ * Runs an aggregation on a data collection and returns the resulting list of items.
3846
+ *
3847
+ *
3848
+ * An aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries.
3849
+ * You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.
3850
+ * @param - Options for running an aggregation.
3851
+ */
3852
+ (options?: AggregateDataItemsOptions | undefined): Promise<AggregateDataItemsResponse>;
3853
+ }
3854
+ declare function countDataItems$1(httpClient: HttpClient): CountDataItemsSignature;
3855
+ interface CountDataItemsSignature {
3856
+ /**
3857
+ * Counts the number of items in a data collection that match the provided filtering preferences.
3858
+ *
3859
+ * > **Note**: When calling `countDataItems()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3860
+ * @param - Options for counting the number of items in a data collection.
3861
+ */
3862
+ (options?: CountDataItemsOptions | undefined): Promise<CountDataItemsResponse & CountDataItemsResponseNonNullableFields>;
3863
+ }
3864
+ declare function queryDistinctValues$1(httpClient: HttpClient): QueryDistinctValuesSignature;
3865
+ interface QueryDistinctValuesSignature {
3866
+ /**
3867
+ * Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.
3868
+ *
3869
+ *
3870
+ * As with `queryDataItems()`, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.
3871
+ * However, `queryDistinctValues()` doesn't return all of the full items that match the query.
3872
+ * Rather, it returns all unique values of the field you specify in `options.fieldName` for items that match the query.
3873
+ * If more than one item has the same value for that field, that value appears only once.
3874
+ *
3875
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
3876
+ *
3877
+ * > **Note**: When calling `queryDistinctValues()` following an update to your collection, the data retrieved may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3878
+ * @param - Options for querying distinct values.
3879
+ */
3880
+ (options?: QueryDistinctValuesOptions | undefined): Promise<QueryDistinctValuesResponse>;
3881
+ }
3882
+ declare function bulkInsertDataItems$1(httpClient: HttpClient): BulkInsertDataItemsSignature;
3883
+ interface BulkInsertDataItemsSignature {
3884
+ /**
3885
+ * Adds multiple items to a collection.
3886
+ *
3887
+ *
3888
+ * When each item is inserted into a collection, its ID is automatically assigned a random value.
3889
+ * You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.
3890
+ * @param - Options for adding multiple items to a collection.
3891
+ */
3892
+ (options?: BulkInsertDataItemsOptions | undefined): Promise<BulkInsertDataItemsResponse & BulkInsertDataItemsResponseNonNullableFields>;
3893
+ }
3894
+ declare function bulkUpdateDataItems$1(httpClient: HttpClient): BulkUpdateDataItemsSignature;
3895
+ interface BulkUpdateDataItemsSignature {
3896
+ /**
3897
+ * Updates multiple items in a collection.
3898
+ *
3899
+ *
3900
+ * This function replaces each specified data item's existing data with the payload provided in the request.
3901
+ *
3902
+ * Each item in the request must include an ID. If an item is found in the specified collection with
3903
+ * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.
3904
+ *
3905
+ * When an item is updated, its `data._updatedDate` field is changed to the current date and time.
3906
+ *
3907
+ * > **Note:**
3908
+ * > After each item is updated, it only contains the fields included in the request. If the existing item has fields with values and those fields
3909
+ * > aren't included in the updated item, their values are lost.
3910
+ * @param - Options for updating multiple items in a collection.
3911
+ */
3912
+ (options?: BulkUpdateDataItemsOptions | undefined): Promise<BulkUpdateDataItemsResponse & BulkUpdateDataItemsResponseNonNullableFields>;
3913
+ }
3914
+ declare function bulkSaveDataItems$1(httpClient: HttpClient): BulkSaveDataItemsSignature;
3915
+ interface BulkSaveDataItemsSignature {
3916
+ /**
3917
+ * Inserts or updates multiple items in a collection.
3918
+ *
3919
+ *
3920
+ * This function inserts or updates each item provided, depending on whether it already exists in the collection. For each item:
3921
+ *
3922
+ * + If you don't provide an ID, a new item is created.
3923
+ *
3924
+ * + If you provide an ID that doesn't exist in the collection, a new item is created with that ID.
3925
+ *
3926
+ * + If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `data._updatedDate` field is changed to the current date and time.
3927
+ *
3928
+ * > **Note:** When you provide an item with an ID that already exists in the collection, the item you provide completely replaces the existing item with that ID.
3929
+ * > This means that all of the item's previous fields and values are lost.
3930
+ * @param - Options for saving multiple items in a collection.
3931
+ */
3932
+ (options?: BulkSaveDataItemsOptions | undefined): Promise<BulkSaveDataItemsResponse & BulkSaveDataItemsResponseNonNullableFields>;
3933
+ }
3934
+ declare function bulkRemoveDataItems$1(httpClient: HttpClient): BulkRemoveDataItemsSignature;
3935
+ interface BulkRemoveDataItemsSignature {
3936
+ /**
3937
+ * Removes multiple items from a collection.
3938
+ *
3939
+ *
3940
+ * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.
3941
+ *
3942
+ * > **Note:** Once an item has been removed from a collection, it can't be restored.
3943
+ * @param - Options for removing multiple items from a collection.
3944
+ */
3945
+ (options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
3946
+ }
3947
+ declare function queryReferencedDataItems$1(httpClient: HttpClient): QueryReferencedDataItemsSignature;
3948
+ interface QueryReferencedDataItemsSignature {
3949
+ /**
3950
+ * Retrieves the full items referenced in the specified field of an item.
3951
+ *
3952
+ *
3953
+ * Reference and multi-reference fields refer to items in different collections.
3954
+ * Use this function to retrieve the full details of the referenced items themselves.
3955
+ *
3956
+ * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.
3957
+ * Querying the **Movies** collection using `queryReferencedDataItems()` returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.
3958
+ * This gives you information from the **People** collection about each of the actors in the specified movie.
3959
+ *
3960
+ * > **Note**: When calling `queryReferencedDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3961
+ * @param - Options for querying referenced data items.
3962
+ */
3963
+ (options?: QueryReferencedDataItemsOptions | undefined): Promise<QueryReferencedDataItemsResponse & QueryReferencedDataItemsResponseNonNullableFields>;
3964
+ }
3965
+ declare function isReferencedDataItem$1(httpClient: HttpClient): IsReferencedDataItemSignature;
3966
+ interface IsReferencedDataItemSignature {
3967
+ /**
3968
+ * Checks whether a field in a referring item contains a reference to a specified item.
3969
+ *
3970
+ * > **Note**: When calling `isReferencedDataItem()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
3971
+ * @param - Options for checking whether a field contains a reference to an item.
3972
+ */
3973
+ (options?: IsReferencedDataItemOptions | undefined): Promise<IsReferencedDataItemResponse & IsReferencedDataItemResponseNonNullableFields>;
3974
+ }
3975
+ declare function insertDataItemReference$1(httpClient: HttpClient): InsertDataItemReferenceSignature;
3976
+ interface InsertDataItemReferenceSignature {
3977
+ /**
3978
+ * Inserts a reference in the specified field in an item in a collection.
3979
+ *
3980
+ *
3981
+ * A reference in `options.dataItemReference` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
3982
+ * @param - Options for inserting a reference.
3983
+ */
3984
+ (options?: InsertDataItemReferenceOptions | undefined): Promise<InsertDataItemReferenceResponse & InsertDataItemReferenceResponseNonNullableFields>;
3985
+ }
3986
+ declare function removeDataItemReference$1(httpClient: HttpClient): RemoveDataItemReferenceSignature;
3987
+ interface RemoveDataItemReferenceSignature {
3988
+ /**
3989
+ * Removes the specified reference from the specified field.
3990
+ * @param - Options for removing a reference.
3991
+ */
3992
+ (options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse & RemoveDataItemReferenceResponseNonNullableFields>;
3993
+ }
3994
+ declare function bulkInsertDataItemReferences$1(httpClient: HttpClient): BulkInsertDataItemReferencesSignature;
3995
+ interface BulkInsertDataItemReferencesSignature {
3996
+ /**
3997
+ * Inserts one or more references in the specified fields of items in a collection.
3998
+ *
3999
+ *
4000
+ * This endpoint adds one or more references to a collection.
4001
+ * Each new reference in `options.dataItemReferences` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
4002
+ * @param - Options for inserting one or more references.
4003
+ */
4004
+ (options?: BulkInsertDataItemReferencesOptions | undefined): Promise<BulkInsertDataItemReferencesResponse & BulkInsertDataItemReferencesResponseNonNullableFields>;
4005
+ }
4006
+ declare function bulkRemoveDataItemReferences$1(httpClient: HttpClient): BulkRemoveDataItemReferencesSignature;
4007
+ interface BulkRemoveDataItemReferencesSignature {
4008
+ /**
4009
+ * Removes one or more references.
4010
+ * @param - Options for removing one or more references.
4011
+ */
4012
+ (options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse & BulkRemoveDataItemReferencesResponseNonNullableFields>;
4013
+ }
4014
+ declare function replaceDataItemReferences$1(httpClient: HttpClient): ReplaceDataItemReferencesSignature;
4015
+ interface ReplaceDataItemReferencesSignature {
4016
+ /**
4017
+ * Replaces references in a specified field of a specified data item.
4018
+ *
4019
+ *
4020
+ * This function replaces the existing reference or references contained in the field specified in `options.referringItemFieldName` within the data item specified in `options.referringItemId`.
4021
+ * The function removes existing references and in their place it adds references to the items specified in `options.newReferencedItemIds`.
4022
+ *
4023
+ * > **Note:** If you pass an empty array in `options.newReferencedItemIds`, all existing references are removed.
4024
+ * @param - Options for replacing references.
4025
+ */
4026
+ (options?: ReplaceDataItemReferencesOptions | undefined): Promise<ReplaceDataItemReferencesResponse & ReplaceDataItemReferencesResponseNonNullableFields>;
4027
+ }
4028
+ declare const onDataItemCreated$1: EventDefinition<DataItemCreatedEnvelope, "wix.data.v2.data_item_created">;
4029
+ declare const onDataItemUpdated$1: EventDefinition<DataItemUpdatedEnvelope, "wix.data.v2.data_item_updated">;
4030
+ declare const onDataItemDeleted$1: EventDefinition<DataItemDeletedEnvelope, "wix.data.v2.data_item_deleted">;
4031
+
3505
4032
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3506
4033
 
3507
4034
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3508
4035
 
3509
- declare const insertDataItem: ReturnType<typeof createRESTModule$1<typeof publicInsertDataItem>>;
3510
- declare const updateDataItem: ReturnType<typeof createRESTModule$1<typeof publicUpdateDataItem>>;
3511
- declare const saveDataItem: ReturnType<typeof createRESTModule$1<typeof publicSaveDataItem>>;
3512
- declare const getDataItem: ReturnType<typeof createRESTModule$1<typeof publicGetDataItem>>;
3513
- declare const removeDataItem: ReturnType<typeof createRESTModule$1<typeof publicRemoveDataItem>>;
3514
- declare const truncateDataItems: ReturnType<typeof createRESTModule$1<typeof publicTruncateDataItems>>;
3515
- declare const queryDataItems: ReturnType<typeof createRESTModule$1<typeof publicQueryDataItems>>;
3516
- declare const aggregateDataItems: ReturnType<typeof createRESTModule$1<typeof publicAggregateDataItems>>;
3517
- declare const countDataItems: ReturnType<typeof createRESTModule$1<typeof publicCountDataItems>>;
3518
- declare const queryDistinctValues: ReturnType<typeof createRESTModule$1<typeof publicQueryDistinctValues>>;
3519
- declare const bulkInsertDataItems: ReturnType<typeof createRESTModule$1<typeof publicBulkInsertDataItems>>;
3520
- declare const bulkUpdateDataItems: ReturnType<typeof createRESTModule$1<typeof publicBulkUpdateDataItems>>;
3521
- declare const bulkSaveDataItems: ReturnType<typeof createRESTModule$1<typeof publicBulkSaveDataItems>>;
3522
- declare const bulkRemoveDataItems: ReturnType<typeof createRESTModule$1<typeof publicBulkRemoveDataItems>>;
3523
- declare const queryReferencedDataItems: ReturnType<typeof createRESTModule$1<typeof publicQueryReferencedDataItems>>;
3524
- declare const isReferencedDataItem: ReturnType<typeof createRESTModule$1<typeof publicIsReferencedDataItem>>;
3525
- declare const insertDataItemReference: ReturnType<typeof createRESTModule$1<typeof publicInsertDataItemReference>>;
3526
- declare const removeDataItemReference: ReturnType<typeof createRESTModule$1<typeof publicRemoveDataItemReference>>;
3527
- declare const bulkInsertDataItemReferences: ReturnType<typeof createRESTModule$1<typeof publicBulkInsertDataItemReferences>>;
3528
- declare const bulkRemoveDataItemReferences: ReturnType<typeof createRESTModule$1<typeof publicBulkRemoveDataItemReferences>>;
3529
- declare const replaceDataItemReferences: ReturnType<typeof createRESTModule$1<typeof publicReplaceDataItemReferences>>;
3530
- declare const onDataItemCreated: ReturnType<typeof createEventModule<typeof publicOnDataItemCreated>>;
3531
- declare const onDataItemUpdated: ReturnType<typeof createEventModule<typeof publicOnDataItemUpdated>>;
3532
- declare const onDataItemDeleted: ReturnType<typeof createEventModule<typeof publicOnDataItemDeleted>>;
4036
+ type _publicInsertDataItemType = typeof insertDataItem$1;
4037
+ declare const insertDataItem: ReturnType<typeof createRESTModule$1<_publicInsertDataItemType>>;
4038
+ type _publicUpdateDataItemType = typeof updateDataItem$1;
4039
+ declare const updateDataItem: ReturnType<typeof createRESTModule$1<_publicUpdateDataItemType>>;
4040
+ type _publicSaveDataItemType = typeof saveDataItem$1;
4041
+ declare const saveDataItem: ReturnType<typeof createRESTModule$1<_publicSaveDataItemType>>;
4042
+ type _publicGetDataItemType = typeof getDataItem$1;
4043
+ declare const getDataItem: ReturnType<typeof createRESTModule$1<_publicGetDataItemType>>;
4044
+ type _publicRemoveDataItemType = typeof removeDataItem$1;
4045
+ declare const removeDataItem: ReturnType<typeof createRESTModule$1<_publicRemoveDataItemType>>;
4046
+ type _publicTruncateDataItemsType = typeof truncateDataItems$1;
4047
+ declare const truncateDataItems: ReturnType<typeof createRESTModule$1<_publicTruncateDataItemsType>>;
4048
+ type _publicQueryDataItemsType = typeof queryDataItems$1;
4049
+ declare const queryDataItems: ReturnType<typeof createRESTModule$1<_publicQueryDataItemsType>>;
4050
+ type _publicAggregateDataItemsType = typeof aggregateDataItems$1;
4051
+ declare const aggregateDataItems: ReturnType<typeof createRESTModule$1<_publicAggregateDataItemsType>>;
4052
+ type _publicCountDataItemsType = typeof countDataItems$1;
4053
+ declare const countDataItems: ReturnType<typeof createRESTModule$1<_publicCountDataItemsType>>;
4054
+ type _publicQueryDistinctValuesType = typeof queryDistinctValues$1;
4055
+ declare const queryDistinctValues: ReturnType<typeof createRESTModule$1<_publicQueryDistinctValuesType>>;
4056
+ type _publicBulkInsertDataItemsType = typeof bulkInsertDataItems$1;
4057
+ declare const bulkInsertDataItems: ReturnType<typeof createRESTModule$1<_publicBulkInsertDataItemsType>>;
4058
+ type _publicBulkUpdateDataItemsType = typeof bulkUpdateDataItems$1;
4059
+ declare const bulkUpdateDataItems: ReturnType<typeof createRESTModule$1<_publicBulkUpdateDataItemsType>>;
4060
+ type _publicBulkSaveDataItemsType = typeof bulkSaveDataItems$1;
4061
+ declare const bulkSaveDataItems: ReturnType<typeof createRESTModule$1<_publicBulkSaveDataItemsType>>;
4062
+ type _publicBulkRemoveDataItemsType = typeof bulkRemoveDataItems$1;
4063
+ declare const bulkRemoveDataItems: ReturnType<typeof createRESTModule$1<_publicBulkRemoveDataItemsType>>;
4064
+ type _publicQueryReferencedDataItemsType = typeof queryReferencedDataItems$1;
4065
+ declare const queryReferencedDataItems: ReturnType<typeof createRESTModule$1<_publicQueryReferencedDataItemsType>>;
4066
+ type _publicIsReferencedDataItemType = typeof isReferencedDataItem$1;
4067
+ declare const isReferencedDataItem: ReturnType<typeof createRESTModule$1<_publicIsReferencedDataItemType>>;
4068
+ type _publicInsertDataItemReferenceType = typeof insertDataItemReference$1;
4069
+ declare const insertDataItemReference: ReturnType<typeof createRESTModule$1<_publicInsertDataItemReferenceType>>;
4070
+ type _publicRemoveDataItemReferenceType = typeof removeDataItemReference$1;
4071
+ declare const removeDataItemReference: ReturnType<typeof createRESTModule$1<_publicRemoveDataItemReferenceType>>;
4072
+ type _publicBulkInsertDataItemReferencesType = typeof bulkInsertDataItemReferences$1;
4073
+ declare const bulkInsertDataItemReferences: ReturnType<typeof createRESTModule$1<_publicBulkInsertDataItemReferencesType>>;
4074
+ type _publicBulkRemoveDataItemReferencesType = typeof bulkRemoveDataItemReferences$1;
4075
+ declare const bulkRemoveDataItemReferences: ReturnType<typeof createRESTModule$1<_publicBulkRemoveDataItemReferencesType>>;
4076
+ type _publicReplaceDataItemReferencesType = typeof replaceDataItemReferences$1;
4077
+ declare const replaceDataItemReferences: ReturnType<typeof createRESTModule$1<_publicReplaceDataItemReferencesType>>;
4078
+
4079
+ type _publicOnDataItemCreatedType = typeof onDataItemCreated$1;
4080
+ /**
4081
+ * Triggered when a data item is inserted.
4082
+ */
4083
+ declare const onDataItemCreated: ReturnType<typeof createEventModule<_publicOnDataItemCreatedType>>;
4084
+
4085
+ type _publicOnDataItemUpdatedType = typeof onDataItemUpdated$1;
4086
+ /**
4087
+ * Triggered when a data item is updated.
4088
+ */
4089
+ declare const onDataItemUpdated: ReturnType<typeof createEventModule<_publicOnDataItemUpdatedType>>;
4090
+
4091
+ type _publicOnDataItemDeletedType = typeof onDataItemDeleted$1;
4092
+ /**
4093
+ * Triggered when a data item is deleted.
4094
+ */
4095
+ declare const onDataItemDeleted: ReturnType<typeof createEventModule<_publicOnDataItemDeletedType>>;
3533
4096
 
3534
4097
  type context$1_ACTION = ACTION;
3535
4098
  declare const context$1_ACTION: typeof ACTION;
@@ -3683,6 +4246,30 @@ type context$1_UpdateDataItemResponse = UpdateDataItemResponse;
3683
4246
  type context$1_UpdateDataItemResponseNonNullableFields = UpdateDataItemResponseNonNullableFields;
3684
4247
  type context$1_WebhookIdentityType = WebhookIdentityType;
3685
4248
  declare const context$1_WebhookIdentityType: typeof WebhookIdentityType;
4249
+ type context$1__publicAggregateDataItemsType = _publicAggregateDataItemsType;
4250
+ type context$1__publicBulkInsertDataItemReferencesType = _publicBulkInsertDataItemReferencesType;
4251
+ type context$1__publicBulkInsertDataItemsType = _publicBulkInsertDataItemsType;
4252
+ type context$1__publicBulkRemoveDataItemReferencesType = _publicBulkRemoveDataItemReferencesType;
4253
+ type context$1__publicBulkRemoveDataItemsType = _publicBulkRemoveDataItemsType;
4254
+ type context$1__publicBulkSaveDataItemsType = _publicBulkSaveDataItemsType;
4255
+ type context$1__publicBulkUpdateDataItemsType = _publicBulkUpdateDataItemsType;
4256
+ type context$1__publicCountDataItemsType = _publicCountDataItemsType;
4257
+ type context$1__publicGetDataItemType = _publicGetDataItemType;
4258
+ type context$1__publicInsertDataItemReferenceType = _publicInsertDataItemReferenceType;
4259
+ type context$1__publicInsertDataItemType = _publicInsertDataItemType;
4260
+ type context$1__publicIsReferencedDataItemType = _publicIsReferencedDataItemType;
4261
+ type context$1__publicOnDataItemCreatedType = _publicOnDataItemCreatedType;
4262
+ type context$1__publicOnDataItemDeletedType = _publicOnDataItemDeletedType;
4263
+ type context$1__publicOnDataItemUpdatedType = _publicOnDataItemUpdatedType;
4264
+ type context$1__publicQueryDataItemsType = _publicQueryDataItemsType;
4265
+ type context$1__publicQueryDistinctValuesType = _publicQueryDistinctValuesType;
4266
+ type context$1__publicQueryReferencedDataItemsType = _publicQueryReferencedDataItemsType;
4267
+ type context$1__publicRemoveDataItemReferenceType = _publicRemoveDataItemReferenceType;
4268
+ type context$1__publicRemoveDataItemType = _publicRemoveDataItemType;
4269
+ type context$1__publicReplaceDataItemReferencesType = _publicReplaceDataItemReferencesType;
4270
+ type context$1__publicSaveDataItemType = _publicSaveDataItemType;
4271
+ type context$1__publicTruncateDataItemsType = _publicTruncateDataItemsType;
4272
+ type context$1__publicUpdateDataItemType = _publicUpdateDataItemType;
3686
4273
  declare const context$1_aggregateDataItems: typeof aggregateDataItems;
3687
4274
  declare const context$1_bulkInsertDataItemReferences: typeof bulkInsertDataItemReferences;
3688
4275
  declare const context$1_bulkInsertDataItems: typeof bulkInsertDataItems;
@@ -3708,7 +4295,7 @@ declare const context$1_saveDataItem: typeof saveDataItem;
3708
4295
  declare const context$1_truncateDataItems: typeof truncateDataItems;
3709
4296
  declare const context$1_updateDataItem: typeof updateDataItem;
3710
4297
  declare namespace context$1 {
3711
- export { context$1_ACTION as ACTION, context$1_Action as Action, type context$1_ActionEvent as ActionEvent, type context$1_AggregateDataItemsOptions as AggregateDataItemsOptions, type context$1_AggregateDataItemsRequest as AggregateDataItemsRequest, type context$1_AggregateDataItemsRequestPagingMethodOneOf as AggregateDataItemsRequestPagingMethodOneOf, type context$1_AggregateDataItemsResponse as AggregateDataItemsResponse, type context$1_Aggregation as Aggregation, type context$1_AppendToArray as AppendToArray, type context$1_ApplicationError as ApplicationError, type context$1_Average as Average, type context$1_BaseEventMetadata as BaseEventMetadata, type context$1_BulkActionMetadata as BulkActionMetadata, context$1_BulkActionType as BulkActionType, type context$1_BulkDataItemReferenceResult as BulkDataItemReferenceResult, type context$1_BulkDataItemResult as BulkDataItemResult, type context$1_BulkInsertDataItemReferencesOptions as BulkInsertDataItemReferencesOptions, type context$1_BulkInsertDataItemReferencesRequest as BulkInsertDataItemReferencesRequest, type context$1_BulkInsertDataItemReferencesResponse as BulkInsertDataItemReferencesResponse, type context$1_BulkInsertDataItemReferencesResponseNonNullableFields as BulkInsertDataItemReferencesResponseNonNullableFields, type context$1_BulkInsertDataItemsOptions as BulkInsertDataItemsOptions, type context$1_BulkInsertDataItemsRequest as BulkInsertDataItemsRequest, type context$1_BulkInsertDataItemsResponse as BulkInsertDataItemsResponse, type context$1_BulkInsertDataItemsResponseNonNullableFields as BulkInsertDataItemsResponseNonNullableFields, type context$1_BulkPatchDataItemsRequest as BulkPatchDataItemsRequest, type context$1_BulkPatchDataItemsResponse as BulkPatchDataItemsResponse, type context$1_BulkRemoveDataItemReferencesOptions as BulkRemoveDataItemReferencesOptions, type context$1_BulkRemoveDataItemReferencesRequest as BulkRemoveDataItemReferencesRequest, type context$1_BulkRemoveDataItemReferencesResponse as BulkRemoveDataItemReferencesResponse, type context$1_BulkRemoveDataItemReferencesResponseNonNullableFields as BulkRemoveDataItemReferencesResponseNonNullableFields, type context$1_BulkRemoveDataItemsOptions as BulkRemoveDataItemsOptions, type context$1_BulkRemoveDataItemsRequest as BulkRemoveDataItemsRequest, type context$1_BulkRemoveDataItemsResponse as BulkRemoveDataItemsResponse, type context$1_BulkRemoveDataItemsResponseNonNullableFields as BulkRemoveDataItemsResponseNonNullableFields, type context$1_BulkSaveDataItemsOptions as BulkSaveDataItemsOptions, type context$1_BulkSaveDataItemsRequest as BulkSaveDataItemsRequest, type context$1_BulkSaveDataItemsResponse as BulkSaveDataItemsResponse, type context$1_BulkSaveDataItemsResponseNonNullableFields as BulkSaveDataItemsResponseNonNullableFields, type context$1_BulkUpdateDataItemsOptions as BulkUpdateDataItemsOptions, type context$1_BulkUpdateDataItemsRequest as BulkUpdateDataItemsRequest, type context$1_BulkUpdateDataItemsResponse as BulkUpdateDataItemsResponse, type context$1_BulkUpdateDataItemsResponseNonNullableFields as BulkUpdateDataItemsResponseNonNullableFields, type context$1_CachingInfo as CachingInfo, type context$1_Count as Count, type context$1_CountDataItemsOptions as CountDataItemsOptions, type context$1_CountDataItemsRequest as CountDataItemsRequest, type context$1_CountDataItemsResponse as CountDataItemsResponse, type context$1_CountDataItemsResponseNonNullableFields as CountDataItemsResponseNonNullableFields, type context$1_CursorPaging as CursorPaging, type context$1_Cursors as Cursors, type context$1_DataItem as DataItem, type context$1_DataItemCreatedEnvelope as DataItemCreatedEnvelope, type context$1_DataItemDeletedEnvelope as DataItemDeletedEnvelope, type context$1_DataItemNonNullableFields as DataItemNonNullableFields, type context$1_DataItemReference as DataItemReference, type context$1_DataItemUpdatedEnvelope as DataItemUpdatedEnvelope, type context$1_DataItemsQueryBuilder as DataItemsQueryBuilder, type context$1_DataItemsQueryResult as DataItemsQueryResult, type context$1_DataPublishPluginOptions as DataPublishPluginOptions, type context$1_DomainEvent as DomainEvent, type context$1_DomainEventBodyOneOf as DomainEventBodyOneOf, type context$1_EntityCreatedEvent as EntityCreatedEvent, type context$1_EntityDeletedEvent as EntityDeletedEvent, type context$1_EntityUpdatedEvent as EntityUpdatedEvent, Environment$1 as Environment, type context$1_EventMetadata as EventMetadata, type context$1_FieldUpdate as FieldUpdate, type context$1_FieldUpdateActionOptionsOneOf as FieldUpdateActionOptionsOneOf, type context$1_GetDataItemOptions as GetDataItemOptions, type context$1_GetDataItemRequest as GetDataItemRequest, type context$1_GetDataItemResponse as GetDataItemResponse, type context$1_GetDataItemResponseNonNullableFields as GetDataItemResponseNonNullableFields, type context$1_IdentificationData as IdentificationData, type context$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context$1_IncrementField as IncrementField, type context$1_InsertDataItemOptions as InsertDataItemOptions, type context$1_InsertDataItemReferenceOptions as InsertDataItemReferenceOptions, type context$1_InsertDataItemReferenceRequest as InsertDataItemReferenceRequest, type context$1_InsertDataItemReferenceResponse as InsertDataItemReferenceResponse, type context$1_InsertDataItemReferenceResponseNonNullableFields as InsertDataItemReferenceResponseNonNullableFields, type context$1_InsertDataItemRequest as InsertDataItemRequest, type context$1_InsertDataItemResponse as InsertDataItemResponse, type context$1_InsertDataItemResponseNonNullableFields as InsertDataItemResponseNonNullableFields, type context$1_IsReferencedDataItemOptions as IsReferencedDataItemOptions, type context$1_IsReferencedDataItemRequest as IsReferencedDataItemRequest, type context$1_IsReferencedDataItemResponse as IsReferencedDataItemResponse, type context$1_IsReferencedDataItemResponseNonNullableFields as IsReferencedDataItemResponseNonNullableFields, type context$1_ItemMetadata as ItemMetadata, type context$1_Max as Max, type context$1_MessageEnvelope as MessageEnvelope, type context$1_Min as Min, type context$1_Operation as Operation, type context$1_OperationCalculateOneOf as OperationCalculateOneOf, type context$1_Options as Options, type Paging$1 as Paging, type context$1_PagingMetadataV2 as PagingMetadataV2, type context$1_PatchDataItemRequest as PatchDataItemRequest, type context$1_PatchDataItemResponse as PatchDataItemResponse, type context$1_PatchSet as PatchSet, type context$1_PublishPluginOptions as PublishPluginOptions, type context$1_QueryDataItemsOptions as QueryDataItemsOptions, type context$1_QueryDataItemsRequest as QueryDataItemsRequest, type context$1_QueryDataItemsResponse as QueryDataItemsResponse, type context$1_QueryDataItemsResponseNonNullableFields as QueryDataItemsResponseNonNullableFields, type context$1_QueryDistinctValuesOptions as QueryDistinctValuesOptions, type context$1_QueryDistinctValuesRequest as QueryDistinctValuesRequest, type context$1_QueryDistinctValuesRequestPagingMethodOneOf as QueryDistinctValuesRequestPagingMethodOneOf, type context$1_QueryDistinctValuesResponse as QueryDistinctValuesResponse, type context$1_QueryReferencedDataItemsOptions as QueryReferencedDataItemsOptions, type context$1_QueryReferencedDataItemsRequest as QueryReferencedDataItemsRequest, type context$1_QueryReferencedDataItemsRequestPagingMethodOneOf as QueryReferencedDataItemsRequestPagingMethodOneOf, type context$1_QueryReferencedDataItemsResponse as QueryReferencedDataItemsResponse, type context$1_QueryReferencedDataItemsResponseNonNullableFields as QueryReferencedDataItemsResponseNonNullableFields, type context$1_QueryV2 as QueryV2, type context$1_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context$1_ReferencedItemOptions as ReferencedItemOptions, type context$1_ReferencedResult as ReferencedResult, type context$1_ReferencedResultEntityOneOf as ReferencedResultEntityOneOf, type context$1_RemoveDataItemOptions as RemoveDataItemOptions, type context$1_RemoveDataItemReferenceOptions as RemoveDataItemReferenceOptions, type context$1_RemoveDataItemReferenceRequest as RemoveDataItemReferenceRequest, type context$1_RemoveDataItemReferenceResponse as RemoveDataItemReferenceResponse, type context$1_RemoveDataItemReferenceResponseNonNullableFields as RemoveDataItemReferenceResponseNonNullableFields, type context$1_RemoveDataItemRequest as RemoveDataItemRequest, type context$1_RemoveDataItemResponse as RemoveDataItemResponse, type context$1_RemoveDataItemResponseNonNullableFields as RemoveDataItemResponseNonNullableFields, type context$1_RemoveFromArray as RemoveFromArray, type context$1_ReplaceDataItemReferencesOptions as ReplaceDataItemReferencesOptions, type context$1_ReplaceDataItemReferencesRequest as ReplaceDataItemReferencesRequest, type context$1_ReplaceDataItemReferencesResponse as ReplaceDataItemReferencesResponse, type context$1_ReplaceDataItemReferencesResponseNonNullableFields as ReplaceDataItemReferencesResponseNonNullableFields, type context$1_RestoreInfo as RestoreInfo, type context$1_SaveDataItemOptions as SaveDataItemOptions, type context$1_SaveDataItemRequest as SaveDataItemRequest, type context$1_SaveDataItemResponse as SaveDataItemResponse, type context$1_SaveDataItemResponseNonNullableFields as SaveDataItemResponseNonNullableFields, type context$1_SetField as SetField, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, type context$1_Sum as Sum, type context$1_TruncateDataItemsOptions as TruncateDataItemsOptions, type context$1_TruncateDataItemsRequest as TruncateDataItemsRequest, type context$1_TruncateDataItemsResponse as TruncateDataItemsResponse, type context$1_UnresolvedReference as UnresolvedReference, type context$1_UpdateDataItemOptions as UpdateDataItemOptions, type context$1_UpdateDataItemRequest as UpdateDataItemRequest, type context$1_UpdateDataItemResponse as UpdateDataItemResponse, type context$1_UpdateDataItemResponseNonNullableFields as UpdateDataItemResponseNonNullableFields, context$1_WebhookIdentityType as WebhookIdentityType, context$1_aggregateDataItems as aggregateDataItems, context$1_bulkInsertDataItemReferences as bulkInsertDataItemReferences, context$1_bulkInsertDataItems as bulkInsertDataItems, context$1_bulkRemoveDataItemReferences as bulkRemoveDataItemReferences, context$1_bulkRemoveDataItems as bulkRemoveDataItems, context$1_bulkSaveDataItems as bulkSaveDataItems, context$1_bulkUpdateDataItems as bulkUpdateDataItems, context$1_countDataItems as countDataItems, context$1_getDataItem as getDataItem, context$1_insertDataItem as insertDataItem, context$1_insertDataItemReference as insertDataItemReference, context$1_isReferencedDataItem as isReferencedDataItem, context$1_onDataItemCreated as onDataItemCreated, context$1_onDataItemDeleted as onDataItemDeleted, context$1_onDataItemUpdated as onDataItemUpdated, context$1_queryDataItems as queryDataItems, context$1_queryDistinctValues as queryDistinctValues, context$1_queryReferencedDataItems as queryReferencedDataItems, context$1_removeDataItem as removeDataItem, context$1_removeDataItemReference as removeDataItemReference, context$1_replaceDataItemReferences as replaceDataItemReferences, context$1_saveDataItem as saveDataItem, context$1_truncateDataItems as truncateDataItems, context$1_updateDataItem as updateDataItem };
4298
+ export { context$1_ACTION as ACTION, context$1_Action as Action, type context$1_ActionEvent as ActionEvent, type context$1_AggregateDataItemsOptions as AggregateDataItemsOptions, type context$1_AggregateDataItemsRequest as AggregateDataItemsRequest, type context$1_AggregateDataItemsRequestPagingMethodOneOf as AggregateDataItemsRequestPagingMethodOneOf, type context$1_AggregateDataItemsResponse as AggregateDataItemsResponse, type context$1_Aggregation as Aggregation, type context$1_AppendToArray as AppendToArray, type context$1_ApplicationError as ApplicationError, type context$1_Average as Average, type context$1_BaseEventMetadata as BaseEventMetadata, type context$1_BulkActionMetadata as BulkActionMetadata, context$1_BulkActionType as BulkActionType, type context$1_BulkDataItemReferenceResult as BulkDataItemReferenceResult, type context$1_BulkDataItemResult as BulkDataItemResult, type context$1_BulkInsertDataItemReferencesOptions as BulkInsertDataItemReferencesOptions, type context$1_BulkInsertDataItemReferencesRequest as BulkInsertDataItemReferencesRequest, type context$1_BulkInsertDataItemReferencesResponse as BulkInsertDataItemReferencesResponse, type context$1_BulkInsertDataItemReferencesResponseNonNullableFields as BulkInsertDataItemReferencesResponseNonNullableFields, type context$1_BulkInsertDataItemsOptions as BulkInsertDataItemsOptions, type context$1_BulkInsertDataItemsRequest as BulkInsertDataItemsRequest, type context$1_BulkInsertDataItemsResponse as BulkInsertDataItemsResponse, type context$1_BulkInsertDataItemsResponseNonNullableFields as BulkInsertDataItemsResponseNonNullableFields, type context$1_BulkPatchDataItemsRequest as BulkPatchDataItemsRequest, type context$1_BulkPatchDataItemsResponse as BulkPatchDataItemsResponse, type context$1_BulkRemoveDataItemReferencesOptions as BulkRemoveDataItemReferencesOptions, type context$1_BulkRemoveDataItemReferencesRequest as BulkRemoveDataItemReferencesRequest, type context$1_BulkRemoveDataItemReferencesResponse as BulkRemoveDataItemReferencesResponse, type context$1_BulkRemoveDataItemReferencesResponseNonNullableFields as BulkRemoveDataItemReferencesResponseNonNullableFields, type context$1_BulkRemoveDataItemsOptions as BulkRemoveDataItemsOptions, type context$1_BulkRemoveDataItemsRequest as BulkRemoveDataItemsRequest, type context$1_BulkRemoveDataItemsResponse as BulkRemoveDataItemsResponse, type context$1_BulkRemoveDataItemsResponseNonNullableFields as BulkRemoveDataItemsResponseNonNullableFields, type context$1_BulkSaveDataItemsOptions as BulkSaveDataItemsOptions, type context$1_BulkSaveDataItemsRequest as BulkSaveDataItemsRequest, type context$1_BulkSaveDataItemsResponse as BulkSaveDataItemsResponse, type context$1_BulkSaveDataItemsResponseNonNullableFields as BulkSaveDataItemsResponseNonNullableFields, type context$1_BulkUpdateDataItemsOptions as BulkUpdateDataItemsOptions, type context$1_BulkUpdateDataItemsRequest as BulkUpdateDataItemsRequest, type context$1_BulkUpdateDataItemsResponse as BulkUpdateDataItemsResponse, type context$1_BulkUpdateDataItemsResponseNonNullableFields as BulkUpdateDataItemsResponseNonNullableFields, type context$1_CachingInfo as CachingInfo, type context$1_Count as Count, type context$1_CountDataItemsOptions as CountDataItemsOptions, type context$1_CountDataItemsRequest as CountDataItemsRequest, type context$1_CountDataItemsResponse as CountDataItemsResponse, type context$1_CountDataItemsResponseNonNullableFields as CountDataItemsResponseNonNullableFields, type context$1_CursorPaging as CursorPaging, type context$1_Cursors as Cursors, type context$1_DataItem as DataItem, type context$1_DataItemCreatedEnvelope as DataItemCreatedEnvelope, type context$1_DataItemDeletedEnvelope as DataItemDeletedEnvelope, type context$1_DataItemNonNullableFields as DataItemNonNullableFields, type context$1_DataItemReference as DataItemReference, type context$1_DataItemUpdatedEnvelope as DataItemUpdatedEnvelope, type context$1_DataItemsQueryBuilder as DataItemsQueryBuilder, type context$1_DataItemsQueryResult as DataItemsQueryResult, type context$1_DataPublishPluginOptions as DataPublishPluginOptions, type context$1_DomainEvent as DomainEvent, type context$1_DomainEventBodyOneOf as DomainEventBodyOneOf, type context$1_EntityCreatedEvent as EntityCreatedEvent, type context$1_EntityDeletedEvent as EntityDeletedEvent, type context$1_EntityUpdatedEvent as EntityUpdatedEvent, Environment$1 as Environment, type context$1_EventMetadata as EventMetadata, type context$1_FieldUpdate as FieldUpdate, type context$1_FieldUpdateActionOptionsOneOf as FieldUpdateActionOptionsOneOf, type context$1_GetDataItemOptions as GetDataItemOptions, type context$1_GetDataItemRequest as GetDataItemRequest, type context$1_GetDataItemResponse as GetDataItemResponse, type context$1_GetDataItemResponseNonNullableFields as GetDataItemResponseNonNullableFields, type context$1_IdentificationData as IdentificationData, type context$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context$1_IncrementField as IncrementField, type context$1_InsertDataItemOptions as InsertDataItemOptions, type context$1_InsertDataItemReferenceOptions as InsertDataItemReferenceOptions, type context$1_InsertDataItemReferenceRequest as InsertDataItemReferenceRequest, type context$1_InsertDataItemReferenceResponse as InsertDataItemReferenceResponse, type context$1_InsertDataItemReferenceResponseNonNullableFields as InsertDataItemReferenceResponseNonNullableFields, type context$1_InsertDataItemRequest as InsertDataItemRequest, type context$1_InsertDataItemResponse as InsertDataItemResponse, type context$1_InsertDataItemResponseNonNullableFields as InsertDataItemResponseNonNullableFields, type context$1_IsReferencedDataItemOptions as IsReferencedDataItemOptions, type context$1_IsReferencedDataItemRequest as IsReferencedDataItemRequest, type context$1_IsReferencedDataItemResponse as IsReferencedDataItemResponse, type context$1_IsReferencedDataItemResponseNonNullableFields as IsReferencedDataItemResponseNonNullableFields, type context$1_ItemMetadata as ItemMetadata, type context$1_Max as Max, type context$1_MessageEnvelope as MessageEnvelope, type context$1_Min as Min, type context$1_Operation as Operation, type context$1_OperationCalculateOneOf as OperationCalculateOneOf, type context$1_Options as Options, type Paging$1 as Paging, type context$1_PagingMetadataV2 as PagingMetadataV2, type context$1_PatchDataItemRequest as PatchDataItemRequest, type context$1_PatchDataItemResponse as PatchDataItemResponse, type context$1_PatchSet as PatchSet, type context$1_PublishPluginOptions as PublishPluginOptions, type context$1_QueryDataItemsOptions as QueryDataItemsOptions, type context$1_QueryDataItemsRequest as QueryDataItemsRequest, type context$1_QueryDataItemsResponse as QueryDataItemsResponse, type context$1_QueryDataItemsResponseNonNullableFields as QueryDataItemsResponseNonNullableFields, type context$1_QueryDistinctValuesOptions as QueryDistinctValuesOptions, type context$1_QueryDistinctValuesRequest as QueryDistinctValuesRequest, type context$1_QueryDistinctValuesRequestPagingMethodOneOf as QueryDistinctValuesRequestPagingMethodOneOf, type context$1_QueryDistinctValuesResponse as QueryDistinctValuesResponse, type context$1_QueryReferencedDataItemsOptions as QueryReferencedDataItemsOptions, type context$1_QueryReferencedDataItemsRequest as QueryReferencedDataItemsRequest, type context$1_QueryReferencedDataItemsRequestPagingMethodOneOf as QueryReferencedDataItemsRequestPagingMethodOneOf, type context$1_QueryReferencedDataItemsResponse as QueryReferencedDataItemsResponse, type context$1_QueryReferencedDataItemsResponseNonNullableFields as QueryReferencedDataItemsResponseNonNullableFields, type context$1_QueryV2 as QueryV2, type context$1_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type context$1_ReferencedItemOptions as ReferencedItemOptions, type context$1_ReferencedResult as ReferencedResult, type context$1_ReferencedResultEntityOneOf as ReferencedResultEntityOneOf, type context$1_RemoveDataItemOptions as RemoveDataItemOptions, type context$1_RemoveDataItemReferenceOptions as RemoveDataItemReferenceOptions, type context$1_RemoveDataItemReferenceRequest as RemoveDataItemReferenceRequest, type context$1_RemoveDataItemReferenceResponse as RemoveDataItemReferenceResponse, type context$1_RemoveDataItemReferenceResponseNonNullableFields as RemoveDataItemReferenceResponseNonNullableFields, type context$1_RemoveDataItemRequest as RemoveDataItemRequest, type context$1_RemoveDataItemResponse as RemoveDataItemResponse, type context$1_RemoveDataItemResponseNonNullableFields as RemoveDataItemResponseNonNullableFields, type context$1_RemoveFromArray as RemoveFromArray, type context$1_ReplaceDataItemReferencesOptions as ReplaceDataItemReferencesOptions, type context$1_ReplaceDataItemReferencesRequest as ReplaceDataItemReferencesRequest, type context$1_ReplaceDataItemReferencesResponse as ReplaceDataItemReferencesResponse, type context$1_ReplaceDataItemReferencesResponseNonNullableFields as ReplaceDataItemReferencesResponseNonNullableFields, type context$1_RestoreInfo as RestoreInfo, type context$1_SaveDataItemOptions as SaveDataItemOptions, type context$1_SaveDataItemRequest as SaveDataItemRequest, type context$1_SaveDataItemResponse as SaveDataItemResponse, type context$1_SaveDataItemResponseNonNullableFields as SaveDataItemResponseNonNullableFields, type context$1_SetField as SetField, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, type context$1_Sum as Sum, type context$1_TruncateDataItemsOptions as TruncateDataItemsOptions, type context$1_TruncateDataItemsRequest as TruncateDataItemsRequest, type context$1_TruncateDataItemsResponse as TruncateDataItemsResponse, type context$1_UnresolvedReference as UnresolvedReference, type context$1_UpdateDataItemOptions as UpdateDataItemOptions, type context$1_UpdateDataItemRequest as UpdateDataItemRequest, type context$1_UpdateDataItemResponse as UpdateDataItemResponse, type context$1_UpdateDataItemResponseNonNullableFields as UpdateDataItemResponseNonNullableFields, context$1_WebhookIdentityType as WebhookIdentityType, type context$1__publicAggregateDataItemsType as _publicAggregateDataItemsType, type context$1__publicBulkInsertDataItemReferencesType as _publicBulkInsertDataItemReferencesType, type context$1__publicBulkInsertDataItemsType as _publicBulkInsertDataItemsType, type context$1__publicBulkRemoveDataItemReferencesType as _publicBulkRemoveDataItemReferencesType, type context$1__publicBulkRemoveDataItemsType as _publicBulkRemoveDataItemsType, type context$1__publicBulkSaveDataItemsType as _publicBulkSaveDataItemsType, type context$1__publicBulkUpdateDataItemsType as _publicBulkUpdateDataItemsType, type context$1__publicCountDataItemsType as _publicCountDataItemsType, type context$1__publicGetDataItemType as _publicGetDataItemType, type context$1__publicInsertDataItemReferenceType as _publicInsertDataItemReferenceType, type context$1__publicInsertDataItemType as _publicInsertDataItemType, type context$1__publicIsReferencedDataItemType as _publicIsReferencedDataItemType, type context$1__publicOnDataItemCreatedType as _publicOnDataItemCreatedType, type context$1__publicOnDataItemDeletedType as _publicOnDataItemDeletedType, type context$1__publicOnDataItemUpdatedType as _publicOnDataItemUpdatedType, type context$1__publicQueryDataItemsType as _publicQueryDataItemsType, type context$1__publicQueryDistinctValuesType as _publicQueryDistinctValuesType, type context$1__publicQueryReferencedDataItemsType as _publicQueryReferencedDataItemsType, type context$1__publicRemoveDataItemReferenceType as _publicRemoveDataItemReferenceType, type context$1__publicRemoveDataItemType as _publicRemoveDataItemType, type context$1__publicReplaceDataItemReferencesType as _publicReplaceDataItemReferencesType, type context$1__publicSaveDataItemType as _publicSaveDataItemType, type context$1__publicTruncateDataItemsType as _publicTruncateDataItemsType, type context$1__publicUpdateDataItemType as _publicUpdateDataItemType, context$1_aggregateDataItems as aggregateDataItems, context$1_bulkInsertDataItemReferences as bulkInsertDataItemReferences, context$1_bulkInsertDataItems as bulkInsertDataItems, context$1_bulkRemoveDataItemReferences as bulkRemoveDataItemReferences, context$1_bulkRemoveDataItems as bulkRemoveDataItems, context$1_bulkSaveDataItems as bulkSaveDataItems, context$1_bulkUpdateDataItems as bulkUpdateDataItems, context$1_countDataItems as countDataItems, context$1_getDataItem as getDataItem, context$1_insertDataItem as insertDataItem, context$1_insertDataItemReference as insertDataItemReference, context$1_isReferencedDataItem as isReferencedDataItem, context$1_onDataItemCreated as onDataItemCreated, context$1_onDataItemDeleted as onDataItemDeleted, context$1_onDataItemUpdated as onDataItemUpdated, onDataItemCreated$1 as publicOnDataItemCreated, onDataItemDeleted$1 as publicOnDataItemDeleted, onDataItemUpdated$1 as publicOnDataItemUpdated, context$1_queryDataItems as queryDataItems, context$1_queryDistinctValues as queryDistinctValues, context$1_queryReferencedDataItems as queryReferencedDataItems, context$1_removeDataItem as removeDataItem, context$1_removeDataItemReference as removeDataItemReference, context$1_replaceDataItemReferences as replaceDataItemReferences, context$1_saveDataItem as saveDataItem, context$1_truncateDataItems as truncateDataItems, context$1_updateDataItem as updateDataItem };
3712
4299
  }
3713
4300
 
3714
4301
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
@@ -3883,11 +4470,60 @@ interface ListIndexesOptions {
3883
4470
  paging?: Paging;
3884
4471
  }
3885
4472
 
4473
+ declare function createIndex$1(httpClient: HttpClient): CreateIndexSignature;
4474
+ interface CreateIndexSignature {
4475
+ /**
4476
+ * Creates an index for a data collection.
4477
+ *
4478
+ * The index can't be used immediately, as the process of generating the index takes time.
4479
+ * You can check whether your index is ready using `listIndexes()`.
4480
+ *
4481
+ * Note that when an index fails to create, the failed index still occupies a slot.
4482
+ * To remove the failed index and free up the slot for a new index, use `dropIndex()`.
4483
+ * @param - ID of the data collection for which to generate the index.
4484
+ * @param - Details of the index to be created.
4485
+ * @param - Options for creating an index.
4486
+ * @returns Details of the index being generated.
4487
+ */
4488
+ (dataCollectionId: string, index: Index): Promise<Index & IndexNonNullableFields>;
4489
+ }
4490
+ declare function dropIndex$1(httpClient: HttpClient): DropIndexSignature;
4491
+ interface DropIndexSignature {
4492
+ /**
4493
+ * Removes an index from a data collection.
4494
+ *
4495
+ * The process of dropping an index from a collection takes time.
4496
+ * You can check whether your index has been dropped by calling `listIndexes()`.
4497
+ * @param - ID of the data collection for which the index to be dropped is defined.
4498
+ * @param - Name of the index to drop.
4499
+ * @param - Options for dropping an index.
4500
+ */
4501
+ (dataCollectionId: string, indexName: string): Promise<void>;
4502
+ }
4503
+ declare function listIndexes$1(httpClient: HttpClient): ListIndexesSignature;
4504
+ interface ListIndexesSignature {
4505
+ /**
4506
+ * Lists all indexes defined for a data collection.
4507
+ *
4508
+ * When an index's status is `ACTIVE`, it is ready to use.
4509
+ * While it is still being created, its status is `BUILDING`.
4510
+ *
4511
+ * When an index's status is `DROPPED`, it has been dropped successfully.
4512
+ * While it is still in the process of being removed, its status is `DROPPING`.
4513
+ * @param - ID of the data collection for which to list indexes.
4514
+ * @param - Options for retrieving a list of indexes.
4515
+ */
4516
+ (dataCollectionId: string, options?: ListIndexesOptions | undefined): Promise<ListIndexesResponse & ListIndexesResponseNonNullableFields>;
4517
+ }
4518
+
3886
4519
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3887
4520
 
3888
- declare const createIndex: ReturnType<typeof createRESTModule<typeof publicCreateIndex>>;
3889
- declare const dropIndex: ReturnType<typeof createRESTModule<typeof publicDropIndex>>;
3890
- declare const listIndexes: ReturnType<typeof createRESTModule<typeof publicListIndexes>>;
4521
+ type _publicCreateIndexType = typeof createIndex$1;
4522
+ declare const createIndex: ReturnType<typeof createRESTModule<_publicCreateIndexType>>;
4523
+ type _publicDropIndexType = typeof dropIndex$1;
4524
+ declare const dropIndex: ReturnType<typeof createRESTModule<_publicDropIndexType>>;
4525
+ type _publicListIndexesType = typeof listIndexes$1;
4526
+ declare const listIndexes: ReturnType<typeof createRESTModule<_publicListIndexesType>>;
3891
4527
 
3892
4528
  type context_CreateIndexRequest = CreateIndexRequest;
3893
4529
  type context_CreateIndexResponse = CreateIndexResponse;
@@ -3910,11 +4546,14 @@ type context_Paging = Paging;
3910
4546
  type context_PagingMetadata = PagingMetadata;
3911
4547
  type context_Status = Status;
3912
4548
  declare const context_Status: typeof Status;
4549
+ type context__publicCreateIndexType = _publicCreateIndexType;
4550
+ type context__publicDropIndexType = _publicDropIndexType;
4551
+ type context__publicListIndexesType = _publicListIndexesType;
3913
4552
  declare const context_createIndex: typeof createIndex;
3914
4553
  declare const context_dropIndex: typeof dropIndex;
3915
4554
  declare const context_listIndexes: typeof listIndexes;
3916
4555
  declare namespace context {
3917
- export { type context_CreateIndexRequest as CreateIndexRequest, type context_CreateIndexResponse as CreateIndexResponse, type context_CreateIndexResponseNonNullableFields as CreateIndexResponseNonNullableFields, type context_DropIndexRequest as DropIndexRequest, type context_DropIndexResponse as DropIndexResponse, context_Environment as Environment, type context_Failure as Failure, type context_Field as Field, type context_Index as Index, type context_IndexNonNullableFields as IndexNonNullableFields, type context_ListIndexesOptions as ListIndexesOptions, type context_ListIndexesRequest as ListIndexesRequest, type context_ListIndexesResponse as ListIndexesResponse, type context_ListIndexesResponseNonNullableFields as ListIndexesResponseNonNullableFields, context_Order as Order, type context_Paging as Paging, type context_PagingMetadata as PagingMetadata, context_Status as Status, context_createIndex as createIndex, context_dropIndex as dropIndex, context_listIndexes as listIndexes };
4556
+ export { type context_CreateIndexRequest as CreateIndexRequest, type context_CreateIndexResponse as CreateIndexResponse, type context_CreateIndexResponseNonNullableFields as CreateIndexResponseNonNullableFields, type context_DropIndexRequest as DropIndexRequest, type context_DropIndexResponse as DropIndexResponse, context_Environment as Environment, type context_Failure as Failure, type context_Field as Field, type context_Index as Index, type context_IndexNonNullableFields as IndexNonNullableFields, type context_ListIndexesOptions as ListIndexesOptions, type context_ListIndexesRequest as ListIndexesRequest, type context_ListIndexesResponse as ListIndexesResponse, type context_ListIndexesResponseNonNullableFields as ListIndexesResponseNonNullableFields, context_Order as Order, type context_Paging as Paging, type context_PagingMetadata as PagingMetadata, context_Status as Status, type context__publicCreateIndexType as _publicCreateIndexType, type context__publicDropIndexType as _publicDropIndexType, type context__publicListIndexesType as _publicListIndexesType, context_createIndex as createIndex, context_dropIndex as dropIndex, context_listIndexes as listIndexes };
3918
4557
  }
3919
4558
 
3920
4559
  export { context$2 as collections, context$3 as externalDatabaseConnections, context as indexes, context$1 as items };