@wix/auto_sdk_data-backend-public-sdk-poc_data 1.0.31 → 1.0.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/build/cjs/index.d.ts +18 -0
  2. package/build/cjs/index.js.map +1 -0
  3. package/build/{data-v1-data-service-data.universal-DwJ77xKF.d.mts → cjs/index.typings.d.ts} +17 -1
  4. package/build/cjs/index.typings.js +1350 -0
  5. package/build/cjs/index.typings.js.map +1 -0
  6. package/build/{internal → cjs}/meta.d.ts +2 -1
  7. package/build/es/index.d.mts +18 -0
  8. package/build/es/index.mjs.map +1 -0
  9. package/build/{data-v1-data-service-data.universal-DwJ77xKF.d.ts → es/index.typings.d.mts} +17 -1
  10. package/build/es/index.typings.mjs +1305 -0
  11. package/build/es/index.typings.mjs.map +1 -0
  12. package/build/{internal → es}/meta.d.mts +2 -1
  13. package/build/es/package.json +3 -0
  14. package/build/internal/{index.d.ts → cjs/index.d.ts} +22 -22
  15. package/build/internal/cjs/index.js.map +1 -0
  16. package/build/internal/{data-v1-data-service-data.universal-B0E_2MN6.d.mts → cjs/index.typings.d.ts} +323 -1
  17. package/build/internal/cjs/index.typings.js +1350 -0
  18. package/build/internal/cjs/index.typings.js.map +1 -0
  19. package/build/{meta.d.ts → internal/cjs/meta.d.ts} +2 -1
  20. package/build/internal/cjs/meta.js.map +1 -0
  21. package/build/internal/{index.d.mts → es/index.d.mts} +22 -22
  22. package/build/internal/es/index.mjs.map +1 -0
  23. package/build/internal/{data-v1-data-service-data.universal-B0E_2MN6.d.ts → es/index.typings.d.mts} +323 -1
  24. package/build/internal/es/index.typings.mjs +1305 -0
  25. package/build/internal/es/index.typings.mjs.map +1 -0
  26. package/build/{meta.d.mts → internal/es/meta.d.mts} +2 -1
  27. package/build/internal/es/meta.mjs.map +1 -0
  28. package/package.json +12 -11
  29. package/build/index.d.mts +0 -18
  30. package/build/index.d.ts +0 -18
  31. package/build/index.js.map +0 -1
  32. package/build/index.mjs.map +0 -1
  33. package/build/internal/index.js.map +0 -1
  34. package/build/internal/index.mjs.map +0 -1
  35. package/build/meta.js.map +0 -1
  36. package/build/meta.mjs.map +0 -1
  37. /package/build/{index.js → cjs/index.js} +0 -0
  38. /package/build/{internal → cjs}/meta.js +0 -0
  39. /package/build/{internal → cjs}/meta.js.map +0 -0
  40. /package/build/{index.mjs → es/index.mjs} +0 -0
  41. /package/build/{internal → es}/meta.mjs +0 -0
  42. /package/build/{internal → es}/meta.mjs.map +0 -0
  43. /package/build/internal/{index.js → cjs/index.js} +0 -0
  44. /package/build/{meta.js → internal/cjs/meta.js} +0 -0
  45. /package/build/internal/{index.mjs → es/index.mjs} +0 -0
  46. /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  interface Item {
2
4
  item?: Record<string, any> | null;
3
5
  }
@@ -464,6 +466,8 @@ declare enum Order {
464
466
  ASC = "ASC",
465
467
  DESC = "DESC"
466
468
  }
469
+ /** @enumType */
470
+ type OrderWithLiterals = Order | 'ASC' | 'DESC';
467
471
  interface QueryReferencedResponse {
468
472
  /**
469
473
  * *Deprecated.** Refer to `entities` instead. List of referenced items.
@@ -573,36 +577,153 @@ interface RestoreFromTrashBinRequest {
573
577
  interface RestoreFromTrashBinResponse {
574
578
  item?: Record<string, any> | null;
575
579
  }
580
+ /**
581
+ * Adds an item to a collection.
582
+ *
583
+ * When an item is inserted into a collection, the following properties and values are added to it:
584
+ * * `_id`: A unique identifier for an item in a collection. 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.
585
+ * * `_createdDate`: The date the item was added to the collection.
586
+ * * `_updatedDate`: The date the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
587
+ * @internal
588
+ * @documentationMaturity preview
589
+ * @permissionId WIX_DATA.INSERT
590
+ * @applicableIdentity APP
591
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Insert
592
+ * @deprecated
593
+ * @targetRemovalDate 2025-06-01
594
+ */
595
+ declare function insert(options?: InsertOptions): Promise<InsertResponse>;
576
596
  interface InsertOptions {
577
597
  /** Item to insert. */
578
598
  item?: Record<string, any> | null;
579
599
  /** ID of the collection in which to insert the item. */
580
600
  dataCollectionId?: string;
581
601
  }
602
+ /**
603
+ * Updates an item in a collection.
604
+ *
605
+ * An item ID must be submitted as part of the request, either as a path parameter or within the `item` body parameter. If an item is found in the specified collection with
606
+ * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the request fails.
607
+ *
608
+ * When an item is updated, its `_updatedDate` property is changed to the current date.
609
+ *
610
+ * **Note:**
611
+ * After an item is updated, it only contains the properties included in the Update Data Item request. If the existing item has properties with values and those properties
612
+ * aren't included in the updated item, their values are lost.
613
+ * @internal
614
+ * @documentationMaturity preview
615
+ * @requiredField options.item
616
+ * @permissionId WIX_DATA.UPDATE
617
+ * @applicableIdentity APP
618
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Update
619
+ * @deprecated
620
+ * @targetRemovalDate 2025-06-01
621
+ */
622
+ declare function update(options?: NonNullablePaths<UpdateOptions, `item`>): Promise<UpdateResponse>;
582
623
  interface UpdateOptions {
583
624
  /** Item to update. The existing item is replaced with this version. */
584
625
  item: Record<string, any> | null;
585
626
  /** ID of the collection containing the existing item. */
586
627
  dataCollectionId?: string;
587
628
  }
629
+ /**
630
+ * Inserts or updates an item in a collection.
631
+ *
632
+ * The Save Data Item endpoint inserts or updates the specified item, depending on whether it already exists in the collection.
633
+ *
634
+ * * If you don't provide an ID, a new item is created.
635
+ *
636
+ * * If you provide an ID that doesn't exist in the collection, a new item is created with that ID.
637
+ *
638
+ * * If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `_updatedDate` property is changed to the current date.
639
+ *
640
+ * ***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.
641
+ * This means that all of the item's previous properties and values are lost.
642
+ * @internal
643
+ * @documentationMaturity preview
644
+ * @permissionId WIX_DATA.UPDATE
645
+ * @applicableIdentity APP
646
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Save
647
+ * @deprecated
648
+ * @targetRemovalDate 2025-06-01
649
+ */
650
+ declare function save(options?: SaveOptions): Promise<SaveResponse>;
588
651
  interface SaveOptions {
589
652
  /** Item to insert or update. */
590
653
  item?: Record<string, any> | null;
591
654
  /** ID of the collection in which to insert or update the item. */
592
655
  dataCollectionId?: string;
593
656
  }
657
+ /**
658
+ * Retrieves an item from a collection.
659
+ * @param itemId - ID of the item to retrieve.
660
+ * @internal
661
+ * @documentationMaturity preview
662
+ * @requiredField itemId
663
+ * @permissionId WIX_DATA.FIND
664
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Get
665
+ * @deprecated
666
+ * @targetRemovalDate 2025-06-01
667
+ */
668
+ declare function get(itemId: string, options?: GetOptions): Promise<GetResponse>;
594
669
  interface GetOptions {
595
670
  /** ID of the collection from which to retrieve the item. */
596
671
  dataCollectionId?: string;
597
672
  }
673
+ /**
674
+ * Removes an item from a collection.
675
+ *
676
+ * If any items in other collections reference the removed item in a reference or multi-reference field, the field is cleared.
677
+ *
678
+ * **Note:**
679
+ * Once an item has been removed from a collection, it can't be restored.
680
+ * @param itemId - ID of the item to remove.
681
+ * @internal
682
+ * @documentationMaturity preview
683
+ * @requiredField itemId
684
+ * @permissionId WIX_DATA.REMOVE
685
+ * @applicableIdentity APP
686
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Remove
687
+ * @deprecated
688
+ * @targetRemovalDate 2025-06-01
689
+ */
690
+ declare function remove(itemId: string, options?: RemoveOptions): Promise<RemoveResponse>;
598
691
  interface RemoveOptions {
599
692
  /** ID of the collection from which to remove the item. */
600
693
  dataCollectionId?: string;
601
694
  }
695
+ /**
696
+ * Removes all items from a collection. Site owner (`ADMIN`) permissions are required in order to invoke this operation.
697
+ *
698
+ * If any items in other collections reference the removed items in reference or multi-reference fields, those fields are cleared.
699
+ *
700
+ * **Note:**
701
+ * Once items have been removed from a collection, they can't be restored.
702
+ * @internal
703
+ * @documentationMaturity preview
704
+ * @permissionId WIX_DATA.TRUNCATE
705
+ * @applicableIdentity APP
706
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Truncate
707
+ * @deprecated
708
+ * @targetRemovalDate 2025-06-01
709
+ */
710
+ declare function truncate(options?: TruncateOptions): Promise<void>;
602
711
  interface TruncateOptions {
603
712
  /** ID of the collection to truncate. */
604
713
  dataCollectionId?: string;
605
714
  }
715
+ /**
716
+ * Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.
717
+ *
718
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
719
+ * @public
720
+ * @documentationMaturity preview
721
+ * @permissionId WIX_DATA.FIND
722
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Query
723
+ * @deprecated
724
+ * @targetRemovalDate 2025-06-01
725
+ */
726
+ declare function query(options?: QueryOptions): Promise<NonNullablePaths<QueryResponse, `items` | `totalCount` | `totalResults` | `partialIncludes`>>;
606
727
  interface QueryOptions {
607
728
  /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
608
729
  dataQuery?: QueryV2;
@@ -622,6 +743,15 @@ interface QueryOptions {
622
743
  /** ID of the collection to query. */
623
744
  dataCollectionId?: string;
624
745
  }
746
+ /** @internal
747
+ * @documentationMaturity preview
748
+ * @permissionId WIX_DATA.AGGREGATE
749
+ * @applicableIdentity APP
750
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Aggregate
751
+ * @deprecated
752
+ * @targetRemovalDate 2025-06-01
753
+ */
754
+ declare function aggregate(options?: AggregateOptions): Promise<NonNullablePaths<AggregationResponse, `items`>>;
625
755
  interface AggregateOptions {
626
756
  /** Paging preferences. */
627
757
  paging?: Paging;
@@ -685,12 +815,40 @@ interface AggregateOptions {
685
815
  /** ID of the collection on which to run the aggregation. */
686
816
  dataCollectionId?: string;
687
817
  }
818
+ /**
819
+ * Returns the number of items in a collection that match a query.
820
+ * @internal
821
+ * @documentationMaturity preview
822
+ * @permissionId WIX_DATA.FIND
823
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Count
824
+ * @deprecated
825
+ * @targetRemovalDate 2025-06-01
826
+ */
827
+ declare function count(options?: CountOptions): Promise<NonNullablePaths<CountResponse, `totalCount` | `totalResults`>>;
688
828
  interface CountOptions {
689
829
  /** Filter preferences defining the query. For more information on how to structure a filter object, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section). */
690
830
  filter?: Record<string, any> | null;
691
831
  /** ID of the collection for which to count query results. */
692
832
  dataCollectionId?: string;
693
833
  }
834
+ /**
835
+ * Retrieves a list of distinct values for a given property in all items that match a query, without duplicates.
836
+ *
837
+ * As with the [Query Data Items]() endpoint, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.
838
+ * However, the Query Distinct Values endpoint doesn't return all of the full items that match the query.
839
+ * Rather, it returns all unique values of the property you specify in `propertyName` for items that match the query.
840
+ * If more than one item has the same value for that property, that value appears only once.
841
+ *
842
+ * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
843
+ * @internal
844
+ * @documentationMaturity preview
845
+ * @requiredField options.propertyName
846
+ * @permissionId WIX_DATA.FIND
847
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.Distinct
848
+ * @deprecated
849
+ * @targetRemovalDate 2025-06-01
850
+ */
851
+ declare function distinct(options?: NonNullablePaths<DistinctOptions, `propertyName`>): Promise<NonNullablePaths<DistinctResponse, `items`>>;
694
852
  interface DistinctOptions {
695
853
  /** Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). */
696
854
  dataQuery?: QueryV2;
@@ -706,30 +864,134 @@ interface DistinctOptions {
706
864
  */
707
865
  omitTotalCount?: boolean;
708
866
  }
867
+ /**
868
+ * Adds multiple items to a collection.
869
+ *
870
+ * When each item is inserted into a collection, the following properties and values are added to it:
871
+ * * `_id`: A unique identifier for an item in a collection. 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.
872
+ * * `_createdDate`: The date the item was added to the collection.
873
+ * * `_updatedDate`: The date the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
874
+ *
875
+ * The endpoint returns a list of the IDs of items successfully inserted in `insertedItemIds`.
876
+ * When any items can't be inserted, error details are provided for each failed item in `errors`.
877
+ * @internal
878
+ * @documentationMaturity preview
879
+ * @requiredField options.items
880
+ * @permissionId WIX_DATA.INSERT
881
+ * @applicableIdentity APP
882
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkInsert
883
+ * @deprecated
884
+ * @targetRemovalDate 2025-06-01
885
+ */
886
+ declare function bulkInsert(options?: NonNullablePaths<BulkInsertOptions, `items`>): Promise<NonNullablePaths<BulkInsertResponse, `insertedItemIds` | `errors` | `errors.${number}.message` | `errors.${number}.details.applicationError.code` | `errors.${number}.details.applicationError.description` | `errors.${number}.originalIndex`>>;
709
887
  interface BulkInsertOptions {
710
888
  /** Items to insert. */
711
889
  items: Record<string, any>[] | null;
712
890
  /** ID of the collection in which to insert the items. */
713
891
  dataCollectionId?: string;
714
892
  }
893
+ /**
894
+ * Inserts or updates multiple items in a collection.
895
+ *
896
+ * The Bulk Save Data Items endpoint inserts or updates each item, depending on whether it already exists in the collection. For each item:
897
+ *
898
+ * * If you don't provide an ID, a new item is created.
899
+ *
900
+ * * If you provide an ID that doesn't exist in the collection, a new item is created with that ID.
901
+ *
902
+ * * If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `_updatedDate` property is changed to the current date.
903
+ *
904
+ * The endpoint returns a list of the IDs of items successfully inserted in `insertedItemIds` and a list of the IDs of items successfully updated in `updatedItemIds`.
905
+ * When any items can't be inserted or updated, error details are provided for each failed item in `errors`.
906
+ *
907
+ * ***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.
908
+ * This means that all of the item's previous properties and values are lost.
909
+ * @internal
910
+ * @documentationMaturity preview
911
+ * @requiredField options.items
912
+ * @permissionId WIX_DATA.UPDATE
913
+ * @applicableIdentity APP
914
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkSave
915
+ * @deprecated
916
+ * @targetRemovalDate 2025-06-01
917
+ */
918
+ declare function bulkSave(options?: NonNullablePaths<BulkSaveOptions, `items`>): Promise<NonNullablePaths<BulkSaveResponse, `insertedItemIds` | `updatedItemIds` | `errors` | `errors.${number}.message` | `errors.${number}.details.applicationError.code` | `errors.${number}.details.applicationError.description` | `errors.${number}.originalIndex`>>;
715
919
  interface BulkSaveOptions {
716
920
  /** Items to insert or update. */
717
921
  items: Record<string, any>[] | null;
718
922
  /** ID of the collection in which to insert or update the items. */
719
923
  dataCollectionId?: string;
720
924
  }
925
+ /**
926
+ * Updates multiple items in a collection.
927
+ *
928
+ * Each item in the request must include an ID. If an item is found in the specified collection with
929
+ * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.
930
+ *
931
+ * When an item is updated, its `_updatedDate` property is changed to the current date.
932
+ *
933
+ * The endpoint returns a list of the IDs of items successfully updated in `updatedItemIds`.
934
+ * When any items can't be inserted, error details are provided for each failed item in `errors`.
935
+ *
936
+ * **Note:**
937
+ * After each item is updated, it only contains the properties included in the Update Data Item request. If the existing item has properties with values and those properties
938
+ * aren't included in the updated item, their values are lost.
939
+ * @internal
940
+ * @documentationMaturity preview
941
+ * @requiredField options.items
942
+ * @permissionId WIX_DATA.UPDATE
943
+ * @applicableIdentity APP
944
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkUpdate
945
+ * @deprecated
946
+ * @targetRemovalDate 2025-06-01
947
+ */
948
+ declare function bulkUpdate(options?: NonNullablePaths<BulkUpdateOptions, `items`>): Promise<NonNullablePaths<BulkUpdateResponse, `updatedItemIds` | `errors` | `errors.${number}.message` | `errors.${number}.details.applicationError.code` | `errors.${number}.details.applicationError.description` | `errors.${number}.originalIndex`>>;
721
949
  interface BulkUpdateOptions {
722
950
  /** Items to update. */
723
951
  items: Record<string, any>[] | null;
724
952
  /** ID of the collection in which to update items. */
725
953
  dataCollectionId?: string;
726
954
  }
955
+ /**
956
+ * Removes multiple items from a collection.
957
+ *
958
+ * If any items in other collections reference the removed items in reference or multi-reference fields, the fields are cleared.
959
+ *
960
+ * The endpoint returns a list of the IDs of items successfully removed in `removedItemIds`.
961
+ * When any items can't be removed, error details are provided for each failed item in `errors`.
962
+ *
963
+ * **Note:** Once an item has been removed from a collection, it can't be restored.
964
+ * @internal
965
+ * @documentationMaturity preview
966
+ * @permissionId WIX_DATA.REMOVE
967
+ * @applicableIdentity APP
968
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkRemove
969
+ * @deprecated
970
+ * @targetRemovalDate 2025-06-01
971
+ */
972
+ declare function bulkRemove(options?: BulkRemoveOptions): Promise<NonNullablePaths<BulkRemoveResponse, `removedItemIds` | `errors` | `errors.${number}.message` | `errors.${number}.details.applicationError.code` | `errors.${number}.details.applicationError.description` | `errors.${number}.originalIndex`>>;
727
973
  interface BulkRemoveOptions {
728
974
  /** IDs of items to remove. */
729
975
  entries?: BulkRemoveRequestEntry[];
730
976
  /** ID of the collection from which to remove the items. */
731
977
  dataCollectionId?: string;
732
978
  }
979
+ /**
980
+ * Gets the full items referenced in the specified property of an item.
981
+ *
982
+ * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.
983
+ * Querying the **Movies** collection using the Query Referenced Data Items endpoint returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.
984
+ * This gives you information from the **People** collection about each of the actors in the specified movie.
985
+ * @internal
986
+ * @documentationMaturity preview
987
+ * @requiredField options.propertyName
988
+ * @requiredField options.referringItemId
989
+ * @permissionId WIX_DATA.FIND
990
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.QueryReferenced
991
+ * @deprecated
992
+ * @targetRemovalDate 2025-06-01
993
+ */
994
+ declare function queryReferenced(options?: NonNullablePaths<QueryReferencedOptions, `propertyName` | `referringItemId`>): Promise<NonNullablePaths<QueryReferencedResponse, `items` | `totalCount` | `totalResults` | `entities` | `entities.${number}.referenceId`>>;
733
995
  interface QueryReferencedOptions {
734
996
  /** ID of the referring item. */
735
997
  referringItemId: string;
@@ -747,6 +1009,24 @@ interface QueryReferencedOptions {
747
1009
  */
748
1010
  omitTotalCount?: boolean;
749
1011
  }
1012
+ /**
1013
+ * Inserts one or more references in the specified properties of items in a collection.
1014
+ *
1015
+ * The Bulk Insert References endpoint adds one or more references to a collection.
1016
+ * Each new reference in the `references` field specifies a referring item's ID, the property in which to insert the reference, and the ID of the referenced item.
1017
+ * @internal
1018
+ * @documentationMaturity preview
1019
+ * @requiredField options.references
1020
+ * @requiredField options.references.propertyName
1021
+ * @requiredField options.references.referencedItemId
1022
+ * @requiredField options.references.referringItemId
1023
+ * @permissionId WIX_DATA.INSERT
1024
+ * @applicableIdentity APP
1025
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkInsertReferences
1026
+ * @deprecated
1027
+ * @targetRemovalDate 2025-06-01
1028
+ */
1029
+ declare function bulkInsertReferences(options?: NonNullablePaths<BulkInsertReferencesOptions, `references` | `references.${number}.propertyName` | `references.${number}.referencedItemId` | `references.${number}.referringItemId`>): Promise<void>;
750
1030
  interface BulkInsertReferencesOptions {
751
1031
  /**
752
1032
  * References to insert.
@@ -756,6 +1036,22 @@ interface BulkInsertReferencesOptions {
756
1036
  /** ID of the collection containing the referring item. */
757
1037
  dataCollectionId?: string;
758
1038
  }
1039
+ /**
1040
+ * Replaces references in a specified property of a specified data item.
1041
+ *
1042
+ * The Bulk Replace References endpoint replaces the existing reference or references contained in the property specified in `propertyName` within the data item specified in `referringItemId`.
1043
+ * The endpoint removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.
1044
+ * @internal
1045
+ * @documentationMaturity preview
1046
+ * @requiredField options.propertyName
1047
+ * @requiredField options.referringItemId
1048
+ * @permissionId WIX_DATA.UPDATE
1049
+ * @applicableIdentity APP
1050
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkReplaceReferences
1051
+ * @deprecated
1052
+ * @targetRemovalDate 2025-06-01
1053
+ */
1054
+ declare function bulkReplaceReferences(options?: NonNullablePaths<BulkReplaceReferencesOptions, `propertyName` | `referringItemId`>): Promise<void>;
759
1055
  interface BulkReplaceReferencesOptions {
760
1056
  /** Property containing the references to the referenced items. */
761
1057
  propertyName: string;
@@ -766,6 +1062,19 @@ interface BulkReplaceReferencesOptions {
766
1062
  /** ID of the collection containing the referring item. */
767
1063
  dataCollectionId?: string;
768
1064
  }
1065
+ /**
1066
+ * Removes one or more references.
1067
+ * @internal
1068
+ * @documentationMaturity preview
1069
+ * @requiredField options.references
1070
+ * @requiredField options.references.propertyName
1071
+ * @permissionId WIX_DATA.REMOVE
1072
+ * @applicableIdentity APP
1073
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.BulkRemoveReferences
1074
+ * @deprecated
1075
+ * @targetRemovalDate 2025-06-01
1076
+ */
1077
+ declare function bulkRemoveReferences(options?: NonNullablePaths<BulkRemoveReferencesOptions, `references` | `references.${number}.propertyName`>): Promise<void>;
769
1078
  interface BulkRemoveReferencesOptions {
770
1079
  /**
771
1080
  * References to be removed.
@@ -775,6 +1084,19 @@ interface BulkRemoveReferencesOptions {
775
1084
  /** ID of the collection containing the referring item. */
776
1085
  dataCollectionId?: string;
777
1086
  }
1087
+ /**
1088
+ * Checks if a specific property of a referring item contains a reference to another specific item.
1089
+ * @internal
1090
+ * @documentationMaturity preview
1091
+ * @requiredField options.propertyName
1092
+ * @requiredField options.referencedItemId
1093
+ * @requiredField options.referringItemId
1094
+ * @permissionId WIX_DATA.FIND
1095
+ * @fqn com.wixpress.cloud.data.api.dataservice.WixDataService.IsReferenced
1096
+ * @deprecated
1097
+ * @targetRemovalDate 2025-06-01
1098
+ */
1099
+ declare function isReferenced(options?: NonNullablePaths<IsReferencedOptions, `propertyName` | `referencedItemId` | `referringItemId`>): Promise<NonNullablePaths<IsReferencedResponse, `isReferenced`>>;
778
1100
  interface IsReferencedOptions {
779
1101
  /** Property that may contain a reference to the specified item. */
780
1102
  propertyName: string;
@@ -786,4 +1108,4 @@ interface IsReferencedOptions {
786
1108
  dataCollectionId?: string;
787
1109
  }
788
1110
 
789
- export { type Sorting as $, type AggregateOptions as A, type BulkInsertOptions as B, type CountOptions as C, type DistinctOptions as D, type InsertRequest as E, type Options as F, type GetOptions as G, type UpdateRequest as H, type InsertOptions as I, type SaveRequest as J, type PatchResponse as K, type PatchWhereRequest as L, type PatchWhereResponse as M, type GetRequest as N, Order as O, type PatchRequest as P, type QueryOptions as Q, type RemoveOptions as R, type SaveOptions as S, type TruncateOptions as T, type UpdateOptions as U, type ReadOptions as V, type RemoveRequest as W, type TruncateRequest as X, type TruncateResponse as Y, type QueryRequest as Z, type Query as _, type InsertResponse as a, type Paging as a0, type QueryV2 as a1, type QueryV2PagingMethodOneOf as a2, type CursorPaging as a3, type PagingMetadataV2 as a4, type Cursors as a5, type AggregationRequest as a6, type CountRequest as a7, type DistinctRequest as a8, type BulkInsertRequest as a9, type BulkError as aa, type ApplicationError as ab, type Details as ac, type BulkSaveRequest as ad, type BulkUpdateRequest as ae, type BulkPatchRequest as af, type Entry as ag, type BulkPatchResponse as ah, type BulkRemoveRequest as ai, type BulkRemoveRequestEntry as aj, type QueryReferencedRequest as ak, type ReferencedEntity as al, type ReferencedEntityEntityOneOf as am, type BulkInsertReferencesRequest as an, type Reference as ao, type BulkInsertReferencesResponse as ap, type BulkReplaceReferencesRequest as aq, type BulkReplaceReferencesResponse as ar, type BulkRemoveReferencesRequest as as, type BulkRemoveReferencesResponse as at, type IsReferencedRequest as au, type RestoreFromTrashBinRequest as av, type RestoreFromTrashBinResponse as aw, type UpdateResponse as b, type SaveResponse as c, type GetResponse as d, type RemoveResponse as e, type QueryResponse as f, type AggregationResponse as g, type CountResponse as h, type DistinctResponse as i, type BulkInsertResponse as j, type BulkSaveOptions as k, type BulkSaveResponse as l, type BulkUpdateOptions as m, type BulkUpdateResponse as n, type BulkRemoveOptions as o, type BulkRemoveResponse as p, type QueryReferencedOptions as q, type QueryReferencedResponse as r, type BulkInsertReferencesOptions as s, type BulkReplaceReferencesOptions as t, type BulkRemoveReferencesOptions as u, type IsReferencedOptions as v, type IsReferencedResponse as w, Segment as x, SortOrder as y, type Item as z };
1111
+ export { type AggregateOptions, type AggregationRequest, type AggregationResponse, type ApplicationError, type BulkError, type BulkInsertOptions, type BulkInsertReferencesOptions, type BulkInsertReferencesRequest, type BulkInsertReferencesResponse, type BulkInsertRequest, type BulkInsertResponse, type BulkPatchRequest, type BulkPatchResponse, type BulkRemoveOptions, type BulkRemoveReferencesOptions, type BulkRemoveReferencesRequest, type BulkRemoveReferencesResponse, type BulkRemoveRequest, type BulkRemoveRequestEntry, type BulkRemoveResponse, type BulkReplaceReferencesOptions, type BulkReplaceReferencesRequest, type BulkReplaceReferencesResponse, type BulkSaveOptions, type BulkSaveRequest, type BulkSaveResponse, type BulkUpdateOptions, type BulkUpdateRequest, type BulkUpdateResponse, type CountOptions, type CountRequest, type CountResponse, type CursorPaging, type Cursors, type Details, type DistinctOptions, type DistinctRequest, type DistinctResponse, type Entry, type GetOptions, type GetRequest, type GetResponse, type InsertOptions, type InsertRequest, type InsertResponse, type IsReferencedOptions, type IsReferencedRequest, type IsReferencedResponse, type Item, type Options, Order, type OrderWithLiterals, type Paging, type PagingMetadataV2, type PatchRequest, type PatchResponse, type PatchWhereRequest, type PatchWhereResponse, type Query, type QueryOptions, type QueryReferencedOptions, type QueryReferencedRequest, type QueryReferencedResponse, type QueryRequest, type QueryResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReadOptions, type Reference, type ReferencedEntity, type ReferencedEntityEntityOneOf, type RemoveOptions, type RemoveRequest, type RemoveResponse, type RestoreFromTrashBinRequest, type RestoreFromTrashBinResponse, type SaveOptions, type SaveRequest, type SaveResponse, Segment, type SegmentWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type TruncateOptions, type TruncateRequest, type TruncateResponse, type UpdateOptions, type UpdateRequest, type UpdateResponse, aggregate, bulkInsert, bulkInsertReferences, bulkRemove, bulkRemoveReferences, bulkReplaceReferences, bulkSave, bulkUpdate, count, distinct, get, insert, isReferenced, query, queryReferenced, remove, save, truncate, update };