@wix/auto_sdk_ecom_payment-settings 1.0.96 → 1.0.98

package/build/internal/es/{interfaces-ecommerce-v1-payment-settings-provider.public-D3093yBX.d.mts → interfaces-ecommerce-v1-payment-settings-provider.public-CYu8Smvw.d.mts}

@@ -4,6 +4,11 @@ interface GetPaymentSettingsRequest {
     /** Order. */
     order?: Order;
 }
+/**
+ * An order represents a completed purchase from a buyer. Orders are created through the checkout flow or manually via the Create Order endpoint.
+ *
+ * The order contains details about purchased items, buyer and recipient information, pricing, tax, shipping, fulfillment status, and payment status.
+ */
 interface Order {
     /**
      * Order ID.
@@ -150,10 +155,10 @@ interface Order {
      */
     purchaseFlowId?: string | null;
     /**
-     * Order recipient address and contact details.
+     * Final recipient's address and contact details.
      *
-     * This field may differ from the address in `shippingInfo.logistics` when:
-     * + The chosen shipping option is pickup point or store pickup.
+     * This field represents who will ultimately receive the order. It may differ from `shippingInfo.logistics.shippingDestination` when:
+     * + The chosen shipping option is a pickup point or store pickup, where `shippingDestination` contains the pickup location.
      * + No shipping option is selected.
      */
     recipientInfo?: ApiAddressWithContact;
@@ -185,15 +190,13 @@ interface OrderLineItem {
     _id?: string;
     /**
      * Item name.
+     *
      * + Stores - `product.name`
      * + Bookings - `service.info.name`
      * + Events - `ticket.name`
      */
     productName?: ProductName;
-    /**
-     * References to the line item's origin catalog.
-     * This field may be empty in the case of a custom line item.
-     */
+    /** References to the line item's origin catalog. Empty for custom line items. */
     catalogReference?: CatalogReference;
     /**
      * Line item quantity.
@@ -850,25 +853,25 @@ interface V1ItemModifier {
     /** The price of the modifier. */
     price?: Price;
 }
-/** Buyer Info */
+/** Buyer information. */
 interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
     /**
-     * Visitor ID (if site visitor is not a member).
+     * Visitor ID. Returned when the buyer isn't a logged-in site member.
      * @format GUID
      */
     visitorId?: string;
     /**
-     * Member ID (if site visitor is a site member).
+     * Member ID. Returned when the buyer is a logged-in site member.
      * @format GUID
      */
     memberId?: string;
     /**
-     * Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
+     * Contact ID. Automatically created if one doesn't exist. For more information, see [Contacts API](https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/contacts/contact-v4/introduction).
      * @format GUID
      */
     contactId?: string | null;
     /**
-     * Buyer email address.
+     * Buyer's email address.
      * @format EMAIL
      */
     email?: string | null;
@@ -876,12 +879,12 @@ interface V1BuyerInfo extends V1BuyerInfoIdOneOf {
 /** @oneof */
 interface V1BuyerInfoIdOneOf {
     /**
-     * Visitor ID (if site visitor is not a member).
+     * Visitor ID. Returned when the buyer isn't a logged-in site member.
      * @format GUID
      */
     visitorId?: string;
     /**
-     * Member ID (if site visitor is a site member).
+     * Member ID. Returned when the buyer is a logged-in site member.
      * @format GUID
      */
     memberId?: string;
@@ -965,17 +968,17 @@ interface CurrencyConversionDetails {
     conversionRate?: string | null;
 }
 interface PriceSummary {
-    /** Subtotal of all the line items, before discounts and before tax. */
+    /** Subtotal of all line items, before discounts and before tax. */
     subtotal?: Price;
     /** Total shipping price, before discounts and before tax. */
     shipping?: Price;
-    /** Total tax on this order. */
+    /** Total tax applied to the order. */
     tax?: Price;
-    /** Total calculated discount value. */
+    /** Total discount amount applied to the order. */
     discount?: Price;
-    /** Order’s total price after discounts and tax. */
+    /** Order's total price after discounts and tax. */
     total?: Price;
-    /** Total price of additional fees before tax. */
+    /** Total additional fees before tax. */
     totalAdditionalFees?: Price;
 }
 /** Billing Info and shipping details */
@@ -1116,9 +1119,9 @@ interface V1ShippingInformation {
     region?: ShippingRegion;
 }
 interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
-    /** Shipping address and contact details. */
+    /** Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. */
     shippingDestination?: ApiAddressWithContact;
-    /** Pickup details. */
+    /** Pickup details for store pickup or pickup point orders. */
     pickupDetails?: PickupDetails;
     /**
      * Expected delivery time in free text. For example, `"3-5 business days"`.
@@ -1126,7 +1129,7 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
      */
     deliveryTime?: string | null;
     /**
-     * Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
+     * Instructions for the carrier. For example, `"Please knock on the door. If unanswered, please call contact number."`.
      * @maxLength 1000
      */
     instructions?: string | null;
@@ -1135,14 +1138,14 @@ interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
      * @deprecated
      */
     deliverByDate?: Date | null;
-    /** Expected delivery time. */
+    /** Expected delivery time slot with start and end times. */
     deliveryTimeSlot?: DeliveryTimeSlot;
 }
 /** @oneof */
 interface DeliveryLogisticsAddressOneOf {
-    /** Shipping address and contact details. */
+    /** Shipping destination address and contact details. For pickup orders, this contains the pickup location address, not the recipient's address. */
     shippingDestination?: ApiAddressWithContact;
-    /** Pickup details. */
+    /** Pickup details for store pickup or pickup point orders. */
     pickupDetails?: PickupDetails;
 }
 interface PickupDetails {
@@ -1248,14 +1251,14 @@ declare enum OrderStatus {
     /**
      * Order approved.
      *
-     * This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
+     * This happens when either an online payment is received **or** when `priceSummary.total` is `0` (a zero-total order).
      * Offline orders (cash payment) are automatically approved.
      */
     APPROVED = "APPROVED",
-    /** Order canceled by the user. */
+    /** Order canceled by the merchant or buyer. */
     CANCELED = "CANCELED",
     /**
-     * Order pending.
+     * Order is waiting for the buyer to complete checkout.
      * @documentationMaturity preview
      */
     PENDING = "PENDING",
@@ -1474,8 +1477,6 @@ interface ItemCombinationLineItem {
     quantity?: number;
 }
 interface Activity extends ActivityContentOneOf {
-    /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
-    customActivity?: CustomActivity;
     /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
     merchantComment?: MerchantComment;
     /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
@@ -1556,8 +1557,6 @@ interface Activity extends ActivityContentOneOf {
 }
 /** @oneof */
 interface ActivityContentOneOf {
-    /** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
-    customActivity?: CustomActivity;
     /** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
     merchantComment?: MerchantComment;
     /** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
@@ -2525,15 +2524,19 @@ interface V1CreatedByStringOneOf {
     appId?: string;
 }
 interface ChannelInfo {
-    /** Sales channel that submitted the order. */
+    /**
+     * Sales channel that submitted the order.
+     *
+     * When creating an order via the API to record an external order, use the channel type that matches the original source. If no matching type exists, use `OTHER_PLATFORM`.
+     */
     type?: ChannelType;
     /**
-     * Reference to an order ID from an external system.
+     * Reference to an order ID from an external system. Relevant when recording orders from external platforms.
      * @maxLength 100
      */
     externalOrderId?: string | null;
     /**
-     * URL to the order in the external system.
+     * URL to the order in the external system. Relevant when recording orders from external platforms.
      * @maxLength 300
      */
     externalOrderUrl?: string | null;
@@ -2961,6 +2964,7 @@ interface GetPaymentSettingsForCheckoutRequest {
     /** Checkout. */
     checkout?: Checkout;
 }
+/** A checkout represents a cart that is in the process of being purchased. It holds calculated prices, tax, shipping, and buyer information needed to complete the purchase. */
 interface Checkout {
     /**
      * Checkout ID.
@@ -4567,7 +4571,7 @@ interface V1AdditionalFee {
      */
     code?: string | null;
     /**
-     * Translated additional fee's name.
+     * Additional fee's name.
      * @minLength 1
      * @maxLength 50
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_ecom_payment-settings",
-  "version": "1.0.96",
+  "version": "1.0.98",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.interfaces.ecommerce.v1.payment_settings_provider"
     }
   },
-  "falconPackageHash": "cd58a6e90dfc96c4c04141806eeddd9dbc9595ed5621a1ce06309377"
+  "falconPackageHash": "c5f1df966914752d108c31a7b51e567405ef62aab072a9aefaa8ec24"
 }