@wix/auto_sdk_benefit-programs_balances 1.0.7 → 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} +76 -203
  2. package/build/{cjs/src/benefit-programs-v1-balance-balances.universal.d.ts → benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.ts} +76 -203
  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} +76 -203
  10. package/build/internal/{es/src/benefit-programs-v1-balance-balances.universal.d.ts → benefit-programs-v1-balance-balances.universal-qcbBfXdg.d.ts} +76 -203
  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 -750
  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 -750
  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 -750
  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 -750
  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,4 +1,4 @@
1
- export interface Balance {
1
+ interface Balance {
2
2
  /**
3
3
  * Balance ID. This is the same as the associated pool's ID.
4
4
  * @format GUID
@@ -50,7 +50,7 @@ export interface Balance {
50
50
  */
51
51
  lastTransactionId?: string | null;
52
52
  }
53
- export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
53
+ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
54
54
  /**
55
55
  * ID of a site visitor that hasn't logged in to the site.
56
56
  * @format GUID
@@ -68,7 +68,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
68
68
  wixUserId?: string;
69
69
  }
70
70
  /** @oneof */
71
- export interface CommonIdentificationDataIdOneOf {
71
+ interface CommonIdentificationDataIdOneOf {
72
72
  /**
73
73
  * ID of a site visitor that hasn't logged in to the site.
74
74
  * @format GUID
@@ -85,7 +85,7 @@ export interface CommonIdentificationDataIdOneOf {
85
85
  */
86
86
  wixUserId?: string;
87
87
  }
88
- export declare enum IdentityType {
88
+ declare enum IdentityType {
89
89
  /** Unknown type. This value is not used. */
90
90
  UNKNOWN = "UNKNOWN",
91
91
  /** A site visitor who has not logged in. */
@@ -95,15 +95,15 @@ export declare enum IdentityType {
95
95
  /** A Wix account holder, such as a site owner or contributor. */
96
96
  WIX_USER = "WIX_USER"
97
97
  }
98
- export interface BalanceAmount {
98
+ interface BalanceAmount {
99
99
  /**
100
- * Amount of available credits.
100
+ * number of available credits.
101
101
  * @decimalValue options { maxScale:4 }
102
102
  * @readonly
103
103
  */
104
104
  available?: string;
105
105
  }
106
- export interface PoolInfo {
106
+ interface PoolInfo {
107
107
  /**
108
108
  * Pool ID.
109
109
  * @format GUID
@@ -134,13 +134,13 @@ export interface PoolInfo {
134
134
  */
135
135
  creditAmount?: string | null;
136
136
  /**
137
- * Namespace for your app or site's benefit programs.
137
+ * 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.
138
138
  * @minLength 1
139
139
  * @maxLength 50
140
140
  */
141
141
  namespace?: string | null;
142
142
  }
143
- export interface ExtendedFields {
143
+ interface ExtendedFields {
144
144
  /**
145
145
  * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
146
146
  * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -151,18 +151,18 @@ export interface ExtendedFields {
151
151
  */
152
152
  namespaces?: Record<string, Record<string, any>>;
153
153
  }
154
- export interface GetBalanceRequest {
154
+ interface GetBalanceRequest {
155
155
  /**
156
156
  * ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
157
157
  * @format GUID
158
158
  */
159
159
  poolId: string;
160
160
  }
161
- export interface GetBalanceResponse {
161
+ interface GetBalanceResponse {
162
162
  /** Retrieved balance. */
163
163
  balance?: Balance;
164
164
  }
165
- export interface ListBalancesRequest {
165
+ interface ListBalancesRequest {
166
166
  /**
167
167
  * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
168
168
  * @format GUID
@@ -172,7 +172,7 @@ export interface ListBalancesRequest {
172
172
  /** Cursor paging. */
173
173
  cursorPaging?: CursorPaging;
174
174
  }
175
- export interface CursorPaging {
175
+ interface CursorPaging {
176
176
  /**
177
177
  * Maximum number of items to return.
178
178
  * @max 100
@@ -187,7 +187,7 @@ export interface CursorPaging {
187
187
  */
188
188
  cursor?: string | null;
189
189
  }
190
- export interface ListBalancesResponse {
190
+ interface ListBalancesResponse {
191
191
  /**
192
192
  * Retrieved balances.
193
193
  * @maxSize 100
@@ -196,7 +196,7 @@ export interface ListBalancesResponse {
196
196
  /** Metadata for paginated results. */
197
197
  metadata?: CursorPagingMetadata;
198
198
  }
199
- export interface CursorPagingMetadata {
199
+ interface CursorPagingMetadata {
200
200
  /** Number of items returned in the response. */
201
201
  count?: number | null;
202
202
  /** Cursor strings that point to the next page, previous page, or both. */
@@ -209,7 +209,7 @@ export interface CursorPagingMetadata {
209
209
  */
210
210
  hasNext?: boolean | null;
211
211
  }
212
- export interface Cursors {
212
+ interface Cursors {
213
213
  /**
214
214
  * Cursor string pointing to the next page in the list of results.
215
215
  * @maxLength 16000
@@ -221,11 +221,11 @@ export interface Cursors {
221
221
  */
222
222
  prev?: string | null;
223
223
  }
224
- export interface QueryBalancesRequest {
224
+ interface QueryBalancesRequest {
225
225
  /** Filter, sort, and paging to apply to the query. */
226
226
  query?: CursorQuery;
227
227
  }
228
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
228
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
229
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`. */
230
230
  cursorPaging?: CursorPaging;
231
231
  /**
@@ -241,11 +241,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
241
241
  sort?: Sorting[];
242
242
  }
243
243
  /** @oneof */
244
- export interface CursorQueryPagingMethodOneOf {
244
+ interface CursorQueryPagingMethodOneOf {
245
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`. */
246
246
  cursorPaging?: CursorPaging;
247
247
  }
248
- export interface Sorting {
248
+ interface Sorting {
249
249
  /**
250
250
  * Field to sort by.
251
251
  * @maxLength 512
@@ -258,22 +258,22 @@ export interface Sorting {
258
258
  */
259
259
  order?: SortOrder;
260
260
  }
261
- export declare enum SortOrder {
261
+ declare enum SortOrder {
262
262
  /** Ascending sort order. */
263
263
  ASC = "ASC",
264
264
  /** Descending sort order. */
265
265
  DESC = "DESC"
266
266
  }
267
- export interface QueryBalancesResponse {
267
+ interface QueryBalancesResponse {
268
268
  /** List of retrieved balances. */
269
269
  balances?: Balance[];
270
270
  /** Metadata for the paginated results. */
271
271
  metadata?: CursorPagingMetadata;
272
272
  }
273
- export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
274
- /** Adjust the balance by a specific amount of credits. */
273
+ interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequestOperationOneOf {
274
+ /** Adjust the balance by a specific number of credits. */
275
275
  adjustOptions?: AdjustOptions;
276
- /** Set the balance to a specific amount of credits. */
276
+ /** Set the balance to a specific number of credits. */
277
277
  setOptions?: SetOptions;
278
278
  /**
279
279
  * ID of the pool associated with the balance to change. This is also the ID of the balance.
@@ -294,13 +294,13 @@ export interface BalanceChangeBalanceRequest extends BalanceChangeBalanceRequest
294
294
  transactionDetails?: TransactionDetails;
295
295
  }
296
296
  /** @oneof */
297
- export interface BalanceChangeBalanceRequestOperationOneOf {
298
- /** Adjust the balance by a specific amount of credits. */
297
+ interface BalanceChangeBalanceRequestOperationOneOf {
298
+ /** Adjust the balance by a specific number of credits. */
299
299
  adjustOptions?: AdjustOptions;
300
- /** Set the balance to a specific amount of credits. */
300
+ /** Set the balance to a specific number of credits. */
301
301
  setOptions?: SetOptions;
302
302
  }
303
- export declare enum ChangeBalanceRequestType {
303
+ declare enum ChangeBalanceRequestType {
304
304
  /** Unknown balance change type. */
305
305
  UNKNOWN_OPERATION = "UNKNOWN_OPERATION",
306
306
  /** Use with `adjustOptions`. */
@@ -308,7 +308,7 @@ export declare enum ChangeBalanceRequestType {
308
308
  /** Use with `setOptions`. */
309
309
  SET = "SET"
310
310
  }
311
- export interface AdjustOptions {
311
+ interface AdjustOptions {
312
312
  /**
313
313
  * Amount to change the balance's available credits by.
314
314
  * - To increase the balance, specify a positive number.
@@ -319,7 +319,7 @@ export interface AdjustOptions {
319
319
  /** Beneficiary of the associated pool. */
320
320
  beneficiary?: CommonIdentificationData;
321
321
  }
322
- export declare enum LimitRule {
322
+ declare enum LimitRule {
323
323
  /** Unknown limit rule */
324
324
  UNKNOWN_LIMIT_RULE = "UNKNOWN_LIMIT_RULE",
325
325
  /** If the limit is exceeded, the operation will fail */
@@ -329,7 +329,7 @@ export declare enum LimitRule {
329
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. */
330
330
  HARD_ENFORCE = "HARD_ENFORCE"
331
331
  }
332
- export interface SetOptions {
332
+ interface SetOptions {
333
333
  /**
334
334
  * Amount to set the balance's available credits to.
335
335
  *
@@ -340,7 +340,7 @@ export interface SetOptions {
340
340
  /** Beneficiary of the associated pool. */
341
341
  beneficiary?: CommonIdentificationData;
342
342
  }
343
- export interface SetInitialOptions {
343
+ interface SetInitialOptions {
344
344
  /**
345
345
  * Set the available balance to the provided amount.
346
346
  * @decimalValue options { maxScale:4 }
@@ -349,7 +349,7 @@ export interface SetInitialOptions {
349
349
  /** Benefit pool owner associated with this balance. */
350
350
  beneficiary?: CommonIdentificationData;
351
351
  }
352
- export interface TransactionDetails {
352
+ interface TransactionDetails {
353
353
  /**
354
354
  * Item associated with the transaction.
355
355
  * @readonly
@@ -369,7 +369,7 @@ export interface TransactionDetails {
369
369
  */
370
370
  reason?: string | null;
371
371
  }
372
- export interface Item {
372
+ interface Item {
373
373
  /**
374
374
  * Item ID.
375
375
  * @format GUID
@@ -401,7 +401,7 @@ export interface Item {
401
401
  */
402
402
  displayName?: string | null;
403
403
  }
404
- export interface ChangeBalanceResponse {
404
+ interface ChangeBalanceResponse {
405
405
  /** Updated balance. */
406
406
  balance?: Balance;
407
407
  /**
@@ -410,7 +410,7 @@ export interface ChangeBalanceResponse {
410
410
  */
411
411
  transactionId?: string | null;
412
412
  }
413
- export interface BalanceExceededLimits {
413
+ interface BalanceExceededLimits {
414
414
  /** Current balance */
415
415
  balance?: BalanceAmount;
416
416
  /**
@@ -432,7 +432,7 @@ export interface BalanceExceededLimits {
432
432
  */
433
433
  upperLimit?: string | null;
434
434
  }
435
- export interface BulkChangeBalancesRequest {
435
+ interface BulkChangeBalancesRequest {
436
436
  /**
437
437
  * List of balances to change.
438
438
  * @minSize 1
@@ -448,11 +448,11 @@ export interface BulkChangeBalancesRequest {
448
448
  /** Whether to return the full balance entities in the response. */
449
449
  returnEntity?: boolean;
450
450
  }
451
- export declare enum Type {
451
+ declare enum Type {
452
452
  /** Unknown balance change type. */
453
453
  UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
454
454
  }
455
- export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
455
+ interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf {
456
456
  /**
457
457
  * ID of the pool associated with the balance to change. This is also the ID of the balance.
458
458
  * @format GUID
@@ -466,9 +466,9 @@ export interface ChangeBalanceRequest extends ChangeBalanceRequestOperationOneOf
466
466
  transactionDetails?: TransactionDetails;
467
467
  }
468
468
  /** @oneof */
469
- export interface ChangeBalanceRequestOperationOneOf {
469
+ interface ChangeBalanceRequestOperationOneOf {
470
470
  }
471
- export interface BulkChangeBalancesResponse {
471
+ interface BulkChangeBalancesResponse {
472
472
  /**
473
473
  * Updated item and associated metadata.
474
474
  * @minSize 1
@@ -478,7 +478,7 @@ export interface BulkChangeBalancesResponse {
478
478
  /** Metadata. */
479
479
  bulkActionMetadata?: BulkActionMetadata;
480
480
  }
481
- export interface ItemMetadata {
481
+ interface ItemMetadata {
482
482
  /**
483
483
  * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
484
484
  * @format GUID
@@ -491,7 +491,7 @@ export interface ItemMetadata {
491
491
  /** Details about the error in case of failure. */
492
492
  error?: ApplicationError;
493
493
  }
494
- export interface ApplicationError {
494
+ interface ApplicationError {
495
495
  /** Error code. */
496
496
  code?: string;
497
497
  /** Description of the error. */
@@ -499,13 +499,13 @@ export interface ApplicationError {
499
499
  /** Data related to the error. */
500
500
  data?: Record<string, any> | null;
501
501
  }
502
- export interface BulkChangeBalanceResult {
502
+ interface BulkChangeBalanceResult {
503
503
  /** Item metadata. */
504
504
  itemMetadata?: ItemMetadata;
505
505
  /** Updated item. */
506
506
  balance?: Balance;
507
507
  }
508
- export interface BulkActionMetadata {
508
+ interface BulkActionMetadata {
509
509
  /** Number of items that were successfully processed. */
510
510
  totalSuccesses?: number;
511
511
  /** Number of items that couldn't be processed. */
@@ -513,7 +513,7 @@ export interface BulkActionMetadata {
513
513
  /** Number of failures without details because detailed failure threshold was exceeded. */
514
514
  undetailedFailures?: number;
515
515
  }
516
- export interface RevertBalanceChangeRequest {
516
+ interface RevertBalanceChangeRequest {
517
517
  /**
518
518
  * ID of the transaction associated with the balance change to revert.
519
519
  * @format GUID
@@ -528,14 +528,14 @@ export interface RevertBalanceChangeRequest {
528
528
  /** Identity reverting the balance change. */
529
529
  instructingParty?: CommonIdentificationData;
530
530
  }
531
- export interface RevertBalanceChangeResponse {
531
+ interface RevertBalanceChangeResponse {
532
532
  /**
533
533
  * ID of the transaction associated with the balance reversion.
534
534
  * @format GUID
535
535
  */
536
536
  transactionId?: string | null;
537
537
  }
538
- export interface ChangeAlreadyReverted {
538
+ interface ChangeAlreadyReverted {
539
539
  /**
540
540
  * The id of the transaction which was already reverted
541
541
  * @format GUID
@@ -547,7 +547,7 @@ export interface ChangeAlreadyReverted {
547
547
  */
548
548
  revertedTransactionId?: string;
549
549
  }
550
- export interface NotEnoughBalance {
550
+ interface NotEnoughBalance {
551
551
  /** Current balance */
552
552
  balance?: BalanceAmount;
553
553
  /**
@@ -557,25 +557,25 @@ export interface NotEnoughBalance {
557
557
  */
558
558
  requested?: string;
559
559
  }
560
- export interface GetTransactionReversibilityRequest {
560
+ interface GetTransactionReversibilityRequest {
561
561
  /**
562
562
  * Id of the transaction to get the reversibility
563
563
  * @format GUID
564
564
  */
565
565
  transactionId?: string;
566
566
  }
567
- export interface GetTransactionReversibilityResponse {
567
+ interface GetTransactionReversibilityResponse {
568
568
  /** The result of transaction reversibility validation */
569
569
  transactionReversibility?: TransactionReversibility;
570
570
  }
571
571
  /** Transaction reversibility results */
572
- export declare enum TransactionReversibility {
572
+ declare enum TransactionReversibility {
573
573
  /** Transaction is allowed to be reverted */
574
574
  TRANSACTION_IS_REVERSIBLE = "TRANSACTION_IS_REVERSIBLE",
575
575
  /** Transaction isn't allowed to be reverted, because it was already reverted */
576
576
  TRANSACTION_ALREADY_REVERSED = "TRANSACTION_ALREADY_REVERSED"
577
577
  }
578
- export interface DomainEvent extends DomainEventBodyOneOf {
578
+ interface DomainEvent extends DomainEventBodyOneOf {
579
579
  createdEvent?: EntityCreatedEvent;
580
580
  updatedEvent?: EntityUpdatedEvent;
581
581
  deletedEvent?: EntityDeletedEvent;
@@ -618,19 +618,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
618
618
  entityEventSequence?: string | null;
619
619
  }
620
620
  /** @oneof */
621
- export interface DomainEventBodyOneOf {
621
+ interface DomainEventBodyOneOf {
622
622
  createdEvent?: EntityCreatedEvent;
623
623
  updatedEvent?: EntityUpdatedEvent;
624
624
  deletedEvent?: EntityDeletedEvent;
625
625
  actionEvent?: ActionEvent;
626
626
  }
627
- export interface EntityCreatedEvent {
627
+ interface EntityCreatedEvent {
628
628
  entity?: string;
629
629
  }
630
- export interface RestoreInfo {
630
+ interface RestoreInfo {
631
631
  deletedDate?: Date | null;
632
632
  }
633
- export interface EntityUpdatedEvent {
633
+ interface EntityUpdatedEvent {
634
634
  /**
635
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.
636
636
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -638,14 +638,14 @@ export interface EntityUpdatedEvent {
638
638
  */
639
639
  currentEntity?: string;
640
640
  }
641
- export interface EntityDeletedEvent {
641
+ interface EntityDeletedEvent {
642
642
  /** Entity that was deleted */
643
643
  deletedEntity?: string | null;
644
644
  }
645
- export interface ActionEvent {
645
+ interface ActionEvent {
646
646
  body?: string;
647
647
  }
648
- export interface MessageEnvelope {
648
+ interface MessageEnvelope {
649
649
  /**
650
650
  * App instance ID.
651
651
  * @format GUID
@@ -661,7 +661,7 @@ export interface MessageEnvelope {
661
661
  /** Stringify payload. */
662
662
  data?: string;
663
663
  }
664
- export interface IdentificationData extends IdentificationDataIdOneOf {
664
+ interface IdentificationData extends IdentificationDataIdOneOf {
665
665
  /**
666
666
  * ID of a site visitor that has not logged in to the site.
667
667
  * @format GUID
@@ -686,7 +686,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
686
686
  identityType?: WebhookIdentityType;
687
687
  }
688
688
  /** @oneof */
689
- export interface IdentificationDataIdOneOf {
689
+ interface IdentificationDataIdOneOf {
690
690
  /**
691
691
  * ID of a site visitor that has not logged in to the site.
692
692
  * @format GUID
@@ -708,77 +708,14 @@ export interface IdentificationDataIdOneOf {
708
708
  */
709
709
  appId?: string;
710
710
  }
711
- export declare enum WebhookIdentityType {
711
+ declare enum WebhookIdentityType {
712
712
  UNKNOWN = "UNKNOWN",
713
713
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
714
714
  MEMBER = "MEMBER",
715
715
  WIX_USER = "WIX_USER",
716
716
  APP = "APP"
717
717
  }
718
- interface CommonIdentificationDataNonNullableFields {
719
- anonymousVisitorId: string;
720
- memberId: string;
721
- wixUserId: string;
722
- identityType: IdentityType;
723
- }
724
- interface BalanceAmountNonNullableFields {
725
- available: string;
726
- }
727
- interface PoolInfoNonNullableFields {
728
- _id: string;
729
- }
730
- export interface BalanceNonNullableFields {
731
- _id: string;
732
- beneficiary?: CommonIdentificationDataNonNullableFields;
733
- amount?: BalanceAmountNonNullableFields;
734
- poolInfo?: PoolInfoNonNullableFields;
735
- }
736
- export interface GetBalanceResponseNonNullableFields {
737
- balance?: BalanceNonNullableFields;
738
- }
739
- export interface ListBalancesResponseNonNullableFields {
740
- balances: BalanceNonNullableFields[];
741
- }
742
- export interface QueryBalancesResponseNonNullableFields {
743
- balances: BalanceNonNullableFields[];
744
- }
745
- export interface ChangeBalanceResponseNonNullableFields {
746
- balance?: BalanceNonNullableFields;
747
- }
748
- /**
749
- * Retrieves a balance.
750
- * @param poolId - ID of the pool associated with the balance to retrieve. This is also the ID of the balance.
751
- * @public
752
- * @documentationMaturity preview
753
- * @requiredField poolId
754
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
755
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
756
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
757
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
758
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
759
- * @permissionScope Manage Events
760
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
761
- * @applicableIdentity APP
762
- * @returns Retrieved balance.
763
- * @fqn wix.benefit_programs.v1.balance.BalanceService.GetBalance
764
- */
765
- export declare function getBalance(poolId: string): Promise<Balance & BalanceNonNullableFields>;
766
- /**
767
- * Retrieves a list of balances.
768
- * @public
769
- * @documentationMaturity preview
770
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
771
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
772
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
773
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
774
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
775
- * @permissionScope Manage Events
776
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
777
- * @applicableIdentity APP
778
- * @fqn wix.benefit_programs.v1.balance.BalanceService.ListBalances
779
- */
780
- export declare function listBalances(options?: ListBalancesOptions): Promise<ListBalancesResponse & ListBalancesResponseNonNullableFields>;
781
- export interface ListBalancesOptions {
718
+ interface ListBalancesOptions {
782
719
  /**
783
720
  * List of IDs of the pools associated with the balances to retrieve. These are also the IDs of the balances.
784
721
  * @format GUID
@@ -788,31 +725,6 @@ export interface ListBalancesOptions {
788
725
  /** Cursor paging. */
789
726
  cursorPaging?: CursorPaging;
790
727
  }
791
- /**
792
- * Creates a query to retrieve a list of balances.
793
- *
794
- * The Query Balances method builds a query to retrieve a list of balances and returns a `BalancesQueryBuilder` object.
795
- *
796
- * The returned object contains the query definition, which is used to run the query using the `find()` method.
797
- *
798
- * 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.
799
- *
800
- * Query Balances has a default paging limit of 50, which you can override.
801
- *
802
- * For a full description of the item object, see the object returned for the `items` property in `BalancesQueryResult`.
803
- * @public
804
- * @documentationMaturity preview
805
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
806
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
807
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.READ
808
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.READ
809
- * @permissionScope Manage Events
810
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
811
- * @permissionId BENEFIT_PROGRAMS.BALANCE_READ
812
- * @applicableIdentity APP
813
- * @fqn wix.benefit_programs.v1.balance.BalanceService.QueryBalances
814
- */
815
- export declare function queryBalances(): BalancesQueryBuilder;
816
728
  interface QueryCursorResult {
817
729
  cursors: Cursors;
818
730
  hasNext: () => boolean;
@@ -820,13 +732,13 @@ interface QueryCursorResult {
820
732
  length: number;
821
733
  pageSize: number;
822
734
  }
823
- export interface BalancesQueryResult extends QueryCursorResult {
735
+ interface BalancesQueryResult extends QueryCursorResult {
824
736
  items: Balance[];
825
737
  query: BalancesQueryBuilder;
826
738
  next: () => Promise<BalancesQueryResult>;
827
739
  prev: () => Promise<BalancesQueryResult>;
828
740
  }
829
- export interface BalancesQueryBuilder {
741
+ interface BalancesQueryBuilder {
830
742
  /** @param propertyName - Property whose value is compared with `value`.
831
743
  * @param value - Value to compare against.
832
744
  * @documentationMaturity preview
@@ -890,67 +802,28 @@ export interface BalancesQueryBuilder {
890
802
  /** @documentationMaturity preview */
891
803
  find: () => Promise<BalancesQueryResult>;
892
804
  }
893
- /**
894
- * Changes the amount of available credits in a balance.
895
- *
896
- * You can adjust or set the amount of available credits.
897
- * @param poolId - ID of the pool associated with the balance to change. This is also the ID of the balance.
898
- * @param idempotencyKey - Unique identifier, generated by the client.
899
- * Used to recognize repeated attempts to make the same request.
900
- * @public
901
- * @documentationMaturity preview
902
- * @requiredField idempotencyKey
903
- * @requiredField options.operation
904
- * @requiredField poolId
905
- * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
906
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
907
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
908
- * @applicableIdentity APP
909
- * @fqn wix.benefit_programs.v1.balance.BalanceService.ChangeBalance
910
- */
911
- export declare function changeBalance(poolId: string, idempotencyKey: string, options?: ChangeBalanceOptions): Promise<ChangeBalanceResponse & ChangeBalanceResponseNonNullableFields>;
912
- export interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
805
+ interface ChangeBalanceOptions extends ChangeBalanceOptionsOperationOneOf {
913
806
  /** Identity changing the balance. */
914
807
  instructingParty?: CommonIdentificationData;
915
808
  /** Balance change type. */
916
809
  type?: ChangeBalanceRequestType;
917
- /** Adjust the balance by a specific amount of credits. */
810
+ /** Adjust the balance by a specific number of credits. */
918
811
  adjustOptions?: AdjustOptions;
919
- /** Set the balance to a specific amount of credits. */
812
+ /** Set the balance to a specific number of credits. */
920
813
  setOptions?: SetOptions;
921
814
  /** Details to send to the transaction created from this balance change. */
922
815
  transactionDetails?: TransactionDetails;
923
816
  }
924
817
  /** @oneof */
925
- export interface ChangeBalanceOptionsOperationOneOf {
926
- /** Adjust the balance by a specific amount of credits. */
818
+ interface ChangeBalanceOptionsOperationOneOf {
819
+ /** Adjust the balance by a specific number of credits. */
927
820
  adjustOptions?: AdjustOptions;
928
- /** Set the balance to a specific amount of credits. */
821
+ /** Set the balance to a specific number of credits. */
929
822
  setOptions?: SetOptions;
930
823
  }
931
- /**
932
- * Reverts a transaction created by calling Change Balance.
933
- *
934
- * For example, if a transaction increased a balance's available credits by 5,
935
- * calling Revert Balance Change with the transaction's ID will decrease the balance's available credit by 5.
936
- *
937
- * > **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.
938
- * @param transactionId - ID of the transaction associated with the balance change to revert.
939
- * @param idempotencyKey - Unique identifier, generated by the client.
940
- * Used to recognize repeated attempts to make the same request.
941
- * @public
942
- * @documentationMaturity preview
943
- * @requiredField idempotencyKey
944
- * @requiredField transactionId
945
- * @permissionId BENEFIT_PROGRAMS.BALANCE_CHANGE
946
- * @permissionScope SCOPE.BENEFIT_PROGRAMS.MANAGE
947
- * @permissionScopeId SCOPE.BENEFIT_PROGRAMS.MANAGE
948
- * @applicableIdentity APP
949
- * @fqn wix.benefit_programs.v1.balance.BalanceService.RevertBalanceChange
950
- */
951
- export declare function revertBalanceChange(transactionId: string, idempotencyKey: string, options?: RevertBalanceChangeOptions): Promise<RevertBalanceChangeResponse>;
952
- export interface RevertBalanceChangeOptions {
824
+ interface RevertBalanceChangeOptions {
953
825
  /** Identity reverting the balance change. */
954
826
  instructingParty?: CommonIdentificationData;
955
827
  }
956
- 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 };