@wix/auto_sdk_benefit-programs_items 1.0.10 → 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.
- package/build/{internal/cjs/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.mts} +72 -283
- package/build/{internal/es/src/benefit-programs-v1-item-items.universal.d.ts → benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.ts} +72 -283
- 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 +906 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +869 -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-C7Ua6Gkb.d.mts} +72 -283
- package/build/{es/src/benefit-programs-v1-item-items.universal.d.ts → internal/benefit-programs-v1-item-items.universal-C7Ua6Gkb.d.ts} +72 -283
- package/build/internal/{es/src/benefit-programs-v1-item-items.public.d.ts → index.d.mts} +29 -17
- package/build/internal/{cjs/src/benefit-programs-v1-item-items.public.d.ts → index.d.ts} +29 -17
- package/build/internal/index.js +906 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +869 -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} +75 -259
- package/build/{es/src/benefit-programs-v1-item-items.types.d.ts → internal/meta.d.ts} +75 -259
- 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} +75 -259
- package/build/{cjs/src/benefit-programs-v1-item-items.types.d.ts → meta.d.ts} +75 -259
- 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 +13 -12
- 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 -541
- 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 -504
- 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 -541
- 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 -504
- package/build/internal/es/src/benefit-programs-v1-item-items.universal.js.map +0 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
import { k as CreateItemRequest$1, l as CreateItemResponse$1, m as BulkCreateItemsRequest$1, a as BulkCreateItemsResponse$1, D as DeleteItemRequest$1, q as DeleteItemResponse$1, r as BulkDeleteItemsRequest$1, b as BulkDeleteItemsResponse$1, s as BulkDeleteItemsByFilterRequest$1, d as BulkDeleteItemsByFilterResponse$1, t as UpdateItemRequest$1, u as UpdateItemResponse$1, v as BulkUpdateItemsRequest$1, f as BulkUpdateItemsResponse$1, G as GetItemRequest$1, w as GetItemResponse$1, x as ListItemsRequest$1, g as ListItemsResponse$1, Q as QueryItemsRequest$1, Y as QueryItemsResponse$1, Z as CountItemsRequest$1, i as CountItemsResponse$1 } from './benefit-programs-v1-item-items.universal-C7Ua6Gkb.js';
|
|
2
|
+
|
|
3
|
+
interface Item {
|
|
2
4
|
/**
|
|
3
5
|
* Benefit item ID.
|
|
4
6
|
* @format GUID
|
|
@@ -73,7 +75,7 @@ export interface Item {
|
|
|
73
75
|
*/
|
|
74
76
|
namespace?: string | null;
|
|
75
77
|
}
|
|
76
|
-
|
|
78
|
+
interface ExtendedFields {
|
|
77
79
|
/**
|
|
78
80
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
79
81
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -84,22 +86,15 @@ export interface ExtendedFields {
|
|
|
84
86
|
*/
|
|
85
87
|
namespaces?: Record<string, Record<string, any>>;
|
|
86
88
|
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* ID of the pool that had its items provisioned
|
|
90
|
-
* @format GUID
|
|
91
|
-
*/
|
|
92
|
-
itemSetId?: string;
|
|
93
|
-
}
|
|
94
|
-
export interface CreateItemRequest {
|
|
89
|
+
interface CreateItemRequest {
|
|
95
90
|
/** Item to create. */
|
|
96
91
|
item: Item;
|
|
97
92
|
}
|
|
98
|
-
|
|
93
|
+
interface CreateItemResponse {
|
|
99
94
|
/** Created item. */
|
|
100
95
|
item?: Item;
|
|
101
96
|
}
|
|
102
|
-
|
|
97
|
+
interface BulkCreateItemsRequest {
|
|
103
98
|
/**
|
|
104
99
|
* Items to create.
|
|
105
100
|
* @minSize 1
|
|
@@ -113,7 +108,7 @@ export interface BulkCreateItemsRequest {
|
|
|
113
108
|
*/
|
|
114
109
|
returnEntity?: boolean;
|
|
115
110
|
}
|
|
116
|
-
|
|
111
|
+
interface BulkCreateItemsResponse {
|
|
117
112
|
/**
|
|
118
113
|
* List of created items and associated metadata.
|
|
119
114
|
* @minSize 1
|
|
@@ -123,13 +118,13 @@ export interface BulkCreateItemsResponse {
|
|
|
123
118
|
/** Bulk action metadata. */
|
|
124
119
|
bulkActionMetadata?: BulkActionMetadata;
|
|
125
120
|
}
|
|
126
|
-
|
|
121
|
+
interface BulkItemResult {
|
|
127
122
|
/** Item metadata. */
|
|
128
123
|
itemMetadata?: ItemMetadata;
|
|
129
124
|
/** Item. */
|
|
130
125
|
item?: Item;
|
|
131
126
|
}
|
|
132
|
-
|
|
127
|
+
interface ItemMetadata {
|
|
133
128
|
/**
|
|
134
129
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
135
130
|
* @format GUID
|
|
@@ -142,7 +137,7 @@ export interface ItemMetadata {
|
|
|
142
137
|
/** Details about the error in case of failure. */
|
|
143
138
|
error?: ApplicationError;
|
|
144
139
|
}
|
|
145
|
-
|
|
140
|
+
interface ApplicationError {
|
|
146
141
|
/** Error code. */
|
|
147
142
|
code?: string;
|
|
148
143
|
/** Description of the error. */
|
|
@@ -150,7 +145,7 @@ export interface ApplicationError {
|
|
|
150
145
|
/** Data related to the error. */
|
|
151
146
|
data?: Record<string, any> | null;
|
|
152
147
|
}
|
|
153
|
-
|
|
148
|
+
interface BulkActionMetadata {
|
|
154
149
|
/** Number of items that were successfully processed. */
|
|
155
150
|
totalSuccesses?: number;
|
|
156
151
|
/** Number of items that couldn't be processed. */
|
|
@@ -158,16 +153,16 @@ export interface BulkActionMetadata {
|
|
|
158
153
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
159
154
|
undetailedFailures?: number;
|
|
160
155
|
}
|
|
161
|
-
|
|
156
|
+
interface DeleteItemRequest {
|
|
162
157
|
/**
|
|
163
158
|
* Item ID.
|
|
164
159
|
* @format GUID
|
|
165
160
|
*/
|
|
166
161
|
itemId: string;
|
|
167
162
|
}
|
|
168
|
-
|
|
163
|
+
interface DeleteItemResponse {
|
|
169
164
|
}
|
|
170
|
-
|
|
165
|
+
interface BulkDeleteItemsRequest {
|
|
171
166
|
/**
|
|
172
167
|
* List of IDs of the items to delete.
|
|
173
168
|
* @minSize 1
|
|
@@ -176,7 +171,7 @@ export interface BulkDeleteItemsRequest {
|
|
|
176
171
|
*/
|
|
177
172
|
itemIds: string[];
|
|
178
173
|
}
|
|
179
|
-
|
|
174
|
+
interface BulkDeleteItemsResponse {
|
|
180
175
|
/**
|
|
181
176
|
* List of deleted items and associated metadata.
|
|
182
177
|
* @minSize 1
|
|
@@ -186,7 +181,7 @@ export interface BulkDeleteItemsResponse {
|
|
|
186
181
|
/** Bulk action metadata. */
|
|
187
182
|
bulkActionMetadata?: BulkActionMetadata;
|
|
188
183
|
}
|
|
189
|
-
|
|
184
|
+
interface BulkDeleteItemsByFilterRequest {
|
|
190
185
|
/**
|
|
191
186
|
* 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.
|
|
192
187
|
* @minLength 1
|
|
@@ -196,22 +191,22 @@ export interface BulkDeleteItemsByFilterRequest {
|
|
|
196
191
|
/** Filter options. To learn more, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
197
192
|
filter?: Record<string, any> | null;
|
|
198
193
|
}
|
|
199
|
-
|
|
194
|
+
interface BulkDeleteItemsByFilterResponse {
|
|
200
195
|
/**
|
|
201
196
|
* 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)).
|
|
202
197
|
* @format GUID
|
|
203
198
|
*/
|
|
204
199
|
jobId?: string;
|
|
205
200
|
}
|
|
206
|
-
|
|
201
|
+
interface UpdateItemRequest {
|
|
207
202
|
/** Item to update. */
|
|
208
203
|
item: Item;
|
|
209
204
|
}
|
|
210
|
-
|
|
205
|
+
interface UpdateItemResponse {
|
|
211
206
|
/** Updated item. */
|
|
212
207
|
item?: Item;
|
|
213
208
|
}
|
|
214
|
-
|
|
209
|
+
interface BulkUpdateItemsRequest {
|
|
215
210
|
/**
|
|
216
211
|
* Items to update.
|
|
217
212
|
* @minSize 1
|
|
@@ -225,13 +220,13 @@ export interface BulkUpdateItemsRequest {
|
|
|
225
220
|
*/
|
|
226
221
|
returnEntity?: boolean;
|
|
227
222
|
}
|
|
228
|
-
|
|
223
|
+
interface MaskedItem {
|
|
229
224
|
/** Item to update. */
|
|
230
225
|
item?: Item;
|
|
231
226
|
/** Explicit list of fields to update. */
|
|
232
227
|
fieldMask?: string[];
|
|
233
228
|
}
|
|
234
|
-
|
|
229
|
+
interface BulkUpdateItemsResponse {
|
|
235
230
|
/**
|
|
236
231
|
* List of updated items and associated metadata.
|
|
237
232
|
* @minSize 1
|
|
@@ -241,24 +236,24 @@ export interface BulkUpdateItemsResponse {
|
|
|
241
236
|
/** Bulk action metadata. */
|
|
242
237
|
bulkActionMetadata?: BulkActionMetadata;
|
|
243
238
|
}
|
|
244
|
-
|
|
239
|
+
interface GetItemRequest {
|
|
245
240
|
/**
|
|
246
241
|
* ID of the item to retrieve.
|
|
247
242
|
* @format GUID
|
|
248
243
|
*/
|
|
249
244
|
itemId: string;
|
|
250
245
|
}
|
|
251
|
-
|
|
246
|
+
interface GetItemResponse {
|
|
252
247
|
/** Retrieved item. */
|
|
253
248
|
item?: Item;
|
|
254
249
|
}
|
|
255
|
-
|
|
250
|
+
interface ListItemsRequest {
|
|
256
251
|
/** Filter. */
|
|
257
252
|
filter?: Filter;
|
|
258
253
|
/** Cursor paging */
|
|
259
254
|
cursorPaging?: CursorPaging;
|
|
260
255
|
}
|
|
261
|
-
|
|
256
|
+
declare enum Type {
|
|
262
257
|
/** Unknown filter type. */
|
|
263
258
|
UNKNOWN_FILTER = "UNKNOWN_FILTER",
|
|
264
259
|
/** Use with `filter.byItemSetIdAndReferenceOptions`. */
|
|
@@ -266,7 +261,7 @@ export declare enum Type {
|
|
|
266
261
|
/** Use with `filter.byReferenceOptions`. */
|
|
267
262
|
BY_REFERENCE = "BY_REFERENCE"
|
|
268
263
|
}
|
|
269
|
-
|
|
264
|
+
interface ByItemSetIdAndReference {
|
|
270
265
|
/**
|
|
271
266
|
* Filter list.
|
|
272
267
|
* @minSize 1
|
|
@@ -274,7 +269,7 @@ export interface ByItemSetIdAndReference {
|
|
|
274
269
|
*/
|
|
275
270
|
filters?: ByItemSetIdAndReferenceFilter[];
|
|
276
271
|
}
|
|
277
|
-
|
|
272
|
+
interface ByItemSetIdAndReferenceFilter {
|
|
278
273
|
/**
|
|
279
274
|
* ID set ID.
|
|
280
275
|
* @format GUID
|
|
@@ -296,7 +291,7 @@ export interface ByItemSetIdAndReferenceFilter {
|
|
|
296
291
|
*/
|
|
297
292
|
providerAppId?: string;
|
|
298
293
|
}
|
|
299
|
-
|
|
294
|
+
interface ByReference {
|
|
300
295
|
/**
|
|
301
296
|
* Filter list.
|
|
302
297
|
* @minSize 1
|
|
@@ -304,7 +299,7 @@ export interface ByReference {
|
|
|
304
299
|
*/
|
|
305
300
|
filters?: ByReferenceFilter[];
|
|
306
301
|
}
|
|
307
|
-
|
|
302
|
+
interface ByReferenceFilter {
|
|
308
303
|
/**
|
|
309
304
|
* External item ID.
|
|
310
305
|
* @format GUID
|
|
@@ -321,7 +316,7 @@ export interface ByReferenceFilter {
|
|
|
321
316
|
*/
|
|
322
317
|
providerAppId?: string;
|
|
323
318
|
}
|
|
324
|
-
|
|
319
|
+
interface Filter extends FilterFilterOneOf {
|
|
325
320
|
/** Filter the request by `itemSetId` and item reference. */
|
|
326
321
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
327
322
|
/** Filter the request item reference. */
|
|
@@ -336,13 +331,13 @@ export interface Filter extends FilterFilterOneOf {
|
|
|
336
331
|
namespace?: string;
|
|
337
332
|
}
|
|
338
333
|
/** @oneof */
|
|
339
|
-
|
|
334
|
+
interface FilterFilterOneOf {
|
|
340
335
|
/** Filter the request by `itemSetId` and item reference. */
|
|
341
336
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
342
337
|
/** Filter the request item reference. */
|
|
343
338
|
byReferenceOptions?: ByReference;
|
|
344
339
|
}
|
|
345
|
-
|
|
340
|
+
interface CursorPaging {
|
|
346
341
|
/**
|
|
347
342
|
* Maximum number of items to return.
|
|
348
343
|
* @max 1000
|
|
@@ -357,13 +352,13 @@ export interface CursorPaging {
|
|
|
357
352
|
*/
|
|
358
353
|
cursor?: string | null;
|
|
359
354
|
}
|
|
360
|
-
|
|
355
|
+
interface ListItemsResponse {
|
|
361
356
|
/** Items. */
|
|
362
357
|
items?: Item[];
|
|
363
358
|
/** Metadata for paginated results. */
|
|
364
359
|
metadata?: CursorPagingMetadata;
|
|
365
360
|
}
|
|
366
|
-
|
|
361
|
+
interface CursorPagingMetadata {
|
|
367
362
|
/** Number of items returned in the response. */
|
|
368
363
|
count?: number | null;
|
|
369
364
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -376,7 +371,7 @@ export interface CursorPagingMetadata {
|
|
|
376
371
|
*/
|
|
377
372
|
hasNext?: boolean | null;
|
|
378
373
|
}
|
|
379
|
-
|
|
374
|
+
interface Cursors {
|
|
380
375
|
/**
|
|
381
376
|
* Cursor string pointing to the next page in the list of results.
|
|
382
377
|
* @maxLength 16000
|
|
@@ -388,11 +383,11 @@ export interface Cursors {
|
|
|
388
383
|
*/
|
|
389
384
|
prev?: string | null;
|
|
390
385
|
}
|
|
391
|
-
|
|
386
|
+
interface QueryItemsRequest {
|
|
392
387
|
/** Filter, sort, and paging to apply to the query. */
|
|
393
388
|
query?: CursorQuery;
|
|
394
389
|
}
|
|
395
|
-
|
|
390
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
396
391
|
/** 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`. */
|
|
397
392
|
cursorPaging?: CursorPaging;
|
|
398
393
|
/**
|
|
@@ -412,11 +407,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
412
407
|
sort?: Sorting[];
|
|
413
408
|
}
|
|
414
409
|
/** @oneof */
|
|
415
|
-
|
|
410
|
+
interface CursorQueryPagingMethodOneOf {
|
|
416
411
|
/** 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`. */
|
|
417
412
|
cursorPaging?: CursorPaging;
|
|
418
413
|
}
|
|
419
|
-
|
|
414
|
+
interface Sorting {
|
|
420
415
|
/**
|
|
421
416
|
* Field to sort by.
|
|
422
417
|
* @maxLength 512
|
|
@@ -425,17 +420,17 @@ export interface Sorting {
|
|
|
425
420
|
/** Sort order. */
|
|
426
421
|
order?: SortOrder;
|
|
427
422
|
}
|
|
428
|
-
|
|
423
|
+
declare enum SortOrder {
|
|
429
424
|
ASC = "ASC",
|
|
430
425
|
DESC = "DESC"
|
|
431
426
|
}
|
|
432
|
-
|
|
427
|
+
interface QueryItemsResponse {
|
|
433
428
|
/** List of retrieved items. */
|
|
434
429
|
items?: Item[];
|
|
435
430
|
/** Metadata for paginated results. */
|
|
436
431
|
metadata?: CursorPagingMetadata;
|
|
437
432
|
}
|
|
438
|
-
|
|
433
|
+
interface CountItemsRequest {
|
|
439
434
|
/**
|
|
440
435
|
* Items to count.
|
|
441
436
|
*
|
|
@@ -443,216 +438,37 @@ export interface CountItemsRequest {
|
|
|
443
438
|
*/
|
|
444
439
|
filter?: Record<string, any> | null;
|
|
445
440
|
}
|
|
446
|
-
|
|
441
|
+
interface CountItemsResponse {
|
|
447
442
|
/** Number of items fulfilling the specified filter conditions. */
|
|
448
443
|
count?: number;
|
|
449
444
|
}
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
* Results
|
|
481
|
-
* @minSize 1
|
|
482
|
-
* @maxSize 1000
|
|
483
|
-
*/
|
|
484
|
-
results?: BulkCloneItemSetsResult[];
|
|
485
|
-
/** Bulk action metadata */
|
|
486
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
487
|
-
/**
|
|
488
|
-
* Id of the job that is cloning the item set
|
|
489
|
-
* @format GUID
|
|
490
|
-
*/
|
|
491
|
-
jobId?: string;
|
|
492
|
-
}
|
|
493
|
-
export interface BulkCloneItemSetsResult {
|
|
494
|
-
/** Item metadata */
|
|
495
|
-
itemMetadata?: ItemMetadata;
|
|
496
|
-
/**
|
|
497
|
-
* Id of the item set that these items were added to
|
|
498
|
-
* @format GUID
|
|
499
|
-
*/
|
|
500
|
-
clonedItemSetId?: string;
|
|
501
|
-
}
|
|
502
|
-
export interface AllocateItemSetsRequest {
|
|
503
|
-
/**
|
|
504
|
-
* Number of sets to allocate
|
|
505
|
-
* @min 1
|
|
506
|
-
* @max 1000
|
|
507
|
-
*/
|
|
508
|
-
numberOfSets?: number;
|
|
509
|
-
}
|
|
510
|
-
export interface AllocateItemSetsResponse {
|
|
511
|
-
/**
|
|
512
|
-
* ID that is a shared reference between a benefit pool and a specific item.
|
|
513
|
-
* @format GUID
|
|
514
|
-
*/
|
|
515
|
-
itemSetIds?: string[];
|
|
516
|
-
}
|
|
517
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
518
|
-
createdEvent?: EntityCreatedEvent;
|
|
519
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
520
|
-
deletedEvent?: EntityDeletedEvent;
|
|
521
|
-
actionEvent?: ActionEvent;
|
|
522
|
-
/**
|
|
523
|
-
* Unique event ID.
|
|
524
|
-
* Allows clients to ignore duplicate webhooks.
|
|
525
|
-
*/
|
|
526
|
-
id?: string;
|
|
527
|
-
/**
|
|
528
|
-
* Assumes actions are also always typed to an entity_type
|
|
529
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
530
|
-
*/
|
|
531
|
-
entityFqdn?: string;
|
|
532
|
-
/**
|
|
533
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
534
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
535
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
536
|
-
*/
|
|
537
|
-
slug?: string;
|
|
538
|
-
/** ID of the entity associated with the event. */
|
|
539
|
-
entityId?: string;
|
|
540
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
541
|
-
eventTime?: Date | null;
|
|
542
|
-
/**
|
|
543
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
544
|
-
* (for example, GDPR).
|
|
545
|
-
*/
|
|
546
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
547
|
-
/** If present, indicates the action that triggered the event. */
|
|
548
|
-
originatedFrom?: string | null;
|
|
549
|
-
/**
|
|
550
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
551
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
552
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
553
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
554
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
555
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
556
|
-
*/
|
|
557
|
-
entityEventSequence?: string | null;
|
|
558
|
-
}
|
|
559
|
-
/** @oneof */
|
|
560
|
-
export interface DomainEventBodyOneOf {
|
|
561
|
-
createdEvent?: EntityCreatedEvent;
|
|
562
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
563
|
-
deletedEvent?: EntityDeletedEvent;
|
|
564
|
-
actionEvent?: ActionEvent;
|
|
565
|
-
}
|
|
566
|
-
export interface EntityCreatedEvent {
|
|
567
|
-
entityAsJson?: string;
|
|
568
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
569
|
-
restoreInfo?: RestoreInfo;
|
|
570
|
-
}
|
|
571
|
-
export interface RestoreInfo {
|
|
572
|
-
deletedDate?: Date | null;
|
|
573
|
-
}
|
|
574
|
-
export interface EntityUpdatedEvent {
|
|
575
|
-
/**
|
|
576
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
577
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
578
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
579
|
-
*/
|
|
580
|
-
currentEntityAsJson?: string;
|
|
581
|
-
}
|
|
582
|
-
export interface EntityDeletedEvent {
|
|
583
|
-
/** Entity that was deleted */
|
|
584
|
-
deletedEntityAsJson?: string | null;
|
|
585
|
-
}
|
|
586
|
-
export interface ActionEvent {
|
|
587
|
-
bodyAsJson?: string;
|
|
588
|
-
}
|
|
589
|
-
export interface MessageEnvelope {
|
|
590
|
-
/**
|
|
591
|
-
* App instance ID.
|
|
592
|
-
* @format GUID
|
|
593
|
-
*/
|
|
594
|
-
instanceId?: string | null;
|
|
595
|
-
/**
|
|
596
|
-
* Event type.
|
|
597
|
-
* @maxLength 150
|
|
598
|
-
*/
|
|
599
|
-
eventType?: string;
|
|
600
|
-
/** The identification type and identity data. */
|
|
601
|
-
identity?: IdentificationData;
|
|
602
|
-
/** Stringify payload. */
|
|
603
|
-
data?: string;
|
|
604
|
-
}
|
|
605
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
606
|
-
/**
|
|
607
|
-
* ID of a site visitor that has not logged in to the site.
|
|
608
|
-
* @format GUID
|
|
609
|
-
*/
|
|
610
|
-
anonymousVisitorId?: string;
|
|
611
|
-
/**
|
|
612
|
-
* ID of a site visitor that has logged in to the site.
|
|
613
|
-
* @format GUID
|
|
614
|
-
*/
|
|
615
|
-
memberId?: string;
|
|
616
|
-
/**
|
|
617
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
618
|
-
* @format GUID
|
|
619
|
-
*/
|
|
620
|
-
wixUserId?: string;
|
|
621
|
-
/**
|
|
622
|
-
* ID of an app.
|
|
623
|
-
* @format GUID
|
|
624
|
-
*/
|
|
625
|
-
appId?: string;
|
|
626
|
-
/** @readonly */
|
|
627
|
-
identityType?: WebhookIdentityType;
|
|
628
|
-
}
|
|
629
|
-
/** @oneof */
|
|
630
|
-
export interface IdentificationDataIdOneOf {
|
|
631
|
-
/**
|
|
632
|
-
* ID of a site visitor that has not logged in to the site.
|
|
633
|
-
* @format GUID
|
|
634
|
-
*/
|
|
635
|
-
anonymousVisitorId?: string;
|
|
636
|
-
/**
|
|
637
|
-
* ID of a site visitor that has logged in to the site.
|
|
638
|
-
* @format GUID
|
|
639
|
-
*/
|
|
640
|
-
memberId?: string;
|
|
641
|
-
/**
|
|
642
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
643
|
-
* @format GUID
|
|
644
|
-
*/
|
|
645
|
-
wixUserId?: string;
|
|
646
|
-
/**
|
|
647
|
-
* ID of an app.
|
|
648
|
-
* @format GUID
|
|
649
|
-
*/
|
|
650
|
-
appId?: string;
|
|
651
|
-
}
|
|
652
|
-
export declare enum WebhookIdentityType {
|
|
653
|
-
UNKNOWN = "UNKNOWN",
|
|
654
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
655
|
-
MEMBER = "MEMBER",
|
|
656
|
-
WIX_USER = "WIX_USER",
|
|
657
|
-
APP = "APP"
|
|
658
|
-
}
|
|
445
|
+
|
|
446
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
447
|
+
getUrl: (context: any) => string;
|
|
448
|
+
httpMethod: K;
|
|
449
|
+
path: string;
|
|
450
|
+
pathParams: M;
|
|
451
|
+
__requestType: T;
|
|
452
|
+
__originalRequestType: S;
|
|
453
|
+
__responseType: Q;
|
|
454
|
+
__originalResponseType: R;
|
|
455
|
+
};
|
|
456
|
+
declare function createItem(): __PublicMethodMetaInfo<'POST', {}, CreateItemRequest$1, CreateItemRequest, CreateItemResponse$1, CreateItemResponse>;
|
|
457
|
+
declare function bulkCreateItems(): __PublicMethodMetaInfo<'POST', {}, BulkCreateItemsRequest$1, BulkCreateItemsRequest, BulkCreateItemsResponse$1, BulkCreateItemsResponse>;
|
|
458
|
+
declare function deleteItem(): __PublicMethodMetaInfo<'POST', {
|
|
459
|
+
itemId: string;
|
|
460
|
+
}, DeleteItemRequest$1, DeleteItemRequest, DeleteItemResponse$1, DeleteItemResponse>;
|
|
461
|
+
declare function bulkDeleteItems(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsRequest$1, BulkDeleteItemsRequest, BulkDeleteItemsResponse$1, BulkDeleteItemsResponse>;
|
|
462
|
+
declare function bulkDeleteItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsByFilterRequest$1, BulkDeleteItemsByFilterRequest, BulkDeleteItemsByFilterResponse$1, BulkDeleteItemsByFilterResponse>;
|
|
463
|
+
declare function updateItem(): __PublicMethodMetaInfo<'PATCH', {
|
|
464
|
+
itemId: string;
|
|
465
|
+
}, UpdateItemRequest$1, UpdateItemRequest, UpdateItemResponse$1, UpdateItemResponse>;
|
|
466
|
+
declare function bulkUpdateItems(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateItemsRequest$1, BulkUpdateItemsRequest, BulkUpdateItemsResponse$1, BulkUpdateItemsResponse>;
|
|
467
|
+
declare function getItem(): __PublicMethodMetaInfo<'GET', {
|
|
468
|
+
itemId: string;
|
|
469
|
+
}, GetItemRequest$1, GetItemRequest, GetItemResponse$1, GetItemResponse>;
|
|
470
|
+
declare function listItems(): __PublicMethodMetaInfo<'GET', {}, ListItemsRequest$1, ListItemsRequest, ListItemsResponse$1, ListItemsResponse>;
|
|
471
|
+
declare function queryItems(): __PublicMethodMetaInfo<'POST', {}, QueryItemsRequest$1, QueryItemsRequest, QueryItemsResponse$1, QueryItemsResponse>;
|
|
472
|
+
declare function countItems(): __PublicMethodMetaInfo<'POST', {}, CountItemsRequest$1, CountItemsRequest, CountItemsResponse$1, CountItemsResponse>;
|
|
473
|
+
|
|
474
|
+
export { type __PublicMethodMetaInfo, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };
|