@wix/auto_sdk_benefit-programs_items 1.0.11 → 1.0.12

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 (130) hide show
  1. package/build/{internal/cjs/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.mts} +96 -289
  2. package/build/{internal/es/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.ts} +96 -289
  3. package/build/index.d.mts +149 -0
  4. package/build/index.d.ts +149 -0
  5. package/build/index.js +906 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +869 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/benefit-programs-v1-item-items.universal.d.ts → internal/benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.mts} +96 -289
  10. package/build/{es/src/benefit-programs-v1-item-items.universal.d.ts → internal/benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.ts} +96 -289
  11. package/build/internal/index.d.mts +149 -0
  12. package/build/internal/index.d.ts +149 -0
  13. package/build/internal/index.js +906 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +869 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/{es/src/benefit-programs-v1-item-items.types.d.ts → internal/meta.d.mts} +88 -272
  18. package/build/internal/{es/src/benefit-programs-v1-item-items.types.d.ts → meta.d.ts} +88 -272
  19. package/build/internal/meta.js +684 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +647 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/{internal/cjs/src/benefit-programs-v1-item-items.types.d.ts → meta.d.mts} +88 -272
  24. package/build/{cjs/src/benefit-programs-v1-item-items.types.d.ts → meta.d.ts} +88 -272
  25. package/build/meta.js +684 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +647 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/benefit-programs-v1-item-items.context.d.ts +0 -15
  40. package/build/cjs/src/benefit-programs-v1-item-items.context.js +0 -21
  41. package/build/cjs/src/benefit-programs-v1-item-items.context.js.map +0 -1
  42. package/build/cjs/src/benefit-programs-v1-item-items.http.d.ts +0 -59
  43. package/build/cjs/src/benefit-programs-v1-item-items.http.js +0 -494
  44. package/build/cjs/src/benefit-programs-v1-item-items.http.js.map +0 -1
  45. package/build/cjs/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
  46. package/build/cjs/src/benefit-programs-v1-item-items.meta.js +0 -237
  47. package/build/cjs/src/benefit-programs-v1-item-items.meta.js.map +0 -1
  48. package/build/cjs/src/benefit-programs-v1-item-items.public.d.ts +0 -119
  49. package/build/cjs/src/benefit-programs-v1-item-items.public.js +0 -76
  50. package/build/cjs/src/benefit-programs-v1-item-items.public.js.map +0 -1
  51. package/build/cjs/src/benefit-programs-v1-item-items.types.js +0 -26
  52. package/build/cjs/src/benefit-programs-v1-item-items.types.js.map +0 -1
  53. package/build/cjs/src/benefit-programs-v1-item-items.universal.js +0 -523
  54. package/build/cjs/src/benefit-programs-v1-item-items.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/benefit-programs-v1-item-items.context.d.ts +0 -15
  66. package/build/es/src/benefit-programs-v1-item-items.context.js +0 -15
  67. package/build/es/src/benefit-programs-v1-item-items.context.js.map +0 -1
  68. package/build/es/src/benefit-programs-v1-item-items.http.d.ts +0 -59
  69. package/build/es/src/benefit-programs-v1-item-items.http.js +0 -480
  70. package/build/es/src/benefit-programs-v1-item-items.http.js.map +0 -1
  71. package/build/es/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
  72. package/build/es/src/benefit-programs-v1-item-items.meta.js +0 -200
  73. package/build/es/src/benefit-programs-v1-item-items.meta.js.map +0 -1
  74. package/build/es/src/benefit-programs-v1-item-items.public.d.ts +0 -119
  75. package/build/es/src/benefit-programs-v1-item-items.public.js +0 -59
  76. package/build/es/src/benefit-programs-v1-item-items.public.js.map +0 -1
  77. package/build/es/src/benefit-programs-v1-item-items.types.js +0 -23
  78. package/build/es/src/benefit-programs-v1-item-items.types.js.map +0 -1
  79. package/build/es/src/benefit-programs-v1-item-items.universal.js +0 -486
  80. package/build/es/src/benefit-programs-v1-item-items.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/benefit-programs-v1-item-items.context.d.ts +0 -15
  91. package/build/internal/cjs/src/benefit-programs-v1-item-items.context.js +0 -21
  92. package/build/internal/cjs/src/benefit-programs-v1-item-items.context.js.map +0 -1
  93. package/build/internal/cjs/src/benefit-programs-v1-item-items.http.d.ts +0 -59
  94. package/build/internal/cjs/src/benefit-programs-v1-item-items.http.js +0 -494
  95. package/build/internal/cjs/src/benefit-programs-v1-item-items.http.js.map +0 -1
  96. package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
  97. package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.js +0 -237
  98. package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.js.map +0 -1
  99. package/build/internal/cjs/src/benefit-programs-v1-item-items.public.d.ts +0 -119
  100. package/build/internal/cjs/src/benefit-programs-v1-item-items.public.js +0 -76
  101. package/build/internal/cjs/src/benefit-programs-v1-item-items.public.js.map +0 -1
  102. package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js +0 -26
  103. package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js.map +0 -1
  104. package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js +0 -523
  105. package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/benefit-programs-v1-item-items.context.d.ts +0 -15
  116. package/build/internal/es/src/benefit-programs-v1-item-items.context.js +0 -15
  117. package/build/internal/es/src/benefit-programs-v1-item-items.context.js.map +0 -1
  118. package/build/internal/es/src/benefit-programs-v1-item-items.http.d.ts +0 -59
  119. package/build/internal/es/src/benefit-programs-v1-item-items.http.js +0 -480
  120. package/build/internal/es/src/benefit-programs-v1-item-items.http.js.map +0 -1
  121. package/build/internal/es/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
  122. package/build/internal/es/src/benefit-programs-v1-item-items.meta.js +0 -200
  123. package/build/internal/es/src/benefit-programs-v1-item-items.meta.js.map +0 -1
  124. package/build/internal/es/src/benefit-programs-v1-item-items.public.d.ts +0 -119
  125. package/build/internal/es/src/benefit-programs-v1-item-items.public.js +0 -59
  126. package/build/internal/es/src/benefit-programs-v1-item-items.public.js.map +0 -1
  127. package/build/internal/es/src/benefit-programs-v1-item-items.types.js +0 -23
  128. package/build/internal/es/src/benefit-programs-v1-item-items.types.js.map +0 -1
  129. package/build/internal/es/src/benefit-programs-v1-item-items.universal.js +0 -486
  130. package/build/internal/es/src/benefit-programs-v1-item-items.universal.js.map +0 -1
@@ -1,17 +1,16 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface Item {
1
+ interface Item {
3
2
  /**
4
- * Item ID.
3
+ * Benefit item ID.
5
4
  * @format GUID
6
5
  * @immutable
7
6
  * @readonly
8
7
  */
9
8
  _id?: string | null;
10
9
  /**
11
- * Revision number, which increments by 1 each time the item is updated.
12
- * To prevent conflicting changes, the current revision must be passed when updating the item.
10
+ * Revision number, which increments by 1 each time the benefit item is updated.
11
+ * To prevent conflicting changes, the current revision must be passed when updating the benefit item.
13
12
  *
14
- * Ignored when creating an item.
13
+ * Ignored when creating a benefit item.
15
14
  * @readonly
16
15
  */
17
16
  revision?: string | null;
@@ -28,45 +27,45 @@ export interface Item {
28
27
  /**
29
28
  * ID of the item in the app providing it.
30
29
  *
31
- * For example, if the item is a product provided by Wix Stores, this would be the product ID.
30
+ * For example, if the item is a product provided by Wix Stores, the `externalId` would be the Wix Stores `product Id`.
32
31
  * @format GUID
33
32
  * @immutable
34
33
  * @readonly
35
34
  */
36
35
  externalId?: string | null;
37
36
  /**
38
- * Item category.
37
+ * Benefit item category.
39
38
  * @maxLength 20
40
39
  * @immutable
41
40
  * @readonly
42
41
  */
43
42
  category?: string | null;
44
43
  /**
45
- * Item set ID of the benefit that this item is a part of.
44
+ * Item set ID of the benefit that this benefit item is a part of.
46
45
  * @format GUID
47
46
  * @immutable
48
47
  * @readonly
49
48
  */
50
49
  itemSetId?: string | null;
51
50
  /**
52
- * Item name.
51
+ * Benefit item display name.
53
52
  * @maxLength 64
54
53
  */
55
54
  displayName?: string | null;
56
55
  /**
57
- * ID of the app that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`.
56
+ * ID of the app ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/apps-created-by-wix) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix)) that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`.
58
57
  * @format GUID
59
58
  * @immutable
60
59
  * @readonly
61
60
  */
62
61
  providerAppId?: string | null;
63
62
  /**
64
- * Custom field data for the item object.
63
+ * Custom field data for the benefit item object.
65
64
  * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
66
65
  */
67
66
  extendedFields?: ExtendedFields;
68
67
  /**
69
- * Namespace for your app or site's benefit programs.
68
+ * 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.
70
69
  * @minLength 1
71
70
  * @maxLength 50
72
71
  * @immutable
@@ -74,7 +73,7 @@ export interface Item {
74
73
  */
75
74
  namespace?: string | null;
76
75
  }
77
- export interface ExtendedFields {
76
+ interface ExtendedFields {
78
77
  /**
79
78
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
80
79
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -85,22 +84,22 @@ export interface ExtendedFields {
85
84
  */
86
85
  namespaces?: Record<string, Record<string, any>>;
87
86
  }
88
- export interface ItemsCloned {
87
+ interface ItemsCloned {
89
88
  /**
90
89
  * ID of the pool that had its items provisioned
91
90
  * @format GUID
92
91
  */
93
92
  itemSetId?: string;
94
93
  }
95
- export interface CreateItemRequest {
94
+ interface CreateItemRequest {
96
95
  /** Item to create. */
97
96
  item: Item;
98
97
  }
99
- export interface CreateItemResponse {
98
+ interface CreateItemResponse {
100
99
  /** Created item. */
101
100
  item?: Item;
102
101
  }
103
- export interface BulkCreateItemsRequest {
102
+ interface BulkCreateItemsRequest {
104
103
  /**
105
104
  * Items to create.
106
105
  * @minSize 1
@@ -114,7 +113,7 @@ export interface BulkCreateItemsRequest {
114
113
  */
115
114
  returnEntity?: boolean;
116
115
  }
117
- export interface BulkCreateItemsResponse {
116
+ interface BulkCreateItemsResponse {
118
117
  /**
119
118
  * List of created items and associated metadata.
120
119
  * @minSize 1
@@ -124,13 +123,13 @@ export interface BulkCreateItemsResponse {
124
123
  /** Bulk action metadata. */
125
124
  bulkActionMetadata?: BulkActionMetadata;
126
125
  }
127
- export interface BulkItemResult {
126
+ interface BulkItemResult {
128
127
  /** Item metadata. */
129
128
  itemMetadata?: ItemMetadata;
130
129
  /** Item. */
131
130
  item?: Item;
132
131
  }
133
- export interface ItemMetadata {
132
+ interface ItemMetadata {
134
133
  /**
135
134
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
136
135
  * @format GUID
@@ -143,7 +142,7 @@ export interface ItemMetadata {
143
142
  /** Details about the error in case of failure. */
144
143
  error?: ApplicationError;
145
144
  }
146
- export interface ApplicationError {
145
+ interface ApplicationError {
147
146
  /** Error code. */
148
147
  code?: string;
149
148
  /** Description of the error. */
@@ -151,7 +150,7 @@ export interface ApplicationError {
151
150
  /** Data related to the error. */
152
151
  data?: Record<string, any> | null;
153
152
  }
154
- export interface BulkActionMetadata {
153
+ interface BulkActionMetadata {
155
154
  /** Number of items that were successfully processed. */
156
155
  totalSuccesses?: number;
157
156
  /** Number of items that couldn't be processed. */
@@ -159,16 +158,16 @@ export interface BulkActionMetadata {
159
158
  /** Number of failures without details because detailed failure threshold was exceeded. */
160
159
  undetailedFailures?: number;
161
160
  }
162
- export interface DeleteItemRequest {
161
+ interface DeleteItemRequest {
163
162
  /**
164
163
  * Item ID.
165
164
  * @format GUID
166
165
  */
167
166
  itemId: string;
168
167
  }
169
- export interface DeleteItemResponse {
168
+ interface DeleteItemResponse {
170
169
  }
171
- export interface BulkDeleteItemsRequest {
170
+ interface BulkDeleteItemsRequest {
172
171
  /**
173
172
  * List of IDs of the items to delete.
174
173
  * @minSize 1
@@ -177,7 +176,7 @@ export interface BulkDeleteItemsRequest {
177
176
  */
178
177
  itemIds: string[];
179
178
  }
180
- export interface BulkDeleteItemsResponse {
179
+ interface BulkDeleteItemsResponse {
181
180
  /**
182
181
  * List of deleted items and associated metadata.
183
182
  * @minSize 1
@@ -187,9 +186,9 @@ export interface BulkDeleteItemsResponse {
187
186
  /** Bulk action metadata. */
188
187
  bulkActionMetadata?: BulkActionMetadata;
189
188
  }
190
- export interface BulkDeleteItemsByFilterRequest {
189
+ interface BulkDeleteItemsByFilterRequest {
191
190
  /**
192
- * Namespace for your app or site's benefit programs.
191
+ * 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.
193
192
  * @minLength 1
194
193
  * @maxLength 50
195
194
  */
@@ -197,22 +196,22 @@ export interface BulkDeleteItemsByFilterRequest {
197
196
  /** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
198
197
  filter?: Record<string, any> | null;
199
198
  }
200
- export interface BulkDeleteItemsByFilterResponse {
199
+ interface BulkDeleteItemsByFilterResponse {
201
200
  /**
202
- * Job ID for item deletion.
201
+ * Job ID for item deletion. Retrieve job details using the Async Job API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/async-jobs/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/async-job/introduction)).
203
202
  * @format GUID
204
203
  */
205
204
  jobId?: string;
206
205
  }
207
- export interface UpdateItemRequest {
206
+ interface UpdateItemRequest {
208
207
  /** Item to update. */
209
208
  item: Item;
210
209
  }
211
- export interface UpdateItemResponse {
210
+ interface UpdateItemResponse {
212
211
  /** Updated item. */
213
212
  item?: Item;
214
213
  }
215
- export interface BulkUpdateItemsRequest {
214
+ interface BulkUpdateItemsRequest {
216
215
  /**
217
216
  * Items to update.
218
217
  * @minSize 1
@@ -226,13 +225,13 @@ export interface BulkUpdateItemsRequest {
226
225
  */
227
226
  returnEntity?: boolean;
228
227
  }
229
- export interface MaskedItem {
228
+ interface MaskedItem {
230
229
  /** Item to update. */
231
230
  item?: Item;
232
231
  /** Explicit list of fields to update. */
233
232
  fieldMask?: string[];
234
233
  }
235
- export interface BulkUpdateItemsResponse {
234
+ interface BulkUpdateItemsResponse {
236
235
  /**
237
236
  * List of updated items and associated metadata.
238
237
  * @minSize 1
@@ -242,24 +241,24 @@ export interface BulkUpdateItemsResponse {
242
241
  /** Bulk action metadata. */
243
242
  bulkActionMetadata?: BulkActionMetadata;
244
243
  }
245
- export interface GetItemRequest {
244
+ interface GetItemRequest {
246
245
  /**
247
246
  * ID of the item to retrieve.
248
247
  * @format GUID
249
248
  */
250
249
  itemId: string;
251
250
  }
252
- export interface GetItemResponse {
251
+ interface GetItemResponse {
253
252
  /** Retrieved item. */
254
253
  item?: Item;
255
254
  }
256
- export interface ListItemsRequest {
255
+ interface ListItemsRequest {
257
256
  /** Filter. */
258
257
  filter?: Filter;
259
258
  /** Cursor paging */
260
259
  cursorPaging?: CursorPaging;
261
260
  }
262
- export declare enum Type {
261
+ declare enum Type {
263
262
  /** Unknown filter type. */
264
263
  UNKNOWN_FILTER = "UNKNOWN_FILTER",
265
264
  /** Use with `filter.byItemSetIdAndReferenceOptions`. */
@@ -267,7 +266,7 @@ export declare enum Type {
267
266
  /** Use with `filter.byReferenceOptions`. */
268
267
  BY_REFERENCE = "BY_REFERENCE"
269
268
  }
270
- export interface ByItemSetIdAndReference {
269
+ interface ByItemSetIdAndReference {
271
270
  /**
272
271
  * Filter list.
273
272
  * @minSize 1
@@ -275,7 +274,7 @@ export interface ByItemSetIdAndReference {
275
274
  */
276
275
  filters?: ByItemSetIdAndReferenceFilter[];
277
276
  }
278
- export interface ByItemSetIdAndReferenceFilter {
277
+ interface ByItemSetIdAndReferenceFilter {
279
278
  /**
280
279
  * ID set ID.
281
280
  * @format GUID
@@ -297,7 +296,7 @@ export interface ByItemSetIdAndReferenceFilter {
297
296
  */
298
297
  providerAppId?: string;
299
298
  }
300
- export interface ByReference {
299
+ interface ByReference {
301
300
  /**
302
301
  * Filter list.
303
302
  * @minSize 1
@@ -305,7 +304,7 @@ export interface ByReference {
305
304
  */
306
305
  filters?: ByReferenceFilter[];
307
306
  }
308
- export interface ByReferenceFilter {
307
+ interface ByReferenceFilter {
309
308
  /**
310
309
  * External item ID.
311
310
  * @format GUID
@@ -322,7 +321,7 @@ export interface ByReferenceFilter {
322
321
  */
323
322
  providerAppId?: string;
324
323
  }
325
- export interface Filter extends FilterFilterOneOf {
324
+ interface Filter extends FilterFilterOneOf {
326
325
  /** Filter the request by `itemSetId` and item reference. */
327
326
  byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
328
327
  /** Filter the request item reference. */
@@ -337,13 +336,13 @@ export interface Filter extends FilterFilterOneOf {
337
336
  namespace?: string;
338
337
  }
339
338
  /** @oneof */
340
- export interface FilterFilterOneOf {
339
+ interface FilterFilterOneOf {
341
340
  /** Filter the request by `itemSetId` and item reference. */
342
341
  byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
343
342
  /** Filter the request item reference. */
344
343
  byReferenceOptions?: ByReference;
345
344
  }
346
- export interface CursorPaging {
345
+ interface CursorPaging {
347
346
  /**
348
347
  * Maximum number of items to return.
349
348
  * @max 1000
@@ -358,13 +357,13 @@ export interface CursorPaging {
358
357
  */
359
358
  cursor?: string | null;
360
359
  }
361
- export interface ListItemsResponse {
360
+ interface ListItemsResponse {
362
361
  /** Items. */
363
362
  items?: Item[];
364
363
  /** Metadata for paginated results. */
365
364
  metadata?: CursorPagingMetadata;
366
365
  }
367
- export interface CursorPagingMetadata {
366
+ interface CursorPagingMetadata {
368
367
  /** Number of items returned in the response. */
369
368
  count?: number | null;
370
369
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -377,7 +376,7 @@ export interface CursorPagingMetadata {
377
376
  */
378
377
  hasNext?: boolean | null;
379
378
  }
380
- export interface Cursors {
379
+ interface Cursors {
381
380
  /**
382
381
  * Cursor string pointing to the next page in the list of results.
383
382
  * @maxLength 16000
@@ -389,11 +388,11 @@ export interface Cursors {
389
388
  */
390
389
  prev?: string | null;
391
390
  }
392
- export interface QueryItemsRequest {
391
+ interface QueryItemsRequest {
393
392
  /** Filter, sort, and paging to apply to the query. */
394
393
  query?: CursorQuery;
395
394
  }
396
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
395
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
397
396
  /** 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`. */
398
397
  cursorPaging?: CursorPaging;
399
398
  /**
@@ -413,11 +412,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
413
412
  sort?: Sorting[];
414
413
  }
415
414
  /** @oneof */
416
- export interface CursorQueryPagingMethodOneOf {
415
+ interface CursorQueryPagingMethodOneOf {
417
416
  /** 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`. */
418
417
  cursorPaging?: CursorPaging;
419
418
  }
420
- export interface Sorting {
419
+ interface Sorting {
421
420
  /**
422
421
  * Field to sort by.
423
422
  * @maxLength 512
@@ -426,17 +425,17 @@ export interface Sorting {
426
425
  /** Sort order. */
427
426
  order?: SortOrder;
428
427
  }
429
- export declare enum SortOrder {
428
+ declare enum SortOrder {
430
429
  ASC = "ASC",
431
430
  DESC = "DESC"
432
431
  }
433
- export interface QueryItemsResponse {
432
+ interface QueryItemsResponse {
434
433
  /** List of retrieved items. */
435
434
  items?: Item[];
436
435
  /** Metadata for paginated results. */
437
436
  metadata?: CursorPagingMetadata;
438
437
  }
439
- export interface CountItemsRequest {
438
+ interface CountItemsRequest {
440
439
  /**
441
440
  * Items to count.
442
441
  *
@@ -444,18 +443,18 @@ export interface CountItemsRequest {
444
443
  */
445
444
  filter?: Record<string, any> | null;
446
445
  }
447
- export interface CountItemsResponse {
446
+ interface CountItemsResponse {
448
447
  /** Number of items fulfilling the specified filter conditions. */
449
448
  count?: number;
450
449
  }
451
- export interface CloneItemsRequest {
450
+ interface CloneItemsRequest {
452
451
  /**
453
452
  * Id of the item set to be cloned
454
453
  * @format GUID
455
454
  */
456
455
  itemSetId?: string;
457
456
  }
458
- export interface CloneItemsResponse {
457
+ interface CloneItemsResponse {
459
458
  /**
460
459
  * Id of the item set that these items were added to
461
460
  * @format GUID
@@ -467,7 +466,7 @@ export interface CloneItemsResponse {
467
466
  */
468
467
  cloneJobId?: string;
469
468
  }
470
- export interface BulkCloneItemSetsRequest {
469
+ interface BulkCloneItemSetsRequest {
471
470
  /**
472
471
  * Id of the item sets to be cloned
473
472
  * @format GUID
@@ -476,7 +475,7 @@ export interface BulkCloneItemSetsRequest {
476
475
  */
477
476
  itemSetIds?: string[];
478
477
  }
479
- export interface BulkCloneItemSetsResponse {
478
+ interface BulkCloneItemSetsResponse {
480
479
  /**
481
480
  * Results
482
481
  * @minSize 1
@@ -491,7 +490,7 @@ export interface BulkCloneItemSetsResponse {
491
490
  */
492
491
  jobId?: string;
493
492
  }
494
- export interface BulkCloneItemSetsResult {
493
+ interface BulkCloneItemSetsResult {
495
494
  /** Item metadata */
496
495
  itemMetadata?: ItemMetadata;
497
496
  /**
@@ -500,7 +499,7 @@ export interface BulkCloneItemSetsResult {
500
499
  */
501
500
  clonedItemSetId?: string;
502
501
  }
503
- export interface AllocateItemSetsRequest {
502
+ interface AllocateItemSetsRequest {
504
503
  /**
505
504
  * Number of sets to allocate
506
505
  * @min 1
@@ -508,14 +507,14 @@ export interface AllocateItemSetsRequest {
508
507
  */
509
508
  numberOfSets?: number;
510
509
  }
511
- export interface AllocateItemSetsResponse {
510
+ interface AllocateItemSetsResponse {
512
511
  /**
513
512
  * ID that is a shared reference between a benefit pool and a specific item.
514
513
  * @format GUID
515
514
  */
516
515
  itemSetIds?: string[];
517
516
  }
518
- export interface DomainEvent extends DomainEventBodyOneOf {
517
+ interface DomainEvent extends DomainEventBodyOneOf {
519
518
  createdEvent?: EntityCreatedEvent;
520
519
  updatedEvent?: EntityUpdatedEvent;
521
520
  deletedEvent?: EntityDeletedEvent;
@@ -558,19 +557,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
558
557
  entityEventSequence?: string | null;
559
558
  }
560
559
  /** @oneof */
561
- export interface DomainEventBodyOneOf {
560
+ interface DomainEventBodyOneOf {
562
561
  createdEvent?: EntityCreatedEvent;
563
562
  updatedEvent?: EntityUpdatedEvent;
564
563
  deletedEvent?: EntityDeletedEvent;
565
564
  actionEvent?: ActionEvent;
566
565
  }
567
- export interface EntityCreatedEvent {
566
+ interface EntityCreatedEvent {
568
567
  entity?: string;
569
568
  }
570
- export interface RestoreInfo {
569
+ interface RestoreInfo {
571
570
  deletedDate?: Date | null;
572
571
  }
573
- export interface EntityUpdatedEvent {
572
+ interface EntityUpdatedEvent {
574
573
  /**
575
574
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
576
575
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -578,14 +577,14 @@ export interface EntityUpdatedEvent {
578
577
  */
579
578
  currentEntity?: string;
580
579
  }
581
- export interface EntityDeletedEvent {
580
+ interface EntityDeletedEvent {
582
581
  /** Entity that was deleted */
583
582
  deletedEntity?: string | null;
584
583
  }
585
- export interface ActionEvent {
584
+ interface ActionEvent {
586
585
  body?: string;
587
586
  }
588
- export interface MessageEnvelope {
587
+ interface MessageEnvelope {
589
588
  /**
590
589
  * App instance ID.
591
590
  * @format GUID
@@ -601,7 +600,7 @@ export interface MessageEnvelope {
601
600
  /** Stringify payload. */
602
601
  data?: string;
603
602
  }
604
- export interface IdentificationData extends IdentificationDataIdOneOf {
603
+ interface IdentificationData extends IdentificationDataIdOneOf {
605
604
  /**
606
605
  * ID of a site visitor that has not logged in to the site.
607
606
  * @format GUID
@@ -626,7 +625,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
626
625
  identityType?: WebhookIdentityType;
627
626
  }
628
627
  /** @oneof */
629
- export interface IdentificationDataIdOneOf {
628
+ interface IdentificationDataIdOneOf {
630
629
  /**
631
630
  * ID of a site visitor that has not logged in to the site.
632
631
  * @format GUID
@@ -648,49 +647,14 @@ export interface IdentificationDataIdOneOf {
648
647
  */
649
648
  appId?: string;
650
649
  }
651
- export declare enum WebhookIdentityType {
650
+ declare enum WebhookIdentityType {
652
651
  UNKNOWN = "UNKNOWN",
653
652
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
654
653
  MEMBER = "MEMBER",
655
654
  WIX_USER = "WIX_USER",
656
655
  APP = "APP"
657
656
  }
658
- /**
659
- * Creates an item.
660
- * @param item - Item to create.
661
- * @public
662
- * @documentationMaturity preview
663
- * @requiredField item
664
- * @requiredField item.externalId
665
- * @requiredField item.itemSetId
666
- * @requiredField item.namespace
667
- * @requiredField item.providerAppId
668
- * @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
669
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
670
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
671
- * @applicableIdentity APP
672
- * @returns Created item.
673
- * @fqn wix.benefit_programs.v1.item.ItemService.CreateItem
674
- */
675
- export declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`>): Promise<Item>;
676
- /**
677
- * Creates items.
678
- * @param items - Items to create.
679
- * @public
680
- * @documentationMaturity preview
681
- * @requiredField items
682
- * @requiredField items.externalId
683
- * @requiredField items.itemSetId
684
- * @requiredField items.namespace
685
- * @requiredField items.providerAppId
686
- * @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
687
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
688
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
689
- * @applicableIdentity APP
690
- * @fqn wix.benefit_programs.v1.item.ItemService.BulkCreateItems
691
- */
692
- export declare function bulkCreateItems(items: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`>[], options?: BulkCreateItemsOptions): Promise<NonNullablePaths<BulkCreateItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
693
- export interface BulkCreateItemsOptions {
657
+ interface BulkCreateItemsOptions {
694
658
  /**
695
659
  * Whether to return the full item entities.
696
660
  *
@@ -698,86 +662,23 @@ export interface BulkCreateItemsOptions {
698
662
  */
699
663
  returnEntity?: boolean;
700
664
  }
701
- /**
702
- * Deletes an item.
703
- * @param itemId - Item ID.
704
- * @public
705
- * @documentationMaturity preview
706
- * @requiredField itemId
707
- * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
708
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
709
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
710
- * @applicableIdentity APP
711
- * @fqn wix.benefit_programs.v1.item.ItemService.DeleteItem
712
- */
713
- export declare function deleteItem(itemId: string): Promise<void>;
714
- /**
715
- * Deletes items.
716
- * @param itemIds - List of IDs of the items to delete.
717
- * @public
718
- * @documentationMaturity preview
719
- * @requiredField itemIds
720
- * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
721
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
722
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
723
- * @applicableIdentity APP
724
- * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItems
725
- */
726
- export declare function bulkDeleteItems(itemIds: string[]): Promise<NonNullablePaths<BulkDeleteItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
727
- /**
728
- * Deletes items that fulfil the specified filter conditions.
729
- *
730
- * For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
731
- * @param namespace - Namespace for your app or site's benefit programs.
732
- * @public
733
- * @documentationMaturity preview
734
- * @requiredField namespace
735
- * @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
736
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
737
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
738
- * @applicableIdentity APP
739
- * @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItemsByFilter
740
- */
741
- export declare function bulkDeleteItemsByFilter(namespace: string, options?: BulkDeleteItemsByFilterOptions): Promise<NonNullablePaths<BulkDeleteItemsByFilterResponse, `jobId`>>;
742
- export interface BulkDeleteItemsByFilterOptions {
665
+ interface BulkDeleteItemsByFilterOptions {
743
666
  /** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
744
667
  filter?: Record<string, any> | null;
745
668
  }
746
- /**
747
- * Updates an item.
748
- *
749
- * Each time the item is updated,
750
- * `revision` increments by 1.
751
- * The current `revision` must be passed when updating the item.
752
- * This ensures you're working with the latest item
753
- * and prevents unintended overwrites.
754
- * @param _id - Item ID.
755
- * @public
756
- * @documentationMaturity preview
757
- * @requiredField _id
758
- * @requiredField item
759
- * @requiredField item.revision
760
- * @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
761
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
762
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
763
- * @applicableIdentity APP
764
- * @returns Updated item.
765
- * @fqn wix.benefit_programs.v1.item.ItemService.UpdateItem
766
- */
767
- export declare function updateItem(_id: string, item: NonNullablePaths<UpdateItem, `revision`>): Promise<Item>;
768
- export interface UpdateItem {
669
+ interface UpdateItem {
769
670
  /**
770
- * Item ID.
671
+ * Benefit item ID.
771
672
  * @format GUID
772
673
  * @immutable
773
674
  * @readonly
774
675
  */
775
676
  _id?: string | null;
776
677
  /**
777
- * Revision number, which increments by 1 each time the item is updated.
778
- * To prevent conflicting changes, the current revision must be passed when updating the item.
678
+ * Revision number, which increments by 1 each time the benefit item is updated.
679
+ * To prevent conflicting changes, the current revision must be passed when updating the benefit item.
779
680
  *
780
- * Ignored when creating an item.
681
+ * Ignored when creating a benefit item.
781
682
  * @readonly
782
683
  */
783
684
  revision?: string | null;
@@ -794,45 +695,45 @@ export interface UpdateItem {
794
695
  /**
795
696
  * ID of the item in the app providing it.
796
697
  *
797
- * For example, if the item is a product provided by Wix Stores, this would be the product ID.
698
+ * For example, if the item is a product provided by Wix Stores, the `externalId` would be the Wix Stores `product Id`.
798
699
  * @format GUID
799
700
  * @immutable
800
701
  * @readonly
801
702
  */
802
703
  externalId?: string | null;
803
704
  /**
804
- * Item category.
705
+ * Benefit item category.
805
706
  * @maxLength 20
806
707
  * @immutable
807
708
  * @readonly
808
709
  */
809
710
  category?: string | null;
810
711
  /**
811
- * Item set ID of the benefit that this item is a part of.
712
+ * Item set ID of the benefit that this benefit item is a part of.
812
713
  * @format GUID
813
714
  * @immutable
814
715
  * @readonly
815
716
  */
816
717
  itemSetId?: string | null;
817
718
  /**
818
- * Item name.
719
+ * Benefit item display name.
819
720
  * @maxLength 64
820
721
  */
821
722
  displayName?: string | null;
822
723
  /**
823
- * ID of the app that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`.
724
+ * ID of the app ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/apps-created-by-wix) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix)) that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`.
824
725
  * @format GUID
825
726
  * @immutable
826
727
  * @readonly
827
728
  */
828
729
  providerAppId?: string | null;
829
730
  /**
830
- * Custom field data for the item object.
731
+ * Custom field data for the benefit item object.
831
732
  * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
832
733
  */
833
734
  extendedFields?: ExtendedFields;
834
735
  /**
835
- * Namespace for your app or site's benefit programs.
736
+ * 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.
836
737
  * @minLength 1
837
738
  * @maxLength 50
838
739
  * @immutable
@@ -840,27 +741,7 @@ export interface UpdateItem {
840
741
  */
841
742
  namespace?: string | null;
842
743
  }
843
- /**
844
- * Updates items.
845
- *
846
- * Each time the item is updated,
847
- * `revision` increments by 1.
848
- * The current `revision` must be passed when updating the item.
849
- * This ensures you're working with the latest item
850
- * and prevents unintended overwrites.
851
- * @public
852
- * @documentationMaturity preview
853
- * @requiredField options.items.item
854
- * @requiredField options.items.item._id
855
- * @requiredField options.items.item.revision
856
- * @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
857
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
858
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
859
- * @applicableIdentity APP
860
- * @fqn wix.benefit_programs.v1.item.ItemService.BulkUpdateItems
861
- */
862
- export declare function bulkUpdateItems(options?: NonNullablePaths<BulkUpdateItemsOptions, `items.${number}.item` | `items.${number}.item._id` | `items.${number}.item.revision`>): Promise<NonNullablePaths<BulkUpdateItemsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
863
- export interface BulkUpdateItemsOptions {
744
+ interface BulkUpdateItemsOptions {
864
745
  /**
865
746
  * Items to update.
866
747
  * @minSize 1
@@ -874,70 +755,12 @@ export interface BulkUpdateItemsOptions {
874
755
  */
875
756
  returnEntity?: boolean;
876
757
  }
877
- /**
878
- * Retrieves a benefit item.
879
- * @param itemId - ID of the item to retrieve.
880
- * @public
881
- * @documentationMaturity preview
882
- * @requiredField itemId
883
- * @permissionId BENEFIT_PROGRAMS.ITEM_READ
884
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
885
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
886
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
887
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
888
- * @permissionScope Manage Events
889
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
890
- * @applicableIdentity APP
891
- * @returns Retrieved item.
892
- * @fqn wix.benefit_programs.v1.item.ItemService.GetItem
893
- */
894
- export declare function getItem(itemId: string): Promise<Item>;
895
- /**
896
- * Retrieves a list of up to 1000 benefit items.
897
- * @public
898
- * @documentationMaturity preview
899
- * @permissionId BENEFIT_PROGRAMS.ITEM_READ
900
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
901
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
902
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
903
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
904
- * @permissionScope Manage Events
905
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
906
- * @applicableIdentity APP
907
- * @fqn wix.benefit_programs.v1.item.ItemService.ListItems
908
- */
909
- export declare function listItems(options?: ListItemsOptions): Promise<NonNullablePaths<ListItemsResponse, `items`>>;
910
- export interface ListItemsOptions {
758
+ interface ListItemsOptions {
911
759
  /** Filter. */
912
760
  filter?: Filter;
913
761
  /** Cursor paging */
914
762
  cursorPaging?: CursorPaging;
915
763
  }
916
- /**
917
- * Creates a query to retrieve a list of items.
918
- *
919
- * The Query Items method builds a query to retrieve a list of items and returns a `ItemsQueryBuilder` object.
920
- *
921
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
922
- *
923
- * You can refine the query by chaining `ItemsQueryBuilder` methods onto the query. `ItemsQueryBuilder` methods enable you to filter, sort, and control the results that Query Items returns.
924
- *
925
- * Query Items has a default paging limit of 50, which you can override.
926
- *
927
- * For a full description of the item object, see the object returned for the `items` property in `ItemsQueryResult`.
928
- * @public
929
- * @documentationMaturity preview
930
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
931
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
932
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
933
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
934
- * @permissionScope Manage Events
935
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
936
- * @permissionId BENEFIT_PROGRAMS.ITEM_READ
937
- * @applicableIdentity APP
938
- * @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
939
- */
940
- export declare function queryItems(): ItemsQueryBuilder;
941
764
  interface QueryCursorResult {
942
765
  cursors: Cursors;
943
766
  hasNext: () => boolean;
@@ -945,13 +768,13 @@ interface QueryCursorResult {
945
768
  length: number;
946
769
  pageSize: number;
947
770
  }
948
- export interface ItemsQueryResult extends QueryCursorResult {
771
+ interface ItemsQueryResult extends QueryCursorResult {
949
772
  items: Item[];
950
773
  query: ItemsQueryBuilder;
951
774
  next: () => Promise<ItemsQueryResult>;
952
775
  prev: () => Promise<ItemsQueryResult>;
953
776
  }
954
- export interface ItemsQueryBuilder {
777
+ interface ItemsQueryBuilder {
955
778
  /** @param propertyName - Property whose value is compared with `value`.
956
779
  * @param value - Value to compare against.
957
780
  * @documentationMaturity preview
@@ -1015,24 +838,7 @@ export interface ItemsQueryBuilder {
1015
838
  /** @documentationMaturity preview */
1016
839
  find: () => Promise<ItemsQueryResult>;
1017
840
  }
1018
- /**
1019
- * Counts how many items exist that fulfil the specified filtering conditions.
1020
- *
1021
- * For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
1022
- * @public
1023
- * @documentationMaturity preview
1024
- * @permissionId BENEFIT_PROGRAMS.ITEM_READ
1025
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
1026
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
1027
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
1028
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
1029
- * @permissionScope Manage Events
1030
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1031
- * @applicableIdentity APP
1032
- * @fqn wix.benefit_programs.v1.item.ItemService.CountItems
1033
- */
1034
- export declare function countItems(options?: CountItemsOptions): Promise<NonNullablePaths<CountItemsResponse, `count`>>;
1035
- export interface CountItemsOptions {
841
+ interface CountItemsOptions {
1036
842
  /**
1037
843
  * Items to count.
1038
844
  *
@@ -1040,4 +846,5 @@ export interface CountItemsOptions {
1040
846
  */
1041
847
  filter?: Record<string, any> | null;
1042
848
  }
1043
- export {};
849
+
850
+ export { type CloneItemsResponse as $, type ApplicationError as A, type BulkCreateItemsOptions as B, type CountItemsOptions as C, type DeleteItemRequest as D, type ExtendedFields as E, type ByReference as F, type GetItemRequest as G, type ByReferenceFilter as H, type Item as I, type Filter as J, type FilterFilterOneOf as K, type ListItemsOptions as L, type MaskedItem as M, type CursorPaging as N, type CursorPagingMetadata as O, type Cursors as P, type QueryItemsRequest as Q, type CursorQuery as R, SortOrder as S, Type as T, type UpdateItem as U, type CursorQueryPagingMethodOneOf as V, WebhookIdentityType as W, type Sorting as X, type QueryItemsResponse as Y, type CountItemsRequest as Z, type CloneItemsRequest as _, type BulkCreateItemsResponse as a, type BulkCloneItemSetsRequest as a0, type BulkCloneItemSetsResponse as a1, type BulkCloneItemSetsResult as a2, type AllocateItemSetsRequest as a3, type AllocateItemSetsResponse as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type ItemsQueryResult as af, type BulkDeleteItemsResponse as b, type BulkDeleteItemsByFilterOptions as c, type BulkDeleteItemsByFilterResponse as d, type BulkUpdateItemsOptions as e, type BulkUpdateItemsResponse as f, type ListItemsResponse as g, type ItemsQueryBuilder as h, type CountItemsResponse as i, type ItemsCloned as j, type CreateItemRequest as k, type CreateItemResponse as l, type BulkCreateItemsRequest as m, type BulkItemResult as n, type ItemMetadata as o, type BulkActionMetadata as p, type DeleteItemResponse as q, type BulkDeleteItemsRequest as r, type BulkDeleteItemsByFilterRequest as s, type UpdateItemRequest as t, type UpdateItemResponse as u, type BulkUpdateItemsRequest as v, type GetItemResponse as w, type ListItemsRequest as x, type ByItemSetIdAndReference as y, type ByItemSetIdAndReferenceFilter as z };