@wix/auto_sdk_benefit-programs_items 1.0.32 → 1.0.34

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.
@@ -664,7 +664,6 @@ type CountItemsApplicationErrors = {
664
664
  * Creates a benefit item.
665
665
  * @param item - Item to create.
666
666
  * @public
667
- * @documentationMaturity preview
668
667
  * @requiredField item
669
668
  * @requiredField item.externalId
670
669
  * @requiredField item.itemSetId
@@ -680,7 +679,6 @@ declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSet
680
679
  * Creates benefit items.
681
680
  * @param items - Items to create.
682
681
  * @public
683
- * @documentationMaturity preview
684
682
  * @requiredField items
685
683
  * @requiredField items.externalId
686
684
  * @requiredField items.itemSetId
@@ -709,7 +707,6 @@ interface BulkCreateItemsOptions {
709
707
  * </blockquote>
710
708
  * @param itemId - Item ID.
711
709
  * @public
712
- * @documentationMaturity preview
713
710
  * @requiredField itemId
714
711
  * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
715
712
  * @applicableIdentity APP
@@ -726,7 +723,6 @@ declare function deleteItem(itemId: string): Promise<void>;
726
723
  * </blockquote>
727
724
  * @param itemIds - List of IDs of the items to delete.
728
725
  * @public
729
- * @documentationMaturity preview
730
726
  * @requiredField itemIds
731
727
  * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
732
728
  * @applicableIdentity APP
@@ -745,7 +741,6 @@ declare function bulkDeleteItems(itemIds: string[]): Promise<NonNullablePaths<Bu
745
741
  * </blockquote>
746
742
  * @param namespace - Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
747
743
  * @public
748
- * @documentationMaturity preview
749
744
  * @requiredField namespace
750
745
  * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
751
746
  * @applicableIdentity APP
@@ -766,7 +761,6 @@ interface BulkDeleteItemsByFilterOptions {
766
761
  * and prevents unintended overwrites.
767
762
  * @param _id - Benefit item ID.
768
763
  * @public
769
- * @documentationMaturity preview
770
764
  * @requiredField _id
771
765
  * @requiredField item
772
766
  * @requiredField item.revision
@@ -860,7 +854,6 @@ interface UpdateItem {
860
854
  * This ensures you're working with the latest benefit item
861
855
  * and prevents unintended overwrites.
862
856
  * @public
863
- * @documentationMaturity preview
864
857
  * @requiredField options.items.item
865
858
  * @requiredField options.items.item._id
866
859
  * @requiredField options.items.item.revision
@@ -887,7 +880,6 @@ interface BulkUpdateItemsOptions {
887
880
  * Retrieves a benefit item.
888
881
  * @param itemId - ID of the item to retrieve.
889
882
  * @public
890
- * @documentationMaturity preview
891
883
  * @requiredField itemId
892
884
  * @permissionId BENEFIT_PROGRAMS.ITEM_READ
893
885
  * @applicableIdentity APP
@@ -898,7 +890,6 @@ declare function getItem(itemId: string): Promise<Item>;
898
890
  /**
899
891
  * Retrieves a list of up to 1000 benefit items.
900
892
  * @public
901
- * @documentationMaturity preview
902
893
  * @permissionId BENEFIT_PROGRAMS.ITEM_READ
903
894
  * @applicableIdentity APP
904
895
  * @fqn wix.benefit_programs.v1.item.ItemService.ListItems
@@ -923,7 +914,6 @@ interface ListItemsOptions {
923
914
  *
924
915
  * For a full description of the item object, see the object returned for the `items` property in `ItemsQueryResult`.
925
916
  * @public
926
- * @documentationMaturity preview
927
917
  * @permissionId BENEFIT_PROGRAMS.ITEM_READ
928
918
  * @applicableIdentity APP
929
919
  * @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
@@ -945,65 +935,46 @@ interface ItemsQueryResult extends QueryCursorResult {
945
935
  interface ItemsQueryBuilder {
946
936
  /** @param propertyName - Property whose value is compared with `value`.
947
937
  * @param value - Value to compare against.
948
- * @documentationMaturity preview
949
938
  */
950
939
  eq: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
951
940
  /** @param propertyName - Property whose value is compared with `value`.
952
941
  * @param value - Value to compare against.
953
- * @documentationMaturity preview
954
942
  */
955
943
  ne: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
956
944
  /** @param propertyName - Property whose value is compared with `value`.
957
945
  * @param value - Value to compare against.
958
- * @documentationMaturity preview
959
946
  */
960
947
  ge: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
961
948
  /** @param propertyName - Property whose value is compared with `value`.
962
949
  * @param value - Value to compare against.
963
- * @documentationMaturity preview
964
950
  */
965
951
  gt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
966
952
  /** @param propertyName - Property whose value is compared with `value`.
967
953
  * @param value - Value to compare against.
968
- * @documentationMaturity preview
969
954
  */
970
955
  le: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
971
956
  /** @param propertyName - Property whose value is compared with `value`.
972
957
  * @param value - Value to compare against.
973
- * @documentationMaturity preview
974
958
  */
975
959
  lt: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
976
960
  /** @param propertyName - Property whose value is compared with `string`.
977
961
  * @param string - String to compare against. Case-insensitive.
978
- * @documentationMaturity preview
979
962
  */
980
963
  startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: string) => ItemsQueryBuilder;
981
964
  /** @param propertyName - Property whose value is compared with `values`.
982
965
  * @param values - List of values to compare against.
983
- * @documentationMaturity preview
984
966
  */
985
967
  hasSome: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any[]) => ItemsQueryBuilder;
986
- /** @documentationMaturity preview */
987
968
  in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: any) => ItemsQueryBuilder;
988
- /** @documentationMaturity preview */
989
969
  exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace', value: boolean) => ItemsQueryBuilder;
990
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
991
- * @documentationMaturity preview
992
- */
970
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
993
971
  ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace'>) => ItemsQueryBuilder;
994
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
995
- * @documentationMaturity preview
996
- */
972
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
997
973
  descending: (...propertyNames: Array<'_id' | '_createdDate' | 'externalId' | 'category' | 'itemSetId' | 'providerAppId' | 'namespace'>) => ItemsQueryBuilder;
998
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
999
- * @documentationMaturity preview
1000
- */
974
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1001
975
  limit: (limit: number) => ItemsQueryBuilder;
1002
- /** @param cursor - A pointer to specific record
1003
- * @documentationMaturity preview
1004
- */
976
+ /** @param cursor - A pointer to specific record */
1005
977
  skipTo: (cursor: string) => ItemsQueryBuilder;
1006
- /** @documentationMaturity preview */
1007
978
  find: () => Promise<ItemsQueryResult>;
1008
979
  }
1009
980
  /**
@@ -1011,7 +982,6 @@ interface ItemsQueryBuilder {
1011
982
  *
1012
983
  * For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
1013
984
  * @public
1014
- * @documentationMaturity preview
1015
985
  * @permissionId BENEFIT_PROGRAMS.ITEM_READ
1016
986
  * @applicableIdentity APP
1017
987
  * @fqn wix.benefit_programs.v1.item.ItemService.CountItems
@@ -14,7 +14,132 @@ import { transformSDKFieldMaskToRESTFieldMask } from "@wix/sdk-runtime/transform
14
14
  import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
15
15
  import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
16
16
  function resolveWixBenefitProgramsV1ItemItemServiceUrl(opts) {
17
- const domainToMappings = {};
17
+ const domainToMappings = {
18
+ _: [
19
+ {
20
+ srcPath: "/_api/benefit-programs-items",
21
+ destPath: ""
22
+ },
23
+ {
24
+ srcPath: "/_api/benefit-programs/v1/items",
25
+ destPath: "/v1/items"
26
+ },
27
+ {
28
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
29
+ destPath: "/v1/bulk/items"
30
+ }
31
+ ],
32
+ "editor._base_domain_": [
33
+ {
34
+ srcPath: "/_api/benefit-programs-items",
35
+ destPath: ""
36
+ },
37
+ {
38
+ srcPath: "/_api/benefit-programs/v1/items",
39
+ destPath: "/v1/items"
40
+ },
41
+ {
42
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
43
+ destPath: "/v1/bulk/items"
44
+ }
45
+ ],
46
+ "blocks._base_domain_": [
47
+ {
48
+ srcPath: "/_api/benefit-programs-items",
49
+ destPath: ""
50
+ },
51
+ {
52
+ srcPath: "/_api/benefit-programs/v1/items",
53
+ destPath: "/v1/items"
54
+ },
55
+ {
56
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
57
+ destPath: "/v1/bulk/items"
58
+ }
59
+ ],
60
+ "create.editorx": [
61
+ {
62
+ srcPath: "/_api/benefit-programs-items",
63
+ destPath: ""
64
+ },
65
+ {
66
+ srcPath: "/_api/benefit-programs/v1/items",
67
+ destPath: "/v1/items"
68
+ },
69
+ {
70
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
71
+ destPath: "/v1/bulk/items"
72
+ }
73
+ ],
74
+ "editor.wixapps.net": [
75
+ {
76
+ srcPath: "/_api/benefit-programs-items",
77
+ destPath: ""
78
+ },
79
+ {
80
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
81
+ destPath: "/v1/bulk/items"
82
+ },
83
+ {
84
+ srcPath: "/_api/benefit-programs/v1/items",
85
+ destPath: "/v1/items"
86
+ }
87
+ ],
88
+ "manage._base_domain_": [
89
+ {
90
+ srcPath: "/_api/benefit-programs-items",
91
+ destPath: ""
92
+ },
93
+ {
94
+ srcPath: "/_api/benefit-programs/v1/items",
95
+ destPath: "/v1/items"
96
+ },
97
+ {
98
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
99
+ destPath: "/v1/bulk/items"
100
+ }
101
+ ],
102
+ "www._base_domain_": [
103
+ {
104
+ srcPath: "/_api/benefit-programs-items",
105
+ destPath: ""
106
+ },
107
+ {
108
+ srcPath: "/_api/benefit-programs/v1/items",
109
+ destPath: "/v1/items"
110
+ },
111
+ {
112
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
113
+ destPath: "/v1/bulk/items"
114
+ }
115
+ ],
116
+ "api._api_base_domain_": [
117
+ {
118
+ srcPath: "/benefit-programs-items",
119
+ destPath: ""
120
+ }
121
+ ],
122
+ "www.wixapis.com": [
123
+ {
124
+ srcPath: "/benefit-programs/v1/items",
125
+ destPath: "/v1/items"
126
+ },
127
+ {
128
+ srcPath: "/benefit-programs/v1/bulk/items",
129
+ destPath: "/v1/bulk/items"
130
+ }
131
+ ],
132
+ "*.dev.wix-code.com": [
133
+ {
134
+ srcPath: "/_api/benefit-programs/v1/items",
135
+ destPath: "/v1/items"
136
+ },
137
+ {
138
+ srcPath: "/_api/benefit-programs/v1/bulk/items",
139
+ destPath: "/v1/bulk/items"
140
+ }
141
+ ]
142
+ };
18
143
  return resolveUrl(Object.assign(opts, { domainToMappings }));
19
144
  }
20
145
  var PACKAGE_NAME = "@wix/auto_sdk_benefit-programs_items";