@wix/auto_sdk_benefit-programs_balances 1.0.8 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/{internal/cjs/src/benefit-programs-v1-balance-balances.universal.d.ts → benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.mts} +66 -169
  2. package/build/{cjs/src/benefit-programs-v1-balance-balances.universal.d.ts → benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.ts} +66 -169
  3. package/build/index.d.mts +72 -0
  4. package/build/index.d.ts +72 -0
  5. package/build/index.js +573 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +538 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/benefit-programs-v1-balance-balances.universal.d.ts → internal/benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.mts} +66 -169
  10. package/build/internal/{es/src/benefit-programs-v1-balance-balances.universal.d.ts → benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.ts} +66 -169
  11. package/build/internal/index.d.mts +72 -0
  12. package/build/internal/index.d.ts +72 -0
  13. package/build/internal/index.js +573 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +538 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +431 -0
  18. package/build/internal/meta.d.ts +431 -0
  19. package/build/internal/meta.js +391 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +360 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +431 -0
  24. package/build/meta.d.ts +431 -0
  25. package/build/meta.js +391 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +360 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/benefit-programs-v1-balance-balances.context.d.ts +0 -9
  40. package/build/cjs/src/benefit-programs-v1-balance-balances.context.js +0 -19
  41. package/build/cjs/src/benefit-programs-v1-balance-balances.context.js.map +0 -1
  42. package/build/cjs/src/benefit-programs-v1-balance-balances.http.d.ts +0 -34
  43. package/build/cjs/src/benefit-programs-v1-balance-balances.http.js +0 -296
  44. package/build/cjs/src/benefit-programs-v1-balance-balances.http.js.map +0 -1
  45. package/build/cjs/src/benefit-programs-v1-balance-balances.meta.d.ts +0 -23
  46. package/build/cjs/src/benefit-programs-v1-balance-balances.meta.js +0 -123
  47. package/build/cjs/src/benefit-programs-v1-balance-balances.meta.js.map +0 -1
  48. package/build/cjs/src/benefit-programs-v1-balance-balances.public.d.ts +0 -66
  49. package/build/cjs/src/benefit-programs-v1-balance-balances.public.js +0 -44
  50. package/build/cjs/src/benefit-programs-v1-balance-balances.public.js.map +0 -1
  51. package/build/cjs/src/benefit-programs-v1-balance-balances.types.d.ts +0 -719
  52. package/build/cjs/src/benefit-programs-v1-balance-balances.types.js +0 -63
  53. package/build/cjs/src/benefit-programs-v1-balance-balances.types.js.map +0 -1
  54. package/build/cjs/src/benefit-programs-v1-balance-balances.universal.js +0 -345
  55. package/build/cjs/src/benefit-programs-v1-balance-balances.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/benefit-programs-v1-balance-balances.context.d.ts +0 -9
  67. package/build/es/src/benefit-programs-v1-balance-balances.context.js +0 -9
  68. package/build/es/src/benefit-programs-v1-balance-balances.context.js.map +0 -1
  69. package/build/es/src/benefit-programs-v1-balance-balances.http.d.ts +0 -34
  70. package/build/es/src/benefit-programs-v1-balance-balances.http.js +0 -288
  71. package/build/es/src/benefit-programs-v1-balance-balances.http.js.map +0 -1
  72. package/build/es/src/benefit-programs-v1-balance-balances.meta.d.ts +0 -23
  73. package/build/es/src/benefit-programs-v1-balance-balances.meta.js +0 -92
  74. package/build/es/src/benefit-programs-v1-balance-balances.meta.js.map +0 -1
  75. package/build/es/src/benefit-programs-v1-balance-balances.public.d.ts +0 -66
  76. package/build/es/src/benefit-programs-v1-balance-balances.public.js +0 -29
  77. package/build/es/src/benefit-programs-v1-balance-balances.public.js.map +0 -1
  78. package/build/es/src/benefit-programs-v1-balance-balances.types.d.ts +0 -719
  79. package/build/es/src/benefit-programs-v1-balance-balances.types.js +0 -60
  80. package/build/es/src/benefit-programs-v1-balance-balances.types.js.map +0 -1
  81. package/build/es/src/benefit-programs-v1-balance-balances.universal.js +0 -314
  82. package/build/es/src/benefit-programs-v1-balance-balances.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.context.d.ts +0 -9
  93. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.context.js +0 -19
  94. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.context.js.map +0 -1
  95. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.http.d.ts +0 -34
  96. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.http.js +0 -296
  97. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.http.js.map +0 -1
  98. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.meta.d.ts +0 -23
  99. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.meta.js +0 -123
  100. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.meta.js.map +0 -1
  101. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.public.d.ts +0 -66
  102. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.public.js +0 -44
  103. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.public.js.map +0 -1
  104. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.types.d.ts +0 -719
  105. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.types.js +0 -63
  106. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.types.js.map +0 -1
  107. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.js +0 -345
  108. package/build/internal/cjs/src/benefit-programs-v1-balance-balances.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/benefit-programs-v1-balance-balances.context.d.ts +0 -9
  119. package/build/internal/es/src/benefit-programs-v1-balance-balances.context.js +0 -9
  120. package/build/internal/es/src/benefit-programs-v1-balance-balances.context.js.map +0 -1
  121. package/build/internal/es/src/benefit-programs-v1-balance-balances.http.d.ts +0 -34
  122. package/build/internal/es/src/benefit-programs-v1-balance-balances.http.js +0 -288
  123. package/build/internal/es/src/benefit-programs-v1-balance-balances.http.js.map +0 -1
  124. package/build/internal/es/src/benefit-programs-v1-balance-balances.meta.d.ts +0 -23
  125. package/build/internal/es/src/benefit-programs-v1-balance-balances.meta.js +0 -92
  126. package/build/internal/es/src/benefit-programs-v1-balance-balances.meta.js.map +0 -1
  127. package/build/internal/es/src/benefit-programs-v1-balance-balances.public.d.ts +0 -66
  128. package/build/internal/es/src/benefit-programs-v1-balance-balances.public.js +0 -29
  129. package/build/internal/es/src/benefit-programs-v1-balance-balances.public.js.map +0 -1
  130. package/build/internal/es/src/benefit-programs-v1-balance-balances.types.d.ts +0 -719
  131. package/build/internal/es/src/benefit-programs-v1-balance-balances.types.js +0 -60
  132. package/build/internal/es/src/benefit-programs-v1-balance-balances.types.js.map +0 -1
  133. package/build/internal/es/src/benefit-programs-v1-balance-balances.universal.js +0 -314
  134. package/build/internal/es/src/benefit-programs-v1-balance-balances.universal.js.map +0 -1
@@ -1,5 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface Balance {
1
+ interface Balance {
3
2
  /**
4
3
  * Balance ID. This is the same as the associated pool's ID.
5
4
  * @format GUID
@@ -51,7 +50,7 @@ export interface Balance {
51
50
  */
52
51
  lastTransactionId?: string | null;
53
52
  }
54
- export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
53
+ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
55
54
  /**
56
55
  * ID of a site visitor that hasn't logged in to the site.
57
56
  * @format GUID
@@ -69,7 +68,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
69
68
  wixUserId?: string;
70
69
  }
71
70
  /** @oneof */
72
- export interface CommonIdentificationDataIdOneOf {
71
+ interface CommonIdentificationDataIdOneOf {
73
72
  /**
74
73
  * ID of a site visitor that hasn't logged in to the site.
75
74
  * @format GUID
@@ -86,7 +85,7 @@ export interface CommonIdentificationDataIdOneOf {
86
85
  */
87
86
  wixUserId?: string;
88
87
  }
89
- export declare enum IdentityType {
88
+ declare enum IdentityType {
90
89
  /** Unknown type. This value is not used. */
91
90
  UNKNOWN = "UNKNOWN",
92
91
  /** A site visitor who has not logged in. */
@@ -96,7 +95,7 @@ export declare enum IdentityType {
96
95
  /** A Wix account holder, such as a site owner or contributor. */
97
96
  WIX_USER = "WIX_USER"
98
97
  }
99
- export interface BalanceAmount {
98
+ interface BalanceAmount {
100
99
  /**
101
100
  * number of available credits.
102
101
  * @decimalValue options { maxScale:4 }
@@ -104,7 +103,7 @@ export interface BalanceAmount {
104
103
  */
105
104
  available?: string;
106
105
  }
107
- export interface PoolInfo {
106
+ interface PoolInfo {
108
107
  /**
109
108
  * Pool ID.
110
109
  * @format GUID
@@ -141,7 +140,7 @@ export interface PoolInfo {
141
140
  */
142
141
  namespace?: string | null;
143
142
  }
144
- export interface ExtendedFields {
143
+ interface ExtendedFields {
145
144
  /**
146
145
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
147
146
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -152,18 +151,18 @@ export interface ExtendedFields {
152
151
  */
153
152
  namespaces?: Record<string, Record<string, any>>;
154
153
  }
155
- export interface GetBalanceRequest {
154
+ interface GetBalanceRequest {
156
155
  /**
157
156
  * ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
158
157
  * @format GUID
159
158
  */
160
159
  poolId: string;
161
160
  }
162
- export interface GetBalanceResponse {
161
+ interface GetBalanceResponse {
163
162
  /** Retrieved balance. */
164
163
  balance?: Balance;
165
164
  }
166
- export interface ListBalancesRequest {
165
+ interface ListBalancesRequest {
167
166
  /**
168
167
  * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
169
168
  * @format GUID
@@ -173,7 +172,7 @@ export interface ListBalancesRequest {
173
172
  /** Cursor paging. */
174
173
  cursorPaging?: CursorPaging;
175
174
  }
176
- export interface CursorPaging {
175
+ interface CursorPaging {
177
176
  /**
178
177
  * Maximum number of items to return.
179
178
  * @max 100
@@ -188,7 +187,7 @@ export interface CursorPaging {
188
187
  */
189
188
  cursor?: string | null;
190
189
  }
191
- export interface ListBalancesResponse {
190
+ interface ListBalancesResponse {
192
191
  /**
193
192
  * Retrieved balances.
194
193
  * @maxSize 100
@@ -197,7 +196,7 @@ export interface ListBalancesResponse {
197
196
  /** Metadata for paginated results. */
198
197
  metadata?: CursorPagingMetadata;
199
198
  }
200
- export interface CursorPagingMetadata {
199
+ interface CursorPagingMetadata {
201
200
  /** Number of items returned in the response. */
202
201
  count?: number | null;
203
202
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -210,7 +209,7 @@ export interface CursorPagingMetadata {
210
209
  */
211
210
  hasNext?: boolean | null;
212
211
  }
213
- export interface Cursors {
212
+ interface Cursors {
214
213
  /**
215
214
  * Cursor string pointing to the next page in the list of results.
216
215
  * @maxLength 16000
@@ -222,11 +221,11 @@ export interface Cursors {
222
221
  */
223
222
  prev?: string | null;
224
223
  }
225
- export interface QueryBalancesRequest {
224
+ interface QueryBalancesRequest {
226
225
  /** Filter, sort, and paging to apply to the query. */
227
226
  query?: CursorQuery;
228
227
  }
229
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
228
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
230
229
  /** 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`. */
231
230
  cursorPaging?: CursorPaging;
232
231
  /**
@@ -242,11 +241,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
242
241
  sort?: Sorting[];
243
242
  }
244
243
  /** @oneof */
245
- export interface CursorQueryPagingMethodOneOf {
244
+ interface CursorQueryPagingMethodOneOf {
246
245
  /** 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`. */
247
246
  cursorPaging?: CursorPaging;
248
247
  }
249
- export interface Sorting {
248
+ interface Sorting {
250
249
  /**
251
250
  * Field to sort by.
252
251
  * @maxLength 512
@@ -259,19 +258,19 @@ export interface Sorting {
259
258
  */
260
259
  order?: SortOrder;
261
260
  }
262
- export declare enum SortOrder {
261
+ declare enum SortOrder {
263
262
  /** Ascending sort order. */
264
263
  ASC = "ASC",
265
264
  /** Descending sort order. */
266
265
  DESC = "DESC"
267
266
  }
268
- export interface QueryBalancesResponse {
267
+ interface QueryBalancesResponse {
269
268
  /** List of retrieved balances. */
270
269
  balances?: Balance[];
271
270
  /** Metadata for the paginated results. */
272
271
  metadata?: CursorPagingMetadata;
273
272
  }
274
- export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
273
+ interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
275
274
  /** Adjust the balance by a specific number of credits. */
276
275
  adjustOptions?: AdjustOptions;
277
276
  /** Set the balance to a specific number of credits. */
@@ -295,13 +294,13 @@ export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequest
295
294
  transactionDetails?: TransactionDetails;
296
295
  }
297
296
  /** @oneof */
298
- export interface BalanceChangeBalanceRequestOperationOneOf {
297
+ interface BalanceChangeBalanceRequestOperationOneOf {
299
298
  /** Adjust the balance by a specific number of credits. */
300
299
  adjustOptions?: AdjustOptions;
301
300
  /** Set the balance to a specific number of credits. */
302
301
  setOptions?: SetOptions;
303
302
  }
304
- export declare enum ChangeBalanceRequestType {
303
+ declare enum ChangeBalanceRequestType {
305
304
  /** Unknown balance change type. */
306
305
  UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
307
306
  /** Use with `adjustOptions`. */
@@ -309,7 +308,7 @@ export declare enum ChangeBalanceRequestType {
309
308
  /** Use with `setOptions`. */
310
309
  SET = "SET"
311
310
  }
312
- export interface AdjustOptions {
311
+ interface AdjustOptions {
313
312
  /**
314
313
  * Amount to change the balance's available credits by.
315
314
  * - To increase the balance, specify a positive number.
@@ -320,7 +319,7 @@ export interface AdjustOptions {
320
319
  /** Beneficiary of the associated pool. */
321
320
  beneficiary?: CommonIdentificationData;
322
321
  }
323
- export declare enum LimitRule {
322
+ declare enum LimitRule {
324
323
  /** Unknown limit rule */
325
324
  UNKNOWN_LIMIT_RULE = "UNKNOWN_LIMIT_RULE",
326
325
  /** If the limit is exceeded, the operation will fail */
@@ -330,7 +329,7 @@ export declare enum LimitRule {
330
329
  /** If the limit is exceeded, the operation will succeed but the balance will be adjusted so that it satisfies the provided limits. If the resulting balance is below the lower_limit, it will be set to the lower_limit. If the resulting balance is above the upper_limit, it will be set to the upper_limit. */
331
330
  HARD_ENFORCE = "HARD_ENFORCE"
332
331
  }
333
- export interface SetOptions {
332
+ interface SetOptions {
334
333
  /**
335
334
  * Amount to set the balance's available credits to.
336
335
  *
@@ -341,7 +340,7 @@ export interface SetOptions {
341
340
  /** Beneficiary of the associated pool. */
342
341
  beneficiary?: CommonIdentificationData;
343
342
  }
344
- export interface SetInitialOptions {
343
+ interface SetInitialOptions {
345
344
  /**
346
345
  * Set the available balance to the provided amount.
347
346
  * @decimalValue options { maxScale:4 }
@@ -350,7 +349,7 @@ export interface SetInitialOptions {
350
349
  /** Benefit pool owner associated with this balance. */
351
350
  beneficiary?: CommonIdentificationData;
352
351
  }
353
- export interface TransactionDetails {
352
+ interface TransactionDetails {
354
353
  /**
355
354
  * Item associated with the transaction.
356
355
  * @readonly
@@ -370,7 +369,7 @@ export interface TransactionDetails {
370
369
  */
371
370
  reason?: string | null;
372
371
  }
373
- export interface Item {
372
+ interface Item {
374
373
  /**
375
374
  * Item ID.
376
375
  * @format GUID
@@ -402,7 +401,7 @@ export interface Item {
402
401
  */
403
402
  displayName?: string | null;
404
403
  }
405
- export interface ChangeBalanceResponse {
404
+ interface ChangeBalanceResponse {
406
405
  /** Updated balance. */
407
406
  balance?: Balance;
408
407
  /**
@@ -411,7 +410,7 @@ export interface ChangeBalanceResponse {
411
410
  */
412
411
  transactionId?: string | null;
413
412
  }
414
- export interface BalanceExceededLimits {
413
+ interface BalanceExceededLimits {
415
414
  /** Current balance */
416
415
  balance?: BalanceAmount;
417
416
  /**
@@ -433,7 +432,7 @@ export interface BalanceExceededLimits {
433
432
  */
434
433
  upperLimit?: string | null;
435
434
  }
436
- export interface BulkChangeBalancesRequest {
435
+ interface BulkChangeBalancesRequest {
437
436
  /**
438
437
  * List of balances to change.
439
438
  * @minSize 1
@@ -449,11 +448,11 @@ export interface BulkChangeBalancesRequest {
449
448
  /** Whether to return the full balance entities in the response. */
450
449
  returnEntity?: boolean;
451
450
  }
452
- export declare enum Type {
451
+ declare enum Type {
453
452
  /** Unknown balance change type. */
454
453
  UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
455
454
  }
456
- export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
455
+ interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
457
456
  /**
458
457
  * ID of the pool associated with the balance to change. This is also the ID of the balance.
459
458
  * @format GUID
@@ -467,9 +466,9 @@ export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf
467
466
  transactionDetails?: TransactionDetails;
468
467
  }
469
468
  /** @oneof */
470
- export interface ChangeBalanceRequestOperationOneOf {
469
+ interface ChangeBalanceRequestOperationOneOf {
471
470
  }
472
- export interface BulkChangeBalancesResponse {
471
+ interface BulkChangeBalancesResponse {
473
472
  /**
474
473
  * Updated item and associated metadata.
475
474
  * @minSize 1
@@ -479,7 +478,7 @@ export interface BulkChangeBalancesResponse {
479
478
  /** Metadata. */
480
479
  bulkActionMetadata?: BulkActionMetadata;
481
480
  }
482
- export interface ItemMetadata {
481
+ interface ItemMetadata {
483
482
  /**
484
483
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
485
484
  * @format GUID
@@ -492,7 +491,7 @@ export interface ItemMetadata {
492
491
  /** Details about the error in case of failure. */
493
492
  error?: ApplicationError;
494
493
  }
495
- export interface ApplicationError {
494
+ interface ApplicationError {
496
495
  /** Error code. */
497
496
  code?: string;
498
497
  /** Description of the error. */
@@ -500,13 +499,13 @@ export interface ApplicationError {
500
499
  /** Data related to the error. */
501
500
  data?: Record<string, any> | null;
502
501
  }
503
- export interface BulkChangeBalanceResult {
502
+ interface BulkChangeBalanceResult {
504
503
  /** Item metadata. */
505
504
  itemMetadata?: ItemMetadata;
506
505
  /** Updated item. */
507
506
  balance?: Balance;
508
507
  }
509
- export interface BulkActionMetadata {
508
+ interface BulkActionMetadata {
510
509
  /** Number of items that were successfully processed. */
511
510
  totalSuccesses?: number;
512
511
  /** Number of items that couldn't be processed. */
@@ -514,7 +513,7 @@ export interface BulkActionMetadata {
514
513
  /** Number of failures without details because detailed failure threshold was exceeded. */
515
514
  undetailedFailures?: number;
516
515
  }
517
- export interface RevertBalanceChangeRequest {
516
+ interface RevertBalanceChangeRequest {
518
517
  /**
519
518
  * ID of the transaction associated with the balance change to revert.
520
519
  * @format GUID
@@ -529,14 +528,14 @@ export interface RevertBalanceChangeRequest {
529
528
  /** Identity reverting the balance change. */
530
529
  instructingParty?: CommonIdentificationData;
531
530
  }
532
- export interface RevertBalanceChangeResponse {
531
+ interface RevertBalanceChangeResponse {
533
532
  /**
534
533
  * ID of the transaction associated with the balance reversion.
535
534
  * @format GUID
536
535
  */
537
536
  transactionId?: string | null;
538
537
  }
539
- export interface ChangeAlreadyReverted {
538
+ interface ChangeAlreadyReverted {
540
539
  /**
541
540
  * The id of the transaction which was already reverted
542
541
  * @format GUID
@@ -548,7 +547,7 @@ export interface ChangeAlreadyReverted {
548
547
  */
549
548
  revertedTransactionId?: string;
550
549
  }
551
- export interface NotEnoughBalance {
550
+ interface NotEnoughBalance {
552
551
  /** Current balance */
553
552
  balance?: BalanceAmount;
554
553
  /**
@@ -558,25 +557,25 @@ export interface NotEnoughBalance {
558
557
  */
559
558
  requested?: string;
560
559
  }
561
- export interface GetTransactionReversibilityRequest {
560
+ interface GetTransactionReversibilityRequest {
562
561
  /**
563
562
  * Id of the transaction to get the reversibility
564
563
  * @format GUID
565
564
  */
566
565
  transactionId?: string;
567
566
  }
568
- export interface GetTransactionReversibilityResponse {
567
+ interface GetTransactionReversibilityResponse {
569
568
  /** The result of transaction reversibility validation */
570
569
  transactionReversibility?: TransactionReversibility;
571
570
  }
572
571
  /** Transaction reversibility results */
573
- export declare enum TransactionReversibility {
572
+ declare enum TransactionReversibility {
574
573
  /** Transaction is allowed to be reverted */
575
574
  TRANSACTION_IS_REVERSIBLE = "TRANSACTION_IS_REVERSIBLE",
576
575
  /** Transaction isn't allowed to be reverted, because it was already reverted */
577
576
  TRANSACTION_ALREADY_REVERSED = "TRANSACTION_ALREADY_REVERSED"
578
577
  }
579
- export interface DomainEvent extends DomainEventBodyOneOf {
578
+ interface DomainEvent extends DomainEventBodyOneOf {
580
579
  createdEvent?: EntityCreatedEvent;
581
580
  updatedEvent?: EntityUpdatedEvent;
582
581
  deletedEvent?: EntityDeletedEvent;
@@ -619,19 +618,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
619
618
  entityEventSequence?: string | null;
620
619
  }
621
620
  /** @oneof */
622
- export interface DomainEventBodyOneOf {
621
+ interface DomainEventBodyOneOf {
623
622
  createdEvent?: EntityCreatedEvent;
624
623
  updatedEvent?: EntityUpdatedEvent;
625
624
  deletedEvent?: EntityDeletedEvent;
626
625
  actionEvent?: ActionEvent;
627
626
  }
628
- export interface EntityCreatedEvent {
627
+ interface EntityCreatedEvent {
629
628
  entity?: string;
630
629
  }
631
- export interface RestoreInfo {
630
+ interface RestoreInfo {
632
631
  deletedDate?: Date | null;
633
632
  }
634
- export interface EntityUpdatedEvent {
633
+ interface EntityUpdatedEvent {
635
634
  /**
636
635
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
637
636
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -639,14 +638,14 @@ export interface EntityUpdatedEvent {
639
638
  */
640
639
  currentEntity?: string;
641
640
  }
642
- export interface EntityDeletedEvent {
641
+ interface EntityDeletedEvent {
643
642
  /** Entity that was deleted */
644
643
  deletedEntity?: string | null;
645
644
  }
646
- export interface ActionEvent {
645
+ interface ActionEvent {
647
646
  body?: string;
648
647
  }
649
- export interface MessageEnvelope {
648
+ interface MessageEnvelope {
650
649
  /**
651
650
  * App instance ID.
652
651
  * @format GUID
@@ -662,7 +661,7 @@ export interface MessageEnvelope {
662
661
  /** Stringify payload. */
663
662
  data?: string;
664
663
  }
665
- export interface IdentificationData extends IdentificationDataIdOneOf {
664
+ interface IdentificationData extends IdentificationDataIdOneOf {
666
665
  /**
667
666
  * ID of a site visitor that has not logged in to the site.
668
667
  * @format GUID
@@ -687,7 +686,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
687
686
  identityType?: WebhookIdentityType;
688
687
  }
689
688
  /** @oneof */
690
- export interface IdentificationDataIdOneOf {
689
+ interface IdentificationDataIdOneOf {
691
690
  /**
692
691
  * ID of a site visitor that has not logged in to the site.
693
692
  * @format GUID
@@ -709,50 +708,14 @@ export interface IdentificationDataIdOneOf {
709
708
  */
710
709
  appId?: string;
711
710
  }
712
- export declare enum WebhookIdentityType {
711
+ declare enum WebhookIdentityType {
713
712
  UNKNOWN = "UNKNOWN",
714
713
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
715
714
  MEMBER = "MEMBER",
716
715
  WIX_USER = "WIX_USER",
717
716
  APP = "APP"
718
717
  }
719
- type BalanceNonNullablePaths = `_id` | `beneficiary.anonymousVisitorId` | `beneficiary.memberId` | `beneficiary.wixUserId` | `amount.available` | `poolInfo._id`;
720
- /**
721
- * Retrieves a balance.
722
- * @param poolId - ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
723
- * @public
724
- * @documentationMaturity preview
725
- * @requiredField poolId
726
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
727
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
728
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
729
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
730
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
731
- * @permissionScope Manage Events
732
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
733
- * @applicableIdentity APP
734
- * @returns Retrieved balance.
735
- * @fqn wix.benefit_programs.v1.balance.BalanceService.GetBalance
736
- */
737
- export declare function getBalance(poolId: string): Promise<NonNullablePaths<Balance, BalanceNonNullablePaths>>;
738
- /**
739
- * Retrieves a list of balances.
740
- * @public
741
- * @documentationMaturity preview
742
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
743
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
744
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
745
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
746
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
747
- * @permissionScope Manage Events
748
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
749
- * @applicableIdentity APP
750
- * @fqn wix.benefit_programs.v1.balance.BalanceService.ListBalances
751
- */
752
- export declare function listBalances(options?: ListBalancesOptions): Promise<NonNullablePaths<ListBalancesResponse, {
753
- [P in BalanceNonNullablePaths]: `balances.${number}.${P}`;
754
- }[BalanceNonNullablePaths]>>;
755
- export interface ListBalancesOptions {
718
+ interface ListBalancesOptions {
756
719
  /**
757
720
  * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
758
721
  * @format GUID
@@ -762,31 +725,6 @@ export interface ListBalancesOptions {
762
725
  /** Cursor paging. */
763
726
  cursorPaging?: CursorPaging;
764
727
  }
765
- /**
766
- * Creates a query to retrieve a list of balances.
767
- *
768
- * The Query Balances method builds a query to retrieve a list of balances and returns a `BalancesQueryBuilder` object.
769
- *
770
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
771
- *
772
- * You can refine the query by chaining `BalancesQueryBuilder` methods onto the query. `BalancesQueryBuilder` methods enable you to filter, sort, and control the results that Query Balances returns.
773
- *
774
- * Query Balances has a default paging limit of 50, which you can override.
775
- *
776
- * For a full description of the item object, see the object returned for the `items` property in `BalancesQueryResult`.
777
- * @public
778
- * @documentationMaturity preview
779
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
780
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
781
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
782
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
783
- * @permissionScope Manage Events
784
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
785
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
786
- * @applicableIdentity APP
787
- * @fqn wix.benefit_programs.v1.balance.BalanceService.QueryBalances
788
- */
789
- export declare function queryBalances(): BalancesQueryBuilder;
790
728
  interface QueryCursorResult {
791
729
  cursors: Cursors;
792
730
  hasNext: () => boolean;
@@ -794,13 +732,13 @@ interface QueryCursorResult {
794
732
  length: number;
795
733
  pageSize: number;
796
734
  }
797
- export interface BalancesQueryResult extends QueryCursorResult {
735
+ interface BalancesQueryResult extends QueryCursorResult {
798
736
  items: Balance[];
799
737
  query: BalancesQueryBuilder;
800
738
  next: () => Promise<BalancesQueryResult>;
801
739
  prev: () => Promise<BalancesQueryResult>;
802
740
  }
803
- export interface BalancesQueryBuilder {
741
+ interface BalancesQueryBuilder {
804
742
  /** @param propertyName - Property whose value is compared with `value`.
805
743
  * @param value - Value to compare against.
806
744
  * @documentationMaturity preview
@@ -864,28 +802,7 @@ export interface BalancesQueryBuilder {
864
802
  /** @documentationMaturity preview */
865
803
  find: () => Promise<BalancesQueryResult>;
866
804
  }
867
- /**
868
- * Changes the number of available credits in a balance.
869
- *
870
- * You can adjust or set the number of available credits.
871
- * @param poolId - ID of the pool associated with the balance to change. This is also the ID of the balance.
872
- * @param idempotencyKey - Unique identifier, generated by the client.
873
- * Used to recognize repeated attempts to make the same request.
874
- * @public
875
- * @documentationMaturity preview
876
- * @requiredField idempotencyKey
877
- * @requiredField options.operation
878
- * @requiredField poolId
879
- * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
880
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
881
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
882
- * @applicableIdentity APP
883
- * @fqn wix.benefit_programs.v1.balance.BalanceService.ChangeBalance
884
- */
885
- export declare function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise<NonNullablePaths<ChangeBalanceResponse, {
886
- [P in BalanceNonNullablePaths]: `balance.${P}`;
887
- }[BalanceNonNullablePaths]>>;
888
- export interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
805
+ interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
889
806
  /** Identity changing the balance. */
890
807
  instructingParty?: CommonIdentificationData;
891
808
  /** Balance change type. */
@@ -898,35 +815,15 @@ export interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf
898
815
  transactionDetails?: TransactionDetails;
899
816
  }
900
817
  /** @oneof */
901
- export interface ChangeBalanceOptionsOperationOneOf {
818
+ interface ChangeBalanceOptionsOperationOneOf {
902
819
  /** Adjust the balance by a specific number of credits. */
903
820
  adjustOptions?: AdjustOptions;
904
821
  /** Set the balance to a specific number of credits. */
905
822
  setOptions?: SetOptions;
906
823
  }
907
- /**
908
- * Reverts a transaction created by calling Change Balance.
909
- *
910
- * For example, if a transaction increased a balance's available credits by 5,
911
- * calling Revert Balance Change with the transaction's ID will decrease the balance's available credit by 5.
912
- *
913
- * > **Note:** If the Change Balance call set the balance, Revert Transaction reverts the amount the balance changed by, ensuring subsequent balance changes are still reflected after the reversion.
914
- * @param transactionId - ID of the transaction associated with the balance change to revert.
915
- * @param idempotencyKey - Unique identifier, generated by the client.
916
- * Used to recognize repeated attempts to make the same request.
917
- * @public
918
- * @documentationMaturity preview
919
- * @requiredField idempotencyKey
920
- * @requiredField transactionId
921
- * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
922
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
923
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
924
- * @applicableIdentity APP
925
- * @fqn wix.benefit_programs.v1.balance.BalanceService.RevertBalanceChange
926
- */
927
- export declare function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise<RevertBalanceChangeResponse>;
928
- export interface RevertBalanceChangeOptions {
824
+ interface RevertBalanceChangeOptions {
929
825
  /** Identity reverting the balance change. */
930
826
  instructingParty?: CommonIdentificationData;
931
827
  }
932
- export {};
828
+
829
+ export { type DomainEventBodyOneOf as $, type AdjustOptions as A, type Balance as B, type ChangeBalanceOptions as C, type BulkChangeBalancesRequest as D, type ExtendedFields as E, type ChangeBalanceRequest as F, type GetBalanceRequest as G, type ChangeBalanceRequestOperationOneOf as H, IdentityType as I, type BulkChangeBalancesResponse as J, type ItemMetadata as K, type ListBalancesOptions as L, type ApplicationError as M, type BulkChangeBalanceResult as N, type BulkActionMetadata as O, type PoolInfo as P, type QueryBalancesRequest as Q, type RevertBalanceChangeOptions as R, SortOrder as S, Type as T, type RevertBalanceChangeRequest as U, type ChangeAlreadyReverted as V, WebhookIdentityType as W, type NotEnoughBalance as X, type GetTransactionReversibilityRequest as Y, type GetTransactionReversibilityResponse as Z, type DomainEvent as _, type ListBalancesResponse as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type BalancesQueryResult as a8, type ChangeBalanceOptionsOperationOneOf as a9, type BalancesQueryBuilder as b, type ChangeBalanceResponse as c, type RevertBalanceChangeResponse as d, ChangeBalanceRequestType as e, LimitRule as f, TransactionReversibility as g, type CommonIdentificationData as h, type CommonIdentificationDataIdOneOf as i, type BalanceAmount as j, type GetBalanceResponse as k, type ListBalancesRequest as l, type CursorPaging as m, type CursorPagingMetadata as n, type Cursors as o, type CursorQuery as p, type CursorQueryPagingMethodOneOf as q, type Sorting as r, type QueryBalancesResponse as s, type BalanceChangeBalanceRequest as t, type BalanceChangeBalanceRequestOperationOneOf as u, type SetOptions as v, type SetInitialOptions as w, type TransactionDetails as x, type Item as y, type BalanceExceededLimits as z };