@wix/auto_sdk_benefit-programs_pools 1.0.86 → 1.0.88

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.
@@ -957,6 +957,14 @@ interface NotEnoughBalance {
957
957
  * @decimalValue options { maxScale:4 }
958
958
  */
959
959
  requestedBalance?: string;
960
+ /** Pool information. */
961
+ poolInfo?: PoolInfo;
962
+ /** Program definition information. */
963
+ programDefinitionInfo?: ProgramDefinitionInfo;
964
+ /** Program information. */
965
+ programInfo?: PoolProgramInfo;
966
+ /** Benefit information. */
967
+ benefitInfo?: BenefitInfo;
960
968
  }
961
969
  interface PoolInfo {
962
970
  /** Current pool balance */
@@ -981,6 +989,11 @@ interface PoolInfo {
981
989
  * @format GUID
982
990
  */
983
991
  poolDefinitionId?: string;
992
+ /**
993
+ * Credit unit type.
994
+ * @maxLength 16
995
+ */
996
+ creditUnitType?: string | null;
984
997
  }
985
998
  interface BalanceAmount {
986
999
  /**
@@ -1012,6 +1025,11 @@ interface BenefitInfo {
1012
1025
  * @maxLength 64
1013
1026
  */
1014
1027
  benefitKey?: string;
1028
+ /**
1029
+ * Price of the benefit in credits.
1030
+ * @decimalValue options { gte:0, maxScale:4 }
1031
+ */
1032
+ price?: string | null;
1015
1033
  }
1016
1034
  interface PolicyExpressionEvaluatedToFalse {
1017
1035
  /**
@@ -1026,6 +1044,14 @@ interface PolicyExpressionEvaluatedToFalse {
1026
1044
  * @maxSize 10
1027
1045
  */
1028
1046
  failureDetails?: FailureDetails[];
1047
+ /** Pool information. */
1048
+ poolInfo?: PoolInfo;
1049
+ /** Program definition information. */
1050
+ programDefinitionInfo?: ProgramDefinitionInfo;
1051
+ /** Program information. */
1052
+ programInfo?: PoolProgramInfo;
1053
+ /** Benefit information. */
1054
+ benefitInfo?: BenefitInfo;
1029
1055
  }
1030
1056
  interface FailureDetails {
1031
1057
  /**
@@ -1060,6 +1086,14 @@ interface PoolNotActive {
1060
1086
  poolId?: string;
1061
1087
  /** Pool status. */
1062
1088
  poolStatus?: PoolStatusWithLiterals;
1089
+ /** Pool information. */
1090
+ poolInfo?: PoolInfo;
1091
+ /** Program definition information. */
1092
+ programDefinitionInfo?: ProgramDefinitionInfo;
1093
+ /** Program information. */
1094
+ programInfo?: PoolProgramInfo;
1095
+ /** Benefit information. */
1096
+ benefitInfo?: BenefitInfo;
1063
1097
  }
1064
1098
  interface PoolNotFound {
1065
1099
  /**
@@ -1091,6 +1125,12 @@ interface BenefitNotFound {
1091
1125
  * @maxLength 64
1092
1126
  */
1093
1127
  benefitKey?: string | null;
1128
+ /** Pool information. */
1129
+ poolInfo?: PoolInfo;
1130
+ /** Program definition information. */
1131
+ programDefinitionInfo?: ProgramDefinitionInfo;
1132
+ /** Program information. */
1133
+ programInfo?: PoolProgramInfo;
1094
1134
  }
1095
1135
  interface ReallocateBenefitRequest {
1096
1136
  /**
@@ -1356,6 +1396,14 @@ interface EligibleBenefit {
1356
1396
  * @decimalValue options { gte:0, maxScale:4 }
1357
1397
  */
1358
1398
  price?: string | null;
1399
+ /** Pool information. */
1400
+ poolInfo?: PoolInfo;
1401
+ /** Benefit information. */
1402
+ benefitInfo?: BenefitInfo;
1403
+ /** Program definition information. */
1404
+ programDefinitionInfo?: ProgramDefinitionInfo;
1405
+ /** Program information. */
1406
+ programInfo?: PoolProgramInfo;
1359
1407
  }
1360
1408
  interface BenefitResult extends BenefitResultResultOneOf {
1361
1409
  /** Returned when item is eligible to be redeemed. */
@@ -2398,7 +2446,7 @@ interface CancelRedemptionOptions {
2398
2446
  * @applicableIdentity APP
2399
2447
  * @fqn wix.benefit_programs.v1.pool.PoolService.CheckBenefitEligibility
2400
2448
  */
2401
- declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.benefitResults` | `result.benefitResults.${number}.eligibleBenefitOptions.poolId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.externalId` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.category` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.providerAppId` | `result.benefitResults.${number}.notEnoughBalanceOptions.poolId` | `result.benefitResults.${number}.notEnoughBalanceOptions.availableBalance` | `result.benefitResults.${number}.notEnoughBalanceOptions.requestedBalance` | `result.benefitResults.${number}.policyExpressionEvaluatedToFalseOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolStatus` | `result.benefitResults.${number}.benefitNotFoundOptions.poolId` | `result.benefitResults.${number}.poolNotFoundOptions.poolId` | `result.benefitResults.${number}.type`, 5>>;
2449
+ declare function checkBenefitEligibility(poolId: string, options?: NonNullablePaths<CheckBenefitEligibilityOptions, `itemReference` | `itemReference.externalId` | `itemReference.providerAppId` | `namespace`, 1>): Promise<NonNullablePaths<CheckBenefitEligibilityResponse, `result.benefitResults` | `result.benefitResults.${number}.eligibleBenefitOptions.poolId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.externalId` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.category` | `result.benefitResults.${number}.eligibleBenefitOptions.itemReference.providerAppId` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.displayName` | `result.benefitResults.${number}.eligibleBenefitOptions.poolInfo.poolDefinitionId` | `result.benefitResults.${number}.eligibleBenefitOptions.benefitInfo.benefitKey` | `result.benefitResults.${number}.eligibleBenefitOptions.programDefinitionInfo._id` | `result.benefitResults.${number}.eligibleBenefitOptions.programInfo._id` | `result.benefitResults.${number}.notEnoughBalanceOptions.poolId` | `result.benefitResults.${number}.notEnoughBalanceOptions.availableBalance` | `result.benefitResults.${number}.notEnoughBalanceOptions.requestedBalance` | `result.benefitResults.${number}.policyExpressionEvaluatedToFalseOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolId` | `result.benefitResults.${number}.poolNotActiveOptions.poolStatus` | `result.benefitResults.${number}.benefitNotFoundOptions.poolId` | `result.benefitResults.${number}.poolNotFoundOptions.poolId` | `result.benefitResults.${number}.type`, 5>>;
2402
2450
  interface CheckBenefitEligibilityOptions {
2403
2451
  /**
2404
2452
  * Key of the benefit to check.
@@ -2479,7 +2527,7 @@ interface BulkCheckBenefitEligibilityOptions {
2479
2527
  * @applicableIdentity APP
2480
2528
  * @fqn wix.benefit_programs.v1.pool.PoolService.GetEligibleBenefits
2481
2529
  */
2482
- declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`, 0>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`, 0>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId`, 3> & {
2530
+ declare function getEligibleBenefits(itemReference: NonNullablePaths<ItemReference, `externalId` | `providerAppId`, 0>, options?: NonNullablePaths<GetEligibleBenefitsOptions, `namespace`, 0>): Promise<NonNullablePaths<GetEligibleBenefitsResponse, `eligibleBenefits` | `eligibleBenefits.${number}.poolId` | `eligibleBenefits.${number}.benefitKey` | `eligibleBenefits.${number}.itemReference.externalId` | `eligibleBenefits.${number}.itemReference.category` | `eligibleBenefits.${number}.itemReference.providerAppId` | `eligibleBenefits.${number}.poolInfo.balance.available` | `eligibleBenefits.${number}.poolInfo.balance.reserved` | `eligibleBenefits.${number}.poolInfo.displayName` | `eligibleBenefits.${number}.poolInfo.poolDefinitionId` | `eligibleBenefits.${number}.benefitInfo.benefitKey` | `eligibleBenefits.${number}.programDefinitionInfo._id` | `eligibleBenefits.${number}.programInfo._id`, 4> & {
2483
2531
  __applicationErrorsType?: GetEligibleBenefitsApplicationErrors;
2484
2532
  }>;
2485
2533
  interface GetEligibleBenefitsOptions {
@@ -13,6 +13,27 @@ import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transform
13
13
  import { transformSDKFieldMaskToRESTFieldMask } from "@wix/sdk-runtime/transformations/field-mask";
14
14
  import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
15
15
  import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
16
+ var TRANSFORM_PATHS_0 = [
17
+ { path: "pool.createdDate" },
18
+ { path: "pool.updatedDate" }
19
+ ];
20
+ var TRANSFORM_PATHS_1 = [{ path: "fieldMask" }];
21
+ var TRANSFORM_PATHS_2 = [
22
+ { path: "pools.createdDate" },
23
+ { path: "pools.updatedDate" }
24
+ ];
25
+ var TRANSFORM_PATHS_3 = [{ path: "targetDate" }];
26
+ var TRANSFORM_PATHS_4 = [{ path: "benefitSelectors.targetDate" }];
27
+ var TRANSFORM_PATHS_5 = [{ path: "results.benefitSelector.targetDate" }];
28
+ var TRANSFORM_PATHS_6 = [{ path: "pools.fieldMask" }];
29
+ var TRANSFORM_PATHS_7 = [
30
+ { path: "pools.pool.createdDate" },
31
+ { path: "pools.pool.updatedDate" }
32
+ ];
33
+ var TRANSFORM_PATHS_8 = [
34
+ { path: "results.item.createdDate" },
35
+ { path: "results.item.updatedDate" }
36
+ ];
16
37
  function resolveWixBenefitProgramsV1PoolPoolServiceUrl(opts) {
17
38
  const domainToMappings = {
18
39
  "api._api_base_domain_": [
@@ -234,7 +255,7 @@ function getPool(payload) {
234
255
  transformResponse: (payload2) => transformPaths(payload2, [
235
256
  {
236
257
  transformFn: transformRESTTimestampToSDKTimestamp,
237
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
258
+ paths: TRANSFORM_PATHS_0
238
259
  }
239
260
  ])
240
261
  };
@@ -247,11 +268,11 @@ function updatePool(payload) {
247
268
  const serializedData = transformPaths(payload, [
248
269
  {
249
270
  transformFn: transformSDKFieldMaskToRESTFieldMask,
250
- paths: [{ path: "fieldMask" }]
271
+ paths: TRANSFORM_PATHS_1
251
272
  },
252
273
  {
253
274
  transformFn: transformSDKTimestampToRESTTimestamp,
254
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
275
+ paths: TRANSFORM_PATHS_0
255
276
  }
256
277
  ]);
257
278
  const metadata = {
@@ -271,7 +292,7 @@ function updatePool(payload) {
271
292
  transformResponse: (payload2) => transformPaths(payload2, [
272
293
  {
273
294
  transformFn: transformRESTTimestampToSDKTimestamp,
274
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
295
+ paths: TRANSFORM_PATHS_0
275
296
  }
276
297
  ])
277
298
  };
@@ -298,10 +319,7 @@ function queryPools(payload) {
298
319
  transformResponse: (payload2) => transformPaths(payload2, [
299
320
  {
300
321
  transformFn: transformRESTTimestampToSDKTimestamp,
301
- paths: [
302
- { path: "pools.createdDate" },
303
- { path: "pools.updatedDate" }
304
- ]
322
+ paths: TRANSFORM_PATHS_2
305
323
  }
306
324
  ])
307
325
  };
@@ -314,7 +332,7 @@ function redeemBenefit(payload) {
314
332
  const serializedData = transformPaths(payload, [
315
333
  {
316
334
  transformFn: transformSDKTimestampToRESTTimestamp,
317
- paths: [{ path: "targetDate" }]
335
+ paths: TRANSFORM_PATHS_3
318
336
  }
319
337
  ]);
320
338
  const metadata = {
@@ -341,7 +359,7 @@ function reallocateBenefit(payload) {
341
359
  const serializedData = transformPaths(payload, [
342
360
  {
343
361
  transformFn: transformSDKTimestampToRESTTimestamp,
344
- paths: [{ path: "targetDate" }]
362
+ paths: TRANSFORM_PATHS_3
345
363
  }
346
364
  ]);
347
365
  const metadata = {
@@ -389,7 +407,7 @@ function checkBenefitEligibility(payload) {
389
407
  const serializedData = transformPaths(payload, [
390
408
  {
391
409
  transformFn: transformSDKTimestampToRESTTimestamp,
392
- paths: [{ path: "targetDate" }]
410
+ paths: TRANSFORM_PATHS_3
393
411
  }
394
412
  ]);
395
413
  const metadata = {
@@ -416,7 +434,7 @@ function bulkCheckBenefitEligibility(payload) {
416
434
  const serializedData = transformPaths(payload, [
417
435
  {
418
436
  transformFn: transformSDKTimestampToRESTTimestamp,
419
- paths: [{ path: "benefitSelectors.targetDate" }]
437
+ paths: TRANSFORM_PATHS_4
420
438
  }
421
439
  ]);
422
440
  const metadata = {
@@ -436,7 +454,7 @@ function bulkCheckBenefitEligibility(payload) {
436
454
  transformResponse: (payload2) => transformPaths(payload2, [
437
455
  {
438
456
  transformFn: transformRESTTimestampToSDKTimestamp,
439
- paths: [{ path: "results.benefitSelector.targetDate" }]
457
+ paths: TRANSFORM_PATHS_5
440
458
  }
441
459
  ])
442
460
  };
@@ -449,7 +467,7 @@ function getEligibleBenefits(payload) {
449
467
  const serializedData = transformPaths(payload, [
450
468
  {
451
469
  transformFn: transformSDKTimestampToRESTTimestamp,
452
- paths: [{ path: "targetDate" }]
470
+ paths: TRANSFORM_PATHS_3
453
471
  }
454
472
  ]);
455
473
  const metadata = {
@@ -476,14 +494,11 @@ function bulkUpdatePools(payload) {
476
494
  const serializedData = transformPaths(payload, [
477
495
  {
478
496
  transformFn: transformSDKFieldMaskToRESTFieldMask,
479
- paths: [{ path: "pools.fieldMask" }]
497
+ paths: TRANSFORM_PATHS_6
480
498
  },
481
499
  {
482
500
  transformFn: transformSDKTimestampToRESTTimestamp,
483
- paths: [
484
- { path: "pools.pool.createdDate" },
485
- { path: "pools.pool.updatedDate" }
486
- ]
501
+ paths: TRANSFORM_PATHS_7
487
502
  }
488
503
  ]);
489
504
  const metadata = {
@@ -503,10 +518,7 @@ function bulkUpdatePools(payload) {
503
518
  transformResponse: (payload2) => transformPaths(payload2, [
504
519
  {
505
520
  transformFn: transformRESTTimestampToSDKTimestamp,
506
- paths: [
507
- { path: "results.item.createdDate" },
508
- { path: "results.item.updatedDate" }
509
- ]
521
+ paths: TRANSFORM_PATHS_8
510
522
  }
511
523
  ])
512
524
  };
@@ -519,7 +531,7 @@ function checkBenefitEligibilityByFilter(payload) {
519
531
  const serializedData = transformPaths(payload, [
520
532
  {
521
533
  transformFn: transformSDKTimestampToRESTTimestamp,
522
- paths: [{ path: "targetDate" }]
534
+ paths: TRANSFORM_PATHS_3
523
535
  }
524
536
  ]);
525
537
  const metadata = {