@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,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-CkMjOEfX.mjs';
|
|
2
|
+
|
|
3
|
+
interface Item {
|
|
2
4
|
/**
|
|
3
5
|
* Benefit item ID.
|
|
4
6
|
* @format GUID
|
|
@@ -67,13 +69,13 @@ export interface Item {
|
|
|
67
69
|
/**
|
|
68
70
|
* 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.
|
|
69
71
|
* @minLength 1
|
|
70
|
-
* @maxLength
|
|
72
|
+
* @maxLength 20
|
|
71
73
|
* @immutable
|
|
72
74
|
* @readonly
|
|
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,32 +181,32 @@ 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
|
|
193
|
-
* @maxLength
|
|
188
|
+
* @maxLength 20
|
|
194
189
|
*/
|
|
195
190
|
namespace: string;
|
|
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`. */
|
|
@@ -267,8 +262,8 @@ export declare enum Type {
|
|
|
267
262
|
BY_REFERENCE = "BY_REFERENCE"
|
|
268
263
|
}
|
|
269
264
|
/** @enumType */
|
|
270
|
-
|
|
271
|
-
|
|
265
|
+
type TypeWithLiterals = Type | 'UNKNOWN_FILTER' | 'BY_ITEM_SET_ID_AND_REFERENCE' | 'BY_REFERENCE';
|
|
266
|
+
interface ByItemSetIdAndReference {
|
|
272
267
|
/**
|
|
273
268
|
* Filter list.
|
|
274
269
|
* @minSize 1
|
|
@@ -276,7 +271,7 @@ export interface ByItemSetIdAndReference {
|
|
|
276
271
|
*/
|
|
277
272
|
filters?: ByItemSetIdAndReferenceFilter[];
|
|
278
273
|
}
|
|
279
|
-
|
|
274
|
+
interface ByItemSetIdAndReferenceFilter {
|
|
280
275
|
/**
|
|
281
276
|
* ID set ID.
|
|
282
277
|
* @format GUID
|
|
@@ -298,7 +293,7 @@ export interface ByItemSetIdAndReferenceFilter {
|
|
|
298
293
|
*/
|
|
299
294
|
providerAppId?: string;
|
|
300
295
|
}
|
|
301
|
-
|
|
296
|
+
interface ByReference {
|
|
302
297
|
/**
|
|
303
298
|
* Filter list.
|
|
304
299
|
* @minSize 1
|
|
@@ -306,7 +301,7 @@ export interface ByReference {
|
|
|
306
301
|
*/
|
|
307
302
|
filters?: ByReferenceFilter[];
|
|
308
303
|
}
|
|
309
|
-
|
|
304
|
+
interface ByReferenceFilter {
|
|
310
305
|
/**
|
|
311
306
|
* External item ID.
|
|
312
307
|
* @format GUID
|
|
@@ -323,7 +318,7 @@ export interface ByReferenceFilter {
|
|
|
323
318
|
*/
|
|
324
319
|
providerAppId?: string;
|
|
325
320
|
}
|
|
326
|
-
|
|
321
|
+
interface Filter extends FilterFilterOneOf {
|
|
327
322
|
/** Filter the request by `itemSetId` and item reference. */
|
|
328
323
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
329
324
|
/** Filter the request item reference. */
|
|
@@ -333,18 +328,18 @@ export interface Filter extends FilterFilterOneOf {
|
|
|
333
328
|
/**
|
|
334
329
|
* Filter by namespace.
|
|
335
330
|
* @minLength 1
|
|
336
|
-
* @maxLength
|
|
331
|
+
* @maxLength 20
|
|
337
332
|
*/
|
|
338
333
|
namespace?: string;
|
|
339
334
|
}
|
|
340
335
|
/** @oneof */
|
|
341
|
-
|
|
336
|
+
interface FilterFilterOneOf {
|
|
342
337
|
/** Filter the request by `itemSetId` and item reference. */
|
|
343
338
|
byItemSetIdAndReferenceOptions?: ByItemSetIdAndReference;
|
|
344
339
|
/** Filter the request item reference. */
|
|
345
340
|
byReferenceOptions?: ByReference;
|
|
346
341
|
}
|
|
347
|
-
|
|
342
|
+
interface CursorPaging {
|
|
348
343
|
/**
|
|
349
344
|
* Maximum number of items to return.
|
|
350
345
|
* @max 1000
|
|
@@ -359,13 +354,13 @@ export interface CursorPaging {
|
|
|
359
354
|
*/
|
|
360
355
|
cursor?: string | null;
|
|
361
356
|
}
|
|
362
|
-
|
|
357
|
+
interface ListItemsResponse {
|
|
363
358
|
/** Items. */
|
|
364
359
|
items?: Item[];
|
|
365
360
|
/** Metadata for paginated results. */
|
|
366
361
|
metadata?: CursorPagingMetadata;
|
|
367
362
|
}
|
|
368
|
-
|
|
363
|
+
interface CursorPagingMetadata {
|
|
369
364
|
/** Number of items returned in the response. */
|
|
370
365
|
count?: number | null;
|
|
371
366
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -378,7 +373,7 @@ export interface CursorPagingMetadata {
|
|
|
378
373
|
*/
|
|
379
374
|
hasNext?: boolean | null;
|
|
380
375
|
}
|
|
381
|
-
|
|
376
|
+
interface Cursors {
|
|
382
377
|
/**
|
|
383
378
|
* Cursor string pointing to the next page in the list of results.
|
|
384
379
|
* @maxLength 16000
|
|
@@ -390,11 +385,11 @@ export interface Cursors {
|
|
|
390
385
|
*/
|
|
391
386
|
prev?: string | null;
|
|
392
387
|
}
|
|
393
|
-
|
|
388
|
+
interface QueryItemsRequest {
|
|
394
389
|
/** Filter, sort, and paging to apply to the query. */
|
|
395
390
|
query?: CursorQuery;
|
|
396
391
|
}
|
|
397
|
-
|
|
392
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
398
393
|
/** 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`. */
|
|
399
394
|
cursorPaging?: CursorPaging;
|
|
400
395
|
/**
|
|
@@ -414,11 +409,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
414
409
|
sort?: Sorting[];
|
|
415
410
|
}
|
|
416
411
|
/** @oneof */
|
|
417
|
-
|
|
412
|
+
interface CursorQueryPagingMethodOneOf {
|
|
418
413
|
/** 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`. */
|
|
419
414
|
cursorPaging?: CursorPaging;
|
|
420
415
|
}
|
|
421
|
-
|
|
416
|
+
interface Sorting {
|
|
422
417
|
/**
|
|
423
418
|
* Field to sort by.
|
|
424
419
|
* @maxLength 512
|
|
@@ -427,19 +422,19 @@ export interface Sorting {
|
|
|
427
422
|
/** Sort order. */
|
|
428
423
|
order?: SortOrderWithLiterals;
|
|
429
424
|
}
|
|
430
|
-
|
|
425
|
+
declare enum SortOrder {
|
|
431
426
|
ASC = "ASC",
|
|
432
427
|
DESC = "DESC"
|
|
433
428
|
}
|
|
434
429
|
/** @enumType */
|
|
435
|
-
|
|
436
|
-
|
|
430
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
431
|
+
interface QueryItemsResponse {
|
|
437
432
|
/** List of retrieved items. */
|
|
438
433
|
items?: Item[];
|
|
439
434
|
/** Metadata for paginated results. */
|
|
440
435
|
metadata?: CursorPagingMetadata;
|
|
441
436
|
}
|
|
442
|
-
|
|
437
|
+
interface CountItemsRequest {
|
|
443
438
|
/**
|
|
444
439
|
* Items to count.
|
|
445
440
|
*
|
|
@@ -447,210 +442,37 @@ export interface CountItemsRequest {
|
|
|
447
442
|
*/
|
|
448
443
|
filter?: Record<string, any> | null;
|
|
449
444
|
}
|
|
450
|
-
|
|
445
|
+
interface CountItemsResponse {
|
|
451
446
|
/** Number of items fulfilling the specified filter conditions. */
|
|
452
447
|
count?: number;
|
|
453
448
|
}
|
|
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
|
-
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
* Results
|
|
485
|
-
* @minSize 1
|
|
486
|
-
* @maxSize 1000
|
|
487
|
-
*/
|
|
488
|
-
results?: BulkCloneItemSetsResult[];
|
|
489
|
-
/** Bulk action metadata */
|
|
490
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
491
|
-
/**
|
|
492
|
-
* Id of the job that is cloning the item set
|
|
493
|
-
* @format GUID
|
|
494
|
-
*/
|
|
495
|
-
jobId?: string;
|
|
496
|
-
}
|
|
497
|
-
export interface BulkCloneItemSetsResult {
|
|
498
|
-
/** Item metadata */
|
|
499
|
-
itemMetadata?: ItemMetadata;
|
|
500
|
-
/**
|
|
501
|
-
* Id of the item set that these items were added to
|
|
502
|
-
* @format GUID
|
|
503
|
-
*/
|
|
504
|
-
clonedItemSetId?: string;
|
|
505
|
-
}
|
|
506
|
-
export interface AllocateItemSetsRequest {
|
|
507
|
-
/**
|
|
508
|
-
* Number of sets to allocate
|
|
509
|
-
* @min 1
|
|
510
|
-
* @max 1000
|
|
511
|
-
*/
|
|
512
|
-
numberOfSets?: number;
|
|
513
|
-
}
|
|
514
|
-
export interface AllocateItemSetsResponse {
|
|
515
|
-
/**
|
|
516
|
-
* ID that is a shared reference between a benefit pool and a specific item.
|
|
517
|
-
* @format GUID
|
|
518
|
-
*/
|
|
519
|
-
itemSetIds?: string[];
|
|
520
|
-
}
|
|
521
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
522
|
-
createdEvent?: EntityCreatedEvent;
|
|
523
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
524
|
-
deletedEvent?: EntityDeletedEvent;
|
|
525
|
-
actionEvent?: ActionEvent;
|
|
526
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
527
|
-
id?: string;
|
|
528
|
-
/**
|
|
529
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
530
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
531
|
-
*/
|
|
532
|
-
entityFqdn?: string;
|
|
533
|
-
/**
|
|
534
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
535
|
-
* For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
551
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
552
|
-
*/
|
|
553
|
-
entityEventSequence?: string | null;
|
|
554
|
-
}
|
|
555
|
-
/** @oneof */
|
|
556
|
-
export interface DomainEventBodyOneOf {
|
|
557
|
-
createdEvent?: EntityCreatedEvent;
|
|
558
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
559
|
-
deletedEvent?: EntityDeletedEvent;
|
|
560
|
-
actionEvent?: ActionEvent;
|
|
561
|
-
}
|
|
562
|
-
export interface EntityCreatedEvent {
|
|
563
|
-
entityAsJson?: string;
|
|
564
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
565
|
-
restoreInfo?: RestoreInfo;
|
|
566
|
-
}
|
|
567
|
-
export interface RestoreInfo {
|
|
568
|
-
deletedDate?: Date | null;
|
|
569
|
-
}
|
|
570
|
-
export interface EntityUpdatedEvent {
|
|
571
|
-
/**
|
|
572
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
573
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
574
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
575
|
-
*/
|
|
576
|
-
currentEntityAsJson?: string;
|
|
577
|
-
}
|
|
578
|
-
export interface EntityDeletedEvent {
|
|
579
|
-
/** Entity that was deleted. */
|
|
580
|
-
deletedEntityAsJson?: string | null;
|
|
581
|
-
}
|
|
582
|
-
export interface ActionEvent {
|
|
583
|
-
bodyAsJson?: string;
|
|
584
|
-
}
|
|
585
|
-
export interface MessageEnvelope {
|
|
586
|
-
/**
|
|
587
|
-
* App instance ID.
|
|
588
|
-
* @format GUID
|
|
589
|
-
*/
|
|
590
|
-
instanceId?: string | null;
|
|
591
|
-
/**
|
|
592
|
-
* Event type.
|
|
593
|
-
* @maxLength 150
|
|
594
|
-
*/
|
|
595
|
-
eventType?: string;
|
|
596
|
-
/** The identification type and identity data. */
|
|
597
|
-
identity?: IdentificationData;
|
|
598
|
-
/** Stringify payload. */
|
|
599
|
-
data?: string;
|
|
600
|
-
}
|
|
601
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
602
|
-
/**
|
|
603
|
-
* ID of a site visitor that has not logged in to the site.
|
|
604
|
-
* @format GUID
|
|
605
|
-
*/
|
|
606
|
-
anonymousVisitorId?: string;
|
|
607
|
-
/**
|
|
608
|
-
* ID of a site visitor that has logged in to the site.
|
|
609
|
-
* @format GUID
|
|
610
|
-
*/
|
|
611
|
-
memberId?: string;
|
|
612
|
-
/**
|
|
613
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
614
|
-
* @format GUID
|
|
615
|
-
*/
|
|
616
|
-
wixUserId?: string;
|
|
617
|
-
/**
|
|
618
|
-
* ID of an app.
|
|
619
|
-
* @format GUID
|
|
620
|
-
*/
|
|
621
|
-
appId?: string;
|
|
622
|
-
/** @readonly */
|
|
623
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
624
|
-
}
|
|
625
|
-
/** @oneof */
|
|
626
|
-
export interface IdentificationDataIdOneOf {
|
|
627
|
-
/**
|
|
628
|
-
* ID of a site visitor that has not logged in to the site.
|
|
629
|
-
* @format GUID
|
|
630
|
-
*/
|
|
631
|
-
anonymousVisitorId?: string;
|
|
632
|
-
/**
|
|
633
|
-
* ID of a site visitor that has logged in to the site.
|
|
634
|
-
* @format GUID
|
|
635
|
-
*/
|
|
636
|
-
memberId?: string;
|
|
637
|
-
/**
|
|
638
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
639
|
-
* @format GUID
|
|
640
|
-
*/
|
|
641
|
-
wixUserId?: string;
|
|
642
|
-
/**
|
|
643
|
-
* ID of an app.
|
|
644
|
-
* @format GUID
|
|
645
|
-
*/
|
|
646
|
-
appId?: string;
|
|
647
|
-
}
|
|
648
|
-
export declare enum WebhookIdentityType {
|
|
649
|
-
UNKNOWN = "UNKNOWN",
|
|
650
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
651
|
-
MEMBER = "MEMBER",
|
|
652
|
-
WIX_USER = "WIX_USER",
|
|
653
|
-
APP = "APP"
|
|
654
|
-
}
|
|
655
|
-
/** @enumType */
|
|
656
|
-
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
449
|
+
|
|
450
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
451
|
+
getUrl: (context: any) => string;
|
|
452
|
+
httpMethod: K;
|
|
453
|
+
path: string;
|
|
454
|
+
pathParams: M;
|
|
455
|
+
__requestType: T;
|
|
456
|
+
__originalRequestType: S;
|
|
457
|
+
__responseType: Q;
|
|
458
|
+
__originalResponseType: R;
|
|
459
|
+
};
|
|
460
|
+
declare function createItem(): __PublicMethodMetaInfo<'POST', {}, CreateItemRequest$1, CreateItemRequest, CreateItemResponse$1, CreateItemResponse>;
|
|
461
|
+
declare function bulkCreateItems(): __PublicMethodMetaInfo<'POST', {}, BulkCreateItemsRequest$1, BulkCreateItemsRequest, BulkCreateItemsResponse$1, BulkCreateItemsResponse>;
|
|
462
|
+
declare function deleteItem(): __PublicMethodMetaInfo<'POST', {
|
|
463
|
+
itemId: string;
|
|
464
|
+
}, DeleteItemRequest$1, DeleteItemRequest, DeleteItemResponse$1, DeleteItemResponse>;
|
|
465
|
+
declare function bulkDeleteItems(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsRequest$1, BulkDeleteItemsRequest, BulkDeleteItemsResponse$1, BulkDeleteItemsResponse>;
|
|
466
|
+
declare function bulkDeleteItemsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteItemsByFilterRequest$1, BulkDeleteItemsByFilterRequest, BulkDeleteItemsByFilterResponse$1, BulkDeleteItemsByFilterResponse>;
|
|
467
|
+
declare function updateItem(): __PublicMethodMetaInfo<'PATCH', {
|
|
468
|
+
itemId: string;
|
|
469
|
+
}, UpdateItemRequest$1, UpdateItemRequest, UpdateItemResponse$1, UpdateItemResponse>;
|
|
470
|
+
declare function bulkUpdateItems(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateItemsRequest$1, BulkUpdateItemsRequest, BulkUpdateItemsResponse$1, BulkUpdateItemsResponse>;
|
|
471
|
+
declare function getItem(): __PublicMethodMetaInfo<'GET', {
|
|
472
|
+
itemId: string;
|
|
473
|
+
}, GetItemRequest$1, GetItemRequest, GetItemResponse$1, GetItemResponse>;
|
|
474
|
+
declare function listItems(): __PublicMethodMetaInfo<'GET', {}, ListItemsRequest$1, ListItemsRequest, ListItemsResponse$1, ListItemsResponse>;
|
|
475
|
+
declare function queryItems(): __PublicMethodMetaInfo<'POST', {}, QueryItemsRequest$1, QueryItemsRequest, QueryItemsResponse$1, QueryItemsResponse>;
|
|
476
|
+
declare function countItems(): __PublicMethodMetaInfo<'POST', {}, CountItemsRequest$1, CountItemsRequest, CountItemsResponse$1, CountItemsResponse>;
|
|
477
|
+
|
|
478
|
+
export { type __PublicMethodMetaInfo, bulkCreateItems, bulkDeleteItems, bulkDeleteItemsByFilter, bulkUpdateItems, countItems, createItem, deleteItem, getItem, listItems, queryItems, updateItem };
|