@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 {
@@ -62,6 +62,27 @@ var import_timestamp2 = require("@wix/sdk-runtime/transformations/timestamp");
62
62
  var import_field_mask = require("@wix/sdk-runtime/transformations/field-mask");
63
63
  var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
64
64
  var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
65
+ var TRANSFORM_PATHS_0 = [
66
+ { path: "pool.createdDate" },
67
+ { path: "pool.updatedDate" }
68
+ ];
69
+ var TRANSFORM_PATHS_1 = [{ path: "fieldMask" }];
70
+ var TRANSFORM_PATHS_2 = [
71
+ { path: "pools.createdDate" },
72
+ { path: "pools.updatedDate" }
73
+ ];
74
+ var TRANSFORM_PATHS_3 = [{ path: "targetDate" }];
75
+ var TRANSFORM_PATHS_4 = [{ path: "benefitSelectors.targetDate" }];
76
+ var TRANSFORM_PATHS_5 = [{ path: "results.benefitSelector.targetDate" }];
77
+ var TRANSFORM_PATHS_6 = [{ path: "pools.fieldMask" }];
78
+ var TRANSFORM_PATHS_7 = [
79
+ { path: "pools.pool.createdDate" },
80
+ { path: "pools.pool.updatedDate" }
81
+ ];
82
+ var TRANSFORM_PATHS_8 = [
83
+ { path: "results.item.createdDate" },
84
+ { path: "results.item.updatedDate" }
85
+ ];
65
86
  function resolveWixBenefitProgramsV1PoolPoolServiceUrl(opts) {
66
87
  const domainToMappings = {
67
88
  "api._api_base_domain_": [
@@ -283,7 +304,7 @@ function getPool(payload) {
283
304
  transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
284
305
  {
285
306
  transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
286
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
307
+ paths: TRANSFORM_PATHS_0
287
308
  }
288
309
  ])
289
310
  };
@@ -296,11 +317,11 @@ function updatePool(payload) {
296
317
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
297
318
  {
298
319
  transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
299
- paths: [{ path: "fieldMask" }]
320
+ paths: TRANSFORM_PATHS_1
300
321
  },
301
322
  {
302
323
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
303
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
324
+ paths: TRANSFORM_PATHS_0
304
325
  }
305
326
  ]);
306
327
  const metadata = {
@@ -320,7 +341,7 @@ function updatePool(payload) {
320
341
  transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
321
342
  {
322
343
  transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
323
- paths: [{ path: "pool.createdDate" }, { path: "pool.updatedDate" }]
344
+ paths: TRANSFORM_PATHS_0
324
345
  }
325
346
  ])
326
347
  };
@@ -347,10 +368,7 @@ function queryPools(payload) {
347
368
  transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
348
369
  {
349
370
  transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
350
- paths: [
351
- { path: "pools.createdDate" },
352
- { path: "pools.updatedDate" }
353
- ]
371
+ paths: TRANSFORM_PATHS_2
354
372
  }
355
373
  ])
356
374
  };
@@ -363,7 +381,7 @@ function redeemBenefit(payload) {
363
381
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
364
382
  {
365
383
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
366
- paths: [{ path: "targetDate" }]
384
+ paths: TRANSFORM_PATHS_3
367
385
  }
368
386
  ]);
369
387
  const metadata = {
@@ -390,7 +408,7 @@ function reallocateBenefit(payload) {
390
408
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
391
409
  {
392
410
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
393
- paths: [{ path: "targetDate" }]
411
+ paths: TRANSFORM_PATHS_3
394
412
  }
395
413
  ]);
396
414
  const metadata = {
@@ -438,7 +456,7 @@ function checkBenefitEligibility(payload) {
438
456
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
439
457
  {
440
458
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
441
- paths: [{ path: "targetDate" }]
459
+ paths: TRANSFORM_PATHS_3
442
460
  }
443
461
  ]);
444
462
  const metadata = {
@@ -465,7 +483,7 @@ function bulkCheckBenefitEligibility(payload) {
465
483
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
466
484
  {
467
485
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
468
- paths: [{ path: "benefitSelectors.targetDate" }]
486
+ paths: TRANSFORM_PATHS_4
469
487
  }
470
488
  ]);
471
489
  const metadata = {
@@ -485,7 +503,7 @@ function bulkCheckBenefitEligibility(payload) {
485
503
  transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
486
504
  {
487
505
  transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
488
- paths: [{ path: "results.benefitSelector.targetDate" }]
506
+ paths: TRANSFORM_PATHS_5
489
507
  }
490
508
  ])
491
509
  };
@@ -498,7 +516,7 @@ function getEligibleBenefits(payload) {
498
516
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
499
517
  {
500
518
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
501
- paths: [{ path: "targetDate" }]
519
+ paths: TRANSFORM_PATHS_3
502
520
  }
503
521
  ]);
504
522
  const metadata = {
@@ -525,14 +543,11 @@ function bulkUpdatePools(payload) {
525
543
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
526
544
  {
527
545
  transformFn: import_field_mask.transformSDKFieldMaskToRESTFieldMask,
528
- paths: [{ path: "pools.fieldMask" }]
546
+ paths: TRANSFORM_PATHS_6
529
547
  },
530
548
  {
531
549
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
532
- paths: [
533
- { path: "pools.pool.createdDate" },
534
- { path: "pools.pool.updatedDate" }
535
- ]
550
+ paths: TRANSFORM_PATHS_7
536
551
  }
537
552
  ]);
538
553
  const metadata = {
@@ -552,10 +567,7 @@ function bulkUpdatePools(payload) {
552
567
  transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
553
568
  {
554
569
  transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
555
- paths: [
556
- { path: "results.item.createdDate" },
557
- { path: "results.item.updatedDate" }
558
- ]
570
+ paths: TRANSFORM_PATHS_8
559
571
  }
560
572
  ])
561
573
  };
@@ -568,7 +580,7 @@ function checkBenefitEligibilityByFilter(payload) {
568
580
  const serializedData = (0, import_transform_paths.transformPaths)(payload, [
569
581
  {
570
582
  transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
571
- paths: [{ path: "targetDate" }]
583
+ paths: TRANSFORM_PATHS_3
572
584
  }
573
585
  ]);
574
586
  const metadata = {