@wix/auto_sdk_benefit-programs_pools 1.0.57 → 1.0.59

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.
@@ -104,8 +104,6 @@ interface Pool {
104
104
  renewalCount?: number | null;
105
105
  }
106
106
  declare enum PoolStatus {
107
- /** Undefined pool status. */
108
- UNDEFINED = "UNDEFINED",
109
107
  /** Pool is active. */
110
108
  ACTIVE = "ACTIVE",
111
109
  /** Pool is paused. It can be resumed. */
@@ -120,7 +118,7 @@ declare enum PoolStatus {
120
118
  PENDING = "PENDING"
121
119
  }
122
120
  /** @enumType */
123
- type PoolStatusWithLiterals = PoolStatus | 'UNDEFINED' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'RENEWING' | 'PENDING';
121
+ type PoolStatusWithLiterals = PoolStatus | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'PROVISIONING' | 'RENEWING' | 'PENDING';
124
122
  interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
125
123
  /**
126
124
  * ID of a site visitor that hasn't logged in to the site.
@@ -246,7 +244,6 @@ interface PolicyExpressionExpressionOneOf {
246
244
  policyOptions?: Policy;
247
245
  }
248
246
  declare enum PolicyExpressionType {
249
- UNKNOWN = "UNKNOWN",
250
247
  /** Use with `operatorNotOptions`. */
251
248
  OPERATOR_NOT = "OPERATOR_NOT",
252
249
  /** Use with `operatorAndOptions`. */
@@ -257,7 +254,7 @@ declare enum PolicyExpressionType {
257
254
  POLICY = "POLICY"
258
255
  }
259
256
  /** @enumType */
260
- type PolicyExpressionTypeWithLiterals = PolicyExpressionType | 'UNKNOWN' | 'OPERATOR_NOT' | 'OPERATOR_AND' | 'OPERATOR_OR' | 'POLICY';
257
+ type PolicyExpressionTypeWithLiterals = PolicyExpressionType | 'OPERATOR_NOT' | 'OPERATOR_AND' | 'OPERATOR_OR' | 'POLICY';
261
258
  interface PolicyExpressionNot {
262
259
  /** Policy expression. If this expression is not fulfilled, benefits can be redeemed. */
263
260
  expression?: PolicyExpression;
@@ -306,8 +303,6 @@ interface PolicyPolicyOneOf {
306
303
  customOptions?: CustomPolicy;
307
304
  }
308
305
  declare enum Type {
309
- /** Unknown policy type. */
310
- UNKNOWN = "UNKNOWN",
311
306
  /** Use with `fixedIntervalOptions`. */
312
307
  FIXED_INTERVAL = "FIXED_INTERVAL",
313
308
  /** Use with `rateLimitedOptions`. */
@@ -316,7 +311,7 @@ declare enum Type {
316
311
  CUSTOM = "CUSTOM"
317
312
  }
318
313
  /** @enumType */
319
- type TypeWithLiterals = Type | 'UNKNOWN' | 'FIXED_INTERVAL' | 'RATE_LIMITED' | 'CUSTOM';
314
+ type TypeWithLiterals = Type | 'FIXED_INTERVAL' | 'RATE_LIMITED' | 'CUSTOM';
320
315
  interface FixedIntervalPolicy {
321
316
  /** Weekday that this interval starts from. If this field is defined, then `toWeekDay` is required. */
322
317
  fromWeekDay?: WeekDayWithLiterals;
@@ -378,17 +373,13 @@ interface RateLimitedPolicy {
378
373
  quotaId?: string | null;
379
374
  }
380
375
  declare enum TimePeriod {
381
- /** Unknown time period. */
382
- UNKNOWN_TIME_PERIOD = "UNKNOWN_TIME_PERIOD",
383
376
  /** Day, starting at midnight. */
384
377
  DAY = "DAY",
385
- /** Calendar week, starting day depending on locale. */
386
- WEEK = "WEEK",
387
378
  /** Calendar month, starting on the first day of the month. */
388
379
  MONTH = "MONTH"
389
380
  }
390
381
  /** @enumType */
391
- type TimePeriodWithLiterals = TimePeriod | 'UNKNOWN_TIME_PERIOD' | 'DAY' | 'WEEK' | 'MONTH';
382
+ type TimePeriodWithLiterals = TimePeriod | 'DAY' | 'MONTH';
392
383
  /** Custom policy as implemented by the Entitlement Policy Provider */
393
384
  interface CustomPolicy {
394
385
  /**
@@ -454,7 +445,7 @@ interface ProgramDefinitionInfo {
454
445
  /**
455
446
  * Display name of the program definition.
456
447
  * @readonly
457
- * @maxLength 128
448
+ * @maxLength 64
458
449
  */
459
450
  displayName?: string | null;
460
451
  /**
@@ -485,15 +476,13 @@ interface PoolProgramInfo {
485
476
  displayName?: string | null;
486
477
  }
487
478
  declare enum PoolOrigin {
488
- /** Unknown pool origin. */
489
- UNKNOWN = "UNKNOWN",
490
479
  /** Benefit pool created by a program provision. */
491
480
  PROVISION = "PROVISION",
492
481
  /** Benefit pool was created when pool definition was added to program definition. */
493
482
  CASCADE = "CASCADE"
494
483
  }
495
484
  /** @enumType */
496
- type PoolOriginWithLiterals = PoolOrigin | 'UNKNOWN' | 'PROVISION' | 'CASCADE';
485
+ type PoolOriginWithLiterals = PoolOrigin | 'PROVISION' | 'CASCADE';
497
486
  interface PoolRenewalAction extends PoolRenewalActionActionOneOf {
498
487
  /**
499
488
  * The pool's details (benefits and settings) will be updated to match the details of the specified pool definition revision.
@@ -520,15 +509,13 @@ interface PoolRenewalActionActionOneOf {
520
509
  updateOptions?: Update;
521
510
  }
522
511
  declare enum PoolRenewalActionType {
523
- /** Undefined action type. */
524
- UNDEFINED = "UNDEFINED",
525
512
  /** Pool will end on program renewal */
526
513
  END = "END",
527
514
  /** Pool will be updated on program renewal */
528
515
  UPDATE = "UPDATE"
529
516
  }
530
517
  /** @enumType */
531
- type PoolRenewalActionTypeWithLiterals = PoolRenewalActionType | 'UNDEFINED' | 'END' | 'UPDATE';
518
+ type PoolRenewalActionTypeWithLiterals = PoolRenewalActionType | 'END' | 'UPDATE';
532
519
  interface Update {
533
520
  /**
534
521
  * The pool's details will be updated to match the details of the specified pool definition revision.
@@ -1156,8 +1143,6 @@ interface EligibilityCheckResult {
1156
1143
  benefitResults?: BenefitResult[];
1157
1144
  }
1158
1145
  declare enum BenefitResultType {
1159
- /** Unknown eligibility. */
1160
- UNKNOWN = "UNKNOWN",
1161
1146
  /** Item is eligible to be redeemed. */
1162
1147
  ELIGIBLE_BENEFIT = "ELIGIBLE_BENEFIT",
1163
1148
  /** Balance is lower than the cost of redeeming the items. */
@@ -1170,7 +1155,7 @@ declare enum BenefitResultType {
1170
1155
  POOL_NOT_FOUND = "POOL_NOT_FOUND"
1171
1156
  }
1172
1157
  /** @enumType */
1173
- type BenefitResultTypeWithLiterals = BenefitResultType | 'UNKNOWN' | 'ELIGIBLE_BENEFIT' | 'NOT_ENOUGH_BALANCE' | 'POOL_NOT_ACTIVE' | 'BENEFIT_NOT_FOUND' | 'POOL_NOT_FOUND';
1158
+ type BenefitResultTypeWithLiterals = BenefitResultType | 'ELIGIBLE_BENEFIT' | 'NOT_ENOUGH_BALANCE' | 'POOL_NOT_ACTIVE' | 'BENEFIT_NOT_FOUND' | 'POOL_NOT_FOUND';
1174
1159
  interface EligibleBenefit {
1175
1160
  /**
1176
1161
  * Pool ID.
@@ -1317,11 +1302,10 @@ interface ListPoolsRequest {
1317
1302
  cursorPaging?: CursorPaging;
1318
1303
  }
1319
1304
  declare enum ListPoolsRequestType {
1320
- UNKNOWN_FILTER = "UNKNOWN_FILTER",
1321
1305
  BY_ITEM_REFERENCE = "BY_ITEM_REFERENCE"
1322
1306
  }
1323
1307
  /** @enumType */
1324
- type ListPoolsRequestTypeWithLiterals = ListPoolsRequestType | 'UNKNOWN_FILTER' | 'BY_ITEM_REFERENCE';
1308
+ type ListPoolsRequestTypeWithLiterals = ListPoolsRequestType | 'BY_ITEM_REFERENCE';
1325
1309
  interface ByItemReference {
1326
1310
  /**
1327
1311
  * A list of filters
@@ -1499,15 +1483,13 @@ interface ProvisionPoolsForProgramResponseResultOneOf {
1499
1483
  asyncOptions?: AsyncResult;
1500
1484
  }
1501
1485
  declare enum ProvisionPoolsForProgramResponseType {
1502
- /** Unknown result type */
1503
- UNKNOWN = "UNKNOWN",
1504
1486
  /** Sync result */
1505
1487
  SYNC = "SYNC",
1506
1488
  /** Async result */
1507
1489
  ASYNC = "ASYNC"
1508
1490
  }
1509
1491
  /** @enumType */
1510
- type ProvisionPoolsForProgramResponseTypeWithLiterals = ProvisionPoolsForProgramResponseType | 'UNKNOWN' | 'SYNC' | 'ASYNC';
1492
+ type ProvisionPoolsForProgramResponseTypeWithLiterals = ProvisionPoolsForProgramResponseType | 'SYNC' | 'ASYNC';
1511
1493
  interface SyncResult {
1512
1494
  /** Indicates if the operation was successful */
1513
1495
  success?: boolean;
@@ -1555,12 +1537,11 @@ interface UpdatePoolStatusRequestPoolSelectorOneOf {
1555
1537
  byProgramIdOptions?: ByProgramIdOptions;
1556
1538
  }
1557
1539
  declare enum PoolSelectorType {
1558
- UNKNOWN_SELECTOR = "UNKNOWN_SELECTOR",
1559
1540
  BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID = "BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID",
1560
1541
  BY_PROGRAM_ID = "BY_PROGRAM_ID"
1561
1542
  }
1562
1543
  /** @enumType */
1563
- type PoolSelectorTypeWithLiterals = PoolSelectorType | 'UNKNOWN_SELECTOR' | 'BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID' | 'BY_PROGRAM_ID';
1544
+ type PoolSelectorTypeWithLiterals = PoolSelectorType | 'BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID' | 'BY_PROGRAM_ID';
1564
1545
  interface ByPoolDefinitionIdAndProgramDefinitionIdOptions {
1565
1546
  /**
1566
1547
  * Pool definition id
@@ -2118,9 +2099,11 @@ type PoolQuery = {
2118
2099
  }[];
2119
2100
  };
2120
2101
  declare const utils: {
2121
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<Pool, PoolQuerySpec, PoolQuery>;
2122
- Filter: _wix_sdk_types.FilterFactory<Pool, PoolQuerySpec>;
2123
- Sort: _wix_sdk_types.SortFactory<PoolQuerySpec>;
2102
+ query: {
2103
+ QueryBuilder: () => _wix_sdk_types.QueryBuilder<Pool, PoolQuerySpec, PoolQuery>;
2104
+ Filter: _wix_sdk_types.FilterFactory<Pool, PoolQuerySpec>;
2105
+ Sort: _wix_sdk_types.SortFactory<PoolQuerySpec>;
2106
+ };
2124
2107
  };
2125
2108
  /**
2126
2109
  * Redeems a specified benefit.
@@ -498,7 +498,6 @@ function checkEligibilityByFilter(payload) {
498
498
  import { transformPaths as transformPaths2 } from "@wix/sdk-runtime/transformations/transform-paths";
499
499
  import { createQueryUtils } from "@wix/sdk-runtime/query-builder-utils";
500
500
  var PoolStatus = /* @__PURE__ */ ((PoolStatus2) => {
501
- PoolStatus2["UNDEFINED"] = "UNDEFINED";
502
501
  PoolStatus2["ACTIVE"] = "ACTIVE";
503
502
  PoolStatus2["PAUSED"] = "PAUSED";
504
503
  PoolStatus2["ENDED"] = "ENDED";
@@ -515,7 +514,6 @@ var IdentityType = /* @__PURE__ */ ((IdentityType2) => {
515
514
  return IdentityType2;
516
515
  })(IdentityType || {});
517
516
  var PolicyExpressionType = /* @__PURE__ */ ((PolicyExpressionType2) => {
518
- PolicyExpressionType2["UNKNOWN"] = "UNKNOWN";
519
517
  PolicyExpressionType2["OPERATOR_NOT"] = "OPERATOR_NOT";
520
518
  PolicyExpressionType2["OPERATOR_AND"] = "OPERATOR_AND";
521
519
  PolicyExpressionType2["OPERATOR_OR"] = "OPERATOR_OR";
@@ -523,7 +521,6 @@ var PolicyExpressionType = /* @__PURE__ */ ((PolicyExpressionType2) => {
523
521
  return PolicyExpressionType2;
524
522
  })(PolicyExpressionType || {});
525
523
  var Type = /* @__PURE__ */ ((Type2) => {
526
- Type2["UNKNOWN"] = "UNKNOWN";
527
524
  Type2["FIXED_INTERVAL"] = "FIXED_INTERVAL";
528
525
  Type2["RATE_LIMITED"] = "RATE_LIMITED";
529
526
  Type2["CUSTOM"] = "CUSTOM";
@@ -541,20 +538,16 @@ var WeekDay = /* @__PURE__ */ ((WeekDay2) => {
541
538
  return WeekDay2;
542
539
  })(WeekDay || {});
543
540
  var TimePeriod = /* @__PURE__ */ ((TimePeriod2) => {
544
- TimePeriod2["UNKNOWN_TIME_PERIOD"] = "UNKNOWN_TIME_PERIOD";
545
541
  TimePeriod2["DAY"] = "DAY";
546
- TimePeriod2["WEEK"] = "WEEK";
547
542
  TimePeriod2["MONTH"] = "MONTH";
548
543
  return TimePeriod2;
549
544
  })(TimePeriod || {});
550
545
  var PoolOrigin = /* @__PURE__ */ ((PoolOrigin2) => {
551
- PoolOrigin2["UNKNOWN"] = "UNKNOWN";
552
546
  PoolOrigin2["PROVISION"] = "PROVISION";
553
547
  PoolOrigin2["CASCADE"] = "CASCADE";
554
548
  return PoolOrigin2;
555
549
  })(PoolOrigin || {});
556
550
  var PoolRenewalActionType = /* @__PURE__ */ ((PoolRenewalActionType2) => {
557
- PoolRenewalActionType2["UNDEFINED"] = "UNDEFINED";
558
551
  PoolRenewalActionType2["END"] = "END";
559
552
  PoolRenewalActionType2["UPDATE"] = "UPDATE";
560
553
  return PoolRenewalActionType2;
@@ -565,7 +558,6 @@ var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
565
558
  return SortOrder2;
566
559
  })(SortOrder || {});
567
560
  var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
568
- BenefitResultType2["UNKNOWN"] = "UNKNOWN";
569
561
  BenefitResultType2["ELIGIBLE_BENEFIT"] = "ELIGIBLE_BENEFIT";
570
562
  BenefitResultType2["NOT_ENOUGH_BALANCE"] = "NOT_ENOUGH_BALANCE";
571
563
  BenefitResultType2["POOL_NOT_ACTIVE"] = "POOL_NOT_ACTIVE";
@@ -574,18 +566,15 @@ var BenefitResultType = /* @__PURE__ */ ((BenefitResultType2) => {
574
566
  return BenefitResultType2;
575
567
  })(BenefitResultType || {});
576
568
  var ListPoolsRequestType = /* @__PURE__ */ ((ListPoolsRequestType2) => {
577
- ListPoolsRequestType2["UNKNOWN_FILTER"] = "UNKNOWN_FILTER";
578
569
  ListPoolsRequestType2["BY_ITEM_REFERENCE"] = "BY_ITEM_REFERENCE";
579
570
  return ListPoolsRequestType2;
580
571
  })(ListPoolsRequestType || {});
581
572
  var ProvisionPoolsForProgramResponseType = /* @__PURE__ */ ((ProvisionPoolsForProgramResponseType2) => {
582
- ProvisionPoolsForProgramResponseType2["UNKNOWN"] = "UNKNOWN";
583
573
  ProvisionPoolsForProgramResponseType2["SYNC"] = "SYNC";
584
574
  ProvisionPoolsForProgramResponseType2["ASYNC"] = "ASYNC";
585
575
  return ProvisionPoolsForProgramResponseType2;
586
576
  })(ProvisionPoolsForProgramResponseType || {});
587
577
  var PoolSelectorType = /* @__PURE__ */ ((PoolSelectorType2) => {
588
- PoolSelectorType2["UNKNOWN_SELECTOR"] = "UNKNOWN_SELECTOR";
589
578
  PoolSelectorType2["BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID"] = "BY_POOL_DEFINITION_ID_AND_PROGRAM_DEFINITION_ID";
590
579
  PoolSelectorType2["BY_PROGRAM_ID"] = "BY_PROGRAM_ID";
591
580
  return PoolSelectorType2;
@@ -719,7 +708,9 @@ async function typedQueryPools(query, options) {
719
708
  }
720
709
  }
721
710
  var utils = {
722
- ...createQueryUtils()
711
+ query: {
712
+ ...createQueryUtils()
713
+ }
723
714
  };
724
715
  async function redeemBenefit2(poolId, options) {
725
716
  const { httpClient, sideEffects } = arguments[2];