@wix/auto_sdk_benefit-programs_pools 1.0.15 → 1.0.16

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/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
  11. package/build/cjs/src/benefit-programs-v1-pool-pools.context.js +28 -0
  12. package/build/cjs/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
  13. package/build/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
  14. package/build/cjs/src/benefit-programs-v1-pool-pools.http.js +494 -0
  15. package/build/cjs/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
  16. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
  17. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js +180 -0
  18. package/build/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
  19. package/build/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
  20. package/build/cjs/src/benefit-programs-v1-pool-pools.public.js +68 -0
  21. package/build/cjs/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
  22. package/build/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
  23. package/build/cjs/src/benefit-programs-v1-pool-pools.types.js +140 -0
  24. package/build/cjs/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
  25. package/build/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts → cjs/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
  26. package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js +587 -0
  27. package/build/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
  39. package/build/es/src/benefit-programs-v1-pool-pools.context.js +12 -0
  40. package/build/es/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
  41. package/build/es/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
  42. package/build/es/src/benefit-programs-v1-pool-pools.http.js +483 -0
  43. package/build/es/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
  44. package/build/es/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
  45. package/build/es/src/benefit-programs-v1-pool-pools.meta.js +146 -0
  46. package/build/es/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
  47. package/build/es/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
  48. package/build/es/src/benefit-programs-v1-pool-pools.public.js +44 -0
  49. package/build/es/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
  50. package/build/es/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
  51. package/build/es/src/benefit-programs-v1-pool-pools.types.js +137 -0
  52. package/build/es/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
  53. package/build/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts → es/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
  54. package/build/es/src/benefit-programs-v1-pool-pools.universal.js +553 -0
  55. package/build/es/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
  66. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js +28 -0
  67. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
  68. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
  69. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js +494 -0
  70. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
  71. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
  72. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js +180 -0
  73. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
  74. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
  75. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js +68 -0
  76. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
  77. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
  78. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js +140 -0
  79. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
  80. package/build/internal/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.mts → cjs/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
  81. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js +587 -0
  82. package/build/internal/cjs/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.d.ts +12 -0
  93. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js +12 -0
  94. package/build/internal/es/src/benefit-programs-v1-pool-pools.context.js.map +1 -0
  95. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.d.ts +56 -0
  96. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js +483 -0
  97. package/build/internal/es/src/benefit-programs-v1-pool-pools.http.js.map +1 -0
  98. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.d.ts +24 -0
  99. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js +146 -0
  100. package/build/internal/es/src/benefit-programs-v1-pool-pools.meta.js.map +1 -0
  101. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.d.ts +96 -0
  102. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js +44 -0
  103. package/build/internal/es/src/benefit-programs-v1-pool-pools.public.js.map +1 -0
  104. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.d.ts +1579 -0
  105. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js +137 -0
  106. package/build/internal/es/src/benefit-programs-v1-pool-pools.types.js.map +1 -0
  107. package/build/internal/{benefit-programs-v1-pool-pools.universal-C7Pd1Zor.d.ts → es/src/benefit-programs-v1-pool-pools.universal.d.ts} +309 -144
  108. package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js +553 -0
  109. package/build/internal/es/src/benefit-programs-v1-pool-pools.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -105
  112. package/build/index.d.ts +0 -105
  113. package/build/index.js +0 -949
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -905
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -105
  118. package/build/internal/index.d.ts +0 -105
  119. package/build/internal/index.js +0 -949
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -905
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -776
  124. package/build/internal/meta.d.ts +0 -776
  125. package/build/internal/meta.js +0 -627
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -593
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -776
  130. package/build/meta.d.ts +0 -776
  131. package/build/meta.js +0 -627
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -593
  134. package/build/meta.mjs.map +0 -1
@@ -1,776 +0,0 @@
1
- import { aa as GetPoolRequest$1, ab as GetPoolResponse$1, ac as UpdatePoolRequest$1, ad as UpdatePoolResponse$1, ag as QueryPoolsRequest$1, al as QueryPoolsResponse$1, ao as RedeemBenefitRequest$1, b as RedeemBenefitResponse$1, aC as CheckBenefitEligibilityRequest$1, c as CheckBenefitEligibilityResponse$1, aH as BulkCheckBenefitEligibilityRequest$1, d as BulkCheckBenefitEligibilityResponse$1, aK as GetEligibleBenefitsRequest$1, e as GetEligibleBenefitsResponse$1, aS as BulkUpdatePoolsRequest$1, g as BulkUpdatePoolsResponse$1 } from './benefit-programs-v1-pool-pools.universal-C7Pd1Zor.mjs';
2
-
3
- interface Pool {
4
- /**
5
- * Pool ID.
6
- * @format GUID
7
- * @immutable
8
- * @readonly
9
- */
10
- id?: string | null;
11
- /**
12
- * Revision number, which increments by 1 each time the pool is updated.
13
- * To prevent conflicting changes, the current revision must be passed when updating the pool.
14
- *
15
- * Ignored when creating a pool.
16
- * @readonly
17
- */
18
- revision?: string | null;
19
- /**
20
- * Date and time the pool was created.
21
- * @readonly
22
- */
23
- createdDate?: Date | null;
24
- /**
25
- * Date and time the pool was updated.
26
- * @readonly
27
- */
28
- updatedDate?: Date | null;
29
- /**
30
- * ID of the associated pool definition.
31
- * @format GUID
32
- * @readonly
33
- * @immutable
34
- */
35
- poolDefinitionId?: string | null;
36
- /**
37
- * ID of the associated program definition.
38
- * @format GUID
39
- * @readonly
40
- * @immutable
41
- */
42
- programDefinitionId?: string | null;
43
- /**
44
- * ID of the program that contains this pool.
45
- * @format GUID
46
- * @readonly
47
- * @immutable
48
- */
49
- programId?: string | null;
50
- /**
51
- * Pool status.
52
- * @readonly
53
- */
54
- status?: PoolStatus;
55
- /**
56
- * Pool beneficiary.
57
- * @readonly
58
- * @immutable
59
- */
60
- beneficiary?: CommonIdentificationData;
61
- /** Pool benefits and settings. */
62
- details?: Details;
63
- /**
64
- * Pool name.
65
- *
66
- * You may want to use the same name that's used in the associated pool definition.
67
- * @maxLength 64
68
- */
69
- displayName?: string;
70
- /**
71
- * 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.
72
- * @readonly
73
- * @immutable
74
- * @minLength 1
75
- * @maxLength 50
76
- */
77
- namespace?: string | null;
78
- /**
79
- * Custom field data for the pool object.
80
- *
81
- * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
82
- */
83
- extendedFields?: ExtendedFields;
84
- /**
85
- * Associated program definition information.
86
- * @readonly
87
- */
88
- programDefinition?: ProgramDefinitionInfo;
89
- /**
90
- * Information about the program containing the pool.
91
- * @readonly
92
- */
93
- program?: PoolProgramInfo;
94
- /**
95
- * Version of the pool definition that this pool was created from.
96
- * @readonly
97
- */
98
- poolDefinitionRevision?: string | null;
99
- /**
100
- * Number of times this pool has been renewed.
101
- * @readonly
102
- */
103
- renewalCount?: number | null;
104
- }
105
- declare enum PoolStatus {
106
- /** Undefined pool status. */
107
- UNDEFINED = "UNDEFINED",
108
- /** Pool is active. */
109
- ACTIVE = "ACTIVE",
110
- /** Pool is paused. It can be resumed. */
111
- PAUSED = "PAUSED",
112
- /** Pool is ended. It can't be resumed. */
113
- ENDED = "ENDED",
114
- /** Pool provisioning is in progress. This status exists for a short time during processing. */
115
- PROVISIONING = "PROVISIONING",
116
- /** Pool renewing is in progress. This status exists for a short time during processing. */
117
- RENEWING = "RENEWING"
118
- }
119
- interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
120
- /**
121
- * ID of a site visitor that hasn't logged in to the site.
122
- * @format GUID
123
- */
124
- anonymousVisitorId?: string;
125
- /**
126
- * ID of a site member.
127
- * @format GUID
128
- */
129
- memberId?: string;
130
- /**
131
- * ID of a Wix user.
132
- * @format GUID
133
- */
134
- wixUserId?: string;
135
- }
136
- /** @oneof */
137
- interface CommonIdentificationDataIdOneOf {
138
- /**
139
- * ID of a site visitor that hasn't logged in to the site.
140
- * @format GUID
141
- */
142
- anonymousVisitorId?: string;
143
- /**
144
- * ID of a site member.
145
- * @format GUID
146
- */
147
- memberId?: string;
148
- /**
149
- * ID of a Wix user.
150
- * @format GUID
151
- */
152
- wixUserId?: string;
153
- }
154
- interface Details {
155
- /**
156
- * List of benefits.
157
- * @maxSize 10
158
- */
159
- benefits?: Benefit[];
160
- /**
161
- * Credit settings.
162
- *
163
- * If this object is empty, you can't set a price for the benefit.
164
- */
165
- creditConfiguration?: CreditConfiguration;
166
- /** Additional information relating to this object. */
167
- additionalData?: Record<string, any> | null;
168
- }
169
- interface Benefit {
170
- /**
171
- * Unique identifier for this benefit.
172
- *
173
- * This key is consistent across the pool definition and all associated pools that contain this benefit.
174
- * @maxLength 64
175
- */
176
- benefitKey?: string;
177
- /**
178
- * ID that is used to associated items with this benefit.
179
- * @format GUID
180
- * @immutable
181
- * @readonly
182
- */
183
- itemSetId?: string | null;
184
- /**
185
- * Price of the benefit in credits. The price is the same for all of this benefit's items.
186
- * @decimalValue options { gte:0, maxScale:4 }
187
- */
188
- price?: string | null;
189
- /** Additional information for this benefit. */
190
- additionalData?: Record<string, any> | null;
191
- /**
192
- * ID of the app providing the benefit items.
193
- * @format GUID
194
- * @immutable
195
- */
196
- providerAppId?: string | null;
197
- /**
198
- * Benefit name.
199
- * @maxLength 40
200
- */
201
- displayName?: string | null;
202
- /**
203
- * Benefit description.
204
- * @maxLength 255
205
- */
206
- description?: string | null;
207
- }
208
- interface CreditConfiguration {
209
- /**
210
- * Initial available amount for associated balances.
211
- * @decimalValue options { gte:0, maxScale:4 }
212
- */
213
- amount?: string;
214
- /** Rollover settings. */
215
- rolloverConfiguration?: RolloverConfiguration;
216
- /**
217
- * Credit unit display name.
218
- * @maxLength 32
219
- */
220
- unitDisplayName?: string | null;
221
- }
222
- interface RolloverConfiguration {
223
- /** Whether unused credits roll over to a new cycle when a program renews. */
224
- enabled?: boolean | null;
225
- /**
226
- * Maximum number of credits that can roll over to the next cycle when a program renews.
227
- * @decimalValue options { gte:0, maxScale:4 }
228
- */
229
- balanceCap?: string | null;
230
- }
231
- interface ExtendedFields {
232
- /**
233
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
234
- * The value of each key is structured according to the schema defined when the extended fields were configured.
235
- *
236
- * You can only access fields for which you have the appropriate permissions.
237
- *
238
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
239
- */
240
- namespaces?: Record<string, Record<string, any>>;
241
- }
242
- interface ProgramDefinitionInfo {
243
- /**
244
- * Program definition ID.
245
- * @format GUID
246
- * @readonly
247
- */
248
- id?: string;
249
- /**
250
- * Program definition external ID.
251
- * @format GUID
252
- * @readonly
253
- */
254
- externalId?: string | null;
255
- }
256
- interface PoolProgramInfo {
257
- /**
258
- * Program ID.
259
- * @format GUID
260
- * @readonly
261
- */
262
- id?: string;
263
- /**
264
- * Program external ID.
265
- * @format GUID
266
- * @readonly
267
- */
268
- externalId?: string | null;
269
- }
270
- interface ItemReference {
271
- /**
272
- * External ID of the item.
273
- * @format GUID
274
- */
275
- externalId?: string;
276
- /**
277
- * Item category.
278
- * @maxLength 20
279
- */
280
- category?: string;
281
- /**
282
- * ID of the app providing the item.
283
- * @format GUID
284
- */
285
- providerAppId?: string;
286
- }
287
- interface GetPoolRequest {
288
- /**
289
- * ID of the pool to retrieve.
290
- * @format GUID
291
- */
292
- poolId: string;
293
- }
294
- interface GetPoolResponse {
295
- /** Retrieved pool. */
296
- pool?: Pool;
297
- }
298
- interface UpdatePoolRequest {
299
- /** Pool to update. */
300
- pool: Pool;
301
- }
302
- interface UpdatePoolResponse {
303
- /** Updated pool. */
304
- pool?: Pool;
305
- }
306
- interface QueryPoolsRequest {
307
- /** Filter, sort, and paging to apply to the query. */
308
- query: CursorQuery;
309
- }
310
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
311
- /** 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`. */
312
- cursorPaging?: CursorPaging;
313
- /**
314
- * Filter object.
315
- * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
316
- * for more information.
317
- */
318
- filter?: Record<string, any> | null;
319
- /**
320
- * List of sort objects.
321
- * @maxSize 5
322
- */
323
- sort?: Sorting[];
324
- }
325
- /** @oneof */
326
- interface CursorQueryPagingMethodOneOf {
327
- /** 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`. */
328
- cursorPaging?: CursorPaging;
329
- }
330
- interface Sorting {
331
- /**
332
- * Field to sort by.
333
- * @maxLength 512
334
- */
335
- fieldName?: string;
336
- /**
337
- * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
338
- *
339
- * Default: `ASC`
340
- */
341
- order?: SortOrder;
342
- }
343
- declare enum SortOrder {
344
- /** Ascending sort order. */
345
- ASC = "ASC",
346
- /** Descending sort order. */
347
- DESC = "DESC"
348
- }
349
- interface CursorPaging {
350
- /**
351
- * Maximum number of items to return.
352
- * @max 100
353
- */
354
- limit?: number | null;
355
- /**
356
- * Pointer to the next or previous page in the list of results.
357
- *
358
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
359
- * Not relevant for the first request.
360
- * @maxLength 16000
361
- */
362
- cursor?: string | null;
363
- }
364
- interface QueryPoolsResponse {
365
- /** List of retrieved pools. */
366
- pools?: Pool[];
367
- /** Metadata for the paginated results. */
368
- metadata?: CursorPagingMetadata;
369
- }
370
- interface CursorPagingMetadata {
371
- /** Number of items returned in the response. */
372
- count?: number | null;
373
- /** Cursor strings that point to the next page, previous page, or both. */
374
- cursors?: Cursors;
375
- /**
376
- * Whether there are more pages to retrieve following the current page.
377
- *
378
- * + `true`: Another page of results can be retrieved.
379
- * + `false`: This is the last page.
380
- */
381
- hasNext?: boolean | null;
382
- }
383
- interface Cursors {
384
- /**
385
- * Cursor string pointing to the next page in the list of results.
386
- * @maxLength 16000
387
- */
388
- next?: string | null;
389
- /**
390
- * Cursor pointing to the previous page in the list of results.
391
- * @maxLength 16000
392
- */
393
- prev?: string | null;
394
- }
395
- interface RedeemBenefitRequest {
396
- /**
397
- * ID of the pool that contains the benefit to redeem.
398
- * @format GUID
399
- */
400
- poolId: string;
401
- /** Information about the item to redeem. */
402
- itemReference: ItemReference;
403
- /**
404
- * Key of the benefit to redeem.
405
- * @maxLength 64
406
- */
407
- benefitKey: string;
408
- /**
409
- * Amount of items to redeem.
410
- * @min 1
411
- */
412
- count?: number;
413
- /**
414
- * Date that the item will be provided to the beneficiary.
415
- *
416
- * The pool's associated balance will update immediately. This parameter should be used to manage the logistics of providing the item.
417
- */
418
- targetDate?: Date | null;
419
- /**
420
- * Unique identifier, generated by the client.
421
- * Used to recognize repeated attempts to make the same request.
422
- * @maxLength 200
423
- */
424
- idempotencyKey: string;
425
- /** Additional information. */
426
- additionalData?: Record<string, any> | null;
427
- /** Beneficiary of the pool containing the benefit to redeem. */
428
- beneficiary?: CommonIdentificationData;
429
- /**
430
- * 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.
431
- * @minLength 1
432
- * @maxLength 50
433
- */
434
- namespace: string;
435
- }
436
- interface RedeemBenefitResponse {
437
- /**
438
- * ID of the transaction recording the associated change in balance.
439
- * @format GUID
440
- */
441
- transactionId?: string;
442
- }
443
- interface NotEnoughBalance {
444
- /**
445
- * Pool ID.
446
- * @format GUID
447
- */
448
- poolId?: string;
449
- /** Item reference. */
450
- itemReference?: ItemReference;
451
- /**
452
- * Pool's associated balance amount in credits.
453
- * @decimalValue options { maxScale:4 }
454
- */
455
- availableBalance?: string;
456
- /**
457
- * Price of the item in credits.
458
- * @decimalValue options { maxScale:4 }
459
- */
460
- requestedBalance?: string;
461
- }
462
- interface PoolNotActive {
463
- /**
464
- * Pool ID.
465
- * @format GUID
466
- */
467
- poolId?: string;
468
- /** Pool status. */
469
- poolStatus?: PoolStatus;
470
- }
471
- interface PoolNotFound {
472
- /**
473
- * Pool ID.
474
- * @format GUID
475
- */
476
- poolId?: string;
477
- }
478
- interface BenefitNotFound {
479
- /**
480
- * Pool ID.
481
- * @format GUID
482
- */
483
- poolId?: string;
484
- /**
485
- * Specified benefit key.
486
- * @format GUID
487
- */
488
- benefitKey?: string | null;
489
- }
490
- interface CheckBenefitEligibilityRequest {
491
- /**
492
- * ID of the pool that the benefit to check belongs to.
493
- * @format GUID
494
- */
495
- poolId: string;
496
- /**
497
- * Key of the benefit to check.
498
- * @maxLength 64
499
- */
500
- benefitKey?: string | null;
501
- /** Information about the item to check. */
502
- itemReference: ItemReference;
503
- /**
504
- * Amount of items to check.
505
- *
506
- * Ensures the balance is high enough to redeem this many items.
507
- * @min 1
508
- */
509
- count?: number;
510
- /**
511
- * Date that the item will be provided to the beneficiary.
512
- *
513
- * This parameter should be used to manage the potential logistics of providing the item.
514
- */
515
- targetDate?: Date | null;
516
- /** Additional information. */
517
- additionalData?: Record<string, any> | null;
518
- /** Beneficiary of the pool containing the benefit to check. */
519
- beneficiary?: CommonIdentificationData;
520
- /**
521
- * 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.
522
- * @minLength 1
523
- * @maxLength 50
524
- */
525
- namespace: string;
526
- }
527
- interface CheckBenefitEligibilityResponse {
528
- /** Result of the eligibility check. */
529
- result?: EligibilityCheckResult;
530
- }
531
- interface EligibilityCheckResult extends EligibilityCheckResultResultOneOf {
532
- /** Returned when item is eligible to be redeemed. */
533
- eligibleOptions?: Eligible;
534
- /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
535
- notEnoughBalanceOptions?: NotEnoughBalance;
536
- /** Returned when the pool isn't active. */
537
- poolNotActiveOptions?: PoolNotActive;
538
- /** Returned when invalid benefit details are provided. */
539
- benefitNotFoundOptions?: BenefitNotFound;
540
- /** Returned when invalid pool details are provided. */
541
- poolNotFoundOptions?: PoolNotFound;
542
- /** Eligibility status. */
543
- type?: EligibilityCheckResultType;
544
- }
545
- /** @oneof */
546
- interface EligibilityCheckResultResultOneOf {
547
- /** Returned when item is eligible to be redeemed. */
548
- eligibleOptions?: Eligible;
549
- /** Returned when the pool's associated balance is lower than the cost of redeeming the items. */
550
- notEnoughBalanceOptions?: NotEnoughBalance;
551
- /** Returned when the pool isn't active. */
552
- poolNotActiveOptions?: PoolNotActive;
553
- /** Returned when invalid benefit details are provided. */
554
- benefitNotFoundOptions?: BenefitNotFound;
555
- /** Returned when invalid pool details are provided. */
556
- poolNotFoundOptions?: PoolNotFound;
557
- }
558
- interface EligibleBenefit {
559
- /**
560
- * Pool ID.
561
- * @format GUID
562
- * @readonly
563
- */
564
- poolId?: string;
565
- /**
566
- * Benefit key.
567
- * @maxLength 64
568
- */
569
- benefitKey?: string;
570
- /** Item reference. */
571
- itemReference?: ItemReference;
572
- /**
573
- * Price of the benefit in credits.
574
- * @decimalValue options { gte:0, maxScale:4 }
575
- */
576
- price?: string | null;
577
- }
578
- declare enum EligibilityCheckResultType {
579
- /** Unknown eligibility. */
580
- UNKNOWN = "UNKNOWN",
581
- /** Item is eligible to be redeemed. */
582
- ELIGIBLE = "ELIGIBLE",
583
- /** Balance is lower than the cost of redeeming the items. */
584
- NOT_ENOUGH_BALANCE = "NOT_ENOUGH_BALANCE",
585
- /** Pool isn't active. */
586
- POOL_NOT_ACTIVE = "POOL_NOT_ACTIVE",
587
- /** Invalid benefit details provided. */
588
- BENEFIT_NOT_FOUND = "BENEFIT_NOT_FOUND",
589
- /** Invalid pool details provided. */
590
- POOL_NOT_FOUND = "POOL_NOT_FOUND"
591
- }
592
- interface Eligible {
593
- /**
594
- * Benefits that are eligible to be redeemed.
595
- * @maxSize 100
596
- */
597
- eligibleBenefits?: EligibleBenefit[];
598
- }
599
- interface BulkCheckBenefitEligibilityRequest {
600
- /**
601
- * List of benefits to check.
602
- * @minSize 1
603
- * @maxSize 100
604
- */
605
- benefitSelectors?: BenefitSelector[];
606
- /**
607
- * 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.
608
- * @minLength 1
609
- * @maxLength 50
610
- */
611
- namespace: string;
612
- /** Pool beneficiary. */
613
- beneficiary?: CommonIdentificationData;
614
- }
615
- interface BenefitSelector {
616
- /**
617
- * ID of the pool that the benefit to check belongs to.
618
- * @format GUID
619
- */
620
- poolId?: string;
621
- /**
622
- * Key of the benefit to check.
623
- * @maxLength 64
624
- */
625
- benefitKey?: string | null;
626
- /** Information about the item to check. */
627
- itemReference?: ItemReference;
628
- /**
629
- * Amount of items to check.
630
- *
631
- * Ensures the balance is high enough to redeem this many it
632
- * @min 1
633
- */
634
- count?: number;
635
- /**
636
- * Date that the item will be provided to the beneficiary.
637
- *
638
- * This parameter should be used to manage the potential logistics of providing the item.
639
- */
640
- targetDate?: Date | null;
641
- /** Additional information. */
642
- additionalData?: Record<string, any> | null;
643
- }
644
- interface BulkCheckBenefitEligibilityResponse {
645
- /**
646
- * List of results checking each benefit.
647
- * @minSize 1
648
- * @maxSize 100
649
- */
650
- results?: BulkEligibilityCheckResult[];
651
- }
652
- interface BulkEligibilityCheckResult {
653
- /** Benefit information specified in API call. */
654
- benefitSelector?: BenefitSelector;
655
- /** Result of the eligibility check. */
656
- result?: EligibilityCheckResult;
657
- }
658
- interface GetEligibleBenefitsRequest {
659
- /** Item reference. */
660
- itemReference: ItemReference;
661
- /**
662
- * Amount of items to check. This ensures the balance is high enough to redeem this many items.
663
- * @min 1
664
- */
665
- count?: number;
666
- /**
667
- * Date that the item will be provided to the beneficiary.
668
- *
669
- * This parameter should be used to manage the potential logistics of providing the item.
670
- */
671
- targetDate?: Date | null;
672
- /** Additional information. */
673
- additionalData?: Record<string, any> | null;
674
- /** Filter request by beneficiary. */
675
- beneficiary?: CommonIdentificationData;
676
- /**
677
- * 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.
678
- * @minLength 1
679
- * @maxLength 50
680
- */
681
- namespace: string;
682
- }
683
- interface GetEligibleBenefitsResponse {
684
- /** Retrieved benefits that can be redeemed. */
685
- eligibleBenefits?: EligibleBenefit[];
686
- }
687
- interface BulkUpdatePoolsRequest {
688
- /**
689
- * Pools to update.
690
- * @minSize 1
691
- * @maxSize 100
692
- */
693
- pools?: MaskedPool[];
694
- /**
695
- * Whether to return the full pool definition entities.
696
- *
697
- * Default: `false`
698
- */
699
- returnEntity?: boolean;
700
- }
701
- interface MaskedPool {
702
- /** Pool to update. */
703
- pool?: Pool;
704
- /** Explicit list of fields to update. */
705
- fieldMask?: string[];
706
- }
707
- interface BulkUpdatePoolsResponse {
708
- /**
709
- * List of updated pools and associated metadata.
710
- * @minSize 1
711
- * @maxSize 100
712
- */
713
- results?: BulkPoolResult[];
714
- /** Bulk action metadata. */
715
- bulkActionMetadata?: BulkActionMetadata;
716
- }
717
- interface BulkPoolResult {
718
- /** Pool metadata. */
719
- poolMetadata?: ItemMetadata;
720
- /** Pool data. */
721
- pool?: Pool;
722
- }
723
- interface ItemMetadata {
724
- /**
725
- * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
726
- * @format GUID
727
- */
728
- id?: string | null;
729
- /** Index of the item within the request array. Allows for correlation between request and response items. */
730
- originalIndex?: number;
731
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
732
- success?: boolean;
733
- /** Details about the error in case of failure. */
734
- error?: ApplicationError;
735
- }
736
- interface ApplicationError {
737
- /** Error code. */
738
- code?: string;
739
- /** Description of the error. */
740
- description?: string;
741
- /** Data related to the error. */
742
- data?: Record<string, any> | null;
743
- }
744
- interface BulkActionMetadata {
745
- /** Number of items that were successfully processed. */
746
- totalSuccesses?: number;
747
- /** Number of items that couldn't be processed. */
748
- totalFailures?: number;
749
- /** Number of failures without details because detailed failure threshold was exceeded. */
750
- undetailedFailures?: number;
751
- }
752
-
753
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
754
- getUrl: (context: any) => string;
755
- httpMethod: K;
756
- path: string;
757
- pathParams: M;
758
- __requestType: T;
759
- __originalRequestType: S;
760
- __responseType: Q;
761
- __originalResponseType: R;
762
- };
763
- declare function getPool(): __PublicMethodMetaInfo<'GET', {
764
- poolId: string;
765
- }, GetPoolRequest$1, GetPoolRequest, GetPoolResponse$1, GetPoolResponse>;
766
- declare function updatePool(): __PublicMethodMetaInfo<'PATCH', {
767
- poolId: string;
768
- }, UpdatePoolRequest$1, UpdatePoolRequest, UpdatePoolResponse$1, UpdatePoolResponse>;
769
- declare function queryPools(): __PublicMethodMetaInfo<'POST', {}, QueryPoolsRequest$1, QueryPoolsRequest, QueryPoolsResponse$1, QueryPoolsResponse>;
770
- declare function redeemBenefit(): __PublicMethodMetaInfo<'POST', {}, RedeemBenefitRequest$1, RedeemBenefitRequest, RedeemBenefitResponse$1, RedeemBenefitResponse>;
771
- declare function checkBenefitEligibility(): __PublicMethodMetaInfo<'POST', {}, CheckBenefitEligibilityRequest$1, CheckBenefitEligibilityRequest, CheckBenefitEligibilityResponse$1, CheckBenefitEligibilityResponse>;
772
- declare function bulkCheckBenefitEligibility(): __PublicMethodMetaInfo<'POST', {}, BulkCheckBenefitEligibilityRequest$1, BulkCheckBenefitEligibilityRequest, BulkCheckBenefitEligibilityResponse$1, BulkCheckBenefitEligibilityResponse>;
773
- declare function getEligibleBenefits(): __PublicMethodMetaInfo<'POST', {}, GetEligibleBenefitsRequest$1, GetEligibleBenefitsRequest, GetEligibleBenefitsResponse$1, GetEligibleBenefitsResponse>;
774
- declare function bulkUpdatePools(): __PublicMethodMetaInfo<'POST', {}, BulkUpdatePoolsRequest$1, BulkUpdatePoolsRequest, BulkUpdatePoolsResponse$1, BulkUpdatePoolsResponse>;
775
-
776
- export { type __PublicMethodMetaInfo, bulkCheckBenefitEligibility, bulkUpdatePools, checkBenefitEligibility, getEligibleBenefits, getPool, queryPools, redeemBenefit, updatePool };