@wix/auto_sdk_benefit-programs_transactions 1.0.9 → 1.0.10
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-transaction-transactions.universal.d.ts → benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.d.mts} +49 -93
- package/build/{cjs/src/benefit-programs-v1-transaction-transactions.universal.d.ts → benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.d.ts} +49 -93
- package/build/index.d.mts +35 -0
- package/build/index.d.ts +35 -0
- package/build/index.js +324 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +294 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/benefit-programs-v1-transaction-transactions.universal.d.ts → benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.d.mts} +49 -93
- package/build/{es/src/benefit-programs-v1-transaction-transactions.universal.d.ts → internal/benefit-programs-v1-transaction-transactions.universal-DjQc6kgD.d.ts} +49 -93
- package/build/internal/index.d.mts +35 -0
- package/build/internal/index.d.ts +35 -0
- package/build/internal/index.js +324 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +294 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +345 -0
- package/build/internal/meta.d.ts +345 -0
- package/build/internal/meta.js +224 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +196 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +345 -0
- package/build/meta.d.ts +345 -0
- package/build/meta.js +224 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +196 -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-transaction-transactions.context.d.ts +0 -6
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.context.js +0 -14
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.context.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.d.ts +0 -17
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.js +0 -172
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.meta.d.ts +0 -16
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.meta.js +0 -66
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.meta.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.public.d.ts +0 -32
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.public.js +0 -24
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.public.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.d.ts +0 -587
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js +0 -48
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js.map +0 -1
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.universal.js +0 -184
- package/build/cjs/src/benefit-programs-v1-transaction-transactions.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-transaction-transactions.context.d.ts +0 -6
- package/build/es/src/benefit-programs-v1-transaction-transactions.context.js +0 -6
- package/build/es/src/benefit-programs-v1-transaction-transactions.context.js.map +0 -1
- package/build/es/src/benefit-programs-v1-transaction-transactions.http.d.ts +0 -17
- package/build/es/src/benefit-programs-v1-transaction-transactions.http.js +0 -167
- package/build/es/src/benefit-programs-v1-transaction-transactions.http.js.map +0 -1
- package/build/es/src/benefit-programs-v1-transaction-transactions.meta.d.ts +0 -16
- package/build/es/src/benefit-programs-v1-transaction-transactions.meta.js +0 -38
- package/build/es/src/benefit-programs-v1-transaction-transactions.meta.js.map +0 -1
- package/build/es/src/benefit-programs-v1-transaction-transactions.public.d.ts +0 -32
- package/build/es/src/benefit-programs-v1-transaction-transactions.public.js +0 -14
- package/build/es/src/benefit-programs-v1-transaction-transactions.public.js.map +0 -1
- package/build/es/src/benefit-programs-v1-transaction-transactions.types.d.ts +0 -587
- package/build/es/src/benefit-programs-v1-transaction-transactions.types.js +0 -45
- package/build/es/src/benefit-programs-v1-transaction-transactions.types.js.map +0 -1
- package/build/es/src/benefit-programs-v1-transaction-transactions.universal.js +0 -156
- package/build/es/src/benefit-programs-v1-transaction-transactions.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-transaction-transactions.context.d.ts +0 -6
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.context.js +0 -14
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.context.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.http.d.ts +0 -17
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.http.js +0 -172
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.http.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.meta.d.ts +0 -16
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.meta.js +0 -66
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.meta.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.public.d.ts +0 -32
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.public.js +0 -24
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.public.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.types.d.ts +0 -587
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.types.js +0 -48
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.types.js.map +0 -1
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.universal.js +0 -184
- package/build/internal/cjs/src/benefit-programs-v1-transaction-transactions.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-transaction-transactions.context.d.ts +0 -6
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.context.js +0 -6
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.context.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.http.d.ts +0 -17
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.http.js +0 -167
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.http.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.meta.d.ts +0 -16
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.meta.js +0 -38
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.meta.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.public.d.ts +0 -32
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.public.js +0 -14
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.public.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.types.d.ts +0 -587
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.types.js +0 -45
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.types.js.map +0 -1
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.universal.js +0 -156
- package/build/internal/es/src/benefit-programs-v1-transaction-transactions.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Transaction {
|
|
1
|
+
interface Transaction {
|
|
3
2
|
/**
|
|
4
3
|
* Transaction ID.
|
|
5
4
|
* @format GUID
|
|
@@ -74,7 +73,7 @@ export interface Transaction {
|
|
|
74
73
|
*/
|
|
75
74
|
extendedFields?: ExtendedFields;
|
|
76
75
|
}
|
|
77
|
-
|
|
76
|
+
interface PoolInfo {
|
|
78
77
|
/**
|
|
79
78
|
* Pool ID.
|
|
80
79
|
* @format GUID
|
|
@@ -111,14 +110,14 @@ export interface PoolInfo {
|
|
|
111
110
|
*/
|
|
112
111
|
namespace?: string | null;
|
|
113
112
|
}
|
|
114
|
-
|
|
113
|
+
declare enum BalanceType {
|
|
115
114
|
UNDEFINED = "UNDEFINED",
|
|
116
115
|
/** In a pool's balance. */
|
|
117
116
|
AVAILABLE = "AVAILABLE",
|
|
118
117
|
/** Outside a pool's balance. */
|
|
119
118
|
EXTERNAL = "EXTERNAL"
|
|
120
119
|
}
|
|
121
|
-
|
|
120
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
122
121
|
/**
|
|
123
122
|
* ID of a site visitor that hasn't logged in to the site.
|
|
124
123
|
* @format GUID
|
|
@@ -136,7 +135,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
136
135
|
wixUserId?: string;
|
|
137
136
|
}
|
|
138
137
|
/** @oneof */
|
|
139
|
-
|
|
138
|
+
interface CommonIdentificationDataIdOneOf {
|
|
140
139
|
/**
|
|
141
140
|
* ID of a site visitor that hasn't logged in to the site.
|
|
142
141
|
* @format GUID
|
|
@@ -153,7 +152,7 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
153
152
|
*/
|
|
154
153
|
wixUserId?: string;
|
|
155
154
|
}
|
|
156
|
-
|
|
155
|
+
declare enum IdentityType {
|
|
157
156
|
/** Unknown type. This value is not used. */
|
|
158
157
|
UNKNOWN = "UNKNOWN",
|
|
159
158
|
/** A site visitor who has not logged in. */
|
|
@@ -163,7 +162,7 @@ export declare enum IdentityType {
|
|
|
163
162
|
/** A Wix account holder, such as a site owner or contributor. */
|
|
164
163
|
WIX_USER = "WIX_USER"
|
|
165
164
|
}
|
|
166
|
-
|
|
165
|
+
declare enum TransactionStatus {
|
|
167
166
|
UNDEFINED = "UNDEFINED",
|
|
168
167
|
/** Transaction is pending. This is the initial transaction status. */
|
|
169
168
|
PENDING = "PENDING",
|
|
@@ -172,7 +171,7 @@ export declare enum TransactionStatus {
|
|
|
172
171
|
/** Transaction failed. */
|
|
173
172
|
FAILED = "FAILED"
|
|
174
173
|
}
|
|
175
|
-
|
|
174
|
+
interface TransactionDetails {
|
|
176
175
|
/**
|
|
177
176
|
* Item associated with the transaction.
|
|
178
177
|
* @readonly
|
|
@@ -192,7 +191,7 @@ export interface TransactionDetails {
|
|
|
192
191
|
*/
|
|
193
192
|
reason?: string | null;
|
|
194
193
|
}
|
|
195
|
-
|
|
194
|
+
interface Item {
|
|
196
195
|
/**
|
|
197
196
|
* Item ID.
|
|
198
197
|
* @format GUID
|
|
@@ -224,7 +223,7 @@ export interface Item {
|
|
|
224
223
|
*/
|
|
225
224
|
displayName?: string | null;
|
|
226
225
|
}
|
|
227
|
-
|
|
226
|
+
interface ExtendedFields {
|
|
228
227
|
/**
|
|
229
228
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
230
229
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -235,15 +234,15 @@ export interface ExtendedFields {
|
|
|
235
234
|
*/
|
|
236
235
|
namespaces?: Record<string, Record<string, any>>;
|
|
237
236
|
}
|
|
238
|
-
|
|
237
|
+
interface CreateTransactionRequest {
|
|
239
238
|
/** Transaction to create. */
|
|
240
239
|
transaction?: Transaction;
|
|
241
240
|
}
|
|
242
|
-
|
|
241
|
+
interface CreateTransactionResponse {
|
|
243
242
|
/** Created transaction. */
|
|
244
243
|
transaction?: Transaction;
|
|
245
244
|
}
|
|
246
|
-
|
|
245
|
+
interface BulkCreateTransactionsRequest {
|
|
247
246
|
/**
|
|
248
247
|
* Transactions to be created.
|
|
249
248
|
* @minSize 1
|
|
@@ -257,7 +256,7 @@ export interface BulkCreateTransactionsRequest {
|
|
|
257
256
|
*/
|
|
258
257
|
returnEntity?: boolean;
|
|
259
258
|
}
|
|
260
|
-
|
|
259
|
+
interface BulkCreateTransactionsResponse {
|
|
261
260
|
/**
|
|
262
261
|
* List of results for each transaction.
|
|
263
262
|
*
|
|
@@ -269,13 +268,13 @@ export interface BulkCreateTransactionsResponse {
|
|
|
269
268
|
/** Bulk action metadata. */
|
|
270
269
|
bulkActionMetadata?: BulkActionMetadata;
|
|
271
270
|
}
|
|
272
|
-
|
|
271
|
+
interface BulkTransactionResult {
|
|
273
272
|
/** Metadata for the item. */
|
|
274
273
|
itemMetadata?: ItemMetadata;
|
|
275
274
|
/** Created transaction. */
|
|
276
275
|
transaction?: Transaction;
|
|
277
276
|
}
|
|
278
|
-
|
|
277
|
+
interface ItemMetadata {
|
|
279
278
|
/**
|
|
280
279
|
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
281
280
|
* @format GUID
|
|
@@ -288,7 +287,7 @@ export interface ItemMetadata {
|
|
|
288
287
|
/** Details about the error in case of failure. */
|
|
289
288
|
error?: ApplicationError;
|
|
290
289
|
}
|
|
291
|
-
|
|
290
|
+
interface ApplicationError {
|
|
292
291
|
/** Error code. */
|
|
293
292
|
code?: string;
|
|
294
293
|
/** Description of the error. */
|
|
@@ -296,7 +295,7 @@ export interface ApplicationError {
|
|
|
296
295
|
/** Data related to the error. */
|
|
297
296
|
data?: Record<string, any> | null;
|
|
298
297
|
}
|
|
299
|
-
|
|
298
|
+
interface BulkActionMetadata {
|
|
300
299
|
/** Number of items that were successfully processed. */
|
|
301
300
|
totalSuccesses?: number;
|
|
302
301
|
/** Number of items that couldn't be processed. */
|
|
@@ -304,15 +303,15 @@ export interface BulkActionMetadata {
|
|
|
304
303
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
305
304
|
undetailedFailures?: number;
|
|
306
305
|
}
|
|
307
|
-
|
|
306
|
+
interface UpdateTransactionRequest {
|
|
308
307
|
/** Transaction to update. */
|
|
309
308
|
transaction?: Transaction;
|
|
310
309
|
}
|
|
311
|
-
|
|
310
|
+
interface UpdateTransactionResponse {
|
|
312
311
|
/** Updated transaction. */
|
|
313
312
|
transaction?: Transaction;
|
|
314
313
|
}
|
|
315
|
-
|
|
314
|
+
interface BulkUpdateTransactionsRequest {
|
|
316
315
|
/**
|
|
317
316
|
* Transactions to update.
|
|
318
317
|
* @minSize 1
|
|
@@ -326,13 +325,13 @@ export interface BulkUpdateTransactionsRequest {
|
|
|
326
325
|
*/
|
|
327
326
|
returnEntity?: boolean;
|
|
328
327
|
}
|
|
329
|
-
|
|
328
|
+
interface MaskedTransaction {
|
|
330
329
|
/** Transaction to be updated. */
|
|
331
330
|
transaction?: Transaction;
|
|
332
331
|
/** Explicit list of fields to update. */
|
|
333
332
|
fieldMask?: string[];
|
|
334
333
|
}
|
|
335
|
-
|
|
334
|
+
interface BulkUpdateTransactionsResponse {
|
|
336
335
|
/**
|
|
337
336
|
* List of results for each Transaction.
|
|
338
337
|
*
|
|
@@ -344,22 +343,22 @@ export interface BulkUpdateTransactionsResponse {
|
|
|
344
343
|
/** Bulk action metadata. */
|
|
345
344
|
bulkActionMetadata?: BulkActionMetadata;
|
|
346
345
|
}
|
|
347
|
-
|
|
346
|
+
interface GetTransactionRequest {
|
|
348
347
|
/**
|
|
349
348
|
* ID of the transaction to retrieve.
|
|
350
349
|
* @format GUID
|
|
351
350
|
*/
|
|
352
351
|
transactionId: string;
|
|
353
352
|
}
|
|
354
|
-
|
|
353
|
+
interface GetTransactionResponse {
|
|
355
354
|
/** Retrieved transaction. */
|
|
356
355
|
transaction?: Transaction;
|
|
357
356
|
}
|
|
358
|
-
|
|
357
|
+
interface QueryTransactionsRequest {
|
|
359
358
|
/** Filter, sort, and paging to apply to the query. */
|
|
360
359
|
query: CursorQuery;
|
|
361
360
|
}
|
|
362
|
-
|
|
361
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
363
362
|
/** 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`. */
|
|
364
363
|
cursorPaging?: CursorPaging;
|
|
365
364
|
/**
|
|
@@ -375,11 +374,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
375
374
|
sort?: Sorting[];
|
|
376
375
|
}
|
|
377
376
|
/** @oneof */
|
|
378
|
-
|
|
377
|
+
interface CursorQueryPagingMethodOneOf {
|
|
379
378
|
/** 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`. */
|
|
380
379
|
cursorPaging?: CursorPaging;
|
|
381
380
|
}
|
|
382
|
-
|
|
381
|
+
interface Sorting {
|
|
383
382
|
/**
|
|
384
383
|
* Field to sort by.
|
|
385
384
|
* @maxLength 512
|
|
@@ -392,13 +391,13 @@ export interface Sorting {
|
|
|
392
391
|
*/
|
|
393
392
|
order?: SortOrder;
|
|
394
393
|
}
|
|
395
|
-
|
|
394
|
+
declare enum SortOrder {
|
|
396
395
|
/** Ascending sort order. */
|
|
397
396
|
ASC = "ASC",
|
|
398
397
|
/** Descending sort order. */
|
|
399
398
|
DESC = "DESC"
|
|
400
399
|
}
|
|
401
|
-
|
|
400
|
+
interface CursorPaging {
|
|
402
401
|
/**
|
|
403
402
|
* Maximum number of items to return.
|
|
404
403
|
* @max 100
|
|
@@ -413,13 +412,13 @@ export interface CursorPaging {
|
|
|
413
412
|
*/
|
|
414
413
|
cursor?: string | null;
|
|
415
414
|
}
|
|
416
|
-
|
|
415
|
+
interface QueryTransactionsResponse {
|
|
417
416
|
/** List of retrieved transactions. */
|
|
418
417
|
transactions?: Transaction[];
|
|
419
418
|
/** Metadata for paginated results. */
|
|
420
419
|
metadata?: CursorPagingMetadata;
|
|
421
420
|
}
|
|
422
|
-
|
|
421
|
+
interface CursorPagingMetadata {
|
|
423
422
|
/** Number of items returned in the response. */
|
|
424
423
|
count?: number | null;
|
|
425
424
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -432,7 +431,7 @@ export interface CursorPagingMetadata {
|
|
|
432
431
|
*/
|
|
433
432
|
hasNext?: boolean | null;
|
|
434
433
|
}
|
|
435
|
-
|
|
434
|
+
interface Cursors {
|
|
436
435
|
/**
|
|
437
436
|
* Cursor string pointing to the next page in the list of results.
|
|
438
437
|
* @maxLength 16000
|
|
@@ -444,7 +443,7 @@ export interface Cursors {
|
|
|
444
443
|
*/
|
|
445
444
|
prev?: string | null;
|
|
446
445
|
}
|
|
447
|
-
|
|
446
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
448
447
|
createdEvent?: EntityCreatedEvent;
|
|
449
448
|
updatedEvent?: EntityUpdatedEvent;
|
|
450
449
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -487,19 +486,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
487
486
|
entityEventSequence?: string | null;
|
|
488
487
|
}
|
|
489
488
|
/** @oneof */
|
|
490
|
-
|
|
489
|
+
interface DomainEventBodyOneOf {
|
|
491
490
|
createdEvent?: EntityCreatedEvent;
|
|
492
491
|
updatedEvent?: EntityUpdatedEvent;
|
|
493
492
|
deletedEvent?: EntityDeletedEvent;
|
|
494
493
|
actionEvent?: ActionEvent;
|
|
495
494
|
}
|
|
496
|
-
|
|
495
|
+
interface EntityCreatedEvent {
|
|
497
496
|
entity?: string;
|
|
498
497
|
}
|
|
499
|
-
|
|
498
|
+
interface RestoreInfo {
|
|
500
499
|
deletedDate?: Date | null;
|
|
501
500
|
}
|
|
502
|
-
|
|
501
|
+
interface EntityUpdatedEvent {
|
|
503
502
|
/**
|
|
504
503
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
505
504
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -507,14 +506,14 @@ export interface EntityUpdatedEvent {
|
|
|
507
506
|
*/
|
|
508
507
|
currentEntity?: string;
|
|
509
508
|
}
|
|
510
|
-
|
|
509
|
+
interface EntityDeletedEvent {
|
|
511
510
|
/** Entity that was deleted */
|
|
512
511
|
deletedEntity?: string | null;
|
|
513
512
|
}
|
|
514
|
-
|
|
513
|
+
interface ActionEvent {
|
|
515
514
|
body?: string;
|
|
516
515
|
}
|
|
517
|
-
|
|
516
|
+
interface MessageEnvelope {
|
|
518
517
|
/**
|
|
519
518
|
* App instance ID.
|
|
520
519
|
* @format GUID
|
|
@@ -530,7 +529,7 @@ export interface MessageEnvelope {
|
|
|
530
529
|
/** Stringify payload. */
|
|
531
530
|
data?: string;
|
|
532
531
|
}
|
|
533
|
-
|
|
532
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
534
533
|
/**
|
|
535
534
|
* ID of a site visitor that has not logged in to the site.
|
|
536
535
|
* @format GUID
|
|
@@ -555,7 +554,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
555
554
|
identityType?: WebhookIdentityType;
|
|
556
555
|
}
|
|
557
556
|
/** @oneof */
|
|
558
|
-
|
|
557
|
+
interface IdentificationDataIdOneOf {
|
|
559
558
|
/**
|
|
560
559
|
* ID of a site visitor that has not logged in to the site.
|
|
561
560
|
* @format GUID
|
|
@@ -577,57 +576,13 @@ export interface IdentificationDataIdOneOf {
|
|
|
577
576
|
*/
|
|
578
577
|
appId?: string;
|
|
579
578
|
}
|
|
580
|
-
|
|
579
|
+
declare enum WebhookIdentityType {
|
|
581
580
|
UNKNOWN = "UNKNOWN",
|
|
582
581
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
583
582
|
MEMBER = "MEMBER",
|
|
584
583
|
WIX_USER = "WIX_USER",
|
|
585
584
|
APP = "APP"
|
|
586
585
|
}
|
|
587
|
-
type TransactionNonNullablePaths = `pool._id` | `amount` | `source` | `target` | `idempotencyKey` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `instructingParty.anonymousVisitorId` | `instructingParty.memberId` | `instructingParty.wixUserId` | `status`;
|
|
588
|
-
/**
|
|
589
|
-
* Retrieves a transaction.
|
|
590
|
-
* @param transactionId - ID of the transaction to retrieve.
|
|
591
|
-
* @public
|
|
592
|
-
* @documentationMaturity preview
|
|
593
|
-
* @requiredField transactionId
|
|
594
|
-
* @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
|
|
595
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
596
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
597
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
598
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
599
|
-
* @permissionScope Manage Events
|
|
600
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
601
|
-
* @applicableIdentity APP
|
|
602
|
-
* @returns Retrieved transaction.
|
|
603
|
-
* @fqn wix.benefit_programs.v1.transaction.TransactionService.GetTransaction
|
|
604
|
-
*/
|
|
605
|
-
export declare function getTransaction(transactionId: string): Promise<NonNullablePaths<Transaction, TransactionNonNullablePaths>>;
|
|
606
|
-
/**
|
|
607
|
-
* Creates a query to retrieve a list of transactions.
|
|
608
|
-
*
|
|
609
|
-
* The Query Transactions method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
|
|
610
|
-
*
|
|
611
|
-
* The returned object contains the query definition, which is used to run the query using the `find()` method.
|
|
612
|
-
*
|
|
613
|
-
* You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Transactions returns.
|
|
614
|
-
*
|
|
615
|
-
* Query Transactions has a default paging limit of 50, which you can override.
|
|
616
|
-
*
|
|
617
|
-
* For a full description of the item object, see the object returned for the `items` property in `TransactionsQueryResult`.
|
|
618
|
-
* @public
|
|
619
|
-
* @documentationMaturity preview
|
|
620
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
621
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
|
|
622
|
-
* @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
|
|
623
|
-
* @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
|
|
624
|
-
* @permissionScope Manage Events
|
|
625
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
626
|
-
* @permissionId BENEFIT_PROGRAMS.TRANSACTION_READ
|
|
627
|
-
* @applicableIdentity APP
|
|
628
|
-
* @fqn wix.benefit_programs.v1.transaction.TransactionService.QueryTransactions
|
|
629
|
-
*/
|
|
630
|
-
export declare function queryTransactions(): TransactionsQueryBuilder;
|
|
631
586
|
interface QueryCursorResult {
|
|
632
587
|
cursors: Cursors;
|
|
633
588
|
hasNext: () => boolean;
|
|
@@ -635,13 +590,13 @@ interface QueryCursorResult {
|
|
|
635
590
|
length: number;
|
|
636
591
|
pageSize: number;
|
|
637
592
|
}
|
|
638
|
-
|
|
593
|
+
interface TransactionsQueryResult extends QueryCursorResult {
|
|
639
594
|
items: Transaction[];
|
|
640
595
|
query: TransactionsQueryBuilder;
|
|
641
596
|
next: () => Promise<TransactionsQueryResult>;
|
|
642
597
|
prev: () => Promise<TransactionsQueryResult>;
|
|
643
598
|
}
|
|
644
|
-
|
|
599
|
+
interface TransactionsQueryBuilder {
|
|
645
600
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
646
601
|
* @param value - Value to compare against.
|
|
647
602
|
* @documentationMaturity preview
|
|
@@ -705,4 +660,5 @@ export interface TransactionsQueryBuilder {
|
|
|
705
660
|
/** @documentationMaturity preview */
|
|
706
661
|
find: () => Promise<TransactionsQueryResult>;
|
|
707
662
|
}
|
|
708
|
-
|
|
663
|
+
|
|
664
|
+
export { type ApplicationError as A, BalanceType as B, type CommonIdentificationData as C, type DomainEvent as D, type ExtendedFields as E, type EntityDeletedEvent as F, type GetTransactionRequest as G, type ActionEvent as H, IdentityType as I, type MessageEnvelope as J, type IdentificationData as K, type IdentificationDataIdOneOf as L, type MaskedTransaction as M, type TransactionsQueryResult as N, type PoolInfo as P, type QueryTransactionsRequest as Q, type RestoreInfo as R, SortOrder as S, type Transaction as T, type UpdateTransactionRequest as U, WebhookIdentityType as W, type TransactionsQueryBuilder as a, TransactionStatus as b, type CommonIdentificationDataIdOneOf as c, type TransactionDetails as d, type Item as e, type CreateTransactionRequest as f, type CreateTransactionResponse as g, type BulkCreateTransactionsRequest as h, type BulkCreateTransactionsResponse as i, type BulkTransactionResult as j, type ItemMetadata as k, type BulkActionMetadata as l, type UpdateTransactionResponse as m, type BulkUpdateTransactionsRequest as n, type BulkUpdateTransactionsResponse as o, type GetTransactionResponse as p, type CursorQuery as q, type CursorQueryPagingMethodOneOf as r, type Sorting as s, type CursorPaging as t, type QueryTransactionsResponse as u, type CursorPagingMetadata as v, type Cursors as w, type DomainEventBodyOneOf as x, type EntityCreatedEvent as y, type EntityUpdatedEvent as z };
|