@wix/data 1.0.178 → 1.0.180

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.
@@ -516,8 +516,11 @@ declare enum CauseOfFailure {
516
516
  DESTINATION_ENDPOINT_NOT_DEFINED = "DESTINATION_ENDPOINT_NOT_DEFINED"
517
517
  }
518
518
  declare enum CollectionsFound {
519
+ /** Attempt to connect to the external database failed, so status is unknown. */
519
520
  UNKNOWN = "UNKNOWN",
521
+ /** External database has existing collections. */
520
522
  YES = "YES",
523
+ /** External database does not have any existing collections. */
521
524
  NO = "NO"
522
525
  }
523
526
  declare enum FieldType {
@@ -564,20 +567,10 @@ declare enum FieldType {
564
567
  interface ConnectionStatus {
565
568
  /** Whether the connection was established successfully. */
566
569
  successful?: boolean;
567
- /**
568
- * If and why a connection attempt failed.
569
- * + `NONE`: No connection failure.
570
- * + `COMMUNICATION_FAILURE`: General communication failure.
571
- * + `DESTINATION_HOST_UNREACHABLE`: External database host is unreachable.
572
- * + `UNAUTHORIZED`: Unauthorized to access external database.
573
- * + `DESTINATION_ENDPOINT_NOT_DEFINED`: `Endpoint` property is not set.
574
- */
570
+ /** Whether and why a connection attempt failed. */
575
571
  causeOfFailure?: CauseOfFailure;
576
572
  /**
577
- * Whether the external database has existing collections. Possible values are:
578
- * + `UNKNOWN`: The attempt to connect to the external database failed, so status is unknown.
579
- * + `NO`: External database does not have any existing collections.
580
- * + `YES`: External database has existing collections.
573
+ * Whether the external database has existing collections.
581
574
  * @readonly
582
575
  */
583
576
  hasCollections?: CollectionsFound;
@@ -607,9 +600,9 @@ interface GetExternalDatabaseConnectionResponse {
607
600
  }
608
601
  interface ListExternalDatabaseConnectionsRequest {
609
602
  /** Paging */
610
- paging?: Paging$3;
603
+ paging?: Paging$2;
611
604
  }
612
- interface Paging$3 {
605
+ interface Paging$2 {
613
606
  /** Number of items to load. */
614
607
  limit?: number | null;
615
608
  /** Number of items to skip in the current sort order. */
@@ -670,11 +663,11 @@ interface DeleteExternalDatabaseConnectionRequest {
670
663
  }
671
664
  interface DeleteExternalDatabaseConnectionResponse {
672
665
  }
673
- interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
674
- createdEvent?: EntityCreatedEvent$2;
675
- updatedEvent?: EntityUpdatedEvent$2;
676
- deletedEvent?: EntityDeletedEvent$2;
677
- actionEvent?: ActionEvent$2;
666
+ interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
667
+ createdEvent?: EntityCreatedEvent$1;
668
+ updatedEvent?: EntityUpdatedEvent$1;
669
+ deletedEvent?: EntityDeletedEvent$1;
670
+ actionEvent?: ActionEvent$1;
678
671
  /**
679
672
  * Unique event ID.
680
673
  * Allows clients to ignore duplicate webhooks.
@@ -713,19 +706,19 @@ interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
713
706
  entityEventSequence?: string | null;
714
707
  }
715
708
  /** @oneof */
716
- interface DomainEventBodyOneOf$2 {
717
- createdEvent?: EntityCreatedEvent$2;
718
- updatedEvent?: EntityUpdatedEvent$2;
719
- deletedEvent?: EntityDeletedEvent$2;
720
- actionEvent?: ActionEvent$2;
709
+ interface DomainEventBodyOneOf$1 {
710
+ createdEvent?: EntityCreatedEvent$1;
711
+ updatedEvent?: EntityUpdatedEvent$1;
712
+ deletedEvent?: EntityDeletedEvent$1;
713
+ actionEvent?: ActionEvent$1;
721
714
  }
722
- interface EntityCreatedEvent$2 {
715
+ interface EntityCreatedEvent$1 {
723
716
  entity?: string;
724
717
  }
725
- interface RestoreInfo$2 {
718
+ interface RestoreInfo$1 {
726
719
  deletedDate?: Date | null;
727
720
  }
728
- interface EntityUpdatedEvent$2 {
721
+ interface EntityUpdatedEvent$1 {
729
722
  /**
730
723
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
731
724
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -733,24 +726,24 @@ interface EntityUpdatedEvent$2 {
733
726
  */
734
727
  currentEntity?: string;
735
728
  }
736
- interface EntityDeletedEvent$2 {
729
+ interface EntityDeletedEvent$1 {
737
730
  /** Entity that was deleted */
738
731
  deletedEntity?: string | null;
739
732
  }
740
- interface ActionEvent$2 {
733
+ interface ActionEvent$1 {
741
734
  body?: string;
742
735
  }
743
- interface MessageEnvelope$2 {
736
+ interface MessageEnvelope$1 {
744
737
  /** App instance ID. */
745
738
  instanceId?: string | null;
746
739
  /** Event type. */
747
740
  eventType?: string;
748
741
  /** The identification type and identity data. */
749
- identity?: IdentificationData$2;
742
+ identity?: IdentificationData$1;
750
743
  /** Stringify payload. */
751
744
  data?: string;
752
745
  }
753
- interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
746
+ interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
754
747
  /** ID of a site visitor that has not logged in to the site. */
755
748
  anonymousVisitorId?: string;
756
749
  /** ID of a site visitor that has logged in to the site. */
@@ -760,10 +753,10 @@ interface IdentificationData$2 extends IdentificationDataIdOneOf$2 {
760
753
  /** ID of an app. */
761
754
  appId?: string;
762
755
  /** @readonly */
763
- identityType?: WebhookIdentityType$2;
756
+ identityType?: WebhookIdentityType$1;
764
757
  }
765
758
  /** @oneof */
766
- interface IdentificationDataIdOneOf$2 {
759
+ interface IdentificationDataIdOneOf$1 {
767
760
  /** ID of a site visitor that has not logged in to the site. */
768
761
  anonymousVisitorId?: string;
769
762
  /** ID of a site visitor that has logged in to the site. */
@@ -773,7 +766,7 @@ interface IdentificationDataIdOneOf$2 {
773
766
  /** ID of an app. */
774
767
  appId?: string;
775
768
  }
776
- declare enum WebhookIdentityType$2 {
769
+ declare enum WebhookIdentityType$1 {
777
770
  UNKNOWN = "UNKNOWN",
778
771
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
779
772
  MEMBER = "MEMBER",
@@ -807,15 +800,15 @@ interface CreateExternalDatabaseConnectionResponseNonNullableFields {
807
800
  interface UpdateExternalDatabaseConnectionResponseNonNullableFields {
808
801
  externalDatabaseConnection?: ExternalDatabaseConnectionNonNullableFields;
809
802
  }
810
- interface BaseEventMetadata$1 {
803
+ interface BaseEventMetadata {
811
804
  /** App instance ID. */
812
805
  instanceId?: string | null;
813
806
  /** Event type. */
814
807
  eventType?: string;
815
808
  /** The identification type and identity data. */
816
- identity?: IdentificationData$2;
809
+ identity?: IdentificationData$1;
817
810
  }
818
- interface EventMetadata$1 extends BaseEventMetadata$1 {
811
+ interface EventMetadata extends BaseEventMetadata {
819
812
  /**
820
813
  * Unique event ID.
821
814
  * Allows clients to ignore duplicate webhooks.
@@ -855,18 +848,18 @@ interface EventMetadata$1 extends BaseEventMetadata$1 {
855
848
  }
856
849
  interface ExternalDatabaseConnectionCreatedEnvelope {
857
850
  entity: ExternalDatabaseConnection;
858
- metadata: EventMetadata$1;
851
+ metadata: EventMetadata;
859
852
  }
860
853
  interface ExternalDatabaseConnectionDeletedEnvelope {
861
- metadata: EventMetadata$1;
854
+ metadata: EventMetadata;
862
855
  }
863
856
  interface ExternalDatabaseConnectionUpdatedEnvelope {
864
857
  entity: ExternalDatabaseConnection;
865
- metadata: EventMetadata$1;
858
+ metadata: EventMetadata;
866
859
  }
867
860
  interface ListExternalDatabaseConnectionsOptions {
868
861
  /** Paging */
869
- paging?: Paging$3;
862
+ paging?: Paging$2;
870
863
  }
871
864
  interface CreateExternalDatabaseConnectionOptions {
872
865
  /** Connection type. */
@@ -955,7 +948,7 @@ declare const onExternalDatabaseConnectionCreated$1: EventDefinition<ExternalDat
955
948
  declare const onExternalDatabaseConnectionDeleted$1: EventDefinition<ExternalDatabaseConnectionDeletedEnvelope, "wix.data.v1.external_database_connection_deleted">;
956
949
  declare const onExternalDatabaseConnectionUpdated$1: EventDefinition<ExternalDatabaseConnectionUpdatedEnvelope, "wix.data.v1.external_database_connection_updated">;
957
950
 
958
- declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
951
+ declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
959
952
 
960
953
  declare const getExternalDatabaseConnection: MaybeContext<BuildRESTFunction<typeof getExternalDatabaseConnection$1> & typeof getExternalDatabaseConnection$1>;
961
954
  declare const listExternalDatabaseConnections: MaybeContext<BuildRESTFunction<typeof listExternalDatabaseConnections$1> & typeof listExternalDatabaseConnections$1>;
@@ -967,67 +960,69 @@ type _publicOnExternalDatabaseConnectionCreatedType = typeof onExternalDatabaseC
967
960
  /**
968
961
  * Triggered when an external database connection is created.
969
962
  */
970
- declare const onExternalDatabaseConnectionCreated: ReturnType<typeof createEventModule$1<_publicOnExternalDatabaseConnectionCreatedType>>;
963
+ declare const onExternalDatabaseConnectionCreated: ReturnType<typeof createEventModule<_publicOnExternalDatabaseConnectionCreatedType>>;
971
964
 
972
965
  type _publicOnExternalDatabaseConnectionDeletedType = typeof onExternalDatabaseConnectionDeleted$1;
973
966
  /**
974
967
  * Triggered when an external database connection is deleted.
975
968
  */
976
- declare const onExternalDatabaseConnectionDeleted: ReturnType<typeof createEventModule$1<_publicOnExternalDatabaseConnectionDeletedType>>;
969
+ declare const onExternalDatabaseConnectionDeleted: ReturnType<typeof createEventModule<_publicOnExternalDatabaseConnectionDeletedType>>;
977
970
 
978
971
  type _publicOnExternalDatabaseConnectionUpdatedType = typeof onExternalDatabaseConnectionUpdated$1;
979
972
  /**
980
973
  * Triggered when an external database connection is updated.
981
974
  */
982
- declare const onExternalDatabaseConnectionUpdated: ReturnType<typeof createEventModule$1<_publicOnExternalDatabaseConnectionUpdatedType>>;
983
-
984
- type context$3_Capabilities = Capabilities;
985
- type context$3_CauseOfFailure = CauseOfFailure;
986
- declare const context$3_CauseOfFailure: typeof CauseOfFailure;
987
- type context$3_CollectionsFound = CollectionsFound;
988
- declare const context$3_CollectionsFound: typeof CollectionsFound;
989
- type context$3_ConnectionStatus = ConnectionStatus;
990
- type context$3_ConnectionType = ConnectionType;
991
- declare const context$3_ConnectionType: typeof ConnectionType;
992
- type context$3_CreateExternalDatabaseConnectionOptions = CreateExternalDatabaseConnectionOptions;
993
- type context$3_CreateExternalDatabaseConnectionRequest = CreateExternalDatabaseConnectionRequest;
994
- type context$3_CreateExternalDatabaseConnectionResponse = CreateExternalDatabaseConnectionResponse;
995
- type context$3_CreateExternalDatabaseConnectionResponseNonNullableFields = CreateExternalDatabaseConnectionResponseNonNullableFields;
996
- type context$3_DeleteExternalDatabaseConnectionRequest = DeleteExternalDatabaseConnectionRequest;
997
- type context$3_DeleteExternalDatabaseConnectionResponse = DeleteExternalDatabaseConnectionResponse;
998
- type context$3_ExternalDatabaseConnection = ExternalDatabaseConnection;
999
- type context$3_ExternalDatabaseConnectionCreatedEnvelope = ExternalDatabaseConnectionCreatedEnvelope;
1000
- type context$3_ExternalDatabaseConnectionDeletedEnvelope = ExternalDatabaseConnectionDeletedEnvelope;
1001
- type context$3_ExternalDatabaseConnectionNonNullableFields = ExternalDatabaseConnectionNonNullableFields;
1002
- type context$3_ExternalDatabaseConnectionUpdatedEnvelope = ExternalDatabaseConnectionUpdatedEnvelope;
1003
- type context$3_FieldType = FieldType;
1004
- declare const context$3_FieldType: typeof FieldType;
1005
- type context$3_GetExternalDatabaseConnectionRequest = GetExternalDatabaseConnectionRequest;
1006
- type context$3_GetExternalDatabaseConnectionResponse = GetExternalDatabaseConnectionResponse;
1007
- type context$3_GetExternalDatabaseConnectionResponseNonNullableFields = GetExternalDatabaseConnectionResponseNonNullableFields;
1008
- type context$3_ListExternalDatabaseConnectionsOptions = ListExternalDatabaseConnectionsOptions;
1009
- type context$3_ListExternalDatabaseConnectionsRequest = ListExternalDatabaseConnectionsRequest;
1010
- type context$3_ListExternalDatabaseConnectionsResponse = ListExternalDatabaseConnectionsResponse;
1011
- type context$3_ListExternalDatabaseConnectionsResponseNonNullableFields = ListExternalDatabaseConnectionsResponseNonNullableFields;
1012
- type context$3_ProtocolVersion = ProtocolVersion;
1013
- declare const context$3_ProtocolVersion: typeof ProtocolVersion;
1014
- type context$3_UpdateExternalDatabaseConnection = UpdateExternalDatabaseConnection;
1015
- type context$3_UpdateExternalDatabaseConnectionRequest = UpdateExternalDatabaseConnectionRequest;
1016
- type context$3_UpdateExternalDatabaseConnectionResponse = UpdateExternalDatabaseConnectionResponse;
1017
- type context$3_UpdateExternalDatabaseConnectionResponseNonNullableFields = UpdateExternalDatabaseConnectionResponseNonNullableFields;
1018
- type context$3__publicOnExternalDatabaseConnectionCreatedType = _publicOnExternalDatabaseConnectionCreatedType;
1019
- type context$3__publicOnExternalDatabaseConnectionDeletedType = _publicOnExternalDatabaseConnectionDeletedType;
1020
- type context$3__publicOnExternalDatabaseConnectionUpdatedType = _publicOnExternalDatabaseConnectionUpdatedType;
1021
- declare const context$3_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
1022
- declare const context$3_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
1023
- declare const context$3_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
1024
- declare const context$3_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;
1025
- declare const context$3_onExternalDatabaseConnectionCreated: typeof onExternalDatabaseConnectionCreated;
1026
- declare const context$3_onExternalDatabaseConnectionDeleted: typeof onExternalDatabaseConnectionDeleted;
1027
- declare const context$3_onExternalDatabaseConnectionUpdated: typeof onExternalDatabaseConnectionUpdated;
1028
- declare const context$3_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
1029
- declare namespace context$3 {
1030
- export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$1 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$1 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__publicOnExternalDatabaseConnectionCreatedType as _publicOnExternalDatabaseConnectionCreatedType, type context$3__publicOnExternalDatabaseConnectionDeletedType as _publicOnExternalDatabaseConnectionDeletedType, type context$3__publicOnExternalDatabaseConnectionUpdatedType as _publicOnExternalDatabaseConnectionUpdatedType, 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 };
975
+ declare const onExternalDatabaseConnectionUpdated: ReturnType<typeof createEventModule<_publicOnExternalDatabaseConnectionUpdatedType>>;
976
+
977
+ type context$2_BaseEventMetadata = BaseEventMetadata;
978
+ type context$2_Capabilities = Capabilities;
979
+ type context$2_CauseOfFailure = CauseOfFailure;
980
+ declare const context$2_CauseOfFailure: typeof CauseOfFailure;
981
+ type context$2_CollectionsFound = CollectionsFound;
982
+ declare const context$2_CollectionsFound: typeof CollectionsFound;
983
+ type context$2_ConnectionStatus = ConnectionStatus;
984
+ type context$2_ConnectionType = ConnectionType;
985
+ declare const context$2_ConnectionType: typeof ConnectionType;
986
+ type context$2_CreateExternalDatabaseConnectionOptions = CreateExternalDatabaseConnectionOptions;
987
+ type context$2_CreateExternalDatabaseConnectionRequest = CreateExternalDatabaseConnectionRequest;
988
+ type context$2_CreateExternalDatabaseConnectionResponse = CreateExternalDatabaseConnectionResponse;
989
+ type context$2_CreateExternalDatabaseConnectionResponseNonNullableFields = CreateExternalDatabaseConnectionResponseNonNullableFields;
990
+ type context$2_DeleteExternalDatabaseConnectionRequest = DeleteExternalDatabaseConnectionRequest;
991
+ type context$2_DeleteExternalDatabaseConnectionResponse = DeleteExternalDatabaseConnectionResponse;
992
+ type context$2_EventMetadata = EventMetadata;
993
+ type context$2_ExternalDatabaseConnection = ExternalDatabaseConnection;
994
+ type context$2_ExternalDatabaseConnectionCreatedEnvelope = ExternalDatabaseConnectionCreatedEnvelope;
995
+ type context$2_ExternalDatabaseConnectionDeletedEnvelope = ExternalDatabaseConnectionDeletedEnvelope;
996
+ type context$2_ExternalDatabaseConnectionNonNullableFields = ExternalDatabaseConnectionNonNullableFields;
997
+ type context$2_ExternalDatabaseConnectionUpdatedEnvelope = ExternalDatabaseConnectionUpdatedEnvelope;
998
+ type context$2_FieldType = FieldType;
999
+ declare const context$2_FieldType: typeof FieldType;
1000
+ type context$2_GetExternalDatabaseConnectionRequest = GetExternalDatabaseConnectionRequest;
1001
+ type context$2_GetExternalDatabaseConnectionResponse = GetExternalDatabaseConnectionResponse;
1002
+ type context$2_GetExternalDatabaseConnectionResponseNonNullableFields = GetExternalDatabaseConnectionResponseNonNullableFields;
1003
+ type context$2_ListExternalDatabaseConnectionsOptions = ListExternalDatabaseConnectionsOptions;
1004
+ type context$2_ListExternalDatabaseConnectionsRequest = ListExternalDatabaseConnectionsRequest;
1005
+ type context$2_ListExternalDatabaseConnectionsResponse = ListExternalDatabaseConnectionsResponse;
1006
+ type context$2_ListExternalDatabaseConnectionsResponseNonNullableFields = ListExternalDatabaseConnectionsResponseNonNullableFields;
1007
+ type context$2_ProtocolVersion = ProtocolVersion;
1008
+ declare const context$2_ProtocolVersion: typeof ProtocolVersion;
1009
+ type context$2_UpdateExternalDatabaseConnection = UpdateExternalDatabaseConnection;
1010
+ type context$2_UpdateExternalDatabaseConnectionRequest = UpdateExternalDatabaseConnectionRequest;
1011
+ type context$2_UpdateExternalDatabaseConnectionResponse = UpdateExternalDatabaseConnectionResponse;
1012
+ type context$2_UpdateExternalDatabaseConnectionResponseNonNullableFields = UpdateExternalDatabaseConnectionResponseNonNullableFields;
1013
+ type context$2__publicOnExternalDatabaseConnectionCreatedType = _publicOnExternalDatabaseConnectionCreatedType;
1014
+ type context$2__publicOnExternalDatabaseConnectionDeletedType = _publicOnExternalDatabaseConnectionDeletedType;
1015
+ type context$2__publicOnExternalDatabaseConnectionUpdatedType = _publicOnExternalDatabaseConnectionUpdatedType;
1016
+ declare const context$2_createExternalDatabaseConnection: typeof createExternalDatabaseConnection;
1017
+ declare const context$2_deleteExternalDatabaseConnection: typeof deleteExternalDatabaseConnection;
1018
+ declare const context$2_getExternalDatabaseConnection: typeof getExternalDatabaseConnection;
1019
+ declare const context$2_listExternalDatabaseConnections: typeof listExternalDatabaseConnections;
1020
+ declare const context$2_onExternalDatabaseConnectionCreated: typeof onExternalDatabaseConnectionCreated;
1021
+ declare const context$2_onExternalDatabaseConnectionDeleted: typeof onExternalDatabaseConnectionDeleted;
1022
+ declare const context$2_onExternalDatabaseConnectionUpdated: typeof onExternalDatabaseConnectionUpdated;
1023
+ declare const context$2_updateExternalDatabaseConnection: typeof updateExternalDatabaseConnection;
1024
+ declare namespace context$2 {
1025
+ export { type ActionEvent$1 as ActionEvent, type context$2_BaseEventMetadata as BaseEventMetadata, type context$2_Capabilities as Capabilities, context$2_CauseOfFailure as CauseOfFailure, context$2_CollectionsFound as CollectionsFound, type context$2_ConnectionStatus as ConnectionStatus, context$2_ConnectionType as ConnectionType, type context$2_CreateExternalDatabaseConnectionOptions as CreateExternalDatabaseConnectionOptions, type context$2_CreateExternalDatabaseConnectionRequest as CreateExternalDatabaseConnectionRequest, type context$2_CreateExternalDatabaseConnectionResponse as CreateExternalDatabaseConnectionResponse, type context$2_CreateExternalDatabaseConnectionResponseNonNullableFields as CreateExternalDatabaseConnectionResponseNonNullableFields, type context$2_DeleteExternalDatabaseConnectionRequest as DeleteExternalDatabaseConnectionRequest, type context$2_DeleteExternalDatabaseConnectionResponse as DeleteExternalDatabaseConnectionResponse, 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 context$2_EventMetadata as EventMetadata, type context$2_ExternalDatabaseConnection as ExternalDatabaseConnection, type context$2_ExternalDatabaseConnectionCreatedEnvelope as ExternalDatabaseConnectionCreatedEnvelope, type context$2_ExternalDatabaseConnectionDeletedEnvelope as ExternalDatabaseConnectionDeletedEnvelope, type context$2_ExternalDatabaseConnectionNonNullableFields as ExternalDatabaseConnectionNonNullableFields, type context$2_ExternalDatabaseConnectionUpdatedEnvelope as ExternalDatabaseConnectionUpdatedEnvelope, context$2_FieldType as FieldType, type context$2_GetExternalDatabaseConnectionRequest as GetExternalDatabaseConnectionRequest, type context$2_GetExternalDatabaseConnectionResponse as GetExternalDatabaseConnectionResponse, type context$2_GetExternalDatabaseConnectionResponseNonNullableFields as GetExternalDatabaseConnectionResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type context$2_ListExternalDatabaseConnectionsOptions as ListExternalDatabaseConnectionsOptions, type context$2_ListExternalDatabaseConnectionsRequest as ListExternalDatabaseConnectionsRequest, type context$2_ListExternalDatabaseConnectionsResponse as ListExternalDatabaseConnectionsResponse, type context$2_ListExternalDatabaseConnectionsResponseNonNullableFields as ListExternalDatabaseConnectionsResponseNonNullableFields, type MessageEnvelope$1 as MessageEnvelope, type Paging$2 as Paging, type PagingMetadata$1 as PagingMetadata, context$2_ProtocolVersion as ProtocolVersion, type RestoreInfo$1 as RestoreInfo, type context$2_UpdateExternalDatabaseConnection as UpdateExternalDatabaseConnection, type context$2_UpdateExternalDatabaseConnectionRequest as UpdateExternalDatabaseConnectionRequest, type context$2_UpdateExternalDatabaseConnectionResponse as UpdateExternalDatabaseConnectionResponse, type context$2_UpdateExternalDatabaseConnectionResponseNonNullableFields as UpdateExternalDatabaseConnectionResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, type context$2__publicOnExternalDatabaseConnectionCreatedType as _publicOnExternalDatabaseConnectionCreatedType, type context$2__publicOnExternalDatabaseConnectionDeletedType as _publicOnExternalDatabaseConnectionDeletedType, type context$2__publicOnExternalDatabaseConnectionUpdatedType as _publicOnExternalDatabaseConnectionUpdatedType, context$2_createExternalDatabaseConnection as createExternalDatabaseConnection, context$2_deleteExternalDatabaseConnection as deleteExternalDatabaseConnection, context$2_getExternalDatabaseConnection as getExternalDatabaseConnection, context$2_listExternalDatabaseConnections as listExternalDatabaseConnections, context$2_onExternalDatabaseConnectionCreated as onExternalDatabaseConnectionCreated, context$2_onExternalDatabaseConnectionDeleted as onExternalDatabaseConnectionDeleted, context$2_onExternalDatabaseConnectionUpdated as onExternalDatabaseConnectionUpdated, onExternalDatabaseConnectionCreated$1 as publicOnExternalDatabaseConnectionCreated, onExternalDatabaseConnectionDeleted$1 as publicOnExternalDatabaseConnectionDeleted, onExternalDatabaseConnectionUpdated$1 as publicOnExternalDatabaseConnectionUpdated, context$2_updateExternalDatabaseConnection as updateExternalDatabaseConnection };
1031
1026
  }
1032
1027
 
1033
1028
  /** A data collection determines the structure of data to be stored in a database. */
@@ -1200,7 +1195,6 @@ interface Field$1 extends FieldRangeValidationsOneOf {
1200
1195
  encrypted?: boolean;
1201
1196
  /** Field description. */
1202
1197
  description?: string | null;
1203
- plugin?: string | null;
1204
1198
  /**
1205
1199
  * Whether the field is read-only. A read-only field can't be changed.
1206
1200
  *
@@ -1480,7 +1474,7 @@ interface Plugin extends PluginOptionsOneOf {
1480
1474
  * Options for the Publish plugin.
1481
1475
  * 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.
1482
1476
  */
1483
- publishOptions?: PublishPluginOptions$1;
1477
+ publishOptions?: PublishPluginOptions;
1484
1478
  /** Options for the Single Item plugin. */
1485
1479
  singleItemOptions?: SingleItemPluginOptions;
1486
1480
  /** Options for the Urlized plugin. */
@@ -1500,7 +1494,7 @@ interface PluginOptionsOneOf {
1500
1494
  * Options for the Publish plugin.
1501
1495
  * 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.
1502
1496
  */
1503
- publishOptions?: PublishPluginOptions$1;
1497
+ publishOptions?: PublishPluginOptions;
1504
1498
  /** Options for the Single Item plugin. */
1505
1499
  singleItemOptions?: SingleItemPluginOptions;
1506
1500
  /** Options for the Urlized plugin. */
@@ -1549,7 +1543,7 @@ declare enum PluginType {
1549
1543
  /** CMS-specific collection properties. */
1550
1544
  CMS = "CMS"
1551
1545
  }
1552
- interface PublishPluginOptions$1 {
1546
+ interface PublishPluginOptions {
1553
1547
  /** Default status. */
1554
1548
  defaultStatus?: Status$1;
1555
1549
  }
@@ -1628,7 +1622,7 @@ interface DataCollectionChangedEvent {
1628
1622
  /** list of new fields */
1629
1623
  fieldsAdded?: Field$1[];
1630
1624
  /** list of changed fields */
1631
- fieldsUpdated?: FieldUpdate$1[];
1625
+ fieldsUpdated?: FieldUpdate[];
1632
1626
  /** list of removed fields */
1633
1627
  fieldsRemoved?: Field$1[];
1634
1628
  /** list of new plugins */
@@ -1638,7 +1632,7 @@ interface DataCollectionChangedEvent {
1638
1632
  /** list of removed plugins */
1639
1633
  pluginsRemoved?: Plugin[];
1640
1634
  }
1641
- interface FieldUpdate$1 {
1635
+ interface FieldUpdate {
1642
1636
  /** previous state of the field */
1643
1637
  previous?: Field$1;
1644
1638
  /** current state of the field */
@@ -1695,9 +1689,9 @@ interface ListDataCollectionsRequest {
1695
1689
  *
1696
1690
  * Default: Ordered by ID in ascending order.
1697
1691
  */
1698
- sort?: Sorting$1;
1692
+ sort?: Sorting;
1699
1693
  /** Pagination information. */
1700
- paging?: Paging$2;
1694
+ paging?: Paging$1;
1701
1695
  /**
1702
1696
  * Whether to retrieve data from the primary database instance.
1703
1697
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1712,17 +1706,17 @@ interface ListDataCollectionsRequest {
1712
1706
  */
1713
1707
  fields?: string[];
1714
1708
  }
1715
- interface Sorting$1 {
1709
+ interface Sorting {
1716
1710
  /** Name of the field to sort by. */
1717
1711
  fieldName?: string;
1718
1712
  /** Sort order. */
1719
- order?: SortOrder$1;
1713
+ order?: SortOrder;
1720
1714
  }
1721
- declare enum SortOrder$1 {
1715
+ declare enum SortOrder {
1722
1716
  ASC = "ASC",
1723
1717
  DESC = "DESC"
1724
1718
  }
1725
- interface Paging$2 {
1719
+ interface Paging$1 {
1726
1720
  /** Number of items to load. */
1727
1721
  limit?: number | null;
1728
1722
  /** Number of items to skip in the current sort order. */
@@ -1732,9 +1726,9 @@ interface ListDataCollectionsResponse {
1732
1726
  /** List of collections. */
1733
1727
  collections?: DataCollection[];
1734
1728
  /** Paging information. */
1735
- pagingMetadata?: PagingMetadataV2$1;
1729
+ pagingMetadata?: PagingMetadataV2;
1736
1730
  }
1737
- interface PagingMetadataV2$1 {
1731
+ interface PagingMetadataV2 {
1738
1732
  /** Number of items returned in the response. */
1739
1733
  count?: number | null;
1740
1734
  /** Offset that was requested. */
@@ -1760,7 +1754,7 @@ interface BulkGetDataCollectionsRequest {
1760
1754
  */
1761
1755
  includeReferencedCollections?: boolean;
1762
1756
  /** Sorting preferences. */
1763
- sort?: Sorting$1;
1757
+ sort?: Sorting;
1764
1758
  /**
1765
1759
  * Whether to retrieve data from the primary database instance.
1766
1760
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -1850,13 +1844,13 @@ interface BulkGetDataCollectionsPageBySnapshotsRequest {
1850
1844
  /** Ids of schema snapshot */
1851
1845
  snapshotIds?: string[];
1852
1846
  /** Pagination information. */
1853
- paging?: Paging$2;
1847
+ paging?: Paging$1;
1854
1848
  }
1855
1849
  interface BulkGetDataCollectionsPageBySnapshotsResponse {
1856
1850
  /** List of snapshot collection map */
1857
1851
  snapshotCollections?: SnapshotCollection[];
1858
1852
  /** Paging information. */
1859
- pagingMetadata?: PagingMetadataV2$1;
1853
+ pagingMetadata?: PagingMetadataV2;
1860
1854
  }
1861
1855
  interface SnapshotCollection {
1862
1856
  /** snapshot to which collection belongs */
@@ -2004,11 +1998,11 @@ interface CreateMigratedCollectionsSnapshotRequest {
2004
1998
  interface CreateMigratedCollectionsSnapshotResponse {
2005
1999
  snapshotId?: string;
2006
2000
  }
2007
- interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
2008
- createdEvent?: EntityCreatedEvent$1;
2009
- updatedEvent?: EntityUpdatedEvent$1;
2010
- deletedEvent?: EntityDeletedEvent$1;
2011
- actionEvent?: ActionEvent$1;
2001
+ interface DomainEvent extends DomainEventBodyOneOf {
2002
+ createdEvent?: EntityCreatedEvent;
2003
+ updatedEvent?: EntityUpdatedEvent;
2004
+ deletedEvent?: EntityDeletedEvent;
2005
+ actionEvent?: ActionEvent;
2012
2006
  /**
2013
2007
  * Unique event ID.
2014
2008
  * Allows clients to ignore duplicate webhooks.
@@ -2047,19 +2041,19 @@ interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
2047
2041
  entityEventSequence?: string | null;
2048
2042
  }
2049
2043
  /** @oneof */
2050
- interface DomainEventBodyOneOf$1 {
2051
- createdEvent?: EntityCreatedEvent$1;
2052
- updatedEvent?: EntityUpdatedEvent$1;
2053
- deletedEvent?: EntityDeletedEvent$1;
2054
- actionEvent?: ActionEvent$1;
2044
+ interface DomainEventBodyOneOf {
2045
+ createdEvent?: EntityCreatedEvent;
2046
+ updatedEvent?: EntityUpdatedEvent;
2047
+ deletedEvent?: EntityDeletedEvent;
2048
+ actionEvent?: ActionEvent;
2055
2049
  }
2056
- interface EntityCreatedEvent$1 {
2050
+ interface EntityCreatedEvent {
2057
2051
  entity?: string;
2058
2052
  }
2059
- interface RestoreInfo$1 {
2053
+ interface RestoreInfo {
2060
2054
  deletedDate?: Date | null;
2061
2055
  }
2062
- interface EntityUpdatedEvent$1 {
2056
+ interface EntityUpdatedEvent {
2063
2057
  /**
2064
2058
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2065
2059
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -2067,24 +2061,24 @@ interface EntityUpdatedEvent$1 {
2067
2061
  */
2068
2062
  currentEntity?: string;
2069
2063
  }
2070
- interface EntityDeletedEvent$1 {
2064
+ interface EntityDeletedEvent {
2071
2065
  /** Entity that was deleted */
2072
2066
  deletedEntity?: string | null;
2073
2067
  }
2074
- interface ActionEvent$1 {
2068
+ interface ActionEvent {
2075
2069
  body?: string;
2076
2070
  }
2077
- interface MessageEnvelope$1 {
2071
+ interface MessageEnvelope {
2078
2072
  /** App instance ID. */
2079
2073
  instanceId?: string | null;
2080
2074
  /** Event type. */
2081
2075
  eventType?: string;
2082
2076
  /** The identification type and identity data. */
2083
- identity?: IdentificationData$1;
2077
+ identity?: IdentificationData;
2084
2078
  /** Stringify payload. */
2085
2079
  data?: string;
2086
2080
  }
2087
- interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
2081
+ interface IdentificationData extends IdentificationDataIdOneOf {
2088
2082
  /** ID of a site visitor that has not logged in to the site. */
2089
2083
  anonymousVisitorId?: string;
2090
2084
  /** ID of a site visitor that has logged in to the site. */
@@ -2094,10 +2088,10 @@ interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
2094
2088
  /** ID of an app. */
2095
2089
  appId?: string;
2096
2090
  /** @readonly */
2097
- identityType?: WebhookIdentityType$1;
2091
+ identityType?: WebhookIdentityType;
2098
2092
  }
2099
2093
  /** @oneof */
2100
- interface IdentificationDataIdOneOf$1 {
2094
+ interface IdentificationDataIdOneOf {
2101
2095
  /** ID of a site visitor that has not logged in to the site. */
2102
2096
  anonymousVisitorId?: string;
2103
2097
  /** ID of a site visitor that has logged in to the site. */
@@ -2107,7 +2101,7 @@ interface IdentificationDataIdOneOf$1 {
2107
2101
  /** ID of an app. */
2108
2102
  appId?: string;
2109
2103
  }
2110
- declare enum WebhookIdentityType$1 {
2104
+ declare enum WebhookIdentityType {
2111
2105
  UNKNOWN = "UNKNOWN",
2112
2106
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2113
2107
  MEMBER = "MEMBER",
@@ -2285,9 +2279,9 @@ interface ListDataCollectionsOptions {
2285
2279
  *
2286
2280
  * Default: Ordered by ID in ascending order.
2287
2281
  */
2288
- sort?: Sorting$1;
2282
+ sort?: Sorting;
2289
2283
  /** Pagination information. */
2290
- paging?: Paging$2;
2284
+ paging?: Paging$1;
2291
2285
  /**
2292
2286
  * Whether to retrieve data from the primary database instance.
2293
2287
  * This decreases performance but ensures data retrieved is up to date even immediately after an update.
@@ -2373,2604 +2367,140 @@ declare const listDataCollections: MaybeContext<BuildRESTFunction<typeof listDat
2373
2367
  declare const updateDataCollection: MaybeContext<BuildRESTFunction<typeof updateDataCollection$1> & typeof updateDataCollection$1>;
2374
2368
  declare const deleteDataCollection: MaybeContext<BuildRESTFunction<typeof deleteDataCollection$1> & typeof deleteDataCollection$1>;
2375
2369
 
2376
- type context$2_AccessLevel = AccessLevel;
2377
- declare const context$2_AccessLevel: typeof AccessLevel;
2378
- type context$2_AllowedDataPermissions = AllowedDataPermissions;
2379
- type context$2_ArraySizeRange = ArraySizeRange;
2380
- type context$2_BulkGetDataCollectionsPageBySnapshotsRequest = BulkGetDataCollectionsPageBySnapshotsRequest;
2381
- type context$2_BulkGetDataCollectionsPageBySnapshotsResponse = BulkGetDataCollectionsPageBySnapshotsResponse;
2382
- type context$2_BulkGetDataCollectionsRequest = BulkGetDataCollectionsRequest;
2383
- type context$2_BulkGetDataCollectionsResponse = BulkGetDataCollectionsResponse;
2384
- type context$2_Calculator = Calculator;
2385
- type context$2_CalculatorPatternOneOf = CalculatorPatternOneOf;
2386
- type context$2_CmsOptions = CmsOptions;
2387
- type context$2_CollectionCapabilities = CollectionCapabilities;
2388
- type context$2_CollectionOperation = CollectionOperation;
2389
- declare const context$2_CollectionOperation: typeof CollectionOperation;
2390
- type context$2_CollectionType = CollectionType;
2391
- declare const context$2_CollectionType: typeof CollectionType;
2392
- type context$2_CreateDataCollectionFieldRequest = CreateDataCollectionFieldRequest;
2393
- type context$2_CreateDataCollectionFieldResponse = CreateDataCollectionFieldResponse;
2394
- type context$2_CreateDataCollectionRequest = CreateDataCollectionRequest;
2395
- type context$2_CreateDataCollectionResponse = CreateDataCollectionResponse;
2396
- type context$2_CreateDataCollectionResponseNonNullableFields = CreateDataCollectionResponseNonNullableFields;
2397
- type context$2_CreateDataCollectionsSnapshotRequest = CreateDataCollectionsSnapshotRequest;
2398
- type context$2_CreateDataCollectionsSnapshotResponse = CreateDataCollectionsSnapshotResponse;
2399
- type context$2_CreateMigratedCollectionsSnapshotRequest = CreateMigratedCollectionsSnapshotRequest;
2400
- type context$2_CreateMigratedCollectionsSnapshotResponse = CreateMigratedCollectionsSnapshotResponse;
2401
- type context$2_DataCollection = DataCollection;
2402
- type context$2_DataCollectionChangedEvent = DataCollectionChangedEvent;
2403
- type context$2_DataCollectionClonedEvent = DataCollectionClonedEvent;
2404
- type context$2_DataCollectionNonNullableFields = DataCollectionNonNullableFields;
2405
- type context$2_DataOperation = DataOperation;
2406
- declare const context$2_DataOperation: typeof DataOperation;
2407
- type context$2_DataPermissions = DataPermissions;
2408
- type context$2_DeleteDataCollectionFieldRequest = DeleteDataCollectionFieldRequest;
2409
- type context$2_DeleteDataCollectionFieldResponse = DeleteDataCollectionFieldResponse;
2410
- type context$2_DeleteDataCollectionRequest = DeleteDataCollectionRequest;
2411
- type context$2_DeleteDataCollectionResponse = DeleteDataCollectionResponse;
2412
- type context$2_DeleteDataCollectionsSnapshotRequest = DeleteDataCollectionsSnapshotRequest;
2413
- type context$2_DeleteDataCollectionsSnapshotResponse = DeleteDataCollectionsSnapshotResponse;
2414
- type context$2_Destination = Destination;
2415
- type context$2_Direction = Direction;
2416
- declare const context$2_Direction: typeof Direction;
2417
- type context$2_FieldCapabilities = FieldCapabilities;
2418
- type context$2_FieldPlugin = FieldPlugin;
2419
- type context$2_FieldPluginOptionsOneOf = FieldPluginOptionsOneOf;
2420
- type context$2_FieldPluginType = FieldPluginType;
2421
- declare const context$2_FieldPluginType: typeof FieldPluginType;
2422
- type context$2_FieldRangeValidationsOneOf = FieldRangeValidationsOneOf;
2423
- type context$2_FieldsPattern = FieldsPattern;
2424
- type context$2_Format = Format;
2425
- declare const context$2_Format: typeof Format;
2426
- type context$2_GetDataCollectionOptions = GetDataCollectionOptions;
2427
- type context$2_GetDataCollectionRequest = GetDataCollectionRequest;
2428
- type context$2_GetDataCollectionResponse = GetDataCollectionResponse;
2429
- type context$2_GetDataCollectionResponseNonNullableFields = GetDataCollectionResponseNonNullableFields;
2430
- type context$2_IndexField = IndexField;
2431
- type context$2_IndexLimits = IndexLimits;
2432
- type context$2_IndexStatus = IndexStatus;
2433
- declare const context$2_IndexStatus: typeof IndexStatus;
2434
- type context$2_ListDataCollectionsOptions = ListDataCollectionsOptions;
2435
- type context$2_ListDataCollectionsRequest = ListDataCollectionsRequest;
2436
- type context$2_ListDataCollectionsResponse = ListDataCollectionsResponse;
2437
- type context$2_ListDataCollectionsResponseNonNullableFields = ListDataCollectionsResponseNonNullableFields;
2438
- type context$2_MultiReference = MultiReference;
2439
- type context$2_MultilingualOptions = MultilingualOptions;
2440
- type context$2_NumberRange = NumberRange;
2441
- type context$2_ObjectField = ObjectField;
2442
- type context$2_PageLink = PageLink;
2443
- type context$2_PageLinkPluginOptions = PageLinkPluginOptions;
2444
- type context$2_PagingMode = PagingMode;
2445
- declare const context$2_PagingMode: typeof PagingMode;
2446
- type context$2_Permissions = Permissions;
2447
- type context$2_Plugin = Plugin;
2448
- type context$2_PluginCmsOptions = PluginCmsOptions;
2449
- type context$2_PluginOptionsOneOf = PluginOptionsOneOf;
2450
- type context$2_PluginType = PluginType;
2451
- declare const context$2_PluginType: typeof PluginType;
2452
- type context$2_PluginUpdate = PluginUpdate;
2453
- type context$2_QueryOperator = QueryOperator;
2454
- declare const context$2_QueryOperator: typeof QueryOperator;
2455
- type context$2_Reference = Reference;
2456
- type context$2_RestorationCollection = RestorationCollection;
2457
- type context$2_RestoreDataCollectionRequest = RestoreDataCollectionRequest;
2458
- type context$2_RestoreDataCollectionResponse = RestoreDataCollectionResponse;
2459
- type context$2_RestoreDataCollectionsFromSnapshotRequest = RestoreDataCollectionsFromSnapshotRequest;
2460
- type context$2_RestoreDataCollectionsFromSnapshotResponse = RestoreDataCollectionsFromSnapshotResponse;
2461
- type context$2_Role = Role;
2462
- declare const context$2_Role: typeof Role;
2463
- type context$2_Segment = Segment;
2464
- declare const context$2_Segment: typeof Segment;
2465
- type context$2_SingleItemPluginOptions = SingleItemPluginOptions;
2466
- type context$2_SiteSort = SiteSort;
2467
- type context$2_SnapshotCollection = SnapshotCollection;
2468
- type context$2_Sort = Sort;
2469
- type context$2_StringLengthRange = StringLengthRange;
2470
- type context$2_Type = Type;
2471
- declare const context$2_Type: typeof Type;
2472
- type context$2_TypeMetadata = TypeMetadata;
2473
- type context$2_TypeMetadataMetadataOneOf = TypeMetadataMetadataOneOf;
2474
- type context$2_UpdateDataCollectionFieldRequest = UpdateDataCollectionFieldRequest;
2475
- type context$2_UpdateDataCollectionFieldResponse = UpdateDataCollectionFieldResponse;
2476
- type context$2_UpdateDataCollectionRequest = UpdateDataCollectionRequest;
2477
- type context$2_UpdateDataCollectionResponse = UpdateDataCollectionResponse;
2478
- type context$2_UpdateDataCollectionResponseNonNullableFields = UpdateDataCollectionResponseNonNullableFields;
2479
- type context$2_UpdateDataPermissionsRequest = UpdateDataPermissionsRequest;
2480
- type context$2_UpdateDataPermissionsResponse = UpdateDataPermissionsResponse;
2481
- type context$2_UrlizedOnlyPattern = UrlizedOnlyPattern;
2482
- type context$2_UrlizedPluginOptions = UrlizedPluginOptions;
2483
- type context$2__Array = _Array;
2484
- type context$2__Object = _Object;
2485
- declare const context$2_createDataCollection: typeof createDataCollection;
2486
- declare const context$2_deleteDataCollection: typeof deleteDataCollection;
2487
- declare const context$2_getDataCollection: typeof getDataCollection;
2488
- declare const context$2_listDataCollections: typeof listDataCollections;
2489
- declare const context$2_updateDataCollection: typeof updateDataCollection;
2490
- declare namespace context$2 {
2491
- export { context$2_AccessLevel as AccessLevel, type ActionEvent$1 as ActionEvent, type context$2_AllowedDataPermissions as AllowedDataPermissions, type context$2_ArraySizeRange as ArraySizeRange, 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_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$2_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$2_DataCollectionNonNullableFields as DataCollectionNonNullableFields, 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, type context$2_Destination as Destination, 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 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_RestorationCollection as RestorationCollection, type context$2_RestoreDataCollectionRequest as RestoreDataCollectionRequest, type context$2_RestoreDataCollectionResponse as RestoreDataCollectionResponse, type context$2_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$2_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo$1 as RestoreInfo, context$2_Role as Role, context$2_Segment as Segment, 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_updateDataCollection as updateDataCollection };
2492
- }
2493
-
2494
- interface DataItem {
2495
- /** Data item ID. */
2496
- _id?: string;
2497
- /**
2498
- * ID of the collection this item belongs to
2499
- * @readonly
2500
- */
2501
- dataCollectionId?: string;
2502
- /**
2503
- * Data item contents.
2504
- *
2505
- * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
2506
- *
2507
- * + `_id`: Item ID.
2508
- * + `_createdDate`: Date and time the item was added to the collection.
2509
- * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
2510
- * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
2511
- */
2512
- data?: Record<string, any> | null;
2513
- }
2514
- interface InsertDataItemRequest {
2515
- /** ID of the collection in which to insert the item. */
2516
- dataCollectionId: string;
2517
- /** Item to insert. */
2518
- dataItem: DataItem;
2519
- /**
2520
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2521
- *
2522
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2523
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2524
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2525
- */
2526
- appOptions?: Record<string, any> | null;
2527
- }
2528
- declare enum Environment$1 {
2529
- LIVE = "LIVE",
2530
- SANDBOX = "SANDBOX",
2531
- SANDBOX_PREFERRED = "SANDBOX_PREFERRED"
2532
- }
2533
- interface Options {
2534
- }
2535
- interface PublishPluginOptions {
2536
- showDraftItems?: boolean;
2537
- }
2538
- interface InsertDataItemResponse {
2539
- /** Inserted data item. */
2540
- dataItem?: DataItem;
2541
- }
2542
- interface PatchDataItemRequest {
2543
- /** ID of the collection containing the existing item. */
2544
- dataCollectionId?: string;
2545
- /** Patch set applied during item update. */
2546
- patchSet?: PatchSet;
2547
- /**
2548
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2549
- *
2550
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2551
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2552
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2553
- */
2554
- appOptions?: Record<string, any> | null;
2555
- /**
2556
- * Options for the Publish plugin.
2557
- * 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.
2558
- */
2559
- publishPluginOptions?: DataPublishPluginOptions;
2560
- }
2561
- interface PatchSet {
2562
- /** Data item ID. */
2563
- dataItemId?: string;
2564
- /** Set of field updates to be applied */
2565
- fieldUpdates?: FieldUpdate[];
2566
- }
2567
- interface FieldUpdate extends FieldUpdateActionOptionsOneOf {
2568
- setField?: SetField;
2569
- incrementField?: IncrementField;
2570
- appendToArray?: AppendToArray;
2571
- removeFromArray?: RemoveFromArray;
2572
- /** Field ID to be patched. For ex "title", "address.street" */
2573
- fieldPath?: string;
2574
- /** Action to be applied */
2575
- action?: ACTION;
2576
- }
2577
- /** @oneof */
2578
- interface FieldUpdateActionOptionsOneOf {
2579
- setField?: SetField;
2580
- incrementField?: IncrementField;
2581
- appendToArray?: AppendToArray;
2582
- removeFromArray?: RemoveFromArray;
2583
- }
2584
- declare enum ACTION {
2585
- UNKNOWN_ACTION = "UNKNOWN_ACTION",
2586
- SET_FIELD = "SET_FIELD",
2587
- REMOVE_FIELD = "REMOVE_FIELD",
2588
- INCREMENT_FIELD = "INCREMENT_FIELD",
2589
- APPEND_TO_ARRAY = "APPEND_TO_ARRAY",
2590
- REMOVE_FROM_ARRAY = "REMOVE_FROM_ARRAY"
2591
- }
2592
- interface SetField {
2593
- value?: any;
2594
- }
2595
- interface IncrementField {
2596
- value?: number;
2597
- }
2598
- interface AppendToArray {
2599
- value?: any;
2600
- }
2601
- interface RemoveFromArray {
2602
- value?: any;
2603
- }
2604
- interface DataPublishPluginOptions {
2605
- /**
2606
- * Whether to include draft items.
2607
- * When `true`, the response includes both published and draft items. Default: `false`.
2608
- */
2609
- includeDraftItems?: boolean;
2610
- }
2611
- interface PatchDataItemResponse {
2612
- /** Updated data item. */
2613
- dataItem?: DataItem;
2614
- }
2615
- interface BulkPatchDataItemsRequest {
2616
- /** ID of the collection in which to update items. */
2617
- dataCollectionId?: string;
2618
- /** Patch sets to apply. */
2619
- patchSets?: PatchSet[];
2620
- /**
2621
- * Whether to return the updated data items.
2622
- * When `true`, the `results` objects contain a `dataItem` field.
2623
- *
2624
- * Default: `false`
2625
- */
2626
- returnEntity?: boolean;
2627
- /**
2628
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
2629
- *
2630
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2631
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2632
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2633
- */
2634
- appOptions?: Record<string, any> | null;
2635
- /**
2636
- * Options for the Publish plugin.
2637
- * 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.
2638
- */
2639
- publishPluginOptions?: DataPublishPluginOptions;
2640
- }
2641
- interface BulkPatchDataItemsResponse {
2642
- /** Information about the updated items. */
2643
- results?: BulkDataItemResult[];
2644
- /** Bulk action metadata. */
2645
- bulkActionMetadata?: BulkActionMetadata;
2646
- }
2647
- interface BulkDataItemResult {
2648
- /**
2649
- * The action attempted for the data item.
2650
- *
2651
- * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
2652
- */
2653
- action?: BulkActionType;
2654
- /** Metadata related to the data item for which the action was attempted. */
2655
- itemMetadata?: ItemMetadata;
2656
- /** The data item for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
2657
- dataItem?: DataItem;
2658
- }
2659
- declare enum BulkActionType {
2660
- UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
2661
- INSERT = "INSERT",
2662
- UPDATE = "UPDATE",
2663
- DELETE = "DELETE",
2664
- PATCH = "PATCH"
2665
- }
2666
- interface ItemMetadata {
2667
- /** Item ID. This field doesn't appear if there is no item ID, for example, when item creation fails. */
2668
- _id?: string | null;
2669
- /** Index of the item within the request array. Allows for correlation between request and response items. */
2670
- originalIndex?: number;
2671
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2672
- success?: boolean;
2673
- /** Details about the error in case of failure. */
2674
- error?: ApplicationError;
2675
- }
2676
- interface ApplicationError {
2677
- /** Error code. */
2678
- code?: string;
2679
- /** Description of the error. */
2680
- description?: string;
2681
- /** Data related to the error. */
2682
- data?: Record<string, any> | null;
2683
- }
2684
- interface BulkActionMetadata {
2685
- /** Number of items successfully processed. */
2686
- totalSuccesses?: number;
2687
- /** Number of items that couldn't be processed. */
2688
- totalFailures?: number;
2689
- }
2690
- interface UpdateDataItemRequest {
2691
- /** ID of the collection containing the existing item. */
2692
- dataCollectionId: string;
2693
- /** Updated data item content. The existing data item's content is replaced entirely. */
2694
- dataItem: DataItem;
2695
- /**
2696
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2697
- *
2698
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2699
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2700
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2701
- */
2702
- appOptions?: Record<string, any> | null;
2703
- /**
2704
- * Options for the Publish plugin.
2705
- * 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.
2706
- */
2707
- publishPluginOptions?: DataPublishPluginOptions;
2708
- }
2709
- interface UpdateDataItemResponse {
2710
- /** Updated data item. */
2711
- dataItem?: DataItem;
2712
- }
2713
- interface SaveDataItemRequest {
2714
- /** ID of the collection in which to insert or update the item. */
2715
- dataCollectionId: string;
2716
- /** Data item to insert or update. */
2717
- dataItem: DataItem;
2718
- /**
2719
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2720
- *
2721
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2722
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2723
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2724
- */
2725
- appOptions?: Record<string, any> | null;
2726
- /**
2727
- * Options for the Publish plugin.
2728
- * 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.
2729
- */
2730
- publishPluginOptions?: DataPublishPluginOptions;
2731
- }
2732
- interface SaveDataItemResponse {
2733
- /** The action carried out for the item. */
2734
- action?: Action;
2735
- /** Inserted or updated data item. */
2736
- dataItem?: DataItem;
2737
- }
2738
- declare enum Action {
2739
- /** Undefined action. */
2740
- UNKNOWN_ACTION = "UNKNOWN_ACTION",
2741
- /** A new item was added to the collection. */
2742
- INSERTED = "INSERTED",
2743
- /** An existing item in the collection was updated. */
2744
- UPDATED = "UPDATED"
2745
- }
2746
- interface GetDataItemRequest {
2747
- /** ID of the collection from which to retrieve the data item. */
2748
- dataCollectionId: string;
2749
- /** ID of the data item to retrieve. */
2750
- dataItemId: string;
2751
- /**
2752
- * Whether to retrieve data from the primary database instance.
2753
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2754
- *
2755
- * Default: `false`
2756
- */
2757
- consistentRead?: boolean;
2758
- /**
2759
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2760
- * If provided, the result text is returned in the specified language.
2761
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2762
- *
2763
- * If not provided, result text is not translated.
2764
- */
2765
- language?: string | null;
2766
- /**
2767
- * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2768
- * **Note:** The `_id` system field is always returned.
2769
- */
2770
- fields?: string[];
2771
- /**
2772
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2773
- *
2774
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2775
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2776
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2777
- */
2778
- appOptions?: Record<string, any> | null;
2779
- /**
2780
- * Options for the Publish plugin.
2781
- * 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.
2782
- */
2783
- publishPluginOptions?: DataPublishPluginOptions;
2784
- }
2785
- interface GetDataItemResponse {
2786
- /** Retrieved item. */
2787
- dataItem?: DataItem;
2788
- }
2789
- interface RemoveDataItemRequest {
2790
- /** ID of the collection from which to remove the item. */
2791
- dataCollectionId: string;
2792
- /** ID of the item to remove. */
2793
- dataItemId: string;
2794
- /**
2795
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2796
- *
2797
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2798
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2799
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2800
- */
2801
- appOptions?: Record<string, any> | null;
2802
- /**
2803
- * Options for the Publish plugin.
2804
- * 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.
2805
- */
2806
- publishPluginOptions?: DataPublishPluginOptions;
2807
- }
2808
- interface RemoveDataItemResponse {
2809
- /** Removed item. */
2810
- dataItem?: DataItem;
2811
- }
2812
- interface TruncateDataItemsRequest {
2813
- /** ID of the collection to truncate. */
2814
- dataCollectionId: string;
2815
- }
2816
- interface TruncateDataItemsResponse {
2817
- }
2818
- interface QueryDataItemsRequest {
2819
- /** ID of the collection to query. */
2820
- dataCollectionId: string;
2821
- /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
2822
- query?: QueryV2;
2823
- /**
2824
- * Whether to return the total count in the response for a query with offset paging.
2825
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
2826
- *
2827
- * Default: `false`
2828
- */
2829
- returnTotalCount?: boolean;
2830
- /**
2831
- * Properties for which to include referenced items in the query's results.
2832
- * Up to 50 referenced items can be included for each item that matches the query.
2833
- * @deprecated
2834
- * @replacedBy referenced_item_options
2835
- * @targetRemovalDate 2025-08-01
2836
- */
2837
- includeReferencedItems?: string[];
2838
- /**
2839
- * Whether to retrieve data from the primary database instance.
2840
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2841
- *
2842
- * Default: `false`
2843
- */
2844
- consistentRead?: boolean;
2845
- /**
2846
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2847
- * If provided, the result text is returned in the specified language.
2848
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
2849
- *
2850
- * If not provided, result text is not translated.
2851
- */
2852
- language?: string | null;
2853
- /**
2854
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
2855
- *
2856
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
2857
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
2858
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
2859
- */
2860
- appOptions?: Record<string, any> | null;
2861
- /**
2862
- * Options for the Publish plugin.
2863
- * 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.
2864
- */
2865
- publishPluginOptions?: DataPublishPluginOptions;
2866
- /** Options for retrieving referenced items. */
2867
- referencedItemOptions?: ReferencedItemOptions[];
2868
- }
2869
- interface QueryV2 extends QueryV2PagingMethodOneOf {
2870
- /** Paging options to limit and skip the number of items. */
2871
- paging?: Paging$1;
2872
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2873
- cursorPaging?: CursorPaging;
2874
- /**
2875
- * Filter object in the following format:
2876
- *
2877
- * `"filter" : {
2878
- * "fieldName1": "value1",
2879
- * "fieldName2":{"$operator":"value2"}
2880
- * }`
2881
- *
2882
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2883
- *
2884
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2885
- */
2886
- filter?: Record<string, any> | null;
2887
- /**
2888
- * Sort object in the following format:
2889
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2890
- */
2891
- sort?: Sorting[];
2892
- /**
2893
- * Fields to return for each item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
2894
- * **Note:** The `_id` system field is always returned.
2895
- */
2896
- fields?: string[];
2897
- }
2898
- /** @oneof */
2899
- interface QueryV2PagingMethodOneOf {
2900
- /** Paging options to limit and skip the number of items. */
2901
- paging?: Paging$1;
2902
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2903
- cursorPaging?: CursorPaging;
2904
- }
2905
- interface Sorting {
2906
- /** Name of the field to sort by. */
2907
- fieldName?: string;
2908
- /**
2909
- * Sort order.
2910
- *
2911
- * Supported values: `ASC`, `DESC`.
2912
- */
2913
- order?: SortOrder;
2914
- }
2915
- declare enum SortOrder {
2916
- ASC = "ASC",
2917
- DESC = "DESC"
2918
- }
2919
- interface Paging$1 {
2920
- /** Number of items to load. */
2921
- limit?: number | null;
2922
- /** Number of items to skip in the current sort order. */
2923
- offset?: number | null;
2924
- }
2925
- interface CursorPaging {
2926
- /** Number of items to load. */
2927
- limit?: number | null;
2928
- /**
2929
- * Pointer to the next or previous page in the list of results.
2930
- *
2931
- * You can get the relevant cursor token
2932
- * from the `pagingMetadata` object in the previous call's response.
2933
- * Not relevant for the first request.
2934
- */
2935
- cursor?: string | null;
2936
- }
2937
- interface ReferencedItemOptions {
2938
- /** Field containing references in the queried item. */
2939
- fieldName?: string;
2940
- /** Maximum number of referenced items to include for each queried item. */
2941
- limit?: number | null;
2942
- }
2943
- interface QueryDataItemsResponse {
2944
- /** Retrieved items. */
2945
- dataItems?: DataItem[];
2946
- /** Paging information. */
2947
- pagingMetadata?: PagingMetadataV2;
2948
- }
2949
- interface CachingInfo {
2950
- /** Caching tags for this collection */
2951
- tags?: string[];
2952
- /** max caching time if set */
2953
- maxAge?: number | null;
2954
- }
2955
- interface PagingMetadataV2 {
2956
- /** Number of items returned in the response. */
2957
- count?: number | null;
2958
- /** Offset that was requested. */
2959
- offset?: number | null;
2960
- /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */
2961
- total?: number | null;
2962
- /** Whether the server failed to calculate the `total` field. */
2963
- tooManyToCount?: boolean | null;
2964
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
2965
- cursors?: Cursors;
2966
- }
2967
- interface Cursors {
2968
- /** Cursor pointing to next page in the list of results. */
2969
- next?: string | null;
2970
- /** Cursor pointing to previous page in the list of results. */
2971
- prev?: string | null;
2972
- }
2973
- interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMethodOneOf {
2974
- /** Paging options to limit and skip the number of items. */
2975
- paging?: Paging$1;
2976
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2977
- cursorPaging?: CursorPaging;
2978
- /** ID of the collection on which to run the aggregation. */
2979
- dataCollectionId: string;
2980
- /**
2981
- * Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
2982
- *
2983
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2984
- */
2985
- initialFilter?: Record<string, any> | null;
2986
- /** Aggregation applied to the data. */
2987
- aggregation?: Aggregation;
2988
- /**
2989
- * Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
2990
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
2991
- */
2992
- finalFilter?: Record<string, any> | null;
2993
- /**
2994
- * Sort object in the following format:
2995
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2996
- */
2997
- sort?: Sorting[];
2998
- /**
2999
- * Whether to return the total count in the response for a query with offset paging.
3000
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3001
- *
3002
- * Default: `false`
3003
- */
3004
- returnTotalCount?: boolean;
3005
- /**
3006
- * Whether to retrieve data from the primary database instance.
3007
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3008
- *
3009
- * Default: `false`
3010
- */
3011
- consistentRead?: boolean;
3012
- /**
3013
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3014
- * If provided, the result text is returned in the specified language.
3015
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3016
- *
3017
- * If not provided, result text is not translated.
3018
- */
3019
- language?: string | null;
3020
- /**
3021
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3022
- *
3023
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3024
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3025
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3026
- */
3027
- appOptions?: Record<string, any> | null;
3028
- /**
3029
- * Options for the Publish plugin.
3030
- * 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.
3031
- */
3032
- publishPluginOptions?: DataPublishPluginOptions;
3033
- }
3034
- /** @oneof */
3035
- interface AggregateDataItemsRequestPagingMethodOneOf {
3036
- /** Paging options to limit and skip the number of items. */
3037
- paging?: Paging$1;
3038
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3039
- cursorPaging?: CursorPaging;
3040
- }
3041
- interface Average {
3042
- /** Name of the field for which to calculate the average value. */
3043
- itemFieldName?: string;
3044
- }
3045
- interface Min {
3046
- /** Name of the field for which to calculate the minimum value. */
3047
- itemFieldName?: string;
3048
- }
3049
- interface Max {
3050
- /** Name of the field for which to calculate the maximum value. */
3051
- itemFieldName?: string;
3052
- }
3053
- interface Sum {
3054
- /** Name of the field for which to calculate the sum. */
3055
- itemFieldName?: string;
3056
- }
3057
- interface Count {
3058
- }
3059
- interface Operation extends OperationCalculateOneOf {
3060
- /** Calculate the average value of a specified field for all items in the grouping. */
3061
- average?: Average;
3062
- /** Calculate the minimum value of a specified field for all items in the grouping. */
3063
- min?: Min;
3064
- /** Calculate the maximum value of a specified field for all items in the grouping. */
3065
- max?: Max;
3066
- /** Calculate the sum of values of a specified field for all items in the grouping. */
3067
- sum?: Sum;
3068
- /** Calculate the number of items in the grouping. */
3069
- itemCount?: Count;
3070
- /** Name of the field containing results of the operation. */
3071
- resultFieldName?: string;
3072
- }
3073
- /** @oneof */
3074
- interface OperationCalculateOneOf {
3075
- /** Calculate the average value of a specified field for all items in the grouping. */
3076
- average?: Average;
3077
- /** Calculate the minimum value of a specified field for all items in the grouping. */
3078
- min?: Min;
3079
- /** Calculate the maximum value of a specified field for all items in the grouping. */
3080
- max?: Max;
3081
- /** Calculate the sum of values of a specified field for all items in the grouping. */
3082
- sum?: Sum;
3083
- /** Calculate the number of items in the grouping. */
3084
- itemCount?: Count;
3085
- }
3086
- interface Aggregation {
3087
- /** Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection. */
3088
- groupingFields?: string[];
3089
- /** Operations to carry out on the data in each grouping. */
3090
- operations?: Operation[];
3091
- }
3092
- interface AggregateDataItemsResponse {
3093
- /** Aggregation results. */
3094
- results?: Record<string, any>[] | null;
3095
- /** Paging information. */
3096
- pagingMetadata?: PagingMetadataV2;
3097
- }
3098
- interface CountDataItemsRequest {
3099
- /** ID of the collection for which to count query results. */
3100
- dataCollectionId: string;
3101
- /**
3102
- * Filter object in the following format:
3103
- *
3104
- * `"filter" : {
3105
- * "fieldName1": "value1",
3106
- * "fieldName2":{"$operator":"value2"}
3107
- * }`.
3108
- *
3109
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3110
- *
3111
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3112
- */
3113
- filter?: Record<string, any> | null;
3114
- /**
3115
- * Whether to retrieve data from the primary database instance.
3116
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3117
- *
3118
- * Default: `false`
3119
- */
3120
- consistentRead?: boolean;
3121
- /**
3122
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3123
- * If provided, the result text is returned in the specified language.
3124
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3125
- *
3126
- * If not provided, result text is not translated.
3127
- */
3128
- language?: string | null;
3129
- /**
3130
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3131
- *
3132
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3133
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3134
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3135
- */
3136
- appOptions?: Record<string, any> | null;
3137
- /**
3138
- * Options for the Publish plugin.
3139
- * 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.
3140
- */
3141
- publishPluginOptions?: DataPublishPluginOptions;
3142
- }
3143
- interface CountDataItemsResponse {
3144
- /** Number of items matching the query. */
3145
- totalCount?: number;
3146
- }
3147
- interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMethodOneOf {
3148
- /** Paging options to limit and skip the number of items. */
3149
- paging?: Paging$1;
3150
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3151
- cursorPaging?: CursorPaging;
3152
- /** ID of the collection to query. */
3153
- dataCollectionId: string;
3154
- /** Item field name for which to return all distinct values. */
3155
- fieldName?: string;
3156
- /**
3157
- * Filter object in the following format:
3158
- *
3159
- * `"filter" : {
3160
- * "fieldName1": "value1",
3161
- * "fieldName2":{"$operator":"value2"}
3162
- * }`.
3163
- *
3164
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3165
- *
3166
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
3167
- */
3168
- filter?: Record<string, any> | null;
3169
- /**
3170
- * Sort order.
3171
- *
3172
- * Supported values: `ASC`, `DESC`.
3173
- */
3174
- order?: SortOrder;
3175
- /**
3176
- * Whether to return the total count in the response for a query with offset paging.
3177
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3178
- *
3179
- * Default: `false`
3180
- */
3181
- returnTotalCount?: boolean;
3182
- /**
3183
- * Whether to retrieve data from the primary database instance.
3184
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3185
- *
3186
- * Default: `false`
3187
- */
3188
- consistentRead?: boolean;
3189
- /**
3190
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3191
- * If provided, the result text is returned in the specified language.
3192
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3193
- *
3194
- * If not provided, result text is not translated.
3195
- */
3196
- language?: string | null;
3197
- /**
3198
- * Options for the Publish plugin.
3199
- * 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.
3200
- */
3201
- publishPluginOptions?: DataPublishPluginOptions;
3202
- }
3203
- /** @oneof */
3204
- interface QueryDistinctValuesRequestPagingMethodOneOf {
3205
- /** Paging options to limit and skip the number of items. */
3206
- paging?: Paging$1;
3207
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3208
- cursorPaging?: CursorPaging;
3209
- }
3210
- interface QueryDistinctValuesResponse {
3211
- /** List of distinct values contained in the field specified in `fieldName`. */
3212
- distinctValues?: any[];
3213
- /** Paging information. */
3214
- pagingMetadata?: PagingMetadataV2;
3215
- }
3216
- interface BulkInsertDataItemsRequest {
3217
- /** ID of the collection in which to insert the items. */
3218
- dataCollectionId: string;
3219
- /** Data items to insert. */
3220
- dataItems: DataItem[];
3221
- /**
3222
- * Whether to return the inserted data items.
3223
- * When `true`, the `results` objects contain a `dataItem` field.
3224
- *
3225
- * Default: `false`
3226
- */
3227
- returnEntity?: boolean;
3228
- /**
3229
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3230
- *
3231
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3232
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3233
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3234
- */
3235
- appOptions?: Record<string, any> | null;
3236
- }
3237
- interface BulkInsertDataItemsResponse {
3238
- /** Information about the inserted items. */
3239
- results?: BulkDataItemResult[];
3240
- /** Bulk action metadata. */
3241
- bulkActionMetadata?: BulkActionMetadata;
3242
- }
3243
- interface BulkUpdateDataItemsRequest {
3244
- /** ID of the collection in which to update items. */
3245
- dataCollectionId: string;
3246
- /** Data items to update. */
3247
- dataItems: DataItem[];
3248
- /**
3249
- * Whether to return the updated data items.
3250
- * When `true`, the `results` objects contain a `dataItem` field.
3251
- *
3252
- * Default: `false`
3253
- */
3254
- returnEntity?: boolean;
3255
- /**
3256
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3257
- *
3258
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3259
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3260
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3261
- */
3262
- appOptions?: Record<string, any> | null;
3263
- /**
3264
- * Options for the Publish plugin.
3265
- * 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.
3266
- */
3267
- publishPluginOptions?: DataPublishPluginOptions;
3268
- }
3269
- interface BulkUpdateDataItemsResponse {
3270
- /** Information about the updated items. */
3271
- results?: BulkDataItemResult[];
3272
- /** Bulk action metadata. */
3273
- bulkActionMetadata?: BulkActionMetadata;
3274
- }
3275
- interface BulkSaveDataItemsRequest {
3276
- /** ID of the collection in which to insert or update the items. */
3277
- dataCollectionId: string;
3278
- /** Data items to insert or update. */
3279
- dataItems: DataItem[];
3280
- /**
3281
- * Whether to return the saved data item.
3282
- * When `true`, the `results` objects contain a `dataItem` field.
3283
- *
3284
- * Default: `false`
3285
- */
3286
- returnEntity?: boolean;
3287
- /**
3288
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3289
- *
3290
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3291
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3292
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3293
- */
3294
- appOptions?: Record<string, any> | null;
3295
- /**
3296
- * Options for the Publish plugin.
3297
- * 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.
3298
- */
3299
- publishPluginOptions?: DataPublishPluginOptions;
3300
- }
3301
- interface BulkSaveDataItemsResponse {
3302
- /** Information about the saved items. */
3303
- results?: BulkDataItemResult[];
3304
- /** Bulk action metadata. */
3305
- bulkActionMetadata?: BulkActionMetadata;
3306
- }
3307
- interface BulkRemoveDataItemsRequest {
3308
- /** ID of the collection from which to remove the item. */
3309
- dataCollectionId: string;
3310
- /** IDs of data items to remove. */
3311
- dataItemIds: string[];
3312
- /**
3313
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3314
- *
3315
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3316
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3317
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3318
- */
3319
- appOptions?: Record<string, any> | null;
3320
- /**
3321
- * Options for the Publish plugin.
3322
- * 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.
3323
- */
3324
- publishPluginOptions?: DataPublishPluginOptions;
3325
- }
3326
- interface BulkRemoveDataItemsResponse {
3327
- /** Information about the removed data items. */
3328
- results?: BulkDataItemResult[];
3329
- /** Bulk action metadata. */
3330
- bulkActionMetadata?: BulkActionMetadata;
3331
- }
3332
- interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsRequestPagingMethodOneOf {
3333
- /** Paging options to limit and skip the number of items. */
3334
- paging?: Paging$1;
3335
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3336
- cursorPaging?: CursorPaging;
3337
- /** ID of the collection containing the referring item. */
3338
- dataCollectionId: string;
3339
- /** ID of the referring item. */
3340
- referringItemId?: string;
3341
- /** Field containing references in the referring item. */
3342
- referringItemFieldName?: string;
3343
- /** Order of the returned referenced items. Sorted by the date each item was referenced. */
3344
- order?: SortOrder;
3345
- /**
3346
- * Whether to return the total count in the response.
3347
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3348
- *
3349
- * Default: `false`
3350
- */
3351
- returnTotalCount?: boolean;
3352
- /**
3353
- * Whether to retrieve data from the primary database instance.
3354
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3355
- *
3356
- * Default: `false`
3357
- */
3358
- consistentRead?: boolean;
3359
- /**
3360
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3361
- * If provided, the result text is returned in the specified language.
3362
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3363
- *
3364
- * If not provided, result text is not translated.
3365
- */
3366
- language?: string | null;
3367
- /**
3368
- * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
3369
- * **Note:** The `_id` system field is always returned.
3370
- */
3371
- fields?: string[];
3372
- /**
3373
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
3374
- *
3375
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3376
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3377
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3378
- */
3379
- appOptions?: Record<string, any> | null;
3380
- /**
3381
- * Options for the Publish plugin.
3382
- * 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.
3383
- */
3384
- publishPluginOptions?: DataPublishPluginOptions;
3385
- }
3386
- /** @oneof */
3387
- interface QueryReferencedDataItemsRequestPagingMethodOneOf {
3388
- /** Paging options to limit and skip the number of items. */
3389
- paging?: Paging$1;
3390
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3391
- cursorPaging?: CursorPaging;
3392
- }
3393
- interface QueryReferencedDataItemsResponse {
3394
- /** Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned. */
3395
- results?: ReferencedResult[];
3396
- /** Paging information. */
3397
- pagingMetadata?: PagingMetadataV2;
3398
- }
3399
- interface UnresolvedReference {
3400
- /**
3401
- * ID of the referring item.
3402
- * @deprecated
3403
- * @targetRemovalDate 2025-03-01
3404
- */
3405
- referringItemId?: string;
3406
- /**
3407
- * Field specified to query for references.
3408
- * @deprecated
3409
- * @targetRemovalDate 2025-03-01
3410
- */
3411
- referringItemFieldName?: string;
3412
- /** ID of unresolved referenced item */
3413
- referencedItemId?: string;
3414
- /** Flag is set if item exists, but user is not authorized to read it */
3415
- unauthorized?: boolean;
3416
- }
3417
- interface ReferencedResult extends ReferencedResultEntityOneOf {
3418
- /** Data item referenced. */
3419
- dataItem?: DataItem;
3420
- /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */
3421
- unresolvedReference?: UnresolvedReference;
3422
- /** ID of the referring item. */
3423
- referringItemId?: string;
3424
- }
3425
- /** @oneof */
3426
- interface ReferencedResultEntityOneOf {
3427
- /** Data item referenced. */
3428
- dataItem?: DataItem;
3429
- /** Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state. */
3430
- unresolvedReference?: UnresolvedReference;
3431
- }
3432
- interface IsReferencedDataItemRequest {
3433
- /** ID of the collection containing the referring data item. */
3434
- dataCollectionId: string;
3435
- /** Field to check for a reference to the item that may be referenced. */
3436
- referringItemFieldName: string;
3437
- /** ID of the referring item. */
3438
- referringItemId: string;
3439
- /** ID of the item that may be referenced. */
3440
- referencedItemId: string;
3441
- /**
3442
- * Whether to retrieve data from the primary database instance.
3443
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3444
- *
3445
- * Default: `false`
3446
- */
3447
- consistentRead?: boolean;
3448
- }
3449
- interface IsReferencedDataItemResponse {
3450
- /** Whether the specified reference exists. */
3451
- isReferenced?: boolean;
3452
- }
3453
- interface InsertDataItemReferenceRequest {
3454
- /** ID of the collection in which to insert the reference. */
3455
- dataCollectionId: string;
3456
- /** Reference to insert */
3457
- dataItemReference?: DataItemReference;
3458
- /**
3459
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3460
- *
3461
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3462
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3463
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3464
- */
3465
- appOptions?: Record<string, any> | null;
3466
- }
3467
- interface DataItemReference {
3468
- /** Referring item field containing the references to the referenced items. */
3469
- referringItemFieldName?: string;
3470
- /** ID of the referring item. */
3471
- referringItemId?: string;
3472
- /** ID of the referenced item. */
3473
- referencedItemId?: string;
3474
- }
3475
- interface InsertDataItemReferenceResponse {
3476
- /** Inserted reference. */
3477
- dataItemReference?: DataItemReference;
3478
- }
3479
- interface RemoveDataItemReferenceRequest {
3480
- /** ID of the collection containing the referring item. */
3481
- dataCollectionId: string;
3482
- /** Reference to remove. */
3483
- dataItemReference: DataItemReference;
3484
- }
3485
- interface RemoveDataItemReferenceResponse {
3486
- /** Removed reference. */
3487
- dataItemReference?: DataItemReference;
3488
- }
3489
- interface BulkInsertDataItemReferencesRequest {
3490
- /** ID of the collection containing the referring items. */
3491
- dataCollectionId: string;
3492
- /** References to insert. */
3493
- dataItemReferences: DataItemReference[];
3494
- /**
3495
- * Whether to return the inserted data item references.
3496
- * When `true`, the `results` objects contain a `dataItemReference` field.
3497
- *
3498
- * Default: `false`
3499
- */
3500
- returnEntity?: boolean;
3501
- }
3502
- interface BulkInsertDataItemReferencesResponse {
3503
- /** Information about the inserted references. */
3504
- results?: BulkDataItemReferenceResult[];
3505
- /** Bulk action metadata. */
3506
- bulkActionMetadata?: BulkActionMetadata;
3507
- }
3508
- interface BulkDataItemReferenceResult {
3509
- /**
3510
- * The action attempted for the reference.
3511
- *
3512
- * Supported values: `UNKNOWN_ACTION_TYPE`, `INSERT`, `UPDATE`, `DELETE`.
3513
- */
3514
- action?: BulkActionType;
3515
- /** Metadata related to the reference for which the action was attempted. */
3516
- referenceMetadata?: ItemMetadata;
3517
- /** The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful. */
3518
- dataItemReference?: DataItemReference;
3519
- }
3520
- interface BulkRemoveDataItemReferencesRequest {
3521
- /** ID of the collection containing the referring items. */
3522
- dataCollectionId: string;
3523
- /** References to remove. */
3524
- dataItemReferences: DataItemReference[];
3525
- }
3526
- interface BulkRemoveDataItemReferencesResponse {
3527
- /** Information about the removed references. */
3528
- results?: BulkDataItemReferenceResult[];
3529
- /** Bulk action metadata. */
3530
- bulkActionMetadata?: BulkActionMetadata;
3531
- }
3532
- interface ReplaceDataItemReferencesRequest {
3533
- /** ID of the collection containing the referring item. */
3534
- dataCollectionId: string;
3535
- /** Field containing references in the referring item. */
3536
- referringItemFieldName: string;
3537
- /** ID of the referring item. */
3538
- referringItemId: string;
3539
- /** List of new referenced item IDs to replace the existing ones. */
3540
- newReferencedItemIds?: string[];
3541
- }
3542
- interface ReplaceDataItemReferencesResponse {
3543
- /** Updated references. */
3544
- dataItemReferences?: DataItemReference[];
3545
- }
3546
- interface DomainEvent extends DomainEventBodyOneOf {
3547
- createdEvent?: EntityCreatedEvent;
3548
- updatedEvent?: EntityUpdatedEvent;
3549
- deletedEvent?: EntityDeletedEvent;
3550
- actionEvent?: ActionEvent;
3551
- /**
3552
- * Unique event ID.
3553
- * Allows clients to ignore duplicate webhooks.
3554
- */
3555
- _id?: string;
3556
- /**
3557
- * Assumes actions are also always typed to an entity_type
3558
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3559
- */
3560
- entityFqdn?: string;
3561
- /**
3562
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3563
- * This is although the created/updated/deleted notion is duplication of the oneof types
3564
- * Example: created/updated/deleted/started/completed/email_opened
3565
- */
3566
- slug?: string;
3567
- /** ID of the entity associated with the event. */
3568
- entityId?: string;
3569
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3570
- eventTime?: Date | null;
3571
- /**
3572
- * Whether the event was triggered as a result of a privacy regulation application
3573
- * (for example, GDPR).
3574
- */
3575
- triggeredByAnonymizeRequest?: boolean | null;
3576
- /** If present, indicates the action that triggered the event. */
3577
- originatedFrom?: string | null;
3578
- /**
3579
- * A sequence number defining the order of updates to the underlying entity.
3580
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3581
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3582
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3583
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3584
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3585
- */
3586
- entityEventSequence?: string | null;
3587
- }
3588
- /** @oneof */
3589
- interface DomainEventBodyOneOf {
3590
- createdEvent?: EntityCreatedEvent;
3591
- updatedEvent?: EntityUpdatedEvent;
3592
- deletedEvent?: EntityDeletedEvent;
3593
- actionEvent?: ActionEvent;
3594
- }
3595
- interface EntityCreatedEvent {
3596
- entity?: string;
3597
- }
3598
- interface RestoreInfo {
3599
- deletedDate?: Date | null;
3600
- }
3601
- interface EntityUpdatedEvent {
3602
- /**
3603
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3604
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3605
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3606
- */
3607
- currentEntity?: string;
3608
- }
3609
- interface EntityDeletedEvent {
3610
- /** Entity that was deleted */
3611
- deletedEntity?: string | null;
3612
- }
3613
- interface ActionEvent {
3614
- body?: string;
3615
- }
3616
- interface MessageEnvelope {
3617
- /** App instance ID. */
3618
- instanceId?: string | null;
3619
- /** Event type. */
3620
- eventType?: string;
3621
- /** The identification type and identity data. */
3622
- identity?: IdentificationData;
3623
- /** Stringify payload. */
3624
- data?: string;
3625
- }
3626
- interface IdentificationData extends IdentificationDataIdOneOf {
3627
- /** ID of a site visitor that has not logged in to the site. */
3628
- anonymousVisitorId?: string;
3629
- /** ID of a site visitor that has logged in to the site. */
3630
- memberId?: string;
3631
- /** ID of a Wix user (site owner, contributor, etc.). */
3632
- wixUserId?: string;
3633
- /** ID of an app. */
3634
- appId?: string;
3635
- /** @readonly */
3636
- identityType?: WebhookIdentityType;
3637
- }
3638
- /** @oneof */
3639
- interface IdentificationDataIdOneOf {
3640
- /** ID of a site visitor that has not logged in to the site. */
3641
- anonymousVisitorId?: string;
3642
- /** ID of a site visitor that has logged in to the site. */
3643
- memberId?: string;
3644
- /** ID of a Wix user (site owner, contributor, etc.). */
3645
- wixUserId?: string;
3646
- /** ID of an app. */
3647
- appId?: string;
3648
- }
3649
- declare enum WebhookIdentityType {
3650
- UNKNOWN = "UNKNOWN",
3651
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3652
- MEMBER = "MEMBER",
3653
- WIX_USER = "WIX_USER",
3654
- APP = "APP"
3655
- }
3656
- interface DataItemNonNullableFields {
3657
- _id: string;
3658
- dataCollectionId: string;
3659
- }
3660
- interface InsertDataItemResponseNonNullableFields {
3661
- dataItem?: DataItemNonNullableFields;
3662
- }
3663
- interface UpdateDataItemResponseNonNullableFields {
3664
- dataItem?: DataItemNonNullableFields;
3665
- }
3666
- interface SaveDataItemResponseNonNullableFields {
3667
- action: Action;
3668
- dataItem?: DataItemNonNullableFields;
3669
- }
3670
- interface GetDataItemResponseNonNullableFields {
3671
- dataItem?: DataItemNonNullableFields;
3672
- }
3673
- interface RemoveDataItemResponseNonNullableFields {
3674
- dataItem?: DataItemNonNullableFields;
3675
- }
3676
- interface CachingInfoNonNullableFields {
3677
- tags: string[];
3678
- }
3679
- interface QueryDataItemsResponseNonNullableFields {
3680
- dataItems: DataItemNonNullableFields[];
3681
- cachingInfo?: CachingInfoNonNullableFields;
3682
- }
3683
- interface CountDataItemsResponseNonNullableFields {
3684
- totalCount: number;
3685
- }
3686
- interface ApplicationErrorNonNullableFields {
3687
- code: string;
3688
- description: string;
3689
- }
3690
- interface ItemMetadataNonNullableFields {
3691
- originalIndex: number;
3692
- success: boolean;
3693
- error?: ApplicationErrorNonNullableFields;
3694
- }
3695
- interface BulkDataItemResultNonNullableFields {
3696
- action: BulkActionType;
3697
- itemMetadata?: ItemMetadataNonNullableFields;
3698
- dataItem?: DataItemNonNullableFields;
3699
- }
3700
- interface BulkActionMetadataNonNullableFields {
3701
- totalSuccesses: number;
3702
- totalFailures: number;
3703
- }
3704
- interface BulkInsertDataItemsResponseNonNullableFields {
3705
- results: BulkDataItemResultNonNullableFields[];
3706
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3707
- }
3708
- interface BulkUpdateDataItemsResponseNonNullableFields {
3709
- results: BulkDataItemResultNonNullableFields[];
3710
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3711
- }
3712
- interface BulkSaveDataItemsResponseNonNullableFields {
3713
- results: BulkDataItemResultNonNullableFields[];
3714
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3715
- }
3716
- interface BulkRemoveDataItemsResponseNonNullableFields {
3717
- results: BulkDataItemResultNonNullableFields[];
3718
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3719
- }
3720
- interface UnresolvedReferenceNonNullableFields {
3721
- referringItemId: string;
3722
- referringItemFieldName: string;
3723
- referencedItemId: string;
3724
- unauthorized: boolean;
3725
- }
3726
- interface ReferencedResultNonNullableFields {
3727
- dataItem?: DataItemNonNullableFields;
3728
- unresolvedReference?: UnresolvedReferenceNonNullableFields;
3729
- referringItemId: string;
3730
- }
3731
- interface QueryReferencedDataItemsResponseNonNullableFields {
3732
- results: ReferencedResultNonNullableFields[];
3733
- }
3734
- interface IsReferencedDataItemResponseNonNullableFields {
3735
- isReferenced: boolean;
3736
- }
3737
- interface DataItemReferenceNonNullableFields {
3738
- referringItemFieldName: string;
3739
- referringItemId: string;
3740
- referencedItemId: string;
3741
- }
3742
- interface InsertDataItemReferenceResponseNonNullableFields {
3743
- dataItemReference?: DataItemReferenceNonNullableFields;
3744
- }
3745
- interface RemoveDataItemReferenceResponseNonNullableFields {
3746
- dataItemReference?: DataItemReferenceNonNullableFields;
3747
- }
3748
- interface BulkDataItemReferenceResultNonNullableFields {
3749
- action: BulkActionType;
3750
- referenceMetadata?: ItemMetadataNonNullableFields;
3751
- dataItemReference?: DataItemReferenceNonNullableFields;
3752
- }
3753
- interface BulkInsertDataItemReferencesResponseNonNullableFields {
3754
- results: BulkDataItemReferenceResultNonNullableFields[];
3755
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3756
- }
3757
- interface BulkRemoveDataItemReferencesResponseNonNullableFields {
3758
- results: BulkDataItemReferenceResultNonNullableFields[];
3759
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
3760
- }
3761
- interface ReplaceDataItemReferencesResponseNonNullableFields {
3762
- dataItemReferences: DataItemReferenceNonNullableFields[];
3763
- }
3764
- interface BaseEventMetadata {
3765
- /** App instance ID. */
3766
- instanceId?: string | null;
3767
- /** Event type. */
3768
- eventType?: string;
3769
- /** The identification type and identity data. */
3770
- identity?: IdentificationData;
3771
- }
3772
- interface EventMetadata extends BaseEventMetadata {
3773
- /**
3774
- * Unique event ID.
3775
- * Allows clients to ignore duplicate webhooks.
3776
- */
3777
- _id?: string;
3778
- /**
3779
- * Assumes actions are also always typed to an entity_type
3780
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3781
- */
3782
- entityFqdn?: string;
3783
- /**
3784
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
3785
- * This is although the created/updated/deleted notion is duplication of the oneof types
3786
- * Example: created/updated/deleted/started/completed/email_opened
3787
- */
3788
- slug?: string;
3789
- /** ID of the entity associated with the event. */
3790
- entityId?: string;
3791
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3792
- eventTime?: Date | null;
3793
- /**
3794
- * Whether the event was triggered as a result of a privacy regulation application
3795
- * (for example, GDPR).
3796
- */
3797
- triggeredByAnonymizeRequest?: boolean | null;
3798
- /** If present, indicates the action that triggered the event. */
3799
- originatedFrom?: string | null;
3800
- /**
3801
- * A sequence number defining the order of updates to the underlying entity.
3802
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
3803
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
3804
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
3805
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
3806
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3807
- */
3808
- entityEventSequence?: string | null;
3809
- }
3810
- interface DataItemCreatedEnvelope {
3811
- entity: DataItem;
3812
- metadata: EventMetadata;
3813
- }
3814
- interface DataItemDeletedEnvelope {
3815
- entity: DataItem;
3816
- metadata: EventMetadata;
3817
- }
3818
- interface DataItemUpdatedEnvelope {
3819
- entity: DataItem;
3820
- metadata: EventMetadata;
3821
- }
3822
- interface InsertDataItemOptions {
3823
- /** ID of the collection in which to insert the item. */
3824
- dataCollectionId: string;
3825
- /** Item to insert. */
3826
- dataItem: DataItem;
3827
- /**
3828
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3829
- *
3830
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3831
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3832
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3833
- */
3834
- appOptions?: Record<string, any> | null;
3835
- }
3836
- interface UpdateDataItemOptions {
3837
- /** Updated data item content. The existing data item's content is replaced entirely. */
3838
- dataItem: {
3839
- /** Data item ID. */
3840
- _id?: string;
3841
- /**
3842
- * ID of the collection this item belongs to
3843
- * @readonly
3844
- */
3845
- dataCollectionId?: string;
3846
- /**
3847
- * Data item contents.
3848
- *
3849
- * Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
3850
- *
3851
- * + `_id`: Item ID.
3852
- * + `_createdDate`: Date and time the item was added to the collection.
3853
- * + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
3854
- * + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
3855
- */
3856
- data?: Record<string, any> | null;
3857
- };
3858
- /** ID of the collection containing the existing item. */
3859
- dataCollectionId: string;
3860
- /**
3861
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3862
- *
3863
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3864
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3865
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3866
- */
3867
- appOptions?: Record<string, any> | null;
3868
- /**
3869
- * Options for the Publish plugin.
3870
- * 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.
3871
- */
3872
- publishPluginOptions?: DataPublishPluginOptions;
3873
- }
3874
- interface SaveDataItemOptions {
3875
- /** ID of the collection in which to insert or update the item. */
3876
- dataCollectionId: string;
3877
- /** Data item to insert or update. */
3878
- dataItem: DataItem;
3879
- /**
3880
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3881
- *
3882
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3883
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3884
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3885
- */
3886
- appOptions?: Record<string, any> | null;
3887
- /**
3888
- * Options for the Publish plugin.
3889
- * 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.
3890
- */
3891
- publishPluginOptions?: DataPublishPluginOptions;
3892
- }
3893
- interface GetDataItemOptions {
3894
- /** ID of the collection from which to retrieve the data item. */
3895
- dataCollectionId: string;
3896
- /**
3897
- * Whether to retrieve data from the primary database instance.
3898
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3899
- *
3900
- * Default: `false`
3901
- */
3902
- consistentRead?: boolean;
3903
- /**
3904
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3905
- * If provided, the result text is returned in the specified language.
3906
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3907
- *
3908
- * If not provided, result text is not translated.
3909
- */
3910
- language?: string | null;
3911
- /**
3912
- * Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
3913
- * **Note:** The `_id` system field is always returned.
3914
- */
3915
- fields?: string[];
3916
- /**
3917
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3918
- *
3919
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3920
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3921
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3922
- */
3923
- appOptions?: Record<string, any> | null;
3924
- /**
3925
- * Options for the Publish plugin.
3926
- * 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.
3927
- */
3928
- publishPluginOptions?: DataPublishPluginOptions;
3929
- }
3930
- interface RemoveDataItemOptions {
3931
- /** ID of the collection from which to remove the item. */
3932
- dataCollectionId: string;
3933
- /**
3934
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3935
- *
3936
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3937
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3938
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3939
- */
3940
- appOptions?: Record<string, any> | null;
3941
- /**
3942
- * Options for the Publish plugin.
3943
- * 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.
3944
- */
3945
- publishPluginOptions?: DataPublishPluginOptions;
3946
- }
3947
- interface TruncateDataItemsOptions {
3948
- /** ID of the collection to truncate. */
3949
- dataCollectionId: string;
3950
- }
3951
- interface QueryDataItemsOptions {
3952
- /** ID of the collection to query. */
3953
- dataCollectionId: string;
3954
- /**
3955
- * Whether to return the total count in the response for a query with offset paging.
3956
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
3957
- *
3958
- * Default: `false`
3959
- */
3960
- returnTotalCount?: boolean | undefined;
3961
- /**
3962
- * Properties for which to include referenced items in the query's results.
3963
- * Up to 50 referenced items can be included for each item that matches the query.
3964
- * @deprecated
3965
- * @replacedBy referenced_item_options
3966
- * @targetRemovalDate 2025-08-01
3967
- */
3968
- includeReferencedItems?: string[] | undefined;
3969
- /**
3970
- * Whether to retrieve data from the primary database instance.
3971
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
3972
- *
3973
- * Default: `false`
3974
- */
3975
- consistentRead?: boolean | undefined;
3976
- /**
3977
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3978
- * If provided, the result text is returned in the specified language.
3979
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
3980
- *
3981
- * If not provided, result text is not translated.
3982
- */
3983
- language?: string | null | undefined;
3984
- /**
3985
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
3986
- *
3987
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
3988
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
3989
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
3990
- */
3991
- appOptions?: Record<string, any> | null | undefined;
3992
- /**
3993
- * Options for the Publish plugin.
3994
- * 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.
3995
- */
3996
- publishPluginOptions?: DataPublishPluginOptions | undefined;
3997
- /** Options for retrieving referenced items. */
3998
- referencedItemOptions?: ReferencedItemOptions[] | undefined;
3999
- }
4000
- interface QueryOffsetResult {
4001
- currentPage: number | undefined;
4002
- totalPages: number | undefined;
4003
- totalCount: number | undefined;
4004
- hasNext: () => boolean;
4005
- hasPrev: () => boolean;
4006
- length: number;
4007
- pageSize: number;
4008
- }
4009
- interface DataItemsQueryResult extends QueryOffsetResult {
4010
- items: DataItem[];
4011
- query: DataItemsQueryBuilder;
4012
- next: () => Promise<DataItemsQueryResult>;
4013
- prev: () => Promise<DataItemsQueryResult>;
4014
- }
4015
- interface DataItemsQueryBuilder {
4016
- /** @param propertyName - Property whose value is compared with `value`.
4017
- * @param value - Value to compare against.
4018
- * @documentationMaturity preview
4019
- */
4020
- eq: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
4021
- /** @param propertyName - Property whose value is compared with `value`.
4022
- * @param value - Value to compare against.
4023
- * @documentationMaturity preview
4024
- */
4025
- ne: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
4026
- /** @param propertyName - Property whose value is compared with `string`.
4027
- * @param string - String to compare against. Case-insensitive.
4028
- * @documentationMaturity preview
4029
- */
4030
- startsWith: (propertyName: '_id' | 'dataCollectionId' | string, value: string) => DataItemsQueryBuilder;
4031
- /** @documentationMaturity preview */
4032
- in: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: any) => DataItemsQueryBuilder;
4033
- /** @documentationMaturity preview */
4034
- exists: (propertyName: '_id' | 'dataCollectionId' | 'data' | string, value: boolean) => DataItemsQueryBuilder;
4035
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4036
- * @documentationMaturity preview
4037
- */
4038
- ascending: (...propertyNames: Array<'_id' | 'dataCollectionId' | 'data' | string>) => DataItemsQueryBuilder;
4039
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
4040
- * @documentationMaturity preview
4041
- */
4042
- descending: (...propertyNames: Array<'_id' | 'dataCollectionId' | 'data' | string>) => DataItemsQueryBuilder;
4043
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
4044
- * @documentationMaturity preview
4045
- */
4046
- limit: (limit: number) => DataItemsQueryBuilder;
4047
- /** @param skip - Number of items to skip in the query results before returning the results.
4048
- * @documentationMaturity preview
4049
- */
4050
- skip: (skip: number) => DataItemsQueryBuilder;
4051
- /** @documentationMaturity preview */
4052
- find: () => Promise<DataItemsQueryResult>;
4053
- }
4054
- interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
4055
- /** ID of the collection on which to run the aggregation. */
4056
- dataCollectionId: string;
4057
- /**
4058
- * Filter applied to the collection's data prior to running the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
4059
- *
4060
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
4061
- */
4062
- initialFilter?: Record<string, any> | null;
4063
- /** Aggregation applied to the data. */
4064
- aggregation?: Aggregation;
4065
- /**
4066
- * Filter applied to the processed data following the aggregation. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
4067
- * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
4068
- */
4069
- finalFilter?: Record<string, any> | null;
4070
- /** Paging options to limit and skip the number of items. */
4071
- paging?: Paging$1;
4072
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
4073
- cursorPaging?: CursorPaging;
4074
- /**
4075
- * Sort object in the following format:
4076
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
4077
- */
4078
- sort?: Sorting[];
4079
- /**
4080
- * Whether to return the total count in the response for a query with offset paging.
4081
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
4082
- *
4083
- * Default: `false`
4084
- */
4085
- returnTotalCount?: boolean;
4086
- /**
4087
- * Whether to retrieve data from the primary database instance.
4088
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4089
- *
4090
- * Default: `false`
4091
- */
4092
- consistentRead?: boolean;
4093
- /**
4094
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4095
- * If provided, the result text is returned in the specified language.
4096
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
4097
- *
4098
- * If not provided, result text is not translated.
4099
- */
4100
- language?: string | null;
4101
- /**
4102
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4103
- *
4104
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4105
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4106
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4107
- */
4108
- appOptions?: Record<string, any> | null;
4109
- /**
4110
- * Options for the Publish plugin.
4111
- * 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.
4112
- */
4113
- publishPluginOptions?: DataPublishPluginOptions;
4114
- }
4115
- interface CountDataItemsOptions {
4116
- /** ID of the collection for which to count query results. */
4117
- dataCollectionId: string;
4118
- /**
4119
- * Filter object in the following format:
4120
- *
4121
- * `"filter" : {
4122
- * "fieldName1": "value1",
4123
- * "fieldName2":{"$operator":"value2"}
4124
- * }`.
4125
- *
4126
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4127
- *
4128
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
4129
- */
4130
- filter?: Record<string, any> | null;
4131
- /**
4132
- * Whether to retrieve data from the primary database instance.
4133
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4134
- *
4135
- * Default: `false`
4136
- */
4137
- consistentRead?: boolean;
4138
- /**
4139
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4140
- * If provided, the result text is returned in the specified language.
4141
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
4142
- *
4143
- * If not provided, result text is not translated.
4144
- */
4145
- language?: string | null;
4146
- /**
4147
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4148
- *
4149
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4150
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4151
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4152
- */
4153
- appOptions?: Record<string, any> | null;
4154
- /**
4155
- * Options for the Publish plugin.
4156
- * 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.
4157
- */
4158
- publishPluginOptions?: DataPublishPluginOptions;
4159
- }
4160
- interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
4161
- /** ID of the collection to query. */
4162
- dataCollectionId: string;
4163
- /** Item field name for which to return all distinct values. */
4164
- fieldName?: string;
4165
- /**
4166
- * Filter object in the following format:
4167
- *
4168
- * `"filter" : {
4169
- * "fieldName1": "value1",
4170
- * "fieldName2":{"$operator":"value2"}
4171
- * }`.
4172
- *
4173
- * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
4174
- *
4175
- * **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
4176
- */
4177
- filter?: Record<string, any> | null;
4178
- /**
4179
- * Sort order.
4180
- *
4181
- * Supported values: `ASC`, `DESC`.
4182
- */
4183
- order?: SortOrder;
4184
- /** Paging options to limit and skip the number of items. */
4185
- paging?: Paging$1;
4186
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
4187
- cursorPaging?: CursorPaging;
4188
- /**
4189
- * Whether to return the total count in the response for a query with offset paging.
4190
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
4191
- *
4192
- * Default: `false`
4193
- */
4194
- returnTotalCount?: boolean;
4195
- /**
4196
- * Whether to retrieve data from the primary database instance.
4197
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4198
- *
4199
- * Default: `false`
4200
- */
4201
- consistentRead?: boolean;
4202
- /**
4203
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4204
- * If provided, the result text is returned in the specified language.
4205
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
4206
- *
4207
- * If not provided, result text is not translated.
4208
- */
4209
- language?: string | null;
4210
- /**
4211
- * Options for the Publish plugin.
4212
- * 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.
4213
- */
4214
- publishPluginOptions?: DataPublishPluginOptions;
4215
- }
4216
- interface BulkInsertDataItemsOptions {
4217
- /** ID of the collection in which to insert the items. */
4218
- dataCollectionId: string;
4219
- /** Data items to insert. */
4220
- dataItems: DataItem[];
4221
- /**
4222
- * Whether to return the inserted data items.
4223
- * When `true`, the `results` objects contain a `dataItem` field.
4224
- *
4225
- * Default: `false`
4226
- */
4227
- returnEntity?: boolean;
4228
- /**
4229
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4230
- *
4231
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4232
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4233
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4234
- */
4235
- appOptions?: Record<string, any> | null;
4236
- }
4237
- interface BulkUpdateDataItemsOptions {
4238
- /** ID of the collection in which to update items. */
4239
- dataCollectionId: string;
4240
- /** Data items to update. */
4241
- dataItems: DataItem[];
4242
- /**
4243
- * Whether to return the updated data items.
4244
- * When `true`, the `results` objects contain a `dataItem` field.
4245
- *
4246
- * Default: `false`
4247
- */
4248
- returnEntity?: boolean;
4249
- /**
4250
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4251
- *
4252
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4253
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4254
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4255
- */
4256
- appOptions?: Record<string, any> | null;
4257
- /**
4258
- * Options for the Publish plugin.
4259
- * 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.
4260
- */
4261
- publishPluginOptions?: DataPublishPluginOptions;
4262
- }
4263
- interface BulkSaveDataItemsOptions {
4264
- /** ID of the collection in which to insert or update the items. */
4265
- dataCollectionId: string;
4266
- /** Data items to insert or update. */
4267
- dataItems: DataItem[];
4268
- /**
4269
- * Whether to return the saved data item.
4270
- * When `true`, the `results` objects contain a `dataItem` field.
4271
- *
4272
- * Default: `false`
4273
- */
4274
- returnEntity?: boolean;
4275
- /**
4276
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4277
- *
4278
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4279
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4280
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4281
- */
4282
- appOptions?: Record<string, any> | null;
4283
- /**
4284
- * Options for the Publish plugin.
4285
- * 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.
4286
- */
4287
- publishPluginOptions?: DataPublishPluginOptions;
4288
- }
4289
- interface BulkRemoveDataItemsOptions {
4290
- /** ID of the collection from which to remove the item. */
4291
- dataCollectionId: string;
4292
- /** IDs of data items to remove. */
4293
- dataItemIds: string[];
4294
- /**
4295
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4296
- *
4297
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4298
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4299
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4300
- */
4301
- appOptions?: Record<string, any> | null;
4302
- /**
4303
- * Options for the Publish plugin.
4304
- * 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.
4305
- */
4306
- publishPluginOptions?: DataPublishPluginOptions;
4307
- }
4308
- interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
4309
- /** ID of the collection containing the referring item. */
4310
- dataCollectionId: string;
4311
- /** ID of the referring item. */
4312
- referringItemId?: string;
4313
- /** Field containing references in the referring item. */
4314
- referringItemFieldName?: string;
4315
- /** Order of the returned referenced items. Sorted by the date each item was referenced. */
4316
- order?: SortOrder;
4317
- /** Paging options to limit and skip the number of items. */
4318
- paging?: Paging$1;
4319
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
4320
- cursorPaging?: CursorPaging;
4321
- /**
4322
- * Whether to return the total count in the response.
4323
- * When `true`, the `pagingMetadata` object in the response contains a `total` field.
4324
- *
4325
- * Default: `false`
4326
- */
4327
- returnTotalCount?: boolean;
4328
- /**
4329
- * Whether to retrieve data from the primary database instance.
4330
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4331
- *
4332
- * Default: `false`
4333
- */
4334
- consistentRead?: boolean;
4335
- /**
4336
- * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4337
- * If provided, the result text is returned in the specified language.
4338
- * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
4339
- *
4340
- * If not provided, result text is not translated.
4341
- */
4342
- language?: string | null;
4343
- /**
4344
- * Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
4345
- * **Note:** The `_id` system field is always returned.
4346
- */
4347
- fields?: string[];
4348
- /**
4349
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
4350
- *
4351
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4352
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4353
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4354
- */
4355
- appOptions?: Record<string, any> | null;
4356
- /**
4357
- * Options for the Publish plugin.
4358
- * 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.
4359
- */
4360
- publishPluginOptions?: DataPublishPluginOptions;
4361
- }
4362
- interface IsReferencedDataItemOptions {
4363
- /** ID of the collection containing the referring data item. */
4364
- dataCollectionId: string;
4365
- /** Field to check for a reference to the item that may be referenced. */
4366
- referringItemFieldName: string;
4367
- /** ID of the referring item. */
4368
- referringItemId: string;
4369
- /** ID of the item that may be referenced. */
4370
- referencedItemId: string;
4371
- /**
4372
- * Whether to retrieve data from the primary database instance.
4373
- * This decreases performance but ensures data retrieved is up to date even immediately after an update.
4374
- *
4375
- * Default: `false`
4376
- */
4377
- consistentRead?: boolean;
4378
- }
4379
- interface InsertDataItemReferenceOptions {
4380
- /** ID of the collection in which to insert the reference. */
4381
- dataCollectionId: string;
4382
- /** Reference to insert */
4383
- dataItemReference?: DataItemReference;
4384
- /**
4385
- * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
4386
- *
4387
- * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
4388
- * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
4389
- * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
4390
- */
4391
- appOptions?: Record<string, any> | null;
4392
- }
4393
- interface RemoveDataItemReferenceOptions {
4394
- /** ID of the collection containing the referring item. */
4395
- dataCollectionId: string;
4396
- /** Reference to remove. */
4397
- dataItemReference: DataItemReference;
4398
- }
4399
- interface BulkInsertDataItemReferencesOptions {
4400
- /** ID of the collection containing the referring items. */
4401
- dataCollectionId: string;
4402
- /** References to insert. */
4403
- dataItemReferences: DataItemReference[];
4404
- /**
4405
- * Whether to return the inserted data item references.
4406
- * When `true`, the `results` objects contain a `dataItemReference` field.
4407
- *
4408
- * Default: `false`
4409
- */
4410
- returnEntity?: boolean;
4411
- }
4412
- interface BulkRemoveDataItemReferencesOptions {
4413
- /** ID of the collection containing the referring items. */
4414
- dataCollectionId: string;
4415
- /** References to remove. */
4416
- dataItemReferences: DataItemReference[];
4417
- }
4418
- interface ReplaceDataItemReferencesOptions {
4419
- /** ID of the collection containing the referring item. */
4420
- dataCollectionId: string;
4421
- /** Field containing references in the referring item. */
4422
- referringItemFieldName: string;
4423
- /** ID of the referring item. */
4424
- referringItemId: string;
4425
- /** List of new referenced item IDs to replace the existing ones. */
4426
- newReferencedItemIds?: string[];
4427
- }
4428
-
4429
- declare function insertDataItem$1(httpClient: HttpClient): InsertDataItemSignature;
4430
- interface InsertDataItemSignature {
4431
- /**
4432
- * Adds an item to a collection.
4433
- *
4434
- *
4435
- * An item can only be inserted into an existing connection.
4436
- * You can create a new collection using the Data Collections API.
4437
- *
4438
- * When an item is inserted into a collection, the item's ID is automatically assigned a random value.
4439
- * You can optionally provide a custom ID in `dataItem.id` when inserting the item.
4440
- * If you specify an ID that already exists in the collection, the insertion will fail.
4441
- *
4442
- * If `options.dataItem.data` is empty, a new item is created with no data fields.
4443
- * @param - Options for adding an item to a collection.
4444
- */
4445
- (options?: InsertDataItemOptions | undefined): Promise<InsertDataItemResponse & InsertDataItemResponseNonNullableFields>;
4446
- }
4447
- declare function updateDataItem$1(httpClient: HttpClient): UpdateDataItemSignature;
4448
- interface UpdateDataItemSignature {
4449
- /**
4450
- * Updates an item in a collection.
4451
- *
4452
- *
4453
- * This function replaces the data item's existing data with the payload provided in `options.dataItem.data` in the request.
4454
- *
4455
- * To update an item, you need to specify an item ID and a collection ID.
4456
- * If an item is found in the specified collection with the specified ID, that item is updated.
4457
- * If the collection doesn't contain an item with that ID, the request fails.
4458
- *
4459
- * When an item is updated, its `data._updatedDate` field is changed to the current date and time.
4460
- *
4461
- * > **Note:**
4462
- * > After an item is updated, it only contains the fields included in the `options.dataItem.data` payload in the `updateDataItem()` call.
4463
- * > If the existing item has fields with values and those fields aren't included in the updated item, their values are lost.
4464
- * @param - Data item ID.
4465
- * @param - Options for updating an item in a collection.
4466
- */
4467
- (_id: string, options?: UpdateDataItemOptions | undefined): Promise<UpdateDataItemResponse & UpdateDataItemResponseNonNullableFields>;
4468
- }
4469
- declare function saveDataItem$1(httpClient: HttpClient): SaveDataItemSignature;
4470
- interface SaveDataItemSignature {
4471
- /**
4472
- * Inserts or updates an item in a collection.
4473
- *
4474
- *
4475
- * The `saveDataItem()` function inserts or updates the specified item, depending on whether it already exists in the collection.
4476
- *
4477
- * + If you don't provide an ID, a new item is created.
4478
- *
4479
- * + If you provide an ID that does not exist in the collection, a new item is created with that ID.
4480
- *
4481
- * + 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.
4482
- *
4483
- * > **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.
4484
- * > This means that the item's previous fields and values are lost.
4485
- * @param - Options for saving an item in a collection.
4486
- */
4487
- (options?: SaveDataItemOptions | undefined): Promise<SaveDataItemResponse & SaveDataItemResponseNonNullableFields>;
4488
- }
4489
- declare function getDataItem$1(httpClient: HttpClient): GetDataItemSignature;
4490
- interface GetDataItemSignature {
4491
- /**
4492
- * Retrieves an item from a collection.
4493
- *
4494
- *
4495
- * > **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`.
4496
- * @param - ID of the data item to retrieve.
4497
- * @param - Options for retrieving an item from a collection.
4498
- * @returns Retrieved item.
4499
- */
4500
- (dataItemId: string, options?: GetDataItemOptions | undefined): Promise<DataItem & DataItemNonNullableFields>;
4501
- }
4502
- declare function removeDataItem$1(httpClient: HttpClient): RemoveDataItemSignature;
4503
- interface RemoveDataItemSignature {
4504
- /**
4505
- * Removes an item from a collection.
4506
- *
4507
- *
4508
- * If any items in other collections reference the removed item in reference or multi-reference fields, those fields are cleared.
4509
- *
4510
- * > **Note:**
4511
- * > Once an item has been removed from a collection, it can't be restored.
4512
- * @param - ID of the item to remove.
4513
- * @param - Options for removing an item from a collection.
4514
- */
4515
- (dataItemId: string, options?: RemoveDataItemOptions | undefined): Promise<RemoveDataItemResponse & RemoveDataItemResponseNonNullableFields>;
4516
- }
4517
- declare function truncateDataItems$1(httpClient: HttpClient): TruncateDataItemsSignature;
4518
- interface TruncateDataItemsSignature {
4519
- /**
4520
- * Removes all items from a collection.
4521
- *
4522
- *
4523
- * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.
4524
- *
4525
- * > **Note:**
4526
- * > Once items have been removed from a collection, they can't be restored.
4527
- * @param - Options for truncating data items from a collection.
4528
- */
4529
- (options: TruncateDataItemsOptions): Promise<void>;
4530
- }
4531
- declare function queryDataItems$1(httpClient: HttpClient): QueryDataItemsSignature;
4532
- interface QueryDataItemsSignature {
4533
- /**
4534
- * Creates a query to retrieve items from a database collection.
4535
- *
4536
- * The `queryDataItems()` function builds a query to retrieve data items from a collection and returns a `DataItemsQueryBuilder` object.
4537
- *
4538
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
4539
- *
4540
- * 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.
4541
- *
4542
- * The `queryDataItems()` function runs with the following `DataItemsQueryBuilder` defaults that you can override:
4543
- *
4544
- * + `skip`: 0
4545
- * + `limit`: 50
4546
- * + `descending`: by `_createdDate`
4547
- *
4548
- * 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.
4549
- *
4550
- * 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.
4551
- *
4552
- * > **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`.
4553
- *
4554
- *
4555
- * @param - Options for querying data items.
4556
- */
4557
- (options: QueryDataItemsOptions): DataItemsQueryBuilder;
4558
- }
4559
- declare function aggregateDataItems$1(httpClient: HttpClient): AggregateDataItemsSignature;
4560
- interface AggregateDataItemsSignature {
4561
- /**
4562
- * Runs an aggregation on a data collection and returns the resulting list of items.
4563
- *
4564
- *
4565
- * An aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries.
4566
- * You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.
4567
- * @param - Options for running an aggregation.
4568
- */
4569
- (options?: AggregateDataItemsOptions | undefined): Promise<AggregateDataItemsResponse>;
4570
- }
4571
- declare function countDataItems$1(httpClient: HttpClient): CountDataItemsSignature;
4572
- interface CountDataItemsSignature {
4573
- /**
4574
- * Counts the number of items in a data collection that match the provided filtering preferences.
4575
- *
4576
- * > **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`.
4577
- * @param - Options for counting the number of items in a data collection.
4578
- */
4579
- (options?: CountDataItemsOptions | undefined): Promise<CountDataItemsResponse & CountDataItemsResponseNonNullableFields>;
4580
- }
4581
- declare function queryDistinctValues$1(httpClient: HttpClient): QueryDistinctValuesSignature;
4582
- interface QueryDistinctValuesSignature {
4583
- /**
4584
- * Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.
4585
- *
4586
- *
4587
- * As with `queryDataItems()`, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.
4588
- * However, `queryDistinctValues()` doesn't return all of the full items that match the query.
4589
- * Rather, it returns all unique values of the field you specify in `options.fieldName` for items that match the query.
4590
- * If more than one item has the same value for that field, that value appears only once.
4591
- *
4592
- * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
4593
- *
4594
- * > **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`.
4595
- * @param - Options for querying distinct values.
4596
- */
4597
- (options?: QueryDistinctValuesOptions | undefined): Promise<QueryDistinctValuesResponse>;
4598
- }
4599
- declare function bulkInsertDataItems$1(httpClient: HttpClient): BulkInsertDataItemsSignature;
4600
- interface BulkInsertDataItemsSignature {
4601
- /**
4602
- * Adds multiple items to a collection.
4603
- *
4604
- *
4605
- * When each item is inserted into a collection, its ID is automatically assigned a random value.
4606
- * 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.
4607
- * @param - Options for adding multiple items to a collection.
4608
- */
4609
- (options?: BulkInsertDataItemsOptions | undefined): Promise<BulkInsertDataItemsResponse & BulkInsertDataItemsResponseNonNullableFields>;
4610
- }
4611
- declare function bulkUpdateDataItems$1(httpClient: HttpClient): BulkUpdateDataItemsSignature;
4612
- interface BulkUpdateDataItemsSignature {
4613
- /**
4614
- * Updates multiple items in a collection.
4615
- *
4616
- *
4617
- * This function replaces each specified data item's existing data with the payload provided in the request.
4618
- *
4619
- * Each item in the request must include an ID. If an item is found in the specified collection with
4620
- * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.
4621
- *
4622
- * When an item is updated, its `data._updatedDate` field is changed to the current date and time.
4623
- *
4624
- * > **Note:**
4625
- * > 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
4626
- * > aren't included in the updated item, their values are lost.
4627
- * @param - Options for updating multiple items in a collection.
4628
- */
4629
- (options?: BulkUpdateDataItemsOptions | undefined): Promise<BulkUpdateDataItemsResponse & BulkUpdateDataItemsResponseNonNullableFields>;
4630
- }
4631
- declare function bulkSaveDataItems$1(httpClient: HttpClient): BulkSaveDataItemsSignature;
4632
- interface BulkSaveDataItemsSignature {
4633
- /**
4634
- * Inserts or updates multiple items in a collection.
4635
- *
4636
- *
4637
- * This function inserts or updates each item provided, depending on whether it already exists in the collection. For each item:
4638
- *
4639
- * + If you don't provide an ID, a new item is created.
4640
- *
4641
- * + If you provide an ID that doesn't exist in the collection, a new item is created with that ID.
4642
- *
4643
- * + 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.
4644
- *
4645
- * > **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.
4646
- * > This means that all of the item's previous fields and values are lost.
4647
- * @param - Options for saving multiple items in a collection.
4648
- */
4649
- (options?: BulkSaveDataItemsOptions | undefined): Promise<BulkSaveDataItemsResponse & BulkSaveDataItemsResponseNonNullableFields>;
4650
- }
4651
- declare function bulkRemoveDataItems$1(httpClient: HttpClient): BulkRemoveDataItemsSignature;
4652
- interface BulkRemoveDataItemsSignature {
4653
- /**
4654
- * Removes multiple items from a collection.
4655
- *
4656
- *
4657
- * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.
4658
- *
4659
- * > **Note:** Once an item has been removed from a collection, it can't be restored.
4660
- * @param - Options for removing multiple items from a collection.
4661
- */
4662
- (options?: BulkRemoveDataItemsOptions | undefined): Promise<BulkRemoveDataItemsResponse & BulkRemoveDataItemsResponseNonNullableFields>;
4663
- }
4664
- declare function queryReferencedDataItems$1(httpClient: HttpClient): QueryReferencedDataItemsSignature;
4665
- interface QueryReferencedDataItemsSignature {
4666
- /**
4667
- * Retrieves the full items referenced in the specified field of an item.
4668
- *
4669
- *
4670
- * Reference and multi-reference fields refer to items in different collections.
4671
- * Use this function to retrieve the full details of the referenced items themselves.
4672
- *
4673
- * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.
4674
- * Querying the **Movies** collection using `queryReferencedDataItems()` returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.
4675
- * This gives you information from the **People** collection about each of the actors in the specified movie.
4676
- *
4677
- * > **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`.
4678
- * @param - Options for querying referenced data items.
4679
- */
4680
- (options?: QueryReferencedDataItemsOptions | undefined): Promise<QueryReferencedDataItemsResponse & QueryReferencedDataItemsResponseNonNullableFields>;
4681
- }
4682
- declare function isReferencedDataItem$1(httpClient: HttpClient): IsReferencedDataItemSignature;
4683
- interface IsReferencedDataItemSignature {
4684
- /**
4685
- * Checks whether a field in a referring item contains a reference to a specified item.
4686
- *
4687
- * > **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`.
4688
- * @param - Options for checking whether a field contains a reference to an item.
4689
- */
4690
- (options?: IsReferencedDataItemOptions | undefined): Promise<IsReferencedDataItemResponse & IsReferencedDataItemResponseNonNullableFields>;
4691
- }
4692
- declare function insertDataItemReference$1(httpClient: HttpClient): InsertDataItemReferenceSignature;
4693
- interface InsertDataItemReferenceSignature {
4694
- /**
4695
- * Inserts a reference in the specified field in an item in a collection.
4696
- *
4697
- *
4698
- * 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.
4699
- * @param - Options for inserting a reference.
4700
- */
4701
- (options?: InsertDataItemReferenceOptions | undefined): Promise<InsertDataItemReferenceResponse & InsertDataItemReferenceResponseNonNullableFields>;
4702
- }
4703
- declare function removeDataItemReference$1(httpClient: HttpClient): RemoveDataItemReferenceSignature;
4704
- interface RemoveDataItemReferenceSignature {
4705
- /**
4706
- * Removes the specified reference from the specified field.
4707
- * @param - Options for removing a reference.
4708
- */
4709
- (options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse & RemoveDataItemReferenceResponseNonNullableFields>;
4710
- }
4711
- declare function bulkInsertDataItemReferences$1(httpClient: HttpClient): BulkInsertDataItemReferencesSignature;
4712
- interface BulkInsertDataItemReferencesSignature {
4713
- /**
4714
- * Inserts one or more references in the specified fields of items in a collection.
4715
- *
4716
- *
4717
- * This endpoint adds one or more references to a collection.
4718
- * 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.
4719
- * @param - Options for inserting one or more references.
4720
- */
4721
- (options?: BulkInsertDataItemReferencesOptions | undefined): Promise<BulkInsertDataItemReferencesResponse & BulkInsertDataItemReferencesResponseNonNullableFields>;
4722
- }
4723
- declare function bulkRemoveDataItemReferences$1(httpClient: HttpClient): BulkRemoveDataItemReferencesSignature;
4724
- interface BulkRemoveDataItemReferencesSignature {
4725
- /**
4726
- * Removes one or more references.
4727
- * @param - Options for removing one or more references.
4728
- */
4729
- (options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse & BulkRemoveDataItemReferencesResponseNonNullableFields>;
4730
- }
4731
- declare function replaceDataItemReferences$1(httpClient: HttpClient): ReplaceDataItemReferencesSignature;
4732
- interface ReplaceDataItemReferencesSignature {
4733
- /**
4734
- * Replaces references in a specified field of a specified data item.
4735
- *
4736
- *
4737
- * This function replaces the existing reference or references contained in the field specified in `options.referringItemFieldName` within the data item specified in `options.referringItemId`.
4738
- * The function removes existing references and in their place it adds references to the items specified in `options.newReferencedItemIds`.
4739
- *
4740
- * > **Note:** If you pass an empty array in `options.newReferencedItemIds`, all existing references are removed.
4741
- * @param - Options for replacing references.
4742
- */
4743
- (options?: ReplaceDataItemReferencesOptions | undefined): Promise<ReplaceDataItemReferencesResponse & ReplaceDataItemReferencesResponseNonNullableFields>;
4744
- }
4745
- declare const onDataItemCreated$1: EventDefinition<DataItemCreatedEnvelope, "wix.data.v2.data_item_created">;
4746
- declare const onDataItemDeleted$1: EventDefinition<DataItemDeletedEnvelope, "wix.data.v2.data_item_deleted">;
4747
- declare const onDataItemUpdated$1: EventDefinition<DataItemUpdatedEnvelope, "wix.data.v2.data_item_updated">;
4748
-
4749
- declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
4750
-
4751
- declare const insertDataItem: MaybeContext<BuildRESTFunction<typeof insertDataItem$1> & typeof insertDataItem$1>;
4752
- declare const updateDataItem: MaybeContext<BuildRESTFunction<typeof updateDataItem$1> & typeof updateDataItem$1>;
4753
- declare const saveDataItem: MaybeContext<BuildRESTFunction<typeof saveDataItem$1> & typeof saveDataItem$1>;
4754
- declare const getDataItem: MaybeContext<BuildRESTFunction<typeof getDataItem$1> & typeof getDataItem$1>;
4755
- declare const removeDataItem: MaybeContext<BuildRESTFunction<typeof removeDataItem$1> & typeof removeDataItem$1>;
4756
- declare const truncateDataItems: MaybeContext<BuildRESTFunction<typeof truncateDataItems$1> & typeof truncateDataItems$1>;
4757
- declare const queryDataItems: MaybeContext<BuildRESTFunction<typeof queryDataItems$1> & typeof queryDataItems$1>;
4758
- declare const aggregateDataItems: MaybeContext<BuildRESTFunction<typeof aggregateDataItems$1> & typeof aggregateDataItems$1>;
4759
- declare const countDataItems: MaybeContext<BuildRESTFunction<typeof countDataItems$1> & typeof countDataItems$1>;
4760
- declare const queryDistinctValues: MaybeContext<BuildRESTFunction<typeof queryDistinctValues$1> & typeof queryDistinctValues$1>;
4761
- declare const bulkInsertDataItems: MaybeContext<BuildRESTFunction<typeof bulkInsertDataItems$1> & typeof bulkInsertDataItems$1>;
4762
- declare const bulkUpdateDataItems: MaybeContext<BuildRESTFunction<typeof bulkUpdateDataItems$1> & typeof bulkUpdateDataItems$1>;
4763
- declare const bulkSaveDataItems: MaybeContext<BuildRESTFunction<typeof bulkSaveDataItems$1> & typeof bulkSaveDataItems$1>;
4764
- declare const bulkRemoveDataItems: MaybeContext<BuildRESTFunction<typeof bulkRemoveDataItems$1> & typeof bulkRemoveDataItems$1>;
4765
- declare const queryReferencedDataItems: MaybeContext<BuildRESTFunction<typeof queryReferencedDataItems$1> & typeof queryReferencedDataItems$1>;
4766
- declare const isReferencedDataItem: MaybeContext<BuildRESTFunction<typeof isReferencedDataItem$1> & typeof isReferencedDataItem$1>;
4767
- declare const insertDataItemReference: MaybeContext<BuildRESTFunction<typeof insertDataItemReference$1> & typeof insertDataItemReference$1>;
4768
- declare const removeDataItemReference: MaybeContext<BuildRESTFunction<typeof removeDataItemReference$1> & typeof removeDataItemReference$1>;
4769
- declare const bulkInsertDataItemReferences: MaybeContext<BuildRESTFunction<typeof bulkInsertDataItemReferences$1> & typeof bulkInsertDataItemReferences$1>;
4770
- declare const bulkRemoveDataItemReferences: MaybeContext<BuildRESTFunction<typeof bulkRemoveDataItemReferences$1> & typeof bulkRemoveDataItemReferences$1>;
4771
- declare const replaceDataItemReferences: MaybeContext<BuildRESTFunction<typeof replaceDataItemReferences$1> & typeof replaceDataItemReferences$1>;
4772
-
4773
- type _publicOnDataItemCreatedType = typeof onDataItemCreated$1;
4774
- /**
4775
- * Triggered when a data item is inserted.
4776
- */
4777
- declare const onDataItemCreated: ReturnType<typeof createEventModule<_publicOnDataItemCreatedType>>;
4778
-
4779
- type _publicOnDataItemDeletedType = typeof onDataItemDeleted$1;
4780
- /**
4781
- * Triggered when a data item is deleted.
4782
- */
4783
- declare const onDataItemDeleted: ReturnType<typeof createEventModule<_publicOnDataItemDeletedType>>;
4784
-
4785
- type _publicOnDataItemUpdatedType = typeof onDataItemUpdated$1;
4786
- /**
4787
- * Triggered when a data item is updated.
4788
- *
4789
- * **Note**: When [scheduling an item's visibility change](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection#scheduling-changes-to-item-visibility), the event is triggered when the scheduled change is set up, not when it goes into effect.
4790
- */
4791
- declare const onDataItemUpdated: ReturnType<typeof createEventModule<_publicOnDataItemUpdatedType>>;
4792
-
4793
- type context$1_ACTION = ACTION;
4794
- declare const context$1_ACTION: typeof ACTION;
4795
- type context$1_Action = Action;
4796
- declare const context$1_Action: typeof Action;
2370
+ type context$1_AccessLevel = AccessLevel;
2371
+ declare const context$1_AccessLevel: typeof AccessLevel;
4797
2372
  type context$1_ActionEvent = ActionEvent;
4798
- type context$1_AggregateDataItemsOptions = AggregateDataItemsOptions;
4799
- type context$1_AggregateDataItemsRequest = AggregateDataItemsRequest;
4800
- type context$1_AggregateDataItemsRequestPagingMethodOneOf = AggregateDataItemsRequestPagingMethodOneOf;
4801
- type context$1_AggregateDataItemsResponse = AggregateDataItemsResponse;
4802
- type context$1_Aggregation = Aggregation;
4803
- type context$1_AppendToArray = AppendToArray;
4804
- type context$1_ApplicationError = ApplicationError;
4805
- type context$1_Average = Average;
4806
- type context$1_BaseEventMetadata = BaseEventMetadata;
4807
- type context$1_BulkActionMetadata = BulkActionMetadata;
4808
- type context$1_BulkActionType = BulkActionType;
4809
- declare const context$1_BulkActionType: typeof BulkActionType;
4810
- type context$1_BulkDataItemReferenceResult = BulkDataItemReferenceResult;
4811
- type context$1_BulkDataItemResult = BulkDataItemResult;
4812
- type context$1_BulkInsertDataItemReferencesOptions = BulkInsertDataItemReferencesOptions;
4813
- type context$1_BulkInsertDataItemReferencesRequest = BulkInsertDataItemReferencesRequest;
4814
- type context$1_BulkInsertDataItemReferencesResponse = BulkInsertDataItemReferencesResponse;
4815
- type context$1_BulkInsertDataItemReferencesResponseNonNullableFields = BulkInsertDataItemReferencesResponseNonNullableFields;
4816
- type context$1_BulkInsertDataItemsOptions = BulkInsertDataItemsOptions;
4817
- type context$1_BulkInsertDataItemsRequest = BulkInsertDataItemsRequest;
4818
- type context$1_BulkInsertDataItemsResponse = BulkInsertDataItemsResponse;
4819
- type context$1_BulkInsertDataItemsResponseNonNullableFields = BulkInsertDataItemsResponseNonNullableFields;
4820
- type context$1_BulkPatchDataItemsRequest = BulkPatchDataItemsRequest;
4821
- type context$1_BulkPatchDataItemsResponse = BulkPatchDataItemsResponse;
4822
- type context$1_BulkRemoveDataItemReferencesOptions = BulkRemoveDataItemReferencesOptions;
4823
- type context$1_BulkRemoveDataItemReferencesRequest = BulkRemoveDataItemReferencesRequest;
4824
- type context$1_BulkRemoveDataItemReferencesResponse = BulkRemoveDataItemReferencesResponse;
4825
- type context$1_BulkRemoveDataItemReferencesResponseNonNullableFields = BulkRemoveDataItemReferencesResponseNonNullableFields;
4826
- type context$1_BulkRemoveDataItemsOptions = BulkRemoveDataItemsOptions;
4827
- type context$1_BulkRemoveDataItemsRequest = BulkRemoveDataItemsRequest;
4828
- type context$1_BulkRemoveDataItemsResponse = BulkRemoveDataItemsResponse;
4829
- type context$1_BulkRemoveDataItemsResponseNonNullableFields = BulkRemoveDataItemsResponseNonNullableFields;
4830
- type context$1_BulkSaveDataItemsOptions = BulkSaveDataItemsOptions;
4831
- type context$1_BulkSaveDataItemsRequest = BulkSaveDataItemsRequest;
4832
- type context$1_BulkSaveDataItemsResponse = BulkSaveDataItemsResponse;
4833
- type context$1_BulkSaveDataItemsResponseNonNullableFields = BulkSaveDataItemsResponseNonNullableFields;
4834
- type context$1_BulkUpdateDataItemsOptions = BulkUpdateDataItemsOptions;
4835
- type context$1_BulkUpdateDataItemsRequest = BulkUpdateDataItemsRequest;
4836
- type context$1_BulkUpdateDataItemsResponse = BulkUpdateDataItemsResponse;
4837
- type context$1_BulkUpdateDataItemsResponseNonNullableFields = BulkUpdateDataItemsResponseNonNullableFields;
4838
- type context$1_CachingInfo = CachingInfo;
4839
- type context$1_Count = Count;
4840
- type context$1_CountDataItemsOptions = CountDataItemsOptions;
4841
- type context$1_CountDataItemsRequest = CountDataItemsRequest;
4842
- type context$1_CountDataItemsResponse = CountDataItemsResponse;
4843
- type context$1_CountDataItemsResponseNonNullableFields = CountDataItemsResponseNonNullableFields;
4844
- type context$1_CursorPaging = CursorPaging;
4845
- type context$1_Cursors = Cursors;
4846
- type context$1_DataItem = DataItem;
4847
- type context$1_DataItemCreatedEnvelope = DataItemCreatedEnvelope;
4848
- type context$1_DataItemDeletedEnvelope = DataItemDeletedEnvelope;
4849
- type context$1_DataItemNonNullableFields = DataItemNonNullableFields;
4850
- type context$1_DataItemReference = DataItemReference;
4851
- type context$1_DataItemUpdatedEnvelope = DataItemUpdatedEnvelope;
4852
- type context$1_DataItemsQueryBuilder = DataItemsQueryBuilder;
4853
- type context$1_DataItemsQueryResult = DataItemsQueryResult;
4854
- type context$1_DataPublishPluginOptions = DataPublishPluginOptions;
2373
+ type context$1_AllowedDataPermissions = AllowedDataPermissions;
2374
+ type context$1_ArraySizeRange = ArraySizeRange;
2375
+ type context$1_BulkGetDataCollectionsPageBySnapshotsRequest = BulkGetDataCollectionsPageBySnapshotsRequest;
2376
+ type context$1_BulkGetDataCollectionsPageBySnapshotsResponse = BulkGetDataCollectionsPageBySnapshotsResponse;
2377
+ type context$1_BulkGetDataCollectionsRequest = BulkGetDataCollectionsRequest;
2378
+ type context$1_BulkGetDataCollectionsResponse = BulkGetDataCollectionsResponse;
2379
+ type context$1_Calculator = Calculator;
2380
+ type context$1_CalculatorPatternOneOf = CalculatorPatternOneOf;
2381
+ type context$1_CmsOptions = CmsOptions;
2382
+ type context$1_CollectionCapabilities = CollectionCapabilities;
2383
+ type context$1_CollectionOperation = CollectionOperation;
2384
+ declare const context$1_CollectionOperation: typeof CollectionOperation;
2385
+ type context$1_CollectionType = CollectionType;
2386
+ declare const context$1_CollectionType: typeof CollectionType;
2387
+ type context$1_CreateDataCollectionFieldRequest = CreateDataCollectionFieldRequest;
2388
+ type context$1_CreateDataCollectionFieldResponse = CreateDataCollectionFieldResponse;
2389
+ type context$1_CreateDataCollectionRequest = CreateDataCollectionRequest;
2390
+ type context$1_CreateDataCollectionResponse = CreateDataCollectionResponse;
2391
+ type context$1_CreateDataCollectionResponseNonNullableFields = CreateDataCollectionResponseNonNullableFields;
2392
+ type context$1_CreateDataCollectionsSnapshotRequest = CreateDataCollectionsSnapshotRequest;
2393
+ type context$1_CreateDataCollectionsSnapshotResponse = CreateDataCollectionsSnapshotResponse;
2394
+ type context$1_CreateMigratedCollectionsSnapshotRequest = CreateMigratedCollectionsSnapshotRequest;
2395
+ type context$1_CreateMigratedCollectionsSnapshotResponse = CreateMigratedCollectionsSnapshotResponse;
2396
+ type context$1_DataCollection = DataCollection;
2397
+ type context$1_DataCollectionChangedEvent = DataCollectionChangedEvent;
2398
+ type context$1_DataCollectionClonedEvent = DataCollectionClonedEvent;
2399
+ type context$1_DataCollectionNonNullableFields = DataCollectionNonNullableFields;
2400
+ type context$1_DataOperation = DataOperation;
2401
+ declare const context$1_DataOperation: typeof DataOperation;
2402
+ type context$1_DataPermissions = DataPermissions;
2403
+ type context$1_DeleteDataCollectionFieldRequest = DeleteDataCollectionFieldRequest;
2404
+ type context$1_DeleteDataCollectionFieldResponse = DeleteDataCollectionFieldResponse;
2405
+ type context$1_DeleteDataCollectionRequest = DeleteDataCollectionRequest;
2406
+ type context$1_DeleteDataCollectionResponse = DeleteDataCollectionResponse;
2407
+ type context$1_DeleteDataCollectionsSnapshotRequest = DeleteDataCollectionsSnapshotRequest;
2408
+ type context$1_DeleteDataCollectionsSnapshotResponse = DeleteDataCollectionsSnapshotResponse;
2409
+ type context$1_Destination = Destination;
2410
+ type context$1_Direction = Direction;
2411
+ declare const context$1_Direction: typeof Direction;
4855
2412
  type context$1_DomainEvent = DomainEvent;
4856
2413
  type context$1_DomainEventBodyOneOf = DomainEventBodyOneOf;
4857
2414
  type context$1_EntityCreatedEvent = EntityCreatedEvent;
4858
2415
  type context$1_EntityDeletedEvent = EntityDeletedEvent;
4859
2416
  type context$1_EntityUpdatedEvent = EntityUpdatedEvent;
4860
- type context$1_EventMetadata = EventMetadata;
2417
+ type context$1_FieldCapabilities = FieldCapabilities;
2418
+ type context$1_FieldPlugin = FieldPlugin;
2419
+ type context$1_FieldPluginOptionsOneOf = FieldPluginOptionsOneOf;
2420
+ type context$1_FieldPluginType = FieldPluginType;
2421
+ declare const context$1_FieldPluginType: typeof FieldPluginType;
2422
+ type context$1_FieldRangeValidationsOneOf = FieldRangeValidationsOneOf;
4861
2423
  type context$1_FieldUpdate = FieldUpdate;
4862
- type context$1_FieldUpdateActionOptionsOneOf = FieldUpdateActionOptionsOneOf;
4863
- type context$1_GetDataItemOptions = GetDataItemOptions;
4864
- type context$1_GetDataItemRequest = GetDataItemRequest;
4865
- type context$1_GetDataItemResponse = GetDataItemResponse;
4866
- type context$1_GetDataItemResponseNonNullableFields = GetDataItemResponseNonNullableFields;
2424
+ type context$1_FieldsPattern = FieldsPattern;
2425
+ type context$1_Format = Format;
2426
+ declare const context$1_Format: typeof Format;
2427
+ type context$1_GetDataCollectionOptions = GetDataCollectionOptions;
2428
+ type context$1_GetDataCollectionRequest = GetDataCollectionRequest;
2429
+ type context$1_GetDataCollectionResponse = GetDataCollectionResponse;
2430
+ type context$1_GetDataCollectionResponseNonNullableFields = GetDataCollectionResponseNonNullableFields;
4867
2431
  type context$1_IdentificationData = IdentificationData;
4868
2432
  type context$1_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
4869
- type context$1_IncrementField = IncrementField;
4870
- type context$1_InsertDataItemOptions = InsertDataItemOptions;
4871
- type context$1_InsertDataItemReferenceOptions = InsertDataItemReferenceOptions;
4872
- type context$1_InsertDataItemReferenceRequest = InsertDataItemReferenceRequest;
4873
- type context$1_InsertDataItemReferenceResponse = InsertDataItemReferenceResponse;
4874
- type context$1_InsertDataItemReferenceResponseNonNullableFields = InsertDataItemReferenceResponseNonNullableFields;
4875
- type context$1_InsertDataItemRequest = InsertDataItemRequest;
4876
- type context$1_InsertDataItemResponse = InsertDataItemResponse;
4877
- type context$1_InsertDataItemResponseNonNullableFields = InsertDataItemResponseNonNullableFields;
4878
- type context$1_IsReferencedDataItemOptions = IsReferencedDataItemOptions;
4879
- type context$1_IsReferencedDataItemRequest = IsReferencedDataItemRequest;
4880
- type context$1_IsReferencedDataItemResponse = IsReferencedDataItemResponse;
4881
- type context$1_IsReferencedDataItemResponseNonNullableFields = IsReferencedDataItemResponseNonNullableFields;
4882
- type context$1_ItemMetadata = ItemMetadata;
4883
- type context$1_Max = Max;
2433
+ type context$1_IndexField = IndexField;
2434
+ type context$1_IndexLimits = IndexLimits;
2435
+ type context$1_IndexStatus = IndexStatus;
2436
+ declare const context$1_IndexStatus: typeof IndexStatus;
2437
+ type context$1_ListDataCollectionsOptions = ListDataCollectionsOptions;
2438
+ type context$1_ListDataCollectionsRequest = ListDataCollectionsRequest;
2439
+ type context$1_ListDataCollectionsResponse = ListDataCollectionsResponse;
2440
+ type context$1_ListDataCollectionsResponseNonNullableFields = ListDataCollectionsResponseNonNullableFields;
4884
2441
  type context$1_MessageEnvelope = MessageEnvelope;
4885
- type context$1_Min = Min;
4886
- type context$1_Operation = Operation;
4887
- type context$1_OperationCalculateOneOf = OperationCalculateOneOf;
4888
- type context$1_Options = Options;
2442
+ type context$1_MultiReference = MultiReference;
2443
+ type context$1_MultilingualOptions = MultilingualOptions;
2444
+ type context$1_NumberRange = NumberRange;
2445
+ type context$1_ObjectField = ObjectField;
2446
+ type context$1_PageLink = PageLink;
2447
+ type context$1_PageLinkPluginOptions = PageLinkPluginOptions;
4889
2448
  type context$1_PagingMetadataV2 = PagingMetadataV2;
4890
- type context$1_PatchDataItemRequest = PatchDataItemRequest;
4891
- type context$1_PatchDataItemResponse = PatchDataItemResponse;
4892
- type context$1_PatchSet = PatchSet;
2449
+ type context$1_PagingMode = PagingMode;
2450
+ declare const context$1_PagingMode: typeof PagingMode;
2451
+ type context$1_Permissions = Permissions;
2452
+ type context$1_Plugin = Plugin;
2453
+ type context$1_PluginCmsOptions = PluginCmsOptions;
2454
+ type context$1_PluginOptionsOneOf = PluginOptionsOneOf;
2455
+ type context$1_PluginType = PluginType;
2456
+ declare const context$1_PluginType: typeof PluginType;
2457
+ type context$1_PluginUpdate = PluginUpdate;
4893
2458
  type context$1_PublishPluginOptions = PublishPluginOptions;
4894
- type context$1_QueryDataItemsOptions = QueryDataItemsOptions;
4895
- type context$1_QueryDataItemsRequest = QueryDataItemsRequest;
4896
- type context$1_QueryDataItemsResponse = QueryDataItemsResponse;
4897
- type context$1_QueryDataItemsResponseNonNullableFields = QueryDataItemsResponseNonNullableFields;
4898
- type context$1_QueryDistinctValuesOptions = QueryDistinctValuesOptions;
4899
- type context$1_QueryDistinctValuesRequest = QueryDistinctValuesRequest;
4900
- type context$1_QueryDistinctValuesRequestPagingMethodOneOf = QueryDistinctValuesRequestPagingMethodOneOf;
4901
- type context$1_QueryDistinctValuesResponse = QueryDistinctValuesResponse;
4902
- type context$1_QueryReferencedDataItemsOptions = QueryReferencedDataItemsOptions;
4903
- type context$1_QueryReferencedDataItemsRequest = QueryReferencedDataItemsRequest;
4904
- type context$1_QueryReferencedDataItemsRequestPagingMethodOneOf = QueryReferencedDataItemsRequestPagingMethodOneOf;
4905
- type context$1_QueryReferencedDataItemsResponse = QueryReferencedDataItemsResponse;
4906
- type context$1_QueryReferencedDataItemsResponseNonNullableFields = QueryReferencedDataItemsResponseNonNullableFields;
4907
- type context$1_QueryV2 = QueryV2;
4908
- type context$1_QueryV2PagingMethodOneOf = QueryV2PagingMethodOneOf;
4909
- type context$1_ReferencedItemOptions = ReferencedItemOptions;
4910
- type context$1_ReferencedResult = ReferencedResult;
4911
- type context$1_ReferencedResultEntityOneOf = ReferencedResultEntityOneOf;
4912
- type context$1_RemoveDataItemOptions = RemoveDataItemOptions;
4913
- type context$1_RemoveDataItemReferenceOptions = RemoveDataItemReferenceOptions;
4914
- type context$1_RemoveDataItemReferenceRequest = RemoveDataItemReferenceRequest;
4915
- type context$1_RemoveDataItemReferenceResponse = RemoveDataItemReferenceResponse;
4916
- type context$1_RemoveDataItemReferenceResponseNonNullableFields = RemoveDataItemReferenceResponseNonNullableFields;
4917
- type context$1_RemoveDataItemRequest = RemoveDataItemRequest;
4918
- type context$1_RemoveDataItemResponse = RemoveDataItemResponse;
4919
- type context$1_RemoveDataItemResponseNonNullableFields = RemoveDataItemResponseNonNullableFields;
4920
- type context$1_RemoveFromArray = RemoveFromArray;
4921
- type context$1_ReplaceDataItemReferencesOptions = ReplaceDataItemReferencesOptions;
4922
- type context$1_ReplaceDataItemReferencesRequest = ReplaceDataItemReferencesRequest;
4923
- type context$1_ReplaceDataItemReferencesResponse = ReplaceDataItemReferencesResponse;
4924
- type context$1_ReplaceDataItemReferencesResponseNonNullableFields = ReplaceDataItemReferencesResponseNonNullableFields;
2459
+ type context$1_QueryOperator = QueryOperator;
2460
+ declare const context$1_QueryOperator: typeof QueryOperator;
2461
+ type context$1_Reference = Reference;
2462
+ type context$1_RestorationCollection = RestorationCollection;
2463
+ type context$1_RestoreDataCollectionRequest = RestoreDataCollectionRequest;
2464
+ type context$1_RestoreDataCollectionResponse = RestoreDataCollectionResponse;
2465
+ type context$1_RestoreDataCollectionsFromSnapshotRequest = RestoreDataCollectionsFromSnapshotRequest;
2466
+ type context$1_RestoreDataCollectionsFromSnapshotResponse = RestoreDataCollectionsFromSnapshotResponse;
4925
2467
  type context$1_RestoreInfo = RestoreInfo;
4926
- type context$1_SaveDataItemOptions = SaveDataItemOptions;
4927
- type context$1_SaveDataItemRequest = SaveDataItemRequest;
4928
- type context$1_SaveDataItemResponse = SaveDataItemResponse;
4929
- type context$1_SaveDataItemResponseNonNullableFields = SaveDataItemResponseNonNullableFields;
4930
- type context$1_SetField = SetField;
2468
+ type context$1_Role = Role;
2469
+ declare const context$1_Role: typeof Role;
2470
+ type context$1_Segment = Segment;
2471
+ declare const context$1_Segment: typeof Segment;
2472
+ type context$1_SingleItemPluginOptions = SingleItemPluginOptions;
2473
+ type context$1_SiteSort = SiteSort;
2474
+ type context$1_SnapshotCollection = SnapshotCollection;
2475
+ type context$1_Sort = Sort;
4931
2476
  type context$1_SortOrder = SortOrder;
4932
2477
  declare const context$1_SortOrder: typeof SortOrder;
4933
2478
  type context$1_Sorting = Sorting;
4934
- type context$1_Sum = Sum;
4935
- type context$1_TruncateDataItemsOptions = TruncateDataItemsOptions;
4936
- type context$1_TruncateDataItemsRequest = TruncateDataItemsRequest;
4937
- type context$1_TruncateDataItemsResponse = TruncateDataItemsResponse;
4938
- type context$1_UnresolvedReference = UnresolvedReference;
4939
- type context$1_UpdateDataItemOptions = UpdateDataItemOptions;
4940
- type context$1_UpdateDataItemRequest = UpdateDataItemRequest;
4941
- type context$1_UpdateDataItemResponse = UpdateDataItemResponse;
4942
- type context$1_UpdateDataItemResponseNonNullableFields = UpdateDataItemResponseNonNullableFields;
2479
+ type context$1_StringLengthRange = StringLengthRange;
2480
+ type context$1_Type = Type;
2481
+ declare const context$1_Type: typeof Type;
2482
+ type context$1_TypeMetadata = TypeMetadata;
2483
+ type context$1_TypeMetadataMetadataOneOf = TypeMetadataMetadataOneOf;
2484
+ type context$1_UpdateDataCollectionFieldRequest = UpdateDataCollectionFieldRequest;
2485
+ type context$1_UpdateDataCollectionFieldResponse = UpdateDataCollectionFieldResponse;
2486
+ type context$1_UpdateDataCollectionRequest = UpdateDataCollectionRequest;
2487
+ type context$1_UpdateDataCollectionResponse = UpdateDataCollectionResponse;
2488
+ type context$1_UpdateDataCollectionResponseNonNullableFields = UpdateDataCollectionResponseNonNullableFields;
2489
+ type context$1_UpdateDataPermissionsRequest = UpdateDataPermissionsRequest;
2490
+ type context$1_UpdateDataPermissionsResponse = UpdateDataPermissionsResponse;
2491
+ type context$1_UrlizedOnlyPattern = UrlizedOnlyPattern;
2492
+ type context$1_UrlizedPluginOptions = UrlizedPluginOptions;
4943
2493
  type context$1_WebhookIdentityType = WebhookIdentityType;
4944
2494
  declare const context$1_WebhookIdentityType: typeof WebhookIdentityType;
4945
- type context$1__publicOnDataItemCreatedType = _publicOnDataItemCreatedType;
4946
- type context$1__publicOnDataItemDeletedType = _publicOnDataItemDeletedType;
4947
- type context$1__publicOnDataItemUpdatedType = _publicOnDataItemUpdatedType;
4948
- declare const context$1_aggregateDataItems: typeof aggregateDataItems;
4949
- declare const context$1_bulkInsertDataItemReferences: typeof bulkInsertDataItemReferences;
4950
- declare const context$1_bulkInsertDataItems: typeof bulkInsertDataItems;
4951
- declare const context$1_bulkRemoveDataItemReferences: typeof bulkRemoveDataItemReferences;
4952
- declare const context$1_bulkRemoveDataItems: typeof bulkRemoveDataItems;
4953
- declare const context$1_bulkSaveDataItems: typeof bulkSaveDataItems;
4954
- declare const context$1_bulkUpdateDataItems: typeof bulkUpdateDataItems;
4955
- declare const context$1_countDataItems: typeof countDataItems;
4956
- declare const context$1_getDataItem: typeof getDataItem;
4957
- declare const context$1_insertDataItem: typeof insertDataItem;
4958
- declare const context$1_insertDataItemReference: typeof insertDataItemReference;
4959
- declare const context$1_isReferencedDataItem: typeof isReferencedDataItem;
4960
- declare const context$1_onDataItemCreated: typeof onDataItemCreated;
4961
- declare const context$1_onDataItemDeleted: typeof onDataItemDeleted;
4962
- declare const context$1_onDataItemUpdated: typeof onDataItemUpdated;
4963
- declare const context$1_queryDataItems: typeof queryDataItems;
4964
- declare const context$1_queryDistinctValues: typeof queryDistinctValues;
4965
- declare const context$1_queryReferencedDataItems: typeof queryReferencedDataItems;
4966
- declare const context$1_removeDataItem: typeof removeDataItem;
4967
- declare const context$1_removeDataItemReference: typeof removeDataItemReference;
4968
- declare const context$1_replaceDataItemReferences: typeof replaceDataItemReferences;
4969
- declare const context$1_saveDataItem: typeof saveDataItem;
4970
- declare const context$1_truncateDataItems: typeof truncateDataItems;
4971
- declare const context$1_updateDataItem: typeof updateDataItem;
2495
+ type context$1__Array = _Array;
2496
+ type context$1__Object = _Object;
2497
+ declare const context$1_createDataCollection: typeof createDataCollection;
2498
+ declare const context$1_deleteDataCollection: typeof deleteDataCollection;
2499
+ declare const context$1_getDataCollection: typeof getDataCollection;
2500
+ declare const context$1_listDataCollections: typeof listDataCollections;
2501
+ declare const context$1_updateDataCollection: typeof updateDataCollection;
4972
2502
  declare namespace context$1 {
4973
- 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__publicOnDataItemCreatedType as _publicOnDataItemCreatedType, type context$1__publicOnDataItemDeletedType as _publicOnDataItemDeletedType, type context$1__publicOnDataItemUpdatedType as _publicOnDataItemUpdatedType, 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 };
2503
+ export { context$1_AccessLevel as AccessLevel, type context$1_ActionEvent as ActionEvent, type context$1_AllowedDataPermissions as AllowedDataPermissions, type context$1_ArraySizeRange as ArraySizeRange, type context$1_BulkGetDataCollectionsPageBySnapshotsRequest as BulkGetDataCollectionsPageBySnapshotsRequest, type context$1_BulkGetDataCollectionsPageBySnapshotsResponse as BulkGetDataCollectionsPageBySnapshotsResponse, type context$1_BulkGetDataCollectionsRequest as BulkGetDataCollectionsRequest, type context$1_BulkGetDataCollectionsResponse as BulkGetDataCollectionsResponse, type context$1_Calculator as Calculator, type context$1_CalculatorPatternOneOf as CalculatorPatternOneOf, type context$1_CmsOptions as CmsOptions, type context$1_CollectionCapabilities as CollectionCapabilities, context$1_CollectionOperation as CollectionOperation, context$1_CollectionType as CollectionType, type context$1_CreateDataCollectionFieldRequest as CreateDataCollectionFieldRequest, type context$1_CreateDataCollectionFieldResponse as CreateDataCollectionFieldResponse, type context$1_CreateDataCollectionRequest as CreateDataCollectionRequest, type context$1_CreateDataCollectionResponse as CreateDataCollectionResponse, type context$1_CreateDataCollectionResponseNonNullableFields as CreateDataCollectionResponseNonNullableFields, type context$1_CreateDataCollectionsSnapshotRequest as CreateDataCollectionsSnapshotRequest, type context$1_CreateDataCollectionsSnapshotResponse as CreateDataCollectionsSnapshotResponse, type context$1_CreateMigratedCollectionsSnapshotRequest as CreateMigratedCollectionsSnapshotRequest, type context$1_CreateMigratedCollectionsSnapshotResponse as CreateMigratedCollectionsSnapshotResponse, type context$1_DataCollection as DataCollection, type context$1_DataCollectionChangedEvent as DataCollectionChangedEvent, type context$1_DataCollectionClonedEvent as DataCollectionClonedEvent, type context$1_DataCollectionNonNullableFields as DataCollectionNonNullableFields, context$1_DataOperation as DataOperation, type context$1_DataPermissions as DataPermissions, type context$1_DeleteDataCollectionFieldRequest as DeleteDataCollectionFieldRequest, type context$1_DeleteDataCollectionFieldResponse as DeleteDataCollectionFieldResponse, type context$1_DeleteDataCollectionRequest as DeleteDataCollectionRequest, type context$1_DeleteDataCollectionResponse as DeleteDataCollectionResponse, type context$1_DeleteDataCollectionsSnapshotRequest as DeleteDataCollectionsSnapshotRequest, type context$1_DeleteDataCollectionsSnapshotResponse as DeleteDataCollectionsSnapshotResponse, type context$1_Destination as Destination, context$1_Direction as Direction, 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, type Failure$1 as Failure, type Field$1 as Field, type context$1_FieldCapabilities as FieldCapabilities, type context$1_FieldPlugin as FieldPlugin, type context$1_FieldPluginOptionsOneOf as FieldPluginOptionsOneOf, context$1_FieldPluginType as FieldPluginType, type context$1_FieldRangeValidationsOneOf as FieldRangeValidationsOneOf, type context$1_FieldUpdate as FieldUpdate, type context$1_FieldsPattern as FieldsPattern, context$1_Format as Format, type context$1_GetDataCollectionOptions as GetDataCollectionOptions, type context$1_GetDataCollectionRequest as GetDataCollectionRequest, type context$1_GetDataCollectionResponse as GetDataCollectionResponse, type context$1_GetDataCollectionResponseNonNullableFields as GetDataCollectionResponseNonNullableFields, type context$1_IdentificationData as IdentificationData, type context$1_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type Index$1 as Index, type context$1_IndexField as IndexField, type context$1_IndexLimits as IndexLimits, context$1_IndexStatus as IndexStatus, type context$1_ListDataCollectionsOptions as ListDataCollectionsOptions, type context$1_ListDataCollectionsRequest as ListDataCollectionsRequest, type context$1_ListDataCollectionsResponse as ListDataCollectionsResponse, type context$1_ListDataCollectionsResponseNonNullableFields as ListDataCollectionsResponseNonNullableFields, type context$1_MessageEnvelope as MessageEnvelope, type context$1_MultiReference as MultiReference, type context$1_MultilingualOptions as MultilingualOptions, type context$1_NumberRange as NumberRange, type context$1_ObjectField as ObjectField, Order$1 as Order, type context$1_PageLink as PageLink, type context$1_PageLinkPluginOptions as PageLinkPluginOptions, type Paging$1 as Paging, type context$1_PagingMetadataV2 as PagingMetadataV2, context$1_PagingMode as PagingMode, type context$1_Permissions as Permissions, type context$1_Plugin as Plugin, type context$1_PluginCmsOptions as PluginCmsOptions, type context$1_PluginOptionsOneOf as PluginOptionsOneOf, context$1_PluginType as PluginType, type context$1_PluginUpdate as PluginUpdate, type context$1_PublishPluginOptions as PublishPluginOptions, context$1_QueryOperator as QueryOperator, type context$1_Reference as Reference, type context$1_RestorationCollection as RestorationCollection, type context$1_RestoreDataCollectionRequest as RestoreDataCollectionRequest, type context$1_RestoreDataCollectionResponse as RestoreDataCollectionResponse, type context$1_RestoreDataCollectionsFromSnapshotRequest as RestoreDataCollectionsFromSnapshotRequest, type context$1_RestoreDataCollectionsFromSnapshotResponse as RestoreDataCollectionsFromSnapshotResponse, type context$1_RestoreInfo as RestoreInfo, context$1_Role as Role, context$1_Segment as Segment, type context$1_SingleItemPluginOptions as SingleItemPluginOptions, type context$1_SiteSort as SiteSort, type context$1_SnapshotCollection as SnapshotCollection, type context$1_Sort as Sort, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, Status$1 as Status, type context$1_StringLengthRange as StringLengthRange, context$1_Type as Type, type context$1_TypeMetadata as TypeMetadata, type context$1_TypeMetadataMetadataOneOf as TypeMetadataMetadataOneOf, type context$1_UpdateDataCollectionFieldRequest as UpdateDataCollectionFieldRequest, type context$1_UpdateDataCollectionFieldResponse as UpdateDataCollectionFieldResponse, type context$1_UpdateDataCollectionRequest as UpdateDataCollectionRequest, type context$1_UpdateDataCollectionResponse as UpdateDataCollectionResponse, type context$1_UpdateDataCollectionResponseNonNullableFields as UpdateDataCollectionResponseNonNullableFields, type context$1_UpdateDataPermissionsRequest as UpdateDataPermissionsRequest, type context$1_UpdateDataPermissionsResponse as UpdateDataPermissionsResponse, type context$1_UrlizedOnlyPattern as UrlizedOnlyPattern, type context$1_UrlizedPluginOptions as UrlizedPluginOptions, context$1_WebhookIdentityType as WebhookIdentityType, type context$1__Array as _Array, type context$1__Object as _Object, context$1_createDataCollection as createDataCollection, context$1_deleteDataCollection as deleteDataCollection, context$1_getDataCollection as getDataCollection, context$1_listDataCollections as listDataCollections, context$1_updateDataCollection as updateDataCollection };
4974
2504
  }
4975
2505
 
4976
2506
  /** An index is a map of a collection's data, organized according to specific fields to increase query speed. */
@@ -5233,4 +2763,4 @@ declare namespace context {
5233
2763
  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_ListAvailableIndexesRequest as ListAvailableIndexesRequest, type context_ListAvailableIndexesResponse as ListAvailableIndexesResponse, 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 };
5234
2764
  }
5235
2765
 
5236
- export { context$2 as collections, context$3 as externalDatabaseConnections, context as indexes, context$1 as items };
2766
+ export { context$1 as collections, context$2 as externalDatabaseConnections, context as indexes };