@wix/ecom 1.0.854 → 1.0.855

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.
@@ -719,6 +719,7 @@ interface DiscountRule$8 {
719
719
  discounts?: Discounts;
720
720
  /**
721
721
  * Discount rule status.
722
+ * Default: `UNDEFINED`
722
723
  * @readonly
723
724
  */
724
725
  status?: Status$5;
@@ -841,13 +842,13 @@ interface ItemQuantityRange {
841
842
  }
842
843
  declare enum TriggerType {
843
844
  UNDEFINED = "UNDEFINED",
844
- /** Chain multiple triggers with AND operator */
845
+ /** Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported. */
845
846
  AND = "AND",
846
- /** Subtotal range trigger */
847
+ /** Subtotal must be within the specified `subtotalRange` values. */
847
848
  SUBTOTAL_RANGE = "SUBTOTAL_RANGE",
848
- /** Item quantity range trigger */
849
+ /** Quantity of items in scope must be within specified `itemQuantityRange` values. */
849
850
  ITEM_QUANTITY_RANGE = "ITEM_QUANTITY_RANGE",
850
- /** Custom trigger, see Custom Triggers SPI for more details */
851
+ /** Custom trigger type defined in `customTrigger` object. */
851
852
  CUSTOM = "CUSTOM",
852
853
  /** Chain multiple triggers with OR operator */
853
854
  OR = "OR"
@@ -907,11 +908,11 @@ interface SpecificItemsInfo {
907
908
  }
908
909
  declare enum DiscountType$8 {
909
910
  UNDEFINED = "UNDEFINED",
910
- /** Percentage discount */
911
+ /** Price is reduced by percentage value. */
911
912
  PERCENTAGE = "PERCENTAGE",
912
- /** Fixed amount discount */
913
+ /** Price is reduced by fixed amount. */
913
914
  FIXED_AMOUNT = "FIXED_AMOUNT",
914
- /** Fixed price discount */
915
+ /** Price will be set to fixed amount. */
915
916
  FIXED_PRICE = "FIXED_PRICE"
916
917
  }
917
918
  interface BuyXGetYInfo {
@@ -1389,7 +1390,7 @@ interface UpdateDiscountRuleResponseNonNullableFields {
1389
1390
  interface QueryDiscountRulesResponseNonNullableFields {
1390
1391
  discountRules: DiscountRuleNonNullableFields$7[];
1391
1392
  }
1392
- interface BaseEventMetadata$d {
1393
+ interface BaseEventMetadata$c {
1393
1394
  /** App instance ID. */
1394
1395
  instanceId?: string | null;
1395
1396
  /** Event type. */
@@ -1397,7 +1398,7 @@ interface BaseEventMetadata$d {
1397
1398
  /** The identification type and identity data. */
1398
1399
  identity?: IdentificationData$n;
1399
1400
  }
1400
- interface EventMetadata$d extends BaseEventMetadata$d {
1401
+ interface EventMetadata$c extends BaseEventMetadata$c {
1401
1402
  /**
1402
1403
  * Unique event ID.
1403
1404
  * Allows clients to ignore duplicate webhooks.
@@ -1437,14 +1438,14 @@ interface EventMetadata$d extends BaseEventMetadata$d {
1437
1438
  }
1438
1439
  interface DiscountRuleCreatedEnvelope {
1439
1440
  entity: DiscountRule$8;
1440
- metadata: EventMetadata$d;
1441
+ metadata: EventMetadata$c;
1442
+ }
1443
+ interface DiscountRuleDeletedEnvelope {
1444
+ metadata: EventMetadata$c;
1441
1445
  }
1442
1446
  interface DiscountRuleUpdatedEnvelope {
1443
1447
  entity: DiscountRule$8;
1444
- metadata: EventMetadata$d;
1445
- }
1446
- interface DiscountRuleDeletedEnvelope {
1447
- metadata: EventMetadata$d;
1448
+ metadata: EventMetadata$c;
1448
1449
  }
1449
1450
  interface UpdateDiscountRule {
1450
1451
  /**
@@ -1496,6 +1497,7 @@ interface UpdateDiscountRule {
1496
1497
  discounts?: Discounts;
1497
1498
  /**
1498
1499
  * Discount rule status.
1500
+ * Default: `UNDEFINED`
1499
1501
  * @readonly
1500
1502
  */
1501
1503
  status?: Status$5;
@@ -1636,10 +1638,10 @@ interface QueryDiscountRulesSignature {
1636
1638
  (): DiscountRulesQueryBuilder;
1637
1639
  }
1638
1640
  declare const onDiscountRuleCreated$1: EventDefinition<DiscountRuleCreatedEnvelope, "wix.ecom.discounts.v1.discount_rule_created">;
1639
- declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
1640
1641
  declare const onDiscountRuleDeleted$1: EventDefinition<DiscountRuleDeletedEnvelope, "wix.ecom.discounts.v1.discount_rule_deleted">;
1642
+ declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
1641
1643
 
1642
- declare function createEventModule$d<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1644
+ declare function createEventModule$c<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1643
1645
 
1644
1646
  declare const createDiscountRule: MaybeContext<BuildRESTFunction<typeof createDiscountRule$1> & typeof createDiscountRule$1>;
1645
1647
  declare const getDiscountRule: MaybeContext<BuildRESTFunction<typeof getDiscountRule$1> & typeof getDiscountRule$1>;
@@ -1651,19 +1653,19 @@ type _publicOnDiscountRuleCreatedType = typeof onDiscountRuleCreated$1;
1651
1653
  /**
1652
1654
  * Triggered when a discount rule is created.
1653
1655
  */
1654
- declare const onDiscountRuleCreated: ReturnType<typeof createEventModule$d<_publicOnDiscountRuleCreatedType>>;
1656
+ declare const onDiscountRuleCreated: ReturnType<typeof createEventModule$c<_publicOnDiscountRuleCreatedType>>;
1655
1657
 
1656
- type _publicOnDiscountRuleUpdatedType = typeof onDiscountRuleUpdated$1;
1658
+ type _publicOnDiscountRuleDeletedType = typeof onDiscountRuleDeleted$1;
1657
1659
  /**
1658
- * Triggered when a discount rule is updated.
1660
+ * Triggered when a discount rule is deleted.
1659
1661
  */
1660
- declare const onDiscountRuleUpdated: ReturnType<typeof createEventModule$d<_publicOnDiscountRuleUpdatedType>>;
1662
+ declare const onDiscountRuleDeleted: ReturnType<typeof createEventModule$c<_publicOnDiscountRuleDeletedType>>;
1661
1663
 
1662
- type _publicOnDiscountRuleDeletedType = typeof onDiscountRuleDeleted$1;
1664
+ type _publicOnDiscountRuleUpdatedType = typeof onDiscountRuleUpdated$1;
1663
1665
  /**
1664
- * Triggered when a discount rule is deleted.
1666
+ * Triggered when a discount rule is updated.
1665
1667
  */
1666
- declare const onDiscountRuleDeleted: ReturnType<typeof createEventModule$d<_publicOnDiscountRuleDeletedType>>;
1668
+ declare const onDiscountRuleUpdated: ReturnType<typeof createEventModule$c<_publicOnDiscountRuleUpdatedType>>;
1667
1669
 
1668
1670
  type index_d$t_ActiveTimeInfo = ActiveTimeInfo;
1669
1671
  type index_d$t_And = And;
@@ -1728,7 +1730,7 @@ declare const index_d$t_onDiscountRuleUpdated: typeof onDiscountRuleUpdated;
1728
1730
  declare const index_d$t_queryDiscountRules: typeof queryDiscountRules;
1729
1731
  declare const index_d$t_updateDiscountRule: typeof updateDiscountRule;
1730
1732
  declare namespace index_d$t {
1731
- export { type ActionEvent$n as ActionEvent, type index_d$t_ActiveTimeInfo as ActiveTimeInfo, type index_d$t_And as And, type AppliedDiscount$8 as AppliedDiscount, type index_d$t_AppliedDiscountRule as AppliedDiscountRule, index_d$t_AppliedSubjectType as AppliedSubjectType, type BaseEventMetadata$d as BaseEventMetadata, type index_d$t_BuyXGetYInfo as BuyXGetYInfo, type index_d$t_CatalogItemFilter as CatalogItemFilter, type CatalogReference$c as CatalogReference, type index_d$t_CreateDiscountRuleRequest as CreateDiscountRuleRequest, type index_d$t_CreateDiscountRuleResponse as CreateDiscountRuleResponse, type index_d$t_CreateDiscountRuleResponseNonNullableFields as CreateDiscountRuleResponseNonNullableFields, type CursorPaging$f as CursorPaging, type Cursors$f as Cursors, type index_d$t_Custom as Custom, type index_d$t_CustomFilter as CustomFilter, type index_d$t_CustomerBuy as CustomerBuy, type index_d$t_CustomerBuyConditionOneOf as CustomerBuyConditionOneOf, type index_d$t_CustomerGet as CustomerGet, type index_d$t_DeleteDiscountRuleRequest as DeleteDiscountRuleRequest, type index_d$t_DeleteDiscountRuleResponse as DeleteDiscountRuleResponse, type Discount$3 as Discount, type index_d$t_DiscountDiscountOneOf as DiscountDiscountOneOf, type DiscountRule$8 as DiscountRule, type index_d$t_DiscountRuleCreatedEnvelope as DiscountRuleCreatedEnvelope, type index_d$t_DiscountRuleDeletedEnvelope as DiscountRuleDeletedEnvelope, type DiscountRuleName$8 as DiscountRuleName, type DiscountRuleNonNullableFields$7 as DiscountRuleNonNullableFields, type index_d$t_DiscountRuleUpdatedEnvelope as DiscountRuleUpdatedEnvelope, type index_d$t_DiscountRuleUsageLimitReached as DiscountRuleUsageLimitReached, type index_d$t_DiscountRulesQueryBuilder as DiscountRulesQueryBuilder, type index_d$t_DiscountRulesQueryResult as DiscountRulesQueryResult, type index_d$t_DiscountSettings as DiscountSettings, type index_d$t_DiscountTrigger as DiscountTrigger, type index_d$t_DiscountTriggerTriggerOneOf as DiscountTriggerTriggerOneOf, DiscountType$8 as DiscountType, type index_d$t_Discounts as Discounts, type DomainEvent$n as DomainEvent, type DomainEventBodyOneOf$n as DomainEventBodyOneOf, type Empty$g as Empty, type EntityCreatedEvent$n as EntityCreatedEvent, type EntityDeletedEvent$n as EntityDeletedEvent, type EntityUpdatedEvent$n as EntityUpdatedEvent, type EventMetadata$d as EventMetadata, type ExtendedFields$c as ExtendedFields, type index_d$t_GetAppliedDiscountsRequest as GetAppliedDiscountsRequest, type index_d$t_GetAppliedDiscountsResponse as GetAppliedDiscountsResponse, type index_d$t_GetDiscountRuleRequest as GetDiscountRuleRequest, type index_d$t_GetDiscountRuleResponse as GetDiscountRuleResponse, type index_d$t_GetDiscountRuleResponseNonNullableFields as GetDiscountRuleResponseNonNullableFields, type IdentificationData$n as IdentificationData, type IdentificationDataIdOneOf$n as IdentificationDataIdOneOf, type index_d$t_ItemQuantityRange as ItemQuantityRange, type LineItem$7 as LineItem, type MessageEnvelope$m as MessageEnvelope, type MultiCurrencyPrice$6 as MultiCurrencyPrice, type index_d$t_Or as Or, type PlatformPaging$2 as PlatformPaging, type PlatformPagingMetadata$2 as PlatformPagingMetadata, type PlatformQuery$2 as PlatformQuery, type PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf, type index_d$t_QueryDiscountRulesRequest as QueryDiscountRulesRequest, type index_d$t_QueryDiscountRulesResponse as QueryDiscountRulesResponse, type index_d$t_QueryDiscountRulesResponseNonNullableFields as QueryDiscountRulesResponseNonNullableFields, type RestoreInfo$n as RestoreInfo, type Scope$5 as Scope, type index_d$t_ScopeScopeItemsOneOf as ScopeScopeItemsOneOf, index_d$t_ScopeType as ScopeType, SortOrder$f as SortOrder, type Sorting$f as Sorting, type index_d$t_SpecificItemsInfo as SpecificItemsInfo, Status$5 as Status, type index_d$t_SubtotalRange as SubtotalRange, index_d$t_TriggerType as TriggerType, index_d$t_Type as Type, type index_d$t_UpdateDiscountRule as UpdateDiscountRule, type index_d$t_UpdateDiscountRuleRequest as UpdateDiscountRuleRequest, type index_d$t_UpdateDiscountRuleResponse as UpdateDiscountRuleResponse, type index_d$t_UpdateDiscountRuleResponseNonNullableFields as UpdateDiscountRuleResponseNonNullableFields, WebhookIdentityType$m as WebhookIdentityType, type index_d$t__publicOnDiscountRuleCreatedType as _publicOnDiscountRuleCreatedType, type index_d$t__publicOnDiscountRuleDeletedType as _publicOnDiscountRuleDeletedType, type index_d$t__publicOnDiscountRuleUpdatedType as _publicOnDiscountRuleUpdatedType, index_d$t_createDiscountRule as createDiscountRule, index_d$t_deleteDiscountRule as deleteDiscountRule, index_d$t_getDiscountRule as getDiscountRule, index_d$t_onDiscountRuleCreated as onDiscountRuleCreated, index_d$t_onDiscountRuleDeleted as onDiscountRuleDeleted, index_d$t_onDiscountRuleUpdated as onDiscountRuleUpdated, onDiscountRuleCreated$1 as publicOnDiscountRuleCreated, onDiscountRuleDeleted$1 as publicOnDiscountRuleDeleted, onDiscountRuleUpdated$1 as publicOnDiscountRuleUpdated, index_d$t_queryDiscountRules as queryDiscountRules, index_d$t_updateDiscountRule as updateDiscountRule };
1733
+ export { type ActionEvent$n as ActionEvent, type index_d$t_ActiveTimeInfo as ActiveTimeInfo, type index_d$t_And as And, type AppliedDiscount$8 as AppliedDiscount, type index_d$t_AppliedDiscountRule as AppliedDiscountRule, index_d$t_AppliedSubjectType as AppliedSubjectType, type BaseEventMetadata$c as BaseEventMetadata, type index_d$t_BuyXGetYInfo as BuyXGetYInfo, type index_d$t_CatalogItemFilter as CatalogItemFilter, type CatalogReference$c as CatalogReference, type index_d$t_CreateDiscountRuleRequest as CreateDiscountRuleRequest, type index_d$t_CreateDiscountRuleResponse as CreateDiscountRuleResponse, type index_d$t_CreateDiscountRuleResponseNonNullableFields as CreateDiscountRuleResponseNonNullableFields, type CursorPaging$f as CursorPaging, type Cursors$f as Cursors, type index_d$t_Custom as Custom, type index_d$t_CustomFilter as CustomFilter, type index_d$t_CustomerBuy as CustomerBuy, type index_d$t_CustomerBuyConditionOneOf as CustomerBuyConditionOneOf, type index_d$t_CustomerGet as CustomerGet, type index_d$t_DeleteDiscountRuleRequest as DeleteDiscountRuleRequest, type index_d$t_DeleteDiscountRuleResponse as DeleteDiscountRuleResponse, type Discount$3 as Discount, type index_d$t_DiscountDiscountOneOf as DiscountDiscountOneOf, type DiscountRule$8 as DiscountRule, type index_d$t_DiscountRuleCreatedEnvelope as DiscountRuleCreatedEnvelope, type index_d$t_DiscountRuleDeletedEnvelope as DiscountRuleDeletedEnvelope, type DiscountRuleName$8 as DiscountRuleName, type DiscountRuleNonNullableFields$7 as DiscountRuleNonNullableFields, type index_d$t_DiscountRuleUpdatedEnvelope as DiscountRuleUpdatedEnvelope, type index_d$t_DiscountRuleUsageLimitReached as DiscountRuleUsageLimitReached, type index_d$t_DiscountRulesQueryBuilder as DiscountRulesQueryBuilder, type index_d$t_DiscountRulesQueryResult as DiscountRulesQueryResult, type index_d$t_DiscountSettings as DiscountSettings, type index_d$t_DiscountTrigger as DiscountTrigger, type index_d$t_DiscountTriggerTriggerOneOf as DiscountTriggerTriggerOneOf, DiscountType$8 as DiscountType, type index_d$t_Discounts as Discounts, type DomainEvent$n as DomainEvent, type DomainEventBodyOneOf$n as DomainEventBodyOneOf, type Empty$g as Empty, type EntityCreatedEvent$n as EntityCreatedEvent, type EntityDeletedEvent$n as EntityDeletedEvent, type EntityUpdatedEvent$n as EntityUpdatedEvent, type EventMetadata$c as EventMetadata, type ExtendedFields$c as ExtendedFields, type index_d$t_GetAppliedDiscountsRequest as GetAppliedDiscountsRequest, type index_d$t_GetAppliedDiscountsResponse as GetAppliedDiscountsResponse, type index_d$t_GetDiscountRuleRequest as GetDiscountRuleRequest, type index_d$t_GetDiscountRuleResponse as GetDiscountRuleResponse, type index_d$t_GetDiscountRuleResponseNonNullableFields as GetDiscountRuleResponseNonNullableFields, type IdentificationData$n as IdentificationData, type IdentificationDataIdOneOf$n as IdentificationDataIdOneOf, type index_d$t_ItemQuantityRange as ItemQuantityRange, type LineItem$7 as LineItem, type MessageEnvelope$m as MessageEnvelope, type MultiCurrencyPrice$6 as MultiCurrencyPrice, type index_d$t_Or as Or, type PlatformPaging$2 as PlatformPaging, type PlatformPagingMetadata$2 as PlatformPagingMetadata, type PlatformQuery$2 as PlatformQuery, type PlatformQueryPagingMethodOneOf$2 as PlatformQueryPagingMethodOneOf, type index_d$t_QueryDiscountRulesRequest as QueryDiscountRulesRequest, type index_d$t_QueryDiscountRulesResponse as QueryDiscountRulesResponse, type index_d$t_QueryDiscountRulesResponseNonNullableFields as QueryDiscountRulesResponseNonNullableFields, type RestoreInfo$n as RestoreInfo, type Scope$5 as Scope, type index_d$t_ScopeScopeItemsOneOf as ScopeScopeItemsOneOf, index_d$t_ScopeType as ScopeType, SortOrder$f as SortOrder, type Sorting$f as Sorting, type index_d$t_SpecificItemsInfo as SpecificItemsInfo, Status$5 as Status, type index_d$t_SubtotalRange as SubtotalRange, index_d$t_TriggerType as TriggerType, index_d$t_Type as Type, type index_d$t_UpdateDiscountRule as UpdateDiscountRule, type index_d$t_UpdateDiscountRuleRequest as UpdateDiscountRuleRequest, type index_d$t_UpdateDiscountRuleResponse as UpdateDiscountRuleResponse, type index_d$t_UpdateDiscountRuleResponseNonNullableFields as UpdateDiscountRuleResponseNonNullableFields, WebhookIdentityType$m as WebhookIdentityType, type index_d$t__publicOnDiscountRuleCreatedType as _publicOnDiscountRuleCreatedType, type index_d$t__publicOnDiscountRuleDeletedType as _publicOnDiscountRuleDeletedType, type index_d$t__publicOnDiscountRuleUpdatedType as _publicOnDiscountRuleUpdatedType, index_d$t_createDiscountRule as createDiscountRule, index_d$t_deleteDiscountRule as deleteDiscountRule, index_d$t_getDiscountRule as getDiscountRule, index_d$t_onDiscountRuleCreated as onDiscountRuleCreated, index_d$t_onDiscountRuleDeleted as onDiscountRuleDeleted, index_d$t_onDiscountRuleUpdated as onDiscountRuleUpdated, onDiscountRuleCreated$1 as publicOnDiscountRuleCreated, onDiscountRuleDeleted$1 as publicOnDiscountRuleDeleted, onDiscountRuleUpdated$1 as publicOnDiscountRuleUpdated, index_d$t_queryDiscountRules as queryDiscountRules, index_d$t_updateDiscountRule as updateDiscountRule };
1732
1734
  }
1733
1735
 
1734
1736
  interface Invoice {
@@ -2511,8 +2513,11 @@ interface Color$6 {
2511
2513
  code?: string | null;
2512
2514
  }
2513
2515
  declare enum DescriptionLineType$6 {
2516
+ /** Unrecognized type. */
2514
2517
  UNRECOGNISED = "UNRECOGNISED",
2518
+ /** Plain text type. */
2515
2519
  PLAIN_TEXT = "PLAIN_TEXT",
2520
+ /** Color type. */
2516
2521
  COLOR = "COLOR"
2517
2522
  }
2518
2523
  interface FocalPoint$7 {
@@ -2557,11 +2562,11 @@ declare enum ItemTypeItemType$7 {
2557
2562
  declare enum PaymentOptionType$7 {
2558
2563
  /** The entire payment for this item happens as part of the checkout. */
2559
2564
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
2560
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
2565
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
2561
2566
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
2562
2567
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
2563
2568
  MEMBERSHIP = "MEMBERSHIP",
2564
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
2569
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
2565
2570
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
2566
2571
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
2567
2572
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -2822,7 +2827,7 @@ declare enum VatType$9 {
2822
2827
  interface ShippingInformation$5 {
2823
2828
  /** App Def Id of external provider which was a source of shipping info */
2824
2829
  carrierId?: string | null;
2825
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
2830
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
2826
2831
  code?: string | null;
2827
2832
  /**
2828
2833
  * Shipping option title.
@@ -3525,7 +3530,7 @@ interface GetSubscriptionContractResponseNonNullableFields {
3525
3530
  interface QuerySubscriptionContractsResponseNonNullableFields {
3526
3531
  subscriptionContracts: SubscriptionContractNonNullableFields[];
3527
3532
  }
3528
- interface BaseEventMetadata$c {
3533
+ interface BaseEventMetadata$b {
3529
3534
  /** App instance ID. */
3530
3535
  instanceId?: string | null;
3531
3536
  /** Event type. */
@@ -3533,7 +3538,7 @@ interface BaseEventMetadata$c {
3533
3538
  /** The identification type and identity data. */
3534
3539
  identity?: IdentificationData$l;
3535
3540
  }
3536
- interface EventMetadata$c extends BaseEventMetadata$c {
3541
+ interface EventMetadata$b extends BaseEventMetadata$b {
3537
3542
  /**
3538
3543
  * Unique event ID.
3539
3544
  * Allows clients to ignore duplicate webhooks.
@@ -3573,14 +3578,14 @@ interface EventMetadata$c extends BaseEventMetadata$c {
3573
3578
  }
3574
3579
  interface SubscriptionContractCreatedEnvelope {
3575
3580
  entity: SubscriptionContract;
3576
- metadata: EventMetadata$c;
3581
+ metadata: EventMetadata$b;
3577
3582
  }
3578
3583
  interface SubscriptionContractDeletedEnvelope {
3579
- metadata: EventMetadata$c;
3584
+ metadata: EventMetadata$b;
3580
3585
  }
3581
3586
  interface SubscriptionContractUpdatedEnvelope {
3582
3587
  entity: SubscriptionContract;
3583
- metadata: EventMetadata$c;
3588
+ metadata: EventMetadata$b;
3584
3589
  }
3585
3590
  interface QueryCursorResult$c {
3586
3591
  cursors: Cursors$e;
@@ -3667,22 +3672,22 @@ declare const onSubscriptionContractCreated$1: EventDefinition<SubscriptionContr
3667
3672
  declare const onSubscriptionContractDeleted$1: EventDefinition<SubscriptionContractDeletedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_deleted">;
3668
3673
  declare const onSubscriptionContractUpdated$1: EventDefinition<SubscriptionContractUpdatedEnvelope, "wix.ecom.subscription_contracts.v1.subscription_contract_updated">;
3669
3674
 
3670
- declare function createEventModule$c<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3675
+ declare function createEventModule$b<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3671
3676
 
3672
3677
  declare const getSubscriptionContract: MaybeContext<BuildRESTFunction<typeof getSubscriptionContract$1> & typeof getSubscriptionContract$1>;
3673
3678
  declare const querySubscriptionContracts: MaybeContext<BuildRESTFunction<typeof querySubscriptionContracts$1> & typeof querySubscriptionContracts$1>;
3674
3679
 
3675
3680
  type _publicOnSubscriptionContractCreatedType = typeof onSubscriptionContractCreated$1;
3676
3681
  /** */
3677
- declare const onSubscriptionContractCreated: ReturnType<typeof createEventModule$c<_publicOnSubscriptionContractCreatedType>>;
3682
+ declare const onSubscriptionContractCreated: ReturnType<typeof createEventModule$b<_publicOnSubscriptionContractCreatedType>>;
3678
3683
 
3679
3684
  type _publicOnSubscriptionContractDeletedType = typeof onSubscriptionContractDeleted$1;
3680
3685
  /** */
3681
- declare const onSubscriptionContractDeleted: ReturnType<typeof createEventModule$c<_publicOnSubscriptionContractDeletedType>>;
3686
+ declare const onSubscriptionContractDeleted: ReturnType<typeof createEventModule$b<_publicOnSubscriptionContractDeletedType>>;
3682
3687
 
3683
3688
  type _publicOnSubscriptionContractUpdatedType = typeof onSubscriptionContractUpdated$1;
3684
3689
  /** */
3685
- declare const onSubscriptionContractUpdated: ReturnType<typeof createEventModule$c<_publicOnSubscriptionContractUpdatedType>>;
3690
+ declare const onSubscriptionContractUpdated: ReturnType<typeof createEventModule$b<_publicOnSubscriptionContractUpdatedType>>;
3686
3691
 
3687
3692
  type index_d$q_CreateSubscriptionContractRequest = CreateSubscriptionContractRequest;
3688
3693
  type index_d$q_CreateSubscriptionContractResponse = CreateSubscriptionContractResponse;
@@ -3712,7 +3717,7 @@ declare const index_d$q_onSubscriptionContractDeleted: typeof onSubscriptionCont
3712
3717
  declare const index_d$q_onSubscriptionContractUpdated: typeof onSubscriptionContractUpdated;
3713
3718
  declare const index_d$q_querySubscriptionContracts: typeof querySubscriptionContracts;
3714
3719
  declare namespace index_d$q {
3715
- export { type ActionEvent$l as ActionEvent, type Address$b as Address, type AddressLocation$a as AddressLocation, type AddressWithContact$6 as AddressWithContact, type AppliedDiscount$7 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$7 as AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata$c as BaseEventMetadata, type BuyerInfo$9 as BuyerInfo, type BuyerInfoIdOneOf$6 as BuyerInfoIdOneOf, type CatalogReference$a as CatalogReference, type ChannelInfo$4 as ChannelInfo, ChannelType$7 as ChannelType, type Color$6 as Color, type Coupon$7 as Coupon, type index_d$q_CreateSubscriptionContractRequest as CreateSubscriptionContractRequest, type index_d$q_CreateSubscriptionContractResponse as CreateSubscriptionContractResponse, type CursorPaging$e as CursorPaging, type CursorPagingMetadata$b as CursorPagingMetadata, type CursorQuery$8 as CursorQuery, type CursorQueryPagingMethodOneOf$8 as CursorQueryPagingMethodOneOf, type Cursors$e as Cursors, type CustomField$5 as CustomField, type DeliveryLogistics$8 as DeliveryLogistics, type DeliveryLogisticsAddressOneOf$1 as DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot$8 as DeliveryTimeSlot, type DescriptionLine$6 as DescriptionLine, type DescriptionLineDescriptionLineValueOneOf$6 as DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName$6 as DescriptionLineName, DescriptionLineType$6 as DescriptionLineType, type DescriptionLineValueOneOf$6 as DescriptionLineValueOneOf, type DigitalFile$3 as DigitalFile, DiscountReason$2 as DiscountReason, type DiscountRule$7 as DiscountRule, type DiscountRuleName$7 as DiscountRuleName, DiscountType$7 as DiscountType, type DomainEvent$l as DomainEvent, type DomainEventBodyOneOf$l as DomainEventBodyOneOf, type Empty$e as Empty, type EntityCreatedEvent$l as EntityCreatedEvent, type EntityDeletedEvent$l as EntityDeletedEvent, type EntityUpdatedEvent$l as EntityUpdatedEvent, type EventMetadata$c as EventMetadata, type ExtendedFields$b as ExtendedFields, type FocalPoint$7 as FocalPoint, type FullAddressContactDetails$8 as FullAddressContactDetails, type index_d$q_GetSubscriptionContractRequest as GetSubscriptionContractRequest, type index_d$q_GetSubscriptionContractResponse as GetSubscriptionContractResponse, type index_d$q_GetSubscriptionContractResponseNonNullableFields as GetSubscriptionContractResponseNonNullableFields, type IdentificationData$l as IdentificationData, type IdentificationDataIdOneOf$l as IdentificationDataIdOneOf, type ItemTaxFullDetails$7 as ItemTaxFullDetails, type ItemType$7 as ItemType, ItemTypeItemType$7 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$7 as ItemTypeItemTypeDataOneOf, JurisdictionType$7 as JurisdictionType, type LineItemDiscount$7 as LineItemDiscount, type LineItemTaxBreakdown$2 as LineItemTaxBreakdown, type LineItemTaxInfo$2 as LineItemTaxInfo, type LocationAndQuantity$2 as LocationAndQuantity, type MerchantDiscount$7 as MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf$2 as MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope$k as MessageEnvelope, type OrderLineItem$2 as OrderLineItem, type OrderTaxBreakdown$2 as OrderTaxBreakdown, type OrderTaxInfo$2 as OrderTaxInfo, PaymentOptionType$7 as PaymentOptionType, type PhysicalProperties$8 as PhysicalProperties, type PickupAddress$4 as PickupAddress, type PickupDetails$9 as PickupDetails, PickupMethod$8 as PickupMethod, type PlainTextValue$6 as PlainTextValue, type Price$5 as Price, type PriceDescription$6 as PriceDescription, type PriceSummary$7 as PriceSummary, type ProductName$6 as ProductName, type index_d$q_QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequest, type index_d$q_QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponse, type index_d$q_QuerySubscriptionContractsResponseNonNullableFields as QuerySubscriptionContractsResponseNonNullableFields, type RestoreInfo$l as RestoreInfo, type ShippingInformation$5 as ShippingInformation, type ShippingPrice$7 as ShippingPrice, type ShippingRegion$7 as ShippingRegion, SortOrder$e as SortOrder, type Sorting$e as Sorting, type StreetAddress$a as StreetAddress, type index_d$q_SubscriptionContract as SubscriptionContract, type index_d$q_SubscriptionContractCreatedEnvelope as SubscriptionContractCreatedEnvelope, type index_d$q_SubscriptionContractDeletedEnvelope as SubscriptionContractDeletedEnvelope, type index_d$q_SubscriptionContractNonNullableFields as SubscriptionContractNonNullableFields, type index_d$q_SubscriptionContractUpdatedEnvelope as SubscriptionContractUpdatedEnvelope, type index_d$q_SubscriptionContractsQueryBuilder as SubscriptionContractsQueryBuilder, type index_d$q_SubscriptionContractsQueryResult as SubscriptionContractsQueryResult, SubscriptionFrequency$8 as SubscriptionFrequency, type SubscriptionInfo$3 as SubscriptionInfo, type SubscriptionSettings$8 as SubscriptionSettings, type TaxableAddress$7 as TaxableAddress, type TaxableAddressTaxableAddressDataOneOf$7 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$7 as TaxableAddressType, type index_d$q_UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequest, type index_d$q_UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponse, type V1SubscriptionSettings$1 as V1SubscriptionSettings, index_d$q_V2SubscriptionFrequency as V2SubscriptionFrequency, type VatId$9 as VatId, VatType$9 as VatType, WebhookIdentityType$k as WebhookIdentityType, WeightUnit$9 as WeightUnit, type index_d$q__publicOnSubscriptionContractCreatedType as _publicOnSubscriptionContractCreatedType, type index_d$q__publicOnSubscriptionContractDeletedType as _publicOnSubscriptionContractDeletedType, type index_d$q__publicOnSubscriptionContractUpdatedType as _publicOnSubscriptionContractUpdatedType, index_d$q_getSubscriptionContract as getSubscriptionContract, index_d$q_onSubscriptionContractCreated as onSubscriptionContractCreated, index_d$q_onSubscriptionContractDeleted as onSubscriptionContractDeleted, index_d$q_onSubscriptionContractUpdated as onSubscriptionContractUpdated, onSubscriptionContractCreated$1 as publicOnSubscriptionContractCreated, onSubscriptionContractDeleted$1 as publicOnSubscriptionContractDeleted, onSubscriptionContractUpdated$1 as publicOnSubscriptionContractUpdated, index_d$q_querySubscriptionContracts as querySubscriptionContracts };
3720
+ export { type ActionEvent$l as ActionEvent, type Address$b as Address, type AddressLocation$a as AddressLocation, type AddressWithContact$6 as AddressWithContact, type AppliedDiscount$7 as AppliedDiscount, type AppliedDiscountDiscountSourceOneOf$7 as AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata$b as BaseEventMetadata, type BuyerInfo$9 as BuyerInfo, type BuyerInfoIdOneOf$6 as BuyerInfoIdOneOf, type CatalogReference$a as CatalogReference, type ChannelInfo$4 as ChannelInfo, ChannelType$7 as ChannelType, type Color$6 as Color, type Coupon$7 as Coupon, type index_d$q_CreateSubscriptionContractRequest as CreateSubscriptionContractRequest, type index_d$q_CreateSubscriptionContractResponse as CreateSubscriptionContractResponse, type CursorPaging$e as CursorPaging, type CursorPagingMetadata$b as CursorPagingMetadata, type CursorQuery$8 as CursorQuery, type CursorQueryPagingMethodOneOf$8 as CursorQueryPagingMethodOneOf, type Cursors$e as Cursors, type CustomField$5 as CustomField, type DeliveryLogistics$8 as DeliveryLogistics, type DeliveryLogisticsAddressOneOf$1 as DeliveryLogisticsAddressOneOf, type DeliveryTimeSlot$8 as DeliveryTimeSlot, type DescriptionLine$6 as DescriptionLine, type DescriptionLineDescriptionLineValueOneOf$6 as DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName$6 as DescriptionLineName, DescriptionLineType$6 as DescriptionLineType, type DescriptionLineValueOneOf$6 as DescriptionLineValueOneOf, type DigitalFile$3 as DigitalFile, DiscountReason$2 as DiscountReason, type DiscountRule$7 as DiscountRule, type DiscountRuleName$7 as DiscountRuleName, DiscountType$7 as DiscountType, type DomainEvent$l as DomainEvent, type DomainEventBodyOneOf$l as DomainEventBodyOneOf, type Empty$e as Empty, type EntityCreatedEvent$l as EntityCreatedEvent, type EntityDeletedEvent$l as EntityDeletedEvent, type EntityUpdatedEvent$l as EntityUpdatedEvent, type EventMetadata$b as EventMetadata, type ExtendedFields$b as ExtendedFields, type FocalPoint$7 as FocalPoint, type FullAddressContactDetails$8 as FullAddressContactDetails, type index_d$q_GetSubscriptionContractRequest as GetSubscriptionContractRequest, type index_d$q_GetSubscriptionContractResponse as GetSubscriptionContractResponse, type index_d$q_GetSubscriptionContractResponseNonNullableFields as GetSubscriptionContractResponseNonNullableFields, type IdentificationData$l as IdentificationData, type IdentificationDataIdOneOf$l as IdentificationDataIdOneOf, type ItemTaxFullDetails$7 as ItemTaxFullDetails, type ItemType$7 as ItemType, ItemTypeItemType$7 as ItemTypeItemType, type ItemTypeItemTypeDataOneOf$7 as ItemTypeItemTypeDataOneOf, JurisdictionType$7 as JurisdictionType, type LineItemDiscount$7 as LineItemDiscount, type LineItemTaxBreakdown$2 as LineItemTaxBreakdown, type LineItemTaxInfo$2 as LineItemTaxInfo, type LocationAndQuantity$2 as LocationAndQuantity, type MerchantDiscount$7 as MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf$2 as MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope$k as MessageEnvelope, type OrderLineItem$2 as OrderLineItem, type OrderTaxBreakdown$2 as OrderTaxBreakdown, type OrderTaxInfo$2 as OrderTaxInfo, PaymentOptionType$7 as PaymentOptionType, type PhysicalProperties$8 as PhysicalProperties, type PickupAddress$4 as PickupAddress, type PickupDetails$9 as PickupDetails, PickupMethod$8 as PickupMethod, type PlainTextValue$6 as PlainTextValue, type Price$5 as Price, type PriceDescription$6 as PriceDescription, type PriceSummary$7 as PriceSummary, type ProductName$6 as ProductName, type index_d$q_QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequest, type index_d$q_QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponse, type index_d$q_QuerySubscriptionContractsResponseNonNullableFields as QuerySubscriptionContractsResponseNonNullableFields, type RestoreInfo$l as RestoreInfo, type ShippingInformation$5 as ShippingInformation, type ShippingPrice$7 as ShippingPrice, type ShippingRegion$7 as ShippingRegion, SortOrder$e as SortOrder, type Sorting$e as Sorting, type StreetAddress$a as StreetAddress, type index_d$q_SubscriptionContract as SubscriptionContract, type index_d$q_SubscriptionContractCreatedEnvelope as SubscriptionContractCreatedEnvelope, type index_d$q_SubscriptionContractDeletedEnvelope as SubscriptionContractDeletedEnvelope, type index_d$q_SubscriptionContractNonNullableFields as SubscriptionContractNonNullableFields, type index_d$q_SubscriptionContractUpdatedEnvelope as SubscriptionContractUpdatedEnvelope, type index_d$q_SubscriptionContractsQueryBuilder as SubscriptionContractsQueryBuilder, type index_d$q_SubscriptionContractsQueryResult as SubscriptionContractsQueryResult, SubscriptionFrequency$8 as SubscriptionFrequency, type SubscriptionInfo$3 as SubscriptionInfo, type SubscriptionSettings$8 as SubscriptionSettings, type TaxableAddress$7 as TaxableAddress, type TaxableAddressTaxableAddressDataOneOf$7 as TaxableAddressTaxableAddressDataOneOf, TaxableAddressType$7 as TaxableAddressType, type index_d$q_UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequest, type index_d$q_UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponse, type V1SubscriptionSettings$1 as V1SubscriptionSettings, index_d$q_V2SubscriptionFrequency as V2SubscriptionFrequency, type VatId$9 as VatId, VatType$9 as VatType, WebhookIdentityType$k as WebhookIdentityType, WeightUnit$9 as WeightUnit, type index_d$q__publicOnSubscriptionContractCreatedType as _publicOnSubscriptionContractCreatedType, type index_d$q__publicOnSubscriptionContractDeletedType as _publicOnSubscriptionContractDeletedType, type index_d$q__publicOnSubscriptionContractUpdatedType as _publicOnSubscriptionContractUpdatedType, index_d$q_getSubscriptionContract as getSubscriptionContract, index_d$q_onSubscriptionContractCreated as onSubscriptionContractCreated, index_d$q_onSubscriptionContractDeleted as onSubscriptionContractDeleted, index_d$q_onSubscriptionContractUpdated as onSubscriptionContractUpdated, onSubscriptionContractCreated$1 as publicOnSubscriptionContractCreated, onSubscriptionContractDeleted$1 as publicOnSubscriptionContractDeleted, onSubscriptionContractUpdated$1 as publicOnSubscriptionContractUpdated, index_d$q_querySubscriptionContracts as querySubscriptionContracts };
3716
3721
  }
3717
3722
 
3718
3723
  interface AbandonedCheckout {
@@ -3756,16 +3761,24 @@ interface AbandonedCheckout {
3756
3761
  subtotalPrice?: MultiCurrencyPrice$5;
3757
3762
  }
3758
3763
  declare enum ActivityType$3 {
3764
+ /** Not implemented. */
3759
3765
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
3766
+ /** Scheduled. */
3760
3767
  SCHEDULED = "SCHEDULED",
3768
+ /** Email sent. */
3761
3769
  EMAIL_SENT = "EMAIL_SENT",
3770
+ /** Email not sent. */
3762
3771
  EMAIL_NOT_SENT = "EMAIL_NOT_SENT",
3772
+ /** Notification sent. */
3763
3773
  NOTIFICATION_SENT = "NOTIFICATION_SENT",
3774
+ /** Task created. */
3764
3775
  TASK_CREATED = "TASK_CREATED"
3765
3776
  }
3766
3777
  /** Status of the abandoned checkout. */
3767
3778
  declare enum Status$4 {
3779
+ /** Abandoned. */
3768
3780
  ABANDONED = "ABANDONED",
3781
+ /** Recovered. */
3769
3782
  RECOVERED = "RECOVERED"
3770
3783
  }
3771
3784
  /** Buyer information. */
@@ -4073,7 +4086,9 @@ interface CommonSorting {
4073
4086
  order?: CommonSortOrder;
4074
4087
  }
4075
4088
  declare enum CommonSortOrder {
4089
+ /** Ascending order. */
4076
4090
  ASC = "ASC",
4091
+ /** Descending order. */
4077
4092
  DESC = "DESC"
4078
4093
  }
4079
4094
  interface SearchDetails {
@@ -4087,9 +4102,9 @@ interface SearchDetails {
4087
4102
  fuzzy?: boolean;
4088
4103
  }
4089
4104
  declare enum Mode {
4090
- /** any */
4105
+ /** Any */
4091
4106
  OR = "OR",
4092
- /** all */
4107
+ /** All */
4093
4108
  AND = "AND"
4094
4109
  }
4095
4110
  interface CommonPaging {
@@ -4353,56 +4368,6 @@ interface RawHttpResponseNonNullableFields$1 {
4353
4368
  body: Uint8Array;
4354
4369
  headers: HeadersEntryNonNullableFields$1[];
4355
4370
  }
4356
- interface BaseEventMetadata$b {
4357
- /** App instance ID. */
4358
- instanceId?: string | null;
4359
- /** Event type. */
4360
- eventType?: string;
4361
- /** The identification type and identity data. */
4362
- identity?: IdentificationData$k;
4363
- }
4364
- interface EventMetadata$b extends BaseEventMetadata$b {
4365
- /**
4366
- * Unique event ID.
4367
- * Allows clients to ignore duplicate webhooks.
4368
- */
4369
- _id?: string;
4370
- /**
4371
- * Assumes actions are also always typed to an entity_type
4372
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
4373
- */
4374
- entityFqdn?: string;
4375
- /**
4376
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4377
- * This is although the created/updated/deleted notion is duplication of the oneof types
4378
- * Example: created/updated/deleted/started/completed/email_opened
4379
- */
4380
- slug?: string;
4381
- /** ID of the entity associated with the event. */
4382
- entityId?: string;
4383
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
4384
- eventTime?: Date | null;
4385
- /**
4386
- * Whether the event was triggered as a result of a privacy regulation application
4387
- * (for example, GDPR).
4388
- */
4389
- triggeredByAnonymizeRequest?: boolean | null;
4390
- /** If present, indicates the action that triggered the event. */
4391
- originatedFrom?: string | null;
4392
- /**
4393
- * A sequence number defining the order of updates to the underlying entity.
4394
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4395
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4396
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4397
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4398
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
4399
- */
4400
- entityEventSequence?: string | null;
4401
- }
4402
- interface AbandonedCheckoutRecoveredEnvelope {
4403
- data: AbandonedCheckoutRecovered;
4404
- metadata: EventMetadata$b;
4405
- }
4406
4371
  interface QueryCursorResult$b {
4407
4372
  cursors: CommonCursors;
4408
4373
  hasNext: () => boolean;
@@ -4531,9 +4496,6 @@ interface RedirectToCheckoutSignature {
4531
4496
  */
4532
4497
  (abandonedCheckoutId: string, metasiteId: string): Promise<RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
4533
4498
  }
4534
- declare const onAbandonedCheckoutRecovered$1: EventDefinition<AbandonedCheckoutRecoveredEnvelope, "wix.ecom.v1.abandoned_checkout_recovered">;
4535
-
4536
- declare function createEventModule$b<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
4537
4499
 
4538
4500
  declare const getAbandonedCheckout: MaybeContext<BuildRESTFunction<typeof getAbandonedCheckout$1> & typeof getAbandonedCheckout$1>;
4539
4501
  declare const deleteAbandonedCheckout: MaybeContext<BuildRESTFunction<typeof deleteAbandonedCheckout$1> & typeof deleteAbandonedCheckout$1>;
@@ -4541,16 +4503,9 @@ declare const queryAbandonedCheckouts: MaybeContext<BuildRESTFunction<typeof que
4541
4503
  declare const searchAbandonedCheckouts: MaybeContext<BuildRESTFunction<typeof searchAbandonedCheckouts$1> & typeof searchAbandonedCheckouts$1>;
4542
4504
  declare const redirectToCheckout: MaybeContext<BuildRESTFunction<typeof redirectToCheckout$1> & typeof redirectToCheckout$1>;
4543
4505
 
4544
- type _publicOnAbandonedCheckoutRecoveredType = typeof onAbandonedCheckoutRecovered$1;
4545
- /**
4546
- * Triggered when an abandoned checkout is recovered (the customer completes the checkout).
4547
- */
4548
- declare const onAbandonedCheckoutRecovered: ReturnType<typeof createEventModule$b<_publicOnAbandonedCheckoutRecoveredType>>;
4549
-
4550
4506
  type index_d$p_AbandonedCheckout = AbandonedCheckout;
4551
4507
  type index_d$p_AbandonedCheckoutNonNullableFields = AbandonedCheckoutNonNullableFields;
4552
4508
  type index_d$p_AbandonedCheckoutRecovered = AbandonedCheckoutRecovered;
4553
- type index_d$p_AbandonedCheckoutRecoveredEnvelope = AbandonedCheckoutRecoveredEnvelope;
4554
4509
  type index_d$p_AbandonedCheckoutsQueryBuilder = AbandonedCheckoutsQueryBuilder;
4555
4510
  type index_d$p_AbandonedCheckoutsQueryResult = AbandonedCheckoutsQueryResult;
4556
4511
  type index_d$p_AddAbandonedCheckoutActivityRequest = AddAbandonedCheckoutActivityRequest;
@@ -4585,15 +4540,13 @@ type index_d$p_SearchAbandonedCheckoutsResponseNonNullableFields = SearchAbandon
4585
4540
  type index_d$p_SearchDetails = SearchDetails;
4586
4541
  type index_d$p_SearchPagingMethodOneOf = SearchPagingMethodOneOf;
4587
4542
  type index_d$p_V1BuyerInfoIdOneOf = V1BuyerInfoIdOneOf;
4588
- type index_d$p__publicOnAbandonedCheckoutRecoveredType = _publicOnAbandonedCheckoutRecoveredType;
4589
4543
  declare const index_d$p_deleteAbandonedCheckout: typeof deleteAbandonedCheckout;
4590
4544
  declare const index_d$p_getAbandonedCheckout: typeof getAbandonedCheckout;
4591
- declare const index_d$p_onAbandonedCheckoutRecovered: typeof onAbandonedCheckoutRecovered;
4592
4545
  declare const index_d$p_queryAbandonedCheckouts: typeof queryAbandonedCheckouts;
4593
4546
  declare const index_d$p_redirectToCheckout: typeof redirectToCheckout;
4594
4547
  declare const index_d$p_searchAbandonedCheckouts: typeof searchAbandonedCheckouts;
4595
4548
  declare namespace index_d$p {
4596
- export { type index_d$p_AbandonedCheckout as AbandonedCheckout, type index_d$p_AbandonedCheckoutNonNullableFields as AbandonedCheckoutNonNullableFields, type index_d$p_AbandonedCheckoutRecovered as AbandonedCheckoutRecovered, type index_d$p_AbandonedCheckoutRecoveredEnvelope as AbandonedCheckoutRecoveredEnvelope, type index_d$p_AbandonedCheckoutsQueryBuilder as AbandonedCheckoutsQueryBuilder, type index_d$p_AbandonedCheckoutsQueryResult as AbandonedCheckoutsQueryResult, type ActionEvent$k as ActionEvent, type Activity$3 as Activity, ActivityType$3 as ActivityType, type index_d$p_AddAbandonedCheckoutActivityRequest as AddAbandonedCheckoutActivityRequest, type index_d$p_AddAbandonedCheckoutActivityResponse as AddAbandonedCheckoutActivityResponse, type BaseEventMetadata$b as BaseEventMetadata, type BuyerInfo$8 as BuyerInfo, type Cancel$1 as Cancel, type index_d$p_CartAbandonedEvent as CartAbandonedEvent, type index_d$p_CartRecoveredEvent as CartRecoveredEvent, type index_d$p_CommonCursorPaging as CommonCursorPaging, type index_d$p_CommonCursors as CommonCursors, type index_d$p_CommonPaging as CommonPaging, type index_d$p_CommonPagingMetadataV2 as CommonPagingMetadataV2, index_d$p_CommonSortOrder as CommonSortOrder, type index_d$p_CommonSorting as CommonSorting, type Complete$1 as Complete, type CursorPaging$d as CursorPaging, type Cursors$d as Cursors, type index_d$p_DeleteAbandonedCheckoutRequest as DeleteAbandonedCheckoutRequest, type index_d$p_DeleteAbandonedCheckoutResponse as DeleteAbandonedCheckoutResponse, type DomainEvent$k as DomainEvent, type DomainEventBodyOneOf$k as DomainEventBodyOneOf, type Empty$d as Empty, type EntityCreatedEvent$k as EntityCreatedEvent, type EntityDeletedEvent$k as EntityDeletedEvent, type EntityUpdatedEvent$k as EntityUpdatedEvent, type EventMetadata$b as EventMetadata, type FullAddressContactDetails$7 as FullAddressContactDetails, type index_d$p_GetAbandonedCheckoutRequest as GetAbandonedCheckoutRequest, type index_d$p_GetAbandonedCheckoutResponse as GetAbandonedCheckoutResponse, type index_d$p_GetAbandonedCheckoutResponseNonNullableFields as GetAbandonedCheckoutResponseNonNullableFields, type HeadersEntry$1 as HeadersEntry, type IdentificationData$k as IdentificationData, type IdentificationDataIdOneOf$k as IdentificationDataIdOneOf, index_d$p_Identity as Identity, type MessageEnvelope$j as MessageEnvelope, index_d$p_Mode as Mode, type MultiCurrencyPrice$5 as MultiCurrencyPrice, type Paging$3 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, type index_d$p_QueryAbandonedCheckoutsRequest as QueryAbandonedCheckoutsRequest, type index_d$p_QueryAbandonedCheckoutsResponse as QueryAbandonedCheckoutsResponse, type index_d$p_QueryAbandonedCheckoutsResponseNonNullableFields as QueryAbandonedCheckoutsResponseNonNullableFields, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, type RawHttpResponse$1 as RawHttpResponse, type RawHttpResponseNonNullableFields$1 as RawHttpResponseNonNullableFields, type index_d$p_RedirectToCheckoutRequest as RedirectToCheckoutRequest, type Reschedule$1 as Reschedule, type RestoreInfo$k as RestoreInfo, type index_d$p_Search as Search, type index_d$p_SearchAbandonedCheckoutsOptions as SearchAbandonedCheckoutsOptions, type index_d$p_SearchAbandonedCheckoutsRequest as SearchAbandonedCheckoutsRequest, type index_d$p_SearchAbandonedCheckoutsResponse as SearchAbandonedCheckoutsResponse, type index_d$p_SearchAbandonedCheckoutsResponseNonNullableFields as SearchAbandonedCheckoutsResponseNonNullableFields, type index_d$p_SearchDetails as SearchDetails, type index_d$p_SearchPagingMethodOneOf as SearchPagingMethodOneOf, SortOrder$d as SortOrder, type Sorting$d as Sorting, Status$4 as Status, type Task$1 as Task, type TaskAction$1 as TaskAction, type TaskActionActionOneOf$1 as TaskActionActionOneOf, type TaskKey$1 as TaskKey, type Totals$2 as Totals, type V1BuyerInfo$1 as V1BuyerInfo, type index_d$p_V1BuyerInfoIdOneOf as V1BuyerInfoIdOneOf, type VatId$8 as VatId, VatType$8 as VatType, WebhookIdentityType$j as WebhookIdentityType, type index_d$p__publicOnAbandonedCheckoutRecoveredType as _publicOnAbandonedCheckoutRecoveredType, index_d$p_deleteAbandonedCheckout as deleteAbandonedCheckout, index_d$p_getAbandonedCheckout as getAbandonedCheckout, index_d$p_onAbandonedCheckoutRecovered as onAbandonedCheckoutRecovered, onAbandonedCheckoutRecovered$1 as publicOnAbandonedCheckoutRecovered, index_d$p_queryAbandonedCheckouts as queryAbandonedCheckouts, index_d$p_redirectToCheckout as redirectToCheckout, index_d$p_searchAbandonedCheckouts as searchAbandonedCheckouts };
4549
+ export { type index_d$p_AbandonedCheckout as AbandonedCheckout, type index_d$p_AbandonedCheckoutNonNullableFields as AbandonedCheckoutNonNullableFields, type index_d$p_AbandonedCheckoutRecovered as AbandonedCheckoutRecovered, type index_d$p_AbandonedCheckoutsQueryBuilder as AbandonedCheckoutsQueryBuilder, type index_d$p_AbandonedCheckoutsQueryResult as AbandonedCheckoutsQueryResult, type ActionEvent$k as ActionEvent, type Activity$3 as Activity, ActivityType$3 as ActivityType, type index_d$p_AddAbandonedCheckoutActivityRequest as AddAbandonedCheckoutActivityRequest, type index_d$p_AddAbandonedCheckoutActivityResponse as AddAbandonedCheckoutActivityResponse, type BuyerInfo$8 as BuyerInfo, type Cancel$1 as Cancel, type index_d$p_CartAbandonedEvent as CartAbandonedEvent, type index_d$p_CartRecoveredEvent as CartRecoveredEvent, type index_d$p_CommonCursorPaging as CommonCursorPaging, type index_d$p_CommonCursors as CommonCursors, type index_d$p_CommonPaging as CommonPaging, type index_d$p_CommonPagingMetadataV2 as CommonPagingMetadataV2, index_d$p_CommonSortOrder as CommonSortOrder, type index_d$p_CommonSorting as CommonSorting, type Complete$1 as Complete, type CursorPaging$d as CursorPaging, type Cursors$d as Cursors, type index_d$p_DeleteAbandonedCheckoutRequest as DeleteAbandonedCheckoutRequest, type index_d$p_DeleteAbandonedCheckoutResponse as DeleteAbandonedCheckoutResponse, type DomainEvent$k as DomainEvent, type DomainEventBodyOneOf$k as DomainEventBodyOneOf, type Empty$d as Empty, type EntityCreatedEvent$k as EntityCreatedEvent, type EntityDeletedEvent$k as EntityDeletedEvent, type EntityUpdatedEvent$k as EntityUpdatedEvent, type FullAddressContactDetails$7 as FullAddressContactDetails, type index_d$p_GetAbandonedCheckoutRequest as GetAbandonedCheckoutRequest, type index_d$p_GetAbandonedCheckoutResponse as GetAbandonedCheckoutResponse, type index_d$p_GetAbandonedCheckoutResponseNonNullableFields as GetAbandonedCheckoutResponseNonNullableFields, type HeadersEntry$1 as HeadersEntry, type IdentificationData$k as IdentificationData, type IdentificationDataIdOneOf$k as IdentificationDataIdOneOf, index_d$p_Identity as Identity, type MessageEnvelope$j as MessageEnvelope, index_d$p_Mode as Mode, type MultiCurrencyPrice$5 as MultiCurrencyPrice, type Paging$3 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, type index_d$p_QueryAbandonedCheckoutsRequest as QueryAbandonedCheckoutsRequest, type index_d$p_QueryAbandonedCheckoutsResponse as QueryAbandonedCheckoutsResponse, type index_d$p_QueryAbandonedCheckoutsResponseNonNullableFields as QueryAbandonedCheckoutsResponseNonNullableFields, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, type RawHttpResponse$1 as RawHttpResponse, type RawHttpResponseNonNullableFields$1 as RawHttpResponseNonNullableFields, type index_d$p_RedirectToCheckoutRequest as RedirectToCheckoutRequest, type Reschedule$1 as Reschedule, type RestoreInfo$k as RestoreInfo, type index_d$p_Search as Search, type index_d$p_SearchAbandonedCheckoutsOptions as SearchAbandonedCheckoutsOptions, type index_d$p_SearchAbandonedCheckoutsRequest as SearchAbandonedCheckoutsRequest, type index_d$p_SearchAbandonedCheckoutsResponse as SearchAbandonedCheckoutsResponse, type index_d$p_SearchAbandonedCheckoutsResponseNonNullableFields as SearchAbandonedCheckoutsResponseNonNullableFields, type index_d$p_SearchDetails as SearchDetails, type index_d$p_SearchPagingMethodOneOf as SearchPagingMethodOneOf, SortOrder$d as SortOrder, type Sorting$d as Sorting, Status$4 as Status, type Task$1 as Task, type TaskAction$1 as TaskAction, type TaskActionActionOneOf$1 as TaskActionActionOneOf, type TaskKey$1 as TaskKey, type Totals$2 as Totals, type V1BuyerInfo$1 as V1BuyerInfo, type index_d$p_V1BuyerInfoIdOneOf as V1BuyerInfoIdOneOf, type VatId$8 as VatId, VatType$8 as VatType, WebhookIdentityType$j as WebhookIdentityType, index_d$p_deleteAbandonedCheckout as deleteAbandonedCheckout, index_d$p_getAbandonedCheckout as getAbandonedCheckout, index_d$p_queryAbandonedCheckouts as queryAbandonedCheckouts, index_d$p_redirectToCheckout as redirectToCheckout, index_d$p_searchAbandonedCheckouts as searchAbandonedCheckouts };
4597
4550
  }
4598
4551
 
4599
4552
  /**
@@ -5774,8 +5727,11 @@ interface Color$5 {
5774
5727
  code?: string | null;
5775
5728
  }
5776
5729
  declare enum DescriptionLineType$5 {
5730
+ /** Unrecognized type. */
5777
5731
  UNRECOGNISED = "UNRECOGNISED",
5732
+ /** Plain text type. */
5778
5733
  PLAIN_TEXT = "PLAIN_TEXT",
5734
+ /** Color type. */
5779
5735
  COLOR = "COLOR"
5780
5736
  }
5781
5737
  interface FocalPoint$6 {
@@ -5802,8 +5758,9 @@ interface ItemAvailabilityInfo$3 {
5802
5758
  }
5803
5759
  declare enum ItemAvailabilityStatus$3 {
5804
5760
  AVAILABLE = "AVAILABLE",
5761
+ /** Item does not exist */
5805
5762
  NOT_FOUND = "NOT_FOUND",
5806
- /** Not in stock */
5763
+ /** Item not in stock */
5807
5764
  NOT_AVAILABLE = "NOT_AVAILABLE",
5808
5765
  /** Available quantity is less than requested */
5809
5766
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -5921,11 +5878,11 @@ declare enum FileType$4 {
5921
5878
  declare enum PaymentOptionType$6 {
5922
5879
  /** The entire payment for this item happens as part of the checkout. */
5923
5880
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
5924
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
5881
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
5925
5882
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
5926
5883
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
5927
5884
  MEMBERSHIP = "MEMBERSHIP",
5928
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
5885
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
5929
5886
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
5930
5887
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
5931
5888
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -7060,12 +7017,12 @@ interface TargetTargetTypeOneOf$3 {
7060
7017
  }
7061
7018
  /** Available locations on the webpage */
7062
7019
  declare enum NameInOther$3 {
7063
- /** default location, in case no specific location is specified */
7020
+ /** Default location, in case no specific location is specified. */
7064
7021
  OTHER_DEFAULT = "OTHER_DEFAULT"
7065
7022
  }
7066
7023
  /** Available locations on the line item */
7067
7024
  declare enum NameInLineItem$3 {
7068
- /** default location, in case no specific location is specified */
7025
+ /** Default location, in case no specific location is specified. */
7069
7026
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
7070
7027
  }
7071
7028
  declare enum SuggestedFix$3 {
@@ -8586,8 +8543,11 @@ interface Color$4 {
8586
8543
  code?: string | null;
8587
8544
  }
8588
8545
  declare enum DescriptionLineType$4 {
8546
+ /** Unrecognized type. */
8589
8547
  UNRECOGNISED = "UNRECOGNISED",
8548
+ /** Plain text type. */
8590
8549
  PLAIN_TEXT = "PLAIN_TEXT",
8550
+ /** Color type. */
8591
8551
  COLOR = "COLOR"
8592
8552
  }
8593
8553
  interface FocalPoint$5 {
@@ -8614,8 +8574,9 @@ interface ItemAvailabilityInfo$2 {
8614
8574
  }
8615
8575
  declare enum ItemAvailabilityStatus$2 {
8616
8576
  AVAILABLE = "AVAILABLE",
8577
+ /** Item does not exist */
8617
8578
  NOT_FOUND = "NOT_FOUND",
8618
- /** Not in stock */
8579
+ /** Item not in stock */
8619
8580
  NOT_AVAILABLE = "NOT_AVAILABLE",
8620
8581
  /** Available quantity is less than requested */
8621
8582
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -8733,11 +8694,11 @@ declare enum FileType$3 {
8733
8694
  declare enum PaymentOptionType$5 {
8734
8695
  /** The entire payment for this item happens as part of the checkout. */
8735
8696
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
8736
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
8697
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
8737
8698
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
8738
8699
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
8739
8700
  MEMBERSHIP = "MEMBERSHIP",
8740
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
8701
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
8741
8702
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
8742
8703
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
8743
8704
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -9872,12 +9833,12 @@ interface TargetTargetTypeOneOf$2 {
9872
9833
  }
9873
9834
  /** Available locations on the webpage */
9874
9835
  declare enum NameInOther$2 {
9875
- /** default location, in case no specific location is specified */
9836
+ /** Default location, in case no specific location is specified. */
9876
9837
  OTHER_DEFAULT = "OTHER_DEFAULT"
9877
9838
  }
9878
9839
  /** Available locations on the line item */
9879
9840
  declare enum NameInLineItem$2 {
9880
- /** default location, in case no specific location is specified */
9841
+ /** Default location, in case no specific location is specified. */
9881
9842
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
9882
9843
  }
9883
9844
  declare enum SuggestedFix$2 {
@@ -11511,8 +11472,11 @@ interface Color$3 {
11511
11472
  code?: string | null;
11512
11473
  }
11513
11474
  declare enum DescriptionLineType$3 {
11475
+ /** Unrecognized type. */
11514
11476
  UNRECOGNISED = "UNRECOGNISED",
11477
+ /** Plain text type. */
11515
11478
  PLAIN_TEXT = "PLAIN_TEXT",
11479
+ /** Color type. */
11516
11480
  COLOR = "COLOR"
11517
11481
  }
11518
11482
  interface FocalPoint$4 {
@@ -11526,20 +11490,16 @@ interface FocalPoint$4 {
11526
11490
  width?: number | null;
11527
11491
  }
11528
11492
  interface ItemAvailabilityInfo$1 {
11529
- /**
11530
- * Item availability status.
11531
- * + `"NOT_FOUND"`: Item does not exist
11532
- * + `"NOT_AVAILABLE"`: Item not in stock
11533
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
11534
- */
11493
+ /** Item availability status. */
11535
11494
  status?: ItemAvailabilityStatus$1;
11536
11495
  /** Quantity available. */
11537
11496
  quantityAvailable?: number | null;
11538
11497
  }
11539
11498
  declare enum ItemAvailabilityStatus$1 {
11540
11499
  AVAILABLE = "AVAILABLE",
11500
+ /** Item does not exist */
11541
11501
  NOT_FOUND = "NOT_FOUND",
11542
- /** Not in stock */
11502
+ /** Item not in stock */
11543
11503
  NOT_AVAILABLE = "NOT_AVAILABLE",
11544
11504
  /** Available quantity is less than requested */
11545
11505
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -11657,11 +11617,11 @@ declare enum FileType$2 {
11657
11617
  declare enum PaymentOptionType$4 {
11658
11618
  /** The entire payment for this item happens as part of the checkout. */
11659
11619
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
11660
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
11620
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
11661
11621
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
11662
11622
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
11663
11623
  MEMBERSHIP = "MEMBERSHIP",
11664
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
11624
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
11665
11625
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
11666
11626
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
11667
11627
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -12514,12 +12474,12 @@ interface TargetTargetTypeOneOf$1 {
12514
12474
  }
12515
12475
  /** Available locations on the webpage */
12516
12476
  declare enum NameInOther$1 {
12517
- /** default location, in case no specific location is specified */
12477
+ /** Default location, in case no specific location is specified. */
12518
12478
  OTHER_DEFAULT = "OTHER_DEFAULT"
12519
12479
  }
12520
12480
  /** Available locations on the line item */
12521
12481
  declare enum NameInLineItem$1 {
12522
- /** default location, in case no specific location is specified */
12482
+ /** Default location, in case no specific location is specified. */
12523
12483
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
12524
12484
  }
12525
12485
  declare enum SuggestedFix$1 {
@@ -15264,8 +15224,11 @@ interface Color$2 {
15264
15224
  code?: string | null;
15265
15225
  }
15266
15226
  declare enum DescriptionLineType$2 {
15227
+ /** Unrecognized type. */
15267
15228
  UNRECOGNISED = "UNRECOGNISED",
15229
+ /** Plain text type. */
15268
15230
  PLAIN_TEXT = "PLAIN_TEXT",
15231
+ /** Color type. */
15269
15232
  COLOR = "COLOR"
15270
15233
  }
15271
15234
  interface PhysicalProperties$4 {
@@ -15290,11 +15253,11 @@ interface PaymentOption {
15290
15253
  declare enum PaymentOptionType$3 {
15291
15254
  /** The entire payment for this item happens as part of the checkout. */
15292
15255
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
15293
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
15256
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
15294
15257
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
15295
15258
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
15296
15259
  MEMBERSHIP = "MEMBERSHIP",
15297
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
15260
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
15298
15261
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
15299
15262
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
15300
15263
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -15602,7 +15565,9 @@ interface Sorting$b {
15602
15565
  order?: SortOrder$b;
15603
15566
  }
15604
15567
  declare enum SortOrder$b {
15568
+ /** Ascending order. */
15605
15569
  ASC = "ASC",
15570
+ /** Descending order. */
15606
15571
  DESC = "DESC"
15607
15572
  }
15608
15573
  interface CursorPaging$b {
@@ -16069,20 +16034,16 @@ interface FocalPoint$2 {
16069
16034
  width?: number | null;
16070
16035
  }
16071
16036
  interface ItemAvailabilityInfo {
16072
- /**
16073
- * Item availability status.
16074
- * + `"NOT_FOUND"`: Item does not exist
16075
- * + `"NOT_AVAILABLE"`: Item not in stock
16076
- * + `"PARTIALLY_AVAILABLE"`: Available quantity is less than requested
16077
- */
16037
+ /** Item availability status. */
16078
16038
  status?: ItemAvailabilityStatus;
16079
16039
  /** Quantity available. */
16080
16040
  quantityAvailable?: number | null;
16081
16041
  }
16082
16042
  declare enum ItemAvailabilityStatus {
16083
16043
  AVAILABLE = "AVAILABLE",
16044
+ /** Item does not exist */
16084
16045
  NOT_FOUND = "NOT_FOUND",
16085
- /** Not in stock */
16046
+ /** Item not in stock */
16086
16047
  NOT_AVAILABLE = "NOT_AVAILABLE",
16087
16048
  /** Available quantity is less than requested */
16088
16049
  PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
@@ -16877,12 +16838,12 @@ interface TargetTargetTypeOneOf {
16877
16838
  }
16878
16839
  /** Available locations on the webpage */
16879
16840
  declare enum NameInOther {
16880
- /** default location, in case no specific location is specified */
16841
+ /** Default location, in case no specific location is specified. */
16881
16842
  OTHER_DEFAULT = "OTHER_DEFAULT"
16882
16843
  }
16883
16844
  /** Available locations on the line item */
16884
16845
  declare enum NameInLineItem {
16885
- /** default location, in case no specific location is specified */
16846
+ /** Default location, in case no specific location is specified. */
16886
16847
  LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
16887
16848
  }
16888
16849
  declare enum SuggestedFix {
@@ -19307,8 +19268,11 @@ interface Color$1 {
19307
19268
  code?: string | null;
19308
19269
  }
19309
19270
  declare enum DescriptionLineType$1 {
19271
+ /** Unrecognized type. */
19310
19272
  UNRECOGNISED = "UNRECOGNISED",
19273
+ /** Plain text type. */
19311
19274
  PLAIN_TEXT = "PLAIN_TEXT",
19275
+ /** Color type. */
19312
19276
  COLOR = "COLOR"
19313
19277
  }
19314
19278
  interface FocalPoint$1 {
@@ -19353,11 +19317,11 @@ declare enum ItemTypeItemType$2 {
19353
19317
  declare enum PaymentOptionType$2 {
19354
19318
  /** The entire payment for this item happens as part of the checkout. */
19355
19319
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
19356
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
19320
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
19357
19321
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
19358
19322
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
19359
19323
  MEMBERSHIP = "MEMBERSHIP",
19360
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
19324
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
19361
19325
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
19362
19326
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
19363
19327
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -19526,7 +19490,7 @@ interface ShippingDetailsChangeTypeOneOf {
19526
19490
  interface V1ShippingInformation$1 {
19527
19491
  /** App Def Id of external provider which was a source of shipping info */
19528
19492
  carrierId?: string | null;
19529
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
19493
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
19530
19494
  code?: string | null;
19531
19495
  /**
19532
19496
  * Shipping option title.
@@ -20729,14 +20693,14 @@ declare enum PaymentStatus$2 {
20729
20693
  PARTIALLY_PAID = "PARTIALLY_PAID"
20730
20694
  }
20731
20695
  declare enum FulfillmentStatus$3 {
20732
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
20696
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
20733
20697
  NOT_FULFILLED = "NOT_FULFILLED",
20734
20698
  /**
20735
- * All of the order items are fulfilled or order was manually marked as fulfilled
20736
- * Orders without shipping info are fulfilled automatically
20699
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
20700
+ * Orders without shipping info are fulfilled automatically.
20737
20701
  */
20738
20702
  FULFILLED = "FULFILLED",
20739
- /** Some, but not all of the order items are fulfilled */
20703
+ /** Some, but not all, of the order items are fulfilled. */
20740
20704
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
20741
20705
  }
20742
20706
  declare enum OrderStatus$1 {
@@ -20867,7 +20831,9 @@ interface LineItemQuantityChange$1 {
20867
20831
  deltaType?: LineItemQuantityChangeType$1;
20868
20832
  }
20869
20833
  declare enum LineItemQuantityChangeType$1 {
20834
+ /** Quantity increased. */
20870
20835
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
20836
+ /** Quantity decreased. */
20871
20837
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
20872
20838
  }
20873
20839
  interface LineItemPriceChange$1 {
@@ -23265,12 +23231,7 @@ interface GiftCard$2 {
23265
23231
  obfuscatedCode?: string;
23266
23232
  /** Gift card balance. */
23267
23233
  balance?: Money;
23268
- /**
23269
- * Current gift card status. Supported values:
23270
- * + **VALID**: Gift card is active and can be used for purchases.
23271
- * + **EXPIRED**: Gift card expiration date has passed and can no longer be used.
23272
- * + **DISABLED**: Gift card has been disabled by the merchant and can no longer be used.
23273
- */
23234
+ /** Current gift card status. */
23274
23235
  status?: Status$1;
23275
23236
  /** App ID of the gift card provider, as returned in eCommerce Get Checkout or List Transactions for Single Order. */
23276
23237
  appId?: string;
@@ -23288,8 +23249,11 @@ interface Money {
23288
23249
  }
23289
23250
  declare enum Status$1 {
23290
23251
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
23252
+ /** Gift card is active and can be used for purchases. */
23291
23253
  VALID = "VALID",
23254
+ /** Gift card expiration date has passed and can no longer be used. */
23292
23255
  EXPIRED = "EXPIRED",
23256
+ /** Gift card has been disabled by the merchant and can no longer be used. */
23293
23257
  DISABLED = "DISABLED"
23294
23258
  }
23295
23259
  interface GetGiftCardRequest {
@@ -24572,8 +24536,11 @@ interface Color {
24572
24536
  code?: string | null;
24573
24537
  }
24574
24538
  declare enum DescriptionLineType {
24539
+ /** Unrecognized type. */
24575
24540
  UNRECOGNISED = "UNRECOGNISED",
24541
+ /** Plain text type. */
24576
24542
  PLAIN_TEXT = "PLAIN_TEXT",
24543
+ /** Color type. */
24577
24544
  COLOR = "COLOR"
24578
24545
  }
24579
24546
  interface FocalPoint {
@@ -24618,11 +24585,11 @@ declare enum ItemTypeItemType$1 {
24618
24585
  declare enum PaymentOptionType$1 {
24619
24586
  /** The entire payment for this item happens as part of the checkout. */
24620
24587
  FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
24621
- /** The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods. */
24588
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
24622
24589
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
24623
24590
  /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
24624
24591
  MEMBERSHIP = "MEMBERSHIP",
24625
- /** Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is specified in `depositAmount`. */
24592
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
24626
24593
  DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
24627
24594
  /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
24628
24595
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -24805,14 +24772,14 @@ declare enum PaymentStatus$1 {
24805
24772
  PARTIALLY_PAID = "PARTIALLY_PAID"
24806
24773
  }
24807
24774
  declare enum FulfillmentStatus$1 {
24808
- /** none of the order items are fulfilled or order was manually marked as unfulfilled */
24775
+ /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
24809
24776
  NOT_FULFILLED = "NOT_FULFILLED",
24810
24777
  /**
24811
- * All of the order items are fulfilled or order was manually marked as fulfilled
24812
- * Orders without shipping info are fulfilled automatically
24778
+ * All of the order items are fulfilled or the order was manually marked as fulfilled.
24779
+ * Orders without shipping info are fulfilled automatically.
24813
24780
  */
24814
24781
  FULFILLED = "FULFILLED",
24815
- /** Some, but not all of the order items are fulfilled */
24782
+ /** Some, but not all, of the order items are fulfilled. */
24816
24783
  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
24817
24784
  }
24818
24785
  declare enum WeightUnit$3 {
@@ -24909,7 +24876,7 @@ declare enum VatType$2 {
24909
24876
  interface V1ShippingInformation {
24910
24877
  /** App Def Id of external provider which was a source of shipping info */
24911
24878
  carrierId?: string | null;
24912
- /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"``. */
24879
+ /** Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`. */
24913
24880
  code?: string | null;
24914
24881
  /**
24915
24882
  * Shipping option title.
@@ -25268,7 +25235,9 @@ interface LineItemQuantityChange {
25268
25235
  deltaType?: LineItemQuantityChangeType;
25269
25236
  }
25270
25237
  declare enum LineItemQuantityChangeType {
25238
+ /** Quantity increased. */
25271
25239
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
25240
+ /** Quantity decreased. */
25272
25241
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
25273
25242
  }
25274
25243
  interface LineItemPriceChange {
@@ -26256,11 +26225,11 @@ interface AuthorizationCapture$1 {
26256
26225
  }
26257
26226
  declare enum AuthorizationCaptureStatus$1 {
26258
26227
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
26259
- /** Whether capture operation still in progress */
26228
+ /** Capture operation still in progress. */
26260
26229
  PENDING = "PENDING",
26261
- /** The capture operation was succeeded */
26230
+ /** Capture operation succeeded. */
26262
26231
  SUCCEEDED = "SUCCEEDED",
26263
- /** The capture operation was failed */
26232
+ /** Capture operation failed. */
26264
26233
  FAILED = "FAILED"
26265
26234
  }
26266
26235
  interface AuthorizationActionFailureDetails$1 {
@@ -26278,28 +26247,25 @@ interface AuthorizationVoid$1 {
26278
26247
  }
26279
26248
  declare enum AuthorizationVoidStatus$1 {
26280
26249
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
26281
- /** Whether void operation still in progress */
26250
+ /** Void operation still in progress. */
26282
26251
  PENDING = "PENDING",
26283
- /** The void operation was succeeded */
26252
+ /** Void operation succeeded. */
26284
26253
  SUCCEEDED = "SUCCEEDED",
26285
- /** The void operation was failed */
26254
+ /** Void operation failed. */
26286
26255
  FAILED = "FAILED"
26287
26256
  }
26288
- /**
26289
- * Reason the authorization was voided.
26290
- *
26291
- * + `MANUAL`: Authorization was voided by user.
26292
- * + `SCHEDULED`: Authorization passed execution date.
26293
- */
26257
+ /** Reason the authorization was voided. */
26294
26258
  declare enum Reason$1 {
26295
26259
  UNKNOWN_REASON = "UNKNOWN_REASON",
26260
+ /** Authorization was voided by user. */
26296
26261
  MANUAL = "MANUAL",
26262
+ /** Authorization passed execution date. */
26297
26263
  SCHEDULED = "SCHEDULED"
26298
26264
  }
26299
26265
  interface V1ScheduledAction {
26300
- /** type of the action */
26266
+ /** Type of the action. */
26301
26267
  actionType?: ActionType$1;
26302
- /** the date and time of the action */
26268
+ /** The date and time of the action. */
26303
26269
  executionDate?: Date | null;
26304
26270
  }
26305
26271
  declare enum ActionType$1 {
@@ -26338,9 +26304,9 @@ interface MembershipPaymentDetails$1 {
26338
26304
  providerAppId?: string;
26339
26305
  }
26340
26306
  declare enum MembershipPaymentStatus$1 {
26341
- /** CHARGED - Payment was charged */
26307
+ /** Payment was charged. */
26342
26308
  CHARGED = "CHARGED",
26343
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
26309
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
26344
26310
  CHARGE_FAILED = "CHARGE_FAILED"
26345
26311
  }
26346
26312
  interface MembershipName$2 {
@@ -26382,19 +26348,17 @@ interface RefundTransaction$1 {
26382
26348
  /** Whether refund was made externally and manually on the payment provider's side. */
26383
26349
  externalRefund?: boolean;
26384
26350
  }
26385
- /**
26386
- * Refund transaction status.
26387
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
26388
- * + `SUCCEEDED`: Refund transaction succeeded.
26389
- * + `FAILED`: Refund transaction failed.
26390
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
26391
- * + `STARTED`: Refund was initiated on payment provider side.
26392
- */
26351
+ /** Refund transaction status. */
26393
26352
  declare enum RefundStatus$1 {
26353
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
26394
26354
  PENDING = "PENDING",
26355
+ /** Refund transaction succeeded. */
26395
26356
  SUCCEEDED = "SUCCEEDED",
26357
+ /** Refund transaction failed. */
26396
26358
  FAILED = "FAILED",
26359
+ /** Refund request acknowledged, and will be executed soon. */
26397
26360
  SCHEDULED = "SCHEDULED",
26361
+ /** Refund was initiated on payment provider side. */
26398
26362
  STARTED = "STARTED"
26399
26363
  }
26400
26364
  /** Business model of a refund request */
@@ -27300,7 +27264,9 @@ interface CreateOrderRequest {
27300
27264
  interface OrderCreationSettings {
27301
27265
  }
27302
27266
  declare enum OrderApprovalStrategy {
27267
+ /** When `order.priceSummary.total = 0`, **or** after receiving payment. */
27303
27268
  DEFAULT = "DEFAULT",
27269
+ /** Order is approved **only** after receiving payment. */
27304
27270
  PAYMENT_RECEIVED = "PAYMENT_RECEIVED",
27305
27271
  PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
27306
27272
  }
@@ -27483,13 +27449,13 @@ interface OrderLineItemChangedDetails {
27483
27449
  }
27484
27450
  /** Type of selected payment option for catalog item */
27485
27451
  declare enum DeltaPaymentOptionType {
27486
- /** irrelevant */
27452
+ /** Irrelevant */
27487
27453
  UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
27488
- /** The entire payment for given item will happen after the checkout. */
27454
+ /** The entire payment for the given item will happen after checkout. */
27489
27455
  FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
27490
27456
  /**
27491
27457
  * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
27492
- * Note: when this option is used, price will be 0.
27458
+ * Note: when this option is used, the price will be 0.
27493
27459
  */
27494
27460
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
27495
27461
  }
@@ -27528,7 +27494,7 @@ interface DraftOrderCommitSettings {
27528
27494
  sendNotificationsToBuyer?: boolean | null;
27529
27495
  /** If false, do not send notifications to business. Default is true. */
27530
27496
  sendNotificationsToBusiness?: boolean | null;
27531
- /** If false,do not add activities to the order. Default is true. */
27497
+ /** If false, do not add activities to the order. Default is true. */
27532
27498
  addActivitiesToOrder?: boolean | null;
27533
27499
  /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
27534
27500
  sendNotificationsToCustomFulfillers?: boolean | null;
@@ -30879,11 +30845,11 @@ interface AuthorizationCapture {
30879
30845
  }
30880
30846
  declare enum AuthorizationCaptureStatus {
30881
30847
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
30882
- /** Whether capture operation still in progress */
30848
+ /** Capture operation still in progress. */
30883
30849
  PENDING = "PENDING",
30884
- /** The capture operation was succeeded */
30850
+ /** Capture operation succeeded. */
30885
30851
  SUCCEEDED = "SUCCEEDED",
30886
- /** The capture operation was failed */
30852
+ /** Capture operation failed. */
30887
30853
  FAILED = "FAILED"
30888
30854
  }
30889
30855
  interface Price$1 {
@@ -30910,28 +30876,25 @@ interface AuthorizationVoid {
30910
30876
  }
30911
30877
  declare enum AuthorizationVoidStatus {
30912
30878
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
30913
- /** Whether void operation still in progress */
30879
+ /** Void operation still in progress. */
30914
30880
  PENDING = "PENDING",
30915
- /** The void operation was succeeded */
30881
+ /** Void operation succeeded. */
30916
30882
  SUCCEEDED = "SUCCEEDED",
30917
- /** The void operation was failed */
30883
+ /** Void operation failed. */
30918
30884
  FAILED = "FAILED"
30919
30885
  }
30920
- /**
30921
- * Reason the authorization was voided.
30922
- *
30923
- * + `MANUAL`: Authorization was voided by user.
30924
- * + `SCHEDULED`: Authorization passed execution date.
30925
- */
30886
+ /** Reason the authorization was voided. */
30926
30887
  declare enum Reason {
30927
30888
  UNKNOWN_REASON = "UNKNOWN_REASON",
30889
+ /** Authorization was voided by user. */
30928
30890
  MANUAL = "MANUAL",
30891
+ /** Authorization passed execution date. */
30929
30892
  SCHEDULED = "SCHEDULED"
30930
30893
  }
30931
30894
  interface ScheduledAction {
30932
- /** type of the action */
30895
+ /** Type of the action. */
30933
30896
  actionType?: ActionType;
30934
- /** the date and time of the action */
30897
+ /** The date and time of the action. */
30935
30898
  executionDate?: Date | null;
30936
30899
  }
30937
30900
  declare enum ActionType {
@@ -30970,9 +30933,9 @@ interface MembershipPaymentDetails {
30970
30933
  providerAppId?: string;
30971
30934
  }
30972
30935
  declare enum MembershipPaymentStatus {
30973
- /** CHARGED - Payment was charged */
30936
+ /** Payment was charged. */
30974
30937
  CHARGED = "CHARGED",
30975
- /** CHARGE_FAILED - The attempt to charge that payment have failed, for example due to lack of credits */
30938
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
30976
30939
  CHARGE_FAILED = "CHARGE_FAILED"
30977
30940
  }
30978
30941
  interface MembershipName$1 {
@@ -31014,19 +30977,17 @@ interface RefundTransaction {
31014
30977
  /** Whether refund was made externally and manually on the payment provider's side. */
31015
30978
  externalRefund?: boolean;
31016
30979
  }
31017
- /**
31018
- * Refund transaction status.
31019
- * + `PENDING`: Refund was initiated on payment provider side. PENDING status was assigned by provider.
31020
- * + `SUCCEEDED`: Refund transaction succeeded.
31021
- * + `FAILED`: Refund transaction failed.
31022
- * + `SCHEDULED`: Refund request acknowledged, and will be executed soon.
31023
- * + `STARTED`: Refund was initiated on payment provider side.
31024
- */
30980
+ /** Refund transaction status. */
31025
30981
  declare enum RefundStatus {
30982
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
31026
30983
  PENDING = "PENDING",
30984
+ /** Refund transaction succeeded. */
31027
30985
  SUCCEEDED = "SUCCEEDED",
30986
+ /** Refund transaction failed. */
31028
30987
  FAILED = "FAILED",
30988
+ /** Refund request acknowledged, and will be executed soon. */
31029
30989
  SCHEDULED = "SCHEDULED",
30990
+ /** Refund was initiated on payment provider side. */
31030
30991
  STARTED = "STARTED"
31031
30992
  }
31032
30993
  /** Business model of a refund request */
@@ -32065,7 +32026,9 @@ interface Sorting$5 {
32065
32026
  order?: SortOrder$5;
32066
32027
  }
32067
32028
  declare enum SortOrder$5 {
32029
+ /** Ascending order. */
32068
32030
  ASC = "ASC",
32031
+ /** Descending order. */
32069
32032
  DESC = "DESC"
32070
32033
  }
32071
32034
  interface CursorPaging$5 {
@@ -32201,28 +32164,47 @@ interface RefundabilityAdditionalRefundabilityInfoOneOf {
32201
32164
  manuallyRefundableReason?: ManuallyRefundableReason;
32202
32165
  }
32203
32166
  declare enum RefundableStatus {
32167
+ /** Not refundable. */
32204
32168
  NOT_REFUNDABLE = "NOT_REFUNDABLE",
32169
+ /** Refundable manually. */
32205
32170
  MANUAL = "MANUAL",
32171
+ /** Refundable. */
32206
32172
  REFUNDABLE = "REFUNDABLE"
32207
32173
  }
32208
32174
  declare enum NonRefundableReason {
32175
+ /** No reason. */
32209
32176
  NONE = "NONE",
32177
+ /** Payment already refunded. */
32210
32178
  ALREADY_REFUNDED = "ALREADY_REFUNDED",
32179
+ /** Payment provider is down. */
32211
32180
  PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
32181
+ /** Internal error occurred. */
32212
32182
  INTERNAL_ERROR = "INTERNAL_ERROR",
32183
+ /** Payment not made. */
32213
32184
  NOT_PAID = "NOT_PAID",
32185
+ /** Access denied. */
32214
32186
  ACCESS_DENIED = "ACCESS_DENIED",
32187
+ /** Payment amount is zero. */
32215
32188
  ZERO_PRICE = "ZERO_PRICE",
32189
+ /** Disabled by provider. */
32216
32190
  DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
32191
+ /** Payment partially paid. */
32217
32192
  PARTIALLY_PAID = "PARTIALLY_PAID",
32193
+ /** Deposit for online item. */
32218
32194
  DEPOSIT_ONLINE_ITEM = "DEPOSIT_ONLINE_ITEM",
32195
+ /** Refund is pending. */
32219
32196
  PENDING_REFUND = "PENDING_REFUND",
32197
+ /** Action forbidden. */
32220
32198
  FORBIDDEN = "FORBIDDEN"
32221
32199
  }
32222
32200
  declare enum ManuallyRefundableReason {
32201
+ /** Payment expired. */
32223
32202
  EXPIRED = "EXPIRED",
32203
+ /** Payment method not supported. */
32224
32204
  NOT_SUPPORTED = "NOT_SUPPORTED",
32205
+ /** Payment not found. */
32225
32206
  NOT_FOUND = "NOT_FOUND",
32207
+ /** Payment made offline. */
32226
32208
  OFFLINE = "OFFLINE"
32227
32209
  }
32228
32210
  interface ListInvoicesForSingleOrderRequest {
@@ -32822,7 +32804,9 @@ interface OrdersSettings {
32822
32804
  }
32823
32805
  declare enum InventoryUpdateTrigger {
32824
32806
  UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
32807
+ /** Stock quantities will update only after the payment is approved. */
32825
32808
  ON_ORDER_PAID = "ON_ORDER_PAID",
32809
+ /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
32826
32810
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
32827
32811
  }
32828
32812
  interface GetOrdersSettingsRequest {
@@ -32872,7 +32856,7 @@ interface DomainEvent$6 extends DomainEventBodyOneOf$6 {
32872
32856
  slug?: string;
32873
32857
  /** ID of the entity associated with the event. */
32874
32858
  entityId?: string;
32875
- /** Event timestamp. */
32859
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
32876
32860
  eventTime?: Date | null;
32877
32861
  /**
32878
32862
  * Whether the event was triggered as a result of a privacy regulation application
@@ -32995,7 +32979,7 @@ interface EventMetadata$2 extends BaseEventMetadata$2 {
32995
32979
  slug?: string;
32996
32980
  /** ID of the entity associated with the event. */
32997
32981
  entityId?: string;
32998
- /** Event timestamp. */
32982
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
32999
32983
  eventTime?: Date | null;
33000
32984
  /**
33001
32985
  * Whether the event was triggered as a result of a privacy regulation application