@wix/auto_sdk_benefit-programs_items 1.0.24 → 1.0.26
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.
- package/build/{internal/cjs/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-CkMjOEfX.d.mts} +79 -290
- package/build/{internal/es/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-CkMjOEfX.d.ts} +79 -290
- package/build/{cjs/src/benefit-programs-v1-item-items.public.d.ts → index.d.mts} +29 -17
- package/build/{es/src/benefit-programs-v1-item-items.public.d.ts → index.d.ts} +29 -17
- package/build/index.js +909 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +872 -0
- package/build/index.mjs.map +1 -0
- package/build/{cjs/src/benefit-programs-v1-item-items.universal.d.ts → internal/benefit-programs-v1-item-items.universal-CkMjOEfX.d.mts} +79 -290
- package/build/{es/src/benefit-programs-v1-item-items.universal.d.ts → internal/benefit-programs-v1-item-items.universal-CkMjOEfX.d.ts} +79 -290
- package/build/internal/{cjs/src/benefit-programs-v1-item-items.public.d.ts → index.d.mts} +29 -17
- package/build/internal/{es/src/benefit-programs-v1-item-items.public.d.ts → index.d.ts} +29 -17
- package/build/internal/index.js +909 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +872 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/{es/src/benefit-programs-v1-item-items.types.d.ts → meta.d.mts} +80 -258
- package/build/{es/src/benefit-programs-v1-item-items.types.d.ts → internal/meta.d.ts} +80 -258
- package/build/internal/meta.js +684 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +647 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{internal/cjs/src/benefit-programs-v1-item-items.types.d.ts → meta.d.mts} +80 -258
- package/build/{cjs/src/benefit-programs-v1-item-items.types.d.ts → meta.d.ts} +80 -258
- package/build/meta.js +684 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +647 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.context.d.ts +0 -15
- package/build/cjs/src/benefit-programs-v1-item-items.context.js +0 -21
- package/build/cjs/src/benefit-programs-v1-item-items.context.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.http.d.ts +0 -81
- package/build/cjs/src/benefit-programs-v1-item-items.http.js +0 -516
- package/build/cjs/src/benefit-programs-v1-item-items.http.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
- package/build/cjs/src/benefit-programs-v1-item-items.meta.js +0 -237
- package/build/cjs/src/benefit-programs-v1-item-items.meta.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.public.js +0 -76
- package/build/cjs/src/benefit-programs-v1-item-items.public.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.types.js +0 -26
- package/build/cjs/src/benefit-programs-v1-item-items.types.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-item-items.universal.js +0 -543
- package/build/cjs/src/benefit-programs-v1-item-items.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/benefit-programs-v1-item-items.context.d.ts +0 -15
- package/build/es/src/benefit-programs-v1-item-items.context.js +0 -15
- package/build/es/src/benefit-programs-v1-item-items.context.js.map +0 -1
- package/build/es/src/benefit-programs-v1-item-items.http.d.ts +0 -81
- package/build/es/src/benefit-programs-v1-item-items.http.js +0 -502
- package/build/es/src/benefit-programs-v1-item-items.http.js.map +0 -1
- package/build/es/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
- package/build/es/src/benefit-programs-v1-item-items.meta.js +0 -200
- package/build/es/src/benefit-programs-v1-item-items.meta.js.map +0 -1
- package/build/es/src/benefit-programs-v1-item-items.public.js +0 -59
- package/build/es/src/benefit-programs-v1-item-items.public.js.map +0 -1
- package/build/es/src/benefit-programs-v1-item-items.types.js +0 -23
- package/build/es/src/benefit-programs-v1-item-items.types.js.map +0 -1
- package/build/es/src/benefit-programs-v1-item-items.universal.js +0 -506
- package/build/es/src/benefit-programs-v1-item-items.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.context.d.ts +0 -15
- package/build/internal/cjs/src/benefit-programs-v1-item-items.context.js +0 -21
- package/build/internal/cjs/src/benefit-programs-v1-item-items.context.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.http.d.ts +0 -81
- package/build/internal/cjs/src/benefit-programs-v1-item-items.http.js +0 -516
- package/build/internal/cjs/src/benefit-programs-v1-item-items.http.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
- package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.js +0 -237
- package/build/internal/cjs/src/benefit-programs-v1-item-items.meta.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.public.js +0 -76
- package/build/internal/cjs/src/benefit-programs-v1-item-items.public.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js +0 -26
- package/build/internal/cjs/src/benefit-programs-v1-item-items.types.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js +0 -543
- package/build/internal/cjs/src/benefit-programs-v1-item-items.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.context.d.ts +0 -15
- package/build/internal/es/src/benefit-programs-v1-item-items.context.js +0 -15
- package/build/internal/es/src/benefit-programs-v1-item-items.context.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.http.d.ts +0 -81
- package/build/internal/es/src/benefit-programs-v1-item-items.http.js +0 -502
- package/build/internal/es/src/benefit-programs-v1-item-items.http.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.meta.d.ts +0 -29
- package/build/internal/es/src/benefit-programs-v1-item-items.meta.js +0 -200
- package/build/internal/es/src/benefit-programs-v1-item-items.meta.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.public.js +0 -59
- package/build/internal/es/src/benefit-programs-v1-item-items.public.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.types.js +0 -23
- package/build/internal/es/src/benefit-programs-v1-item-items.types.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.js +0 -506
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Item {
|
|
1
|
+
interface Item {
|
|
3
2
|
/**
|
|
4
3
|
* Benefit item ID.
|
|
5
4
|
* @format GUID
|
|
@@ -68,13 +67,13 @@ export interface Item {
|
|
|
68
67
|
/**
|
|
69
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
|
-
* @maxLength
|
|
70
|
+
* @maxLength 20
|
|
72
71
|
* @immutable
|
|
73
72
|
* @readonly
|
|
74
73
|
*/
|
|
75
74
|
namespace?: string | null;
|
|
76
75
|
}
|
|
77
|
-
|
|
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
|
-
|
|
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
|
-
|
|
94
|
+
interface CreateItemRequest {
|
|
96
95
|
/** Item to create. */
|
|
97
96
|
item: Item;
|
|
98
97
|
}
|
|
99
|
-
|
|
98
|
+
interface CreateItemResponse {
|
|
100
99
|
/** Created item. */
|
|
101
100
|
item?: Item;
|
|
102
101
|
}
|
|
103
|
-
|
|
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
|
-
|
|
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
|
-
|
|
126
|
+
interface BulkItemResult {
|
|
128
127
|
/** Item metadata. */
|
|
129
128
|
itemMetadata?: ItemMetadata;
|
|
130
129
|
/** Item. */
|
|
131
130
|
item?: Item;
|
|
132
131
|
}
|
|
133
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
161
|
+
interface DeleteItemRequest {
|
|
163
162
|
/**
|
|
164
163
|
* Item ID.
|
|
165
164
|
* @format GUID
|
|
166
165
|
*/
|
|
167
166
|
itemId: string;
|
|
168
167
|
}
|
|
169
|
-
|
|
168
|
+
interface DeleteItemResponse {
|
|
170
169
|
}
|
|
171
|
-
|
|
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
|
-
|
|
179
|
+
interface BulkDeleteItemsResponse {
|
|
181
180
|
/**
|
|
182
181
|
* List of deleted items and associated metadata.
|
|
183
182
|
* @minSize 1
|
|
@@ -187,32 +186,32 @@ export interface BulkDeleteItemsResponse {
|
|
|
187
186
|
/** Bulk action metadata. */
|
|
188
187
|
bulkActionMetadata?: BulkActionMetadata;
|
|
189
188
|
}
|
|
190
|
-
|
|
189
|
+
interface BulkDeleteItemsByFilterRequest {
|
|
191
190
|
/**
|
|
192
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
|
-
* @maxLength
|
|
193
|
+
* @maxLength 20
|
|
195
194
|
*/
|
|
196
195
|
namespace: string;
|
|
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
|
-
|
|
199
|
+
interface BulkDeleteItemsByFilterResponse {
|
|
201
200
|
/**
|
|
202
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
|
-
|
|
206
|
+
interface UpdateItemRequest {
|
|
208
207
|
/** Item to update. */
|
|
209
208
|
item: Item;
|
|
210
209
|
}
|
|
211
|
-
|
|
210
|
+
interface UpdateItemResponse {
|
|
212
211
|
/** Updated item. */
|
|
213
212
|
item?: Item;
|
|
214
213
|
}
|
|
215
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
251
|
+
interface GetItemResponse {
|
|
253
252
|
/** Retrieved item. */
|
|
254
253
|
item?: Item;
|
|
255
254
|
}
|
|
256
|
-
|
|
255
|
+
interface ListItemsRequest {
|
|
257
256
|
/** Filter. */
|
|
258
257
|
filter?: Filter;
|
|
259
258
|
/** Cursor paging */
|
|
260
259
|
cursorPaging?: CursorPaging;
|
|
261
260
|
}
|
|
262
|
-
|
|
261
|
+
declare enum Type {
|
|
263
262
|
/** Unknown filter type. */
|
|
264
263
|
UNKNOWN_FILTER = "UNKNOWN_FILTER",
|
|
265
264
|
/** Use with `filter.byItemSetIdAndReferenceOptions`. */
|
|
@@ -268,8 +267,8 @@ export declare enum Type {
|
|
|
268
267
|
BY_REFERENCE = "BY_REFERENCE"
|
|
269
268
|
}
|
|
270
269
|
/** @enumType */
|
|
271
|
-
|
|
272
|
-
|
|
270
|
+
type TypeWithLiterals = Type | 'UNKNOWN_FILTER' | 'BY_ITEM_SET_ID_AND_REFERENCE' | 'BY_REFERENCE';
|
|
271
|
+
interface ByItemSetIdAndReference {
|
|
273
272
|
/**
|
|
274
273
|
* Filter list.
|
|
275
274
|
* @minSize 1
|
|
@@ -277,7 +276,7 @@ export interface ByItemSetIdAndReference {
|
|
|
277
276
|
*/
|
|
278
277
|
filters?: ByItemSetIdAndReferenceFilter[];
|
|
279
278
|
}
|
|
280
|
-
|
|
279
|
+
interface ByItemSetIdAndReferenceFilter {
|
|
281
280
|
/**
|
|
282
281
|
* ID set ID.
|
|
283
282
|
* @format GUID
|
|
@@ -299,7 +298,7 @@ export interface ByItemSetIdAndReferenceFilter {
|
|
|
299
298
|
*/
|
|
300
299
|
providerAppId?: string;
|
|
301
300
|
}
|
|
302
|
-
|
|
301
|
+
interface ByReference {
|
|
303
302
|
/**
|
|
304
303
|
* Filter list.
|
|
305
304
|
* @minSize 1
|
|
@@ -307,7 +306,7 @@ export interface ByReference {
|
|
|
307
306
|
*/
|
|
308
307
|
filters?: ByReferenceFilter[];
|
|
309
308
|
}
|
|
310
|
-
|
|
309
|
+
interface ByReferenceFilter {
|
|
311
310
|
/**
|
|
312
311
|
* External item ID.
|
|
313
312
|
* @format GUID
|
|
@@ -324,7 +323,7 @@ export interface ByReferenceFilter {
|
|
|
324
323
|
*/
|
|
325
324
|
providerAppId?: string;
|
|
326
325
|
}
|
|
327
|
-
|
|
326
|
+
interface Filter extends FilterFilterOneOf {
|
|
328
327
|
/** Filter the request by `itemSetId` and item reference. */
|
|
329
328
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
330
329
|
/** Filter the request item reference. */
|
|
@@ -334,18 +333,18 @@ export interface Filter extends FilterFilterOneOf {
|
|
|
334
333
|
/**
|
|
335
334
|
* Filter by namespace.
|
|
336
335
|
* @minLength 1
|
|
337
|
-
* @maxLength
|
|
336
|
+
* @maxLength 20
|
|
338
337
|
*/
|
|
339
338
|
namespace?: string;
|
|
340
339
|
}
|
|
341
340
|
/** @oneof */
|
|
342
|
-
|
|
341
|
+
interface FilterFilterOneOf {
|
|
343
342
|
/** Filter the request by `itemSetId` and item reference. */
|
|
344
343
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
345
344
|
/** Filter the request item reference. */
|
|
346
345
|
byReferenceOptions?: ByReference;
|
|
347
346
|
}
|
|
348
|
-
|
|
347
|
+
interface CursorPaging {
|
|
349
348
|
/**
|
|
350
349
|
* Maximum number of items to return.
|
|
351
350
|
* @max 1000
|
|
@@ -360,13 +359,13 @@ export interface CursorPaging {
|
|
|
360
359
|
*/
|
|
361
360
|
cursor?: string | null;
|
|
362
361
|
}
|
|
363
|
-
|
|
362
|
+
interface ListItemsResponse {
|
|
364
363
|
/** Items. */
|
|
365
364
|
items?: Item[];
|
|
366
365
|
/** Metadata for paginated results. */
|
|
367
366
|
metadata?: CursorPagingMetadata;
|
|
368
367
|
}
|
|
369
|
-
|
|
368
|
+
interface CursorPagingMetadata {
|
|
370
369
|
/** Number of items returned in the response. */
|
|
371
370
|
count?: number | null;
|
|
372
371
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -379,7 +378,7 @@ export interface CursorPagingMetadata {
|
|
|
379
378
|
*/
|
|
380
379
|
hasNext?: boolean | null;
|
|
381
380
|
}
|
|
382
|
-
|
|
381
|
+
interface Cursors {
|
|
383
382
|
/**
|
|
384
383
|
* Cursor string pointing to the next page in the list of results.
|
|
385
384
|
* @maxLength 16000
|
|
@@ -391,11 +390,11 @@ export interface Cursors {
|
|
|
391
390
|
*/
|
|
392
391
|
prev?: string | null;
|
|
393
392
|
}
|
|
394
|
-
|
|
393
|
+
interface QueryItemsRequest {
|
|
395
394
|
/** Filter, sort, and paging to apply to the query. */
|
|
396
395
|
query?: CursorQuery;
|
|
397
396
|
}
|
|
398
|
-
|
|
397
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
399
398
|
/** 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`. */
|
|
400
399
|
cursorPaging?: CursorPaging;
|
|
401
400
|
/**
|
|
@@ -415,11 +414,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
415
414
|
sort?: Sorting[];
|
|
416
415
|
}
|
|
417
416
|
/** @oneof */
|
|
418
|
-
|
|
417
|
+
interface CursorQueryPagingMethodOneOf {
|
|
419
418
|
/** 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`. */
|
|
420
419
|
cursorPaging?: CursorPaging;
|
|
421
420
|
}
|
|
422
|
-
|
|
421
|
+
interface Sorting {
|
|
423
422
|
/**
|
|
424
423
|
* Field to sort by.
|
|
425
424
|
* @maxLength 512
|
|
@@ -428,19 +427,19 @@ export interface Sorting {
|
|
|
428
427
|
/** Sort order. */
|
|
429
428
|
order?: SortOrderWithLiterals;
|
|
430
429
|
}
|
|
431
|
-
|
|
430
|
+
declare enum SortOrder {
|
|
432
431
|
ASC = "ASC",
|
|
433
432
|
DESC = "DESC"
|
|
434
433
|
}
|
|
435
434
|
/** @enumType */
|
|
436
|
-
|
|
437
|
-
|
|
435
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
436
|
+
interface QueryItemsResponse {
|
|
438
437
|
/** List of retrieved items. */
|
|
439
438
|
items?: Item[];
|
|
440
439
|
/** Metadata for paginated results. */
|
|
441
440
|
metadata?: CursorPagingMetadata;
|
|
442
441
|
}
|
|
443
|
-
|
|
442
|
+
interface CountItemsRequest {
|
|
444
443
|
/**
|
|
445
444
|
* Items to count.
|
|
446
445
|
*
|
|
@@ -448,18 +447,18 @@ export interface CountItemsRequest {
|
|
|
448
447
|
*/
|
|
449
448
|
filter?: Record<string, any> | null;
|
|
450
449
|
}
|
|
451
|
-
|
|
450
|
+
interface CountItemsResponse {
|
|
452
451
|
/** Number of items fulfilling the specified filter conditions. */
|
|
453
452
|
count?: number;
|
|
454
453
|
}
|
|
455
|
-
|
|
454
|
+
interface CloneItemsRequest {
|
|
456
455
|
/**
|
|
457
456
|
* Id of the item set to be cloned
|
|
458
457
|
* @format GUID
|
|
459
458
|
*/
|
|
460
459
|
itemSetId?: string;
|
|
461
460
|
}
|
|
462
|
-
|
|
461
|
+
interface CloneItemsResponse {
|
|
463
462
|
/**
|
|
464
463
|
* Id of the item set that these items were added to
|
|
465
464
|
* @format GUID
|
|
@@ -471,7 +470,7 @@ export interface CloneItemsResponse {
|
|
|
471
470
|
*/
|
|
472
471
|
cloneJobId?: string;
|
|
473
472
|
}
|
|
474
|
-
|
|
473
|
+
interface BulkCloneItemSetsRequest {
|
|
475
474
|
/**
|
|
476
475
|
* Id of the item sets to be cloned
|
|
477
476
|
* @format GUID
|
|
@@ -480,7 +479,7 @@ export interface BulkCloneItemSetsRequest {
|
|
|
480
479
|
*/
|
|
481
480
|
itemSetIds?: string[];
|
|
482
481
|
}
|
|
483
|
-
|
|
482
|
+
interface BulkCloneItemSetsResponse {
|
|
484
483
|
/**
|
|
485
484
|
* Results
|
|
486
485
|
* @minSize 1
|
|
@@ -495,7 +494,7 @@ export interface BulkCloneItemSetsResponse {
|
|
|
495
494
|
*/
|
|
496
495
|
jobId?: string;
|
|
497
496
|
}
|
|
498
|
-
|
|
497
|
+
interface BulkCloneItemSetsResult {
|
|
499
498
|
/** Item metadata */
|
|
500
499
|
itemMetadata?: ItemMetadata;
|
|
501
500
|
/**
|
|
@@ -504,7 +503,7 @@ export interface BulkCloneItemSetsResult {
|
|
|
504
503
|
*/
|
|
505
504
|
clonedItemSetId?: string;
|
|
506
505
|
}
|
|
507
|
-
|
|
506
|
+
interface AllocateItemSetsRequest {
|
|
508
507
|
/**
|
|
509
508
|
* Number of sets to allocate
|
|
510
509
|
* @min 1
|
|
@@ -512,14 +511,14 @@ export interface AllocateItemSetsRequest {
|
|
|
512
511
|
*/
|
|
513
512
|
numberOfSets?: number;
|
|
514
513
|
}
|
|
515
|
-
|
|
514
|
+
interface AllocateItemSetsResponse {
|
|
516
515
|
/**
|
|
517
516
|
* ID that is a shared reference between a benefit pool and a specific item.
|
|
518
517
|
* @format GUID
|
|
519
518
|
*/
|
|
520
519
|
itemSetIds?: string[];
|
|
521
520
|
}
|
|
522
|
-
|
|
521
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
523
522
|
createdEvent?: EntityCreatedEvent;
|
|
524
523
|
updatedEvent?: EntityUpdatedEvent;
|
|
525
524
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -554,19 +553,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
554
553
|
entityEventSequence?: string | null;
|
|
555
554
|
}
|
|
556
555
|
/** @oneof */
|
|
557
|
-
|
|
556
|
+
interface DomainEventBodyOneOf {
|
|
558
557
|
createdEvent?: EntityCreatedEvent;
|
|
559
558
|
updatedEvent?: EntityUpdatedEvent;
|
|
560
559
|
deletedEvent?: EntityDeletedEvent;
|
|
561
560
|
actionEvent?: ActionEvent;
|
|
562
561
|
}
|
|
563
|
-
|
|
562
|
+
interface EntityCreatedEvent {
|
|
564
563
|
entity?: string;
|
|
565
564
|
}
|
|
566
|
-
|
|
565
|
+
interface RestoreInfo {
|
|
567
566
|
deletedDate?: Date | null;
|
|
568
567
|
}
|
|
569
|
-
|
|
568
|
+
interface EntityUpdatedEvent {
|
|
570
569
|
/**
|
|
571
570
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
572
571
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -574,14 +573,14 @@ export interface EntityUpdatedEvent {
|
|
|
574
573
|
*/
|
|
575
574
|
currentEntity?: string;
|
|
576
575
|
}
|
|
577
|
-
|
|
576
|
+
interface EntityDeletedEvent {
|
|
578
577
|
/** Entity that was deleted. */
|
|
579
578
|
deletedEntity?: string | null;
|
|
580
579
|
}
|
|
581
|
-
|
|
580
|
+
interface ActionEvent {
|
|
582
581
|
body?: string;
|
|
583
582
|
}
|
|
584
|
-
|
|
583
|
+
interface MessageEnvelope {
|
|
585
584
|
/**
|
|
586
585
|
* App instance ID.
|
|
587
586
|
* @format GUID
|
|
@@ -597,7 +596,7 @@ export interface MessageEnvelope {
|
|
|
597
596
|
/** Stringify payload. */
|
|
598
597
|
data?: string;
|
|
599
598
|
}
|
|
600
|
-
|
|
599
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
601
600
|
/**
|
|
602
601
|
* ID of a site visitor that has not logged in to the site.
|
|
603
602
|
* @format GUID
|
|
@@ -622,7 +621,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
622
621
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
623
622
|
}
|
|
624
623
|
/** @oneof */
|
|
625
|
-
|
|
624
|
+
interface IdentificationDataIdOneOf {
|
|
626
625
|
/**
|
|
627
626
|
* ID of a site visitor that has not logged in to the site.
|
|
628
627
|
* @format GUID
|
|
@@ -644,7 +643,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
644
643
|
*/
|
|
645
644
|
appId?: string;
|
|
646
645
|
}
|
|
647
|
-
|
|
646
|
+
declare enum WebhookIdentityType {
|
|
648
647
|
UNKNOWN = "UNKNOWN",
|
|
649
648
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
650
649
|
MEMBER = "MEMBER",
|
|
@@ -652,43 +651,8 @@ export declare enum WebhookIdentityType {
|
|
|
652
651
|
APP = "APP"
|
|
653
652
|
}
|
|
654
653
|
/** @enumType */
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
* Creates a benefit item.
|
|
658
|
-
* @param item - Item to create.
|
|
659
|
-
* @public
|
|
660
|
-
* @documentationMaturity preview
|
|
661
|
-
* @requiredField item
|
|
662
|
-
* @requiredField item.externalId
|
|
663
|
-
* @requiredField item.itemSetId
|
|
664
|
-
* @requiredField item.namespace
|
|
665
|
-
* @requiredField item.providerAppId
|
|
666
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
|
|
667
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
668
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
669
|
-
* @applicableIdentity APP
|
|
670
|
-
* @returns Created item.
|
|
671
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.CreateItem
|
|
672
|
-
*/
|
|
673
|
-
export declare function createItem(item: NonNullablePaths<Item, `externalId` | `itemSetId` | `namespace` | `providerAppId`>): Promise<Item>;
|
|
674
|
-
/**
|
|
675
|
-
* Creates benefit items.
|
|
676
|
-
* @param items - Items to create.
|
|
677
|
-
* @public
|
|
678
|
-
* @documentationMaturity preview
|
|
679
|
-
* @requiredField items
|
|
680
|
-
* @requiredField items.externalId
|
|
681
|
-
* @requiredField items.itemSetId
|
|
682
|
-
* @requiredField items.namespace
|
|
683
|
-
* @requiredField items.providerAppId
|
|
684
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_CREATE
|
|
685
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
686
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
687
|
-
* @applicableIdentity APP
|
|
688
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.BulkCreateItems
|
|
689
|
-
*/
|
|
690
|
-
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`>>;
|
|
691
|
-
export interface BulkCreateItemsOptions {
|
|
654
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
655
|
+
interface BulkCreateItemsOptions {
|
|
692
656
|
/**
|
|
693
657
|
* Whether to return the full item entities.
|
|
694
658
|
*
|
|
@@ -696,92 +660,11 @@ export interface BulkCreateItemsOptions {
|
|
|
696
660
|
*/
|
|
697
661
|
returnEntity?: boolean;
|
|
698
662
|
}
|
|
699
|
-
|
|
700
|
-
* Deletes a benefit item.
|
|
701
|
-
*
|
|
702
|
-
* <blockquote class="caution">
|
|
703
|
-
* <strong>Caution:</strong>
|
|
704
|
-
*
|
|
705
|
-
* Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
|
|
706
|
-
* </blockquote>
|
|
707
|
-
* @param itemId - Item ID.
|
|
708
|
-
* @public
|
|
709
|
-
* @documentationMaturity preview
|
|
710
|
-
* @requiredField itemId
|
|
711
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
712
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
713
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
714
|
-
* @applicableIdentity APP
|
|
715
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.DeleteItem
|
|
716
|
-
*/
|
|
717
|
-
export declare function deleteItem(itemId: string): Promise<void>;
|
|
718
|
-
/**
|
|
719
|
-
* Deletes benefit items.
|
|
720
|
-
*
|
|
721
|
-
* <blockquote class="caution">
|
|
722
|
-
* <strong>Caution:</strong>
|
|
723
|
-
*
|
|
724
|
-
* Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
|
|
725
|
-
* </blockquote>
|
|
726
|
-
* @param itemIds - List of IDs of the items to delete.
|
|
727
|
-
* @public
|
|
728
|
-
* @documentationMaturity preview
|
|
729
|
-
* @requiredField itemIds
|
|
730
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
731
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
732
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
733
|
-
* @applicableIdentity APP
|
|
734
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItems
|
|
735
|
-
*/
|
|
736
|
-
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`>>;
|
|
737
|
-
/**
|
|
738
|
-
* Deletes benefit items that fulfill the specified filter conditions.
|
|
739
|
-
*
|
|
740
|
-
* For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
|
|
741
|
-
*
|
|
742
|
-
* <blockquote class="caution">
|
|
743
|
-
* <strong>Caution:</strong>
|
|
744
|
-
*
|
|
745
|
-
* Deleting a benefit item removes the association between a benefit and the item with immediate effect. This may affect currently active pools.
|
|
746
|
-
* </blockquote>
|
|
747
|
-
* @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.
|
|
748
|
-
* @public
|
|
749
|
-
* @documentationMaturity preview
|
|
750
|
-
* @requiredField namespace
|
|
751
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_DELETE
|
|
752
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
753
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
754
|
-
* @applicableIdentity APP
|
|
755
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.BulkDeleteItemsByFilter
|
|
756
|
-
*/
|
|
757
|
-
export declare function bulkDeleteItemsByFilter(namespace: string, options?: BulkDeleteItemsByFilterOptions): Promise<NonNullablePaths<BulkDeleteItemsByFilterResponse, `jobId`>>;
|
|
758
|
-
export interface BulkDeleteItemsByFilterOptions {
|
|
663
|
+
interface BulkDeleteItemsByFilterOptions {
|
|
759
664
|
/** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
760
665
|
filter?: Record<string, any> | null;
|
|
761
666
|
}
|
|
762
|
-
|
|
763
|
-
* Updates a benefit item.
|
|
764
|
-
*
|
|
765
|
-
* Each time the benefit item is updated,
|
|
766
|
-
* `revision` increments by 1.
|
|
767
|
-
* The current `revision` must be passed when updating the benefit item.
|
|
768
|
-
* This ensures you're working with the latest benefit item
|
|
769
|
-
* and prevents unintended overwrites.
|
|
770
|
-
* @param _id - Benefit item ID.
|
|
771
|
-
* @public
|
|
772
|
-
* @documentationMaturity preview
|
|
773
|
-
* @requiredField _id
|
|
774
|
-
* @requiredField item
|
|
775
|
-
* @requiredField item.revision
|
|
776
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
|
|
777
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
778
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
779
|
-
* @applicableIdentity APP
|
|
780
|
-
* @returns Updated item.
|
|
781
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.UpdateItem
|
|
782
|
-
*/
|
|
783
|
-
export declare function updateItem(_id: string, item: NonNullablePaths<UpdateItem, `revision`>): Promise<Item>;
|
|
784
|
-
export interface UpdateItem {
|
|
667
|
+
interface UpdateItem {
|
|
785
668
|
/**
|
|
786
669
|
* Benefit item ID.
|
|
787
670
|
* @format GUID
|
|
@@ -850,33 +733,13 @@ export interface UpdateItem {
|
|
|
850
733
|
/**
|
|
851
734
|
* 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.
|
|
852
735
|
* @minLength 1
|
|
853
|
-
* @maxLength
|
|
736
|
+
* @maxLength 20
|
|
854
737
|
* @immutable
|
|
855
738
|
* @readonly
|
|
856
739
|
*/
|
|
857
740
|
namespace?: string | null;
|
|
858
741
|
}
|
|
859
|
-
|
|
860
|
-
* Updates benefit items.
|
|
861
|
-
*
|
|
862
|
-
* Each time the benefit item is updated,
|
|
863
|
-
* `revision` increments by 1.
|
|
864
|
-
* The current `revision` must be passed when updating the benefit item.
|
|
865
|
-
* This ensures you're working with the latest benefit item
|
|
866
|
-
* and prevents unintended overwrites.
|
|
867
|
-
* @public
|
|
868
|
-
* @documentationMaturity preview
|
|
869
|
-
* @requiredField options.items.item
|
|
870
|
-
* @requiredField options.items.item._id
|
|
871
|
-
* @requiredField options.items.item.revision
|
|
872
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_UPDATE
|
|
873
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
874
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
875
|
-
* @applicableIdentity APP
|
|
876
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.BulkUpdateItems
|
|
877
|
-
*/
|
|
878
|
-
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`>>;
|
|
879
|
-
export interface BulkUpdateItemsOptions {
|
|
742
|
+
interface BulkUpdateItemsOptions {
|
|
880
743
|
/**
|
|
881
744
|
* Items to update.
|
|
882
745
|
* @minSize 1
|
|
@@ -890,70 +753,12 @@ export interface BulkUpdateItemsOptions {
|
|
|
890
753
|
*/
|
|
891
754
|
returnEntity?: boolean;
|
|
892
755
|
}
|
|
893
|
-
|
|
894
|
-
* Retrieves a benefit item.
|
|
895
|
-
* @param itemId - ID of the item to retrieve.
|
|
896
|
-
* @public
|
|
897
|
-
* @documentationMaturity preview
|
|
898
|
-
* @requiredField itemId
|
|
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
|
-
* @returns Retrieved item.
|
|
908
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.GetItem
|
|
909
|
-
*/
|
|
910
|
-
export declare function getItem(itemId: string): Promise<Item>;
|
|
911
|
-
/**
|
|
912
|
-
* Retrieves a list of up to 1000 benefit items.
|
|
913
|
-
* @public
|
|
914
|
-
* @documentationMaturity preview
|
|
915
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
916
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
917
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
918
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
919
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
920
|
-
* @permissionScope Manage Events
|
|
921
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
922
|
-
* @applicableIdentity APP
|
|
923
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.ListItems
|
|
924
|
-
*/
|
|
925
|
-
export declare function listItems(options?: ListItemsOptions): Promise<NonNullablePaths<ListItemsResponse, `items`>>;
|
|
926
|
-
export interface ListItemsOptions {
|
|
756
|
+
interface ListItemsOptions {
|
|
927
757
|
/** Filter. */
|
|
928
758
|
filter?: Filter;
|
|
929
759
|
/** Cursor paging */
|
|
930
760
|
cursorPaging?: CursorPaging;
|
|
931
761
|
}
|
|
932
|
-
/**
|
|
933
|
-
* Creates a query to retrieve a list of items.
|
|
934
|
-
*
|
|
935
|
-
* The Query Items method builds a query to retrieve a list of items and returns a `ItemsQueryBuilder` object.
|
|
936
|
-
*
|
|
937
|
-
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
938
|
-
*
|
|
939
|
-
* 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.
|
|
940
|
-
*
|
|
941
|
-
* Query Items has a default paging limit of 50, which you can override.
|
|
942
|
-
*
|
|
943
|
-
* For a full description of the item object, see the object returned for the `items` property in `ItemsQueryResult`.
|
|
944
|
-
* @public
|
|
945
|
-
* @documentationMaturity preview
|
|
946
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
947
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
948
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
949
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
950
|
-
* @permissionScope Manage Events
|
|
951
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
952
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
953
|
-
* @applicableIdentity APP
|
|
954
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.QueryItems
|
|
955
|
-
*/
|
|
956
|
-
export declare function queryItems(): ItemsQueryBuilder;
|
|
957
762
|
interface QueryCursorResult {
|
|
958
763
|
cursors: Cursors;
|
|
959
764
|
hasNext: () => boolean;
|
|
@@ -961,13 +766,13 @@ interface QueryCursorResult {
|
|
|
961
766
|
length: number;
|
|
962
767
|
pageSize: number;
|
|
963
768
|
}
|
|
964
|
-
|
|
769
|
+
interface ItemsQueryResult extends QueryCursorResult {
|
|
965
770
|
items: Item[];
|
|
966
771
|
query: ItemsQueryBuilder;
|
|
967
772
|
next: () => Promise<ItemsQueryResult>;
|
|
968
773
|
prev: () => Promise<ItemsQueryResult>;
|
|
969
774
|
}
|
|
970
|
-
|
|
775
|
+
interface ItemsQueryBuilder {
|
|
971
776
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
972
777
|
* @param value - Value to compare against.
|
|
973
778
|
* @documentationMaturity preview
|
|
@@ -1031,24 +836,7 @@ export interface ItemsQueryBuilder {
|
|
|
1031
836
|
/** @documentationMaturity preview */
|
|
1032
837
|
find: () => Promise<ItemsQueryResult>;
|
|
1033
838
|
}
|
|
1034
|
-
|
|
1035
|
-
* Counts how many benefit items exist that fulfill the specified filtering conditions.
|
|
1036
|
-
*
|
|
1037
|
-
* For a list of supported filters, see [Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/items/filtering-and-sorting).
|
|
1038
|
-
* @public
|
|
1039
|
-
* @documentationMaturity preview
|
|
1040
|
-
* @permissionId BENEFIT_PROGRAMS.ITEM_READ
|
|
1041
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1042
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
1043
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
1044
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
1045
|
-
* @permissionScope Manage Events
|
|
1046
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1047
|
-
* @applicableIdentity APP
|
|
1048
|
-
* @fqn wix.benefit_programs.v1.item.ItemService.CountItems
|
|
1049
|
-
*/
|
|
1050
|
-
export declare function countItems(options?: CountItemsOptions): Promise<NonNullablePaths<CountItemsResponse, `count`>>;
|
|
1051
|
-
export interface CountItemsOptions {
|
|
839
|
+
interface CountItemsOptions {
|
|
1052
840
|
/**
|
|
1053
841
|
* Items to count.
|
|
1054
842
|
*
|
|
@@ -1056,4 +844,5 @@ export interface CountItemsOptions {
|
|
|
1056
844
|
*/
|
|
1057
845
|
filter?: Record<string, any> | null;
|
|
1058
846
|
}
|
|
1059
|
-
|
|
847
|
+
|
|
848
|
+
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 };
|