@wix/auto_sdk_ecom_delivery-solutions 1.0.5 → 1.0.7

package/build/internal/{es/src/gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.types.d.ts → gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.d.ts}

@@ -1,11 +1,11 @@
-export interface DeliveryRatesGateway {
+interface DeliveryRatesGateway {
     /**
      * @format GUID
      * @readonly
      */
-    id?: string | null;
+    _id?: string | null;
 }
-export interface GetDeliverySolutionsRequest {
+interface GetDeliverySolutionsRequest {
     /**
      * list of items to delivery that each of them points to delivery profile and delivery rule.
      * @minSize 1
@@ -39,14 +39,21 @@ export interface GetDeliverySolutionsRequest {
      * @format GUID
      */
     purchaseFlowId?: string | null;
+    /**
+     * Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.
+     * For example, a Wix Pay Link ID.
+     * @internal
+     * @maxSize 20
+     */
+    externalReferences?: ExternalReference[];
 }
-export interface DeliverableItem {
+interface DeliverableItem {
     /**
      * The ID of the line item.
      * @minLength 1
      * @maxLength 100
      */
-    id?: string;
+    _id?: string;
     /**
      * Item name.
      * @maxLength 400
@@ -94,7 +101,7 @@ export interface DeliverableItem {
     taxIncludedInPrice?: boolean | null;
 }
 /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
-export interface CatalogReference {
+interface CatalogReference {
     /**
      * ID of the item within the catalog it belongs to.
      * @minLength 1
@@ -120,7 +127,7 @@ export interface CatalogReference {
      */
     options?: Record<string, any> | null;
 }
-export interface PhysicalProperties {
+interface PhysicalProperties {
     /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
     weight?: number | null;
     /**
@@ -132,11 +139,11 @@ export interface PhysicalProperties {
     shippable?: boolean;
 }
 /** Physical address */
-export interface Address extends AddressStreetOneOf {
+interface Address extends AddressStreetOneOf {
     /** Street name and number. */
     streetAddress?: StreetAddress;
     /** Main address line, usually street and number as free text. */
-    addressLine?: string | null;
+    addressLine1?: string | null;
     /**
      * Country code.
      * @format COUNTRY
@@ -152,31 +159,31 @@ export interface Address extends AddressStreetOneOf {
     addressLine2?: string | null;
 }
 /** @oneof */
-export interface AddressStreetOneOf {
+interface AddressStreetOneOf {
     /** Street name and number. */
     streetAddress?: StreetAddress;
     /** Main address line, usually street and number as free text. */
     addressLine?: string | null;
 }
-export interface StreetAddress {
+interface StreetAddress {
     /** Street number. */
     number?: string;
     /** Street name. */
     name?: string;
 }
-export interface AddressLocation {
+interface AddressLocation {
     /** Address latitude. */
     latitude?: number | null;
     /** Address longitude. */
     longitude?: number | null;
 }
-export interface Subdivision {
+interface Subdivision {
     /** Short subdivision code. */
     code?: string;
     /** Subdivision full name. */
     name?: string;
 }
-export declare enum SubdivisionType {
+declare enum SubdivisionType {
     UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
     /** State */
     ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -192,7 +199,7 @@ export declare enum SubdivisionType {
     COUNTRY = "COUNTRY"
 }
 /** Full contact details for an address */
-export interface FullAddressContactDetails {
+interface FullAddressContactDetails {
     /** Contact's first name. */
     firstName?: string | null;
     /** Contact's last name. */
@@ -212,9 +219,9 @@ export interface FullAddressContactDetails {
     /** Tax info. Currently usable only in Brazil. */
     vatId?: VatId;
 }
-export interface VatId {
+interface VatId {
     /** Customer's tax ID. */
-    id?: string;
+    _id?: string;
     /**
      * Tax type.
      *
@@ -225,14 +232,14 @@ export interface VatId {
     type?: VatType;
 }
 /** tax info types */
-export declare enum VatType {
+declare enum VatType {
     UNSPECIFIED = "UNSPECIFIED",
     /** CPF - for individual tax payers. */
     CPF = "CPF",
     /** CNPJ - for corporations */
     CNPJ = "CNPJ"
 }
-export declare enum WeightUnit {
+declare enum WeightUnit {
     /** Weight unit can't be classified due to an error. */
     UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
     /** Kilograms. */
@@ -240,7 +247,7 @@ export declare enum WeightUnit {
     /** Pounds. */
     LB = "LB"
 }
-export interface UserPreference {
+interface UserPreference {
     /**
      * The delivery carrier app id
      * @format GUID
@@ -252,7 +259,7 @@ export interface UserPreference {
      */
     code?: string;
 }
-export interface ExternalReference {
+interface ExternalReference {
     /**
      * ID of the app associated with the purchase flow.
      * For example, the Wix Pay Links app ID.
@@ -273,7 +280,7 @@ export interface ExternalReference {
  * Each delivery option has a list of items that can be delivered by it - the chosen one
  * on Errors throw a business error from TC to catch and trigger destination completion
  */
-export interface GetDeliverySolutionsResponse {
+interface GetDeliverySolutionsResponse {
     /**
      * Delivery Options with their associated items
      * @maxSize 300
@@ -285,7 +292,7 @@ export interface GetDeliverySolutionsResponse {
      */
     errors?: DeliveryCarrierError[];
 }
-export interface DeliverySolution {
+interface DeliverySolution {
     /**
      * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
      * @maxLength 250
@@ -309,7 +316,7 @@ export interface DeliverySolution {
     /** If the delivery solution is a partial and doesn't apply to all items. */
     partial?: boolean | null;
 }
-export interface DeliveryLogistics {
+interface DeliveryLogistics {
     /**
      * When the item is expected to be delivered in free text. For example, `"3-5 business days"`.
      * @maxLength 1000
@@ -325,7 +332,7 @@ export interface DeliveryLogistics {
     /** Date and Time of the delivery option */
     deliveryTimeSlot?: DeliveryTimeSlot;
 }
-export interface PickupDetails {
+interface PickupDetails {
     /** Pickup address. */
     address?: Address;
     /**
@@ -337,18 +344,18 @@ export interface PickupDetails {
      */
     pickupMethod?: PickupMethod;
 }
-export declare enum PickupMethod {
+declare enum PickupMethod {
     UNKNOWN_METHOD = "UNKNOWN_METHOD",
     STORE_PICKUP = "STORE_PICKUP",
     PICKUP_POINT = "PICKUP_POINT"
 }
-export interface DeliveryTimeSlot {
+interface DeliveryTimeSlot {
     /** starting time of the delivery time slot */
     from?: Date | null;
     /** ending time of the delivery time slot */
     to?: Date | null;
 }
-export interface DeliveryCost {
+interface DeliveryCost {
     /**
      * The shipping rate's price. Must align with the [currency's decimal separator](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).
      * @format DECIMAL_VALUE
@@ -366,7 +373,7 @@ export interface DeliveryCost {
      */
     additionalCharges?: AdditionalCharge[];
 }
-export interface AdditionalCharge {
+interface AdditionalCharge {
     /** Additional charge type. */
     type?: ChargeType;
     /**
@@ -381,10 +388,10 @@ export interface AdditionalCharge {
      */
     price?: string;
 }
-export declare enum ChargeType {
+declare enum ChargeType {
     HANDLING_FEE = "HANDLING_FEE"
 }
-export interface DeliveryAllocation {
+interface DeliveryAllocation {
     /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
     deliveryCarrier?: Carrier;
     /** The delivery region that are relevant for this delivery solution. */
@@ -392,7 +399,7 @@ export interface DeliveryAllocation {
     /** Populated if the delivery solution is a partially supplied by this carrier. */
     applicableLineItems?: ApplicableLineItems;
 }
-export interface Carrier {
+interface Carrier {
     /**
      * The carrier app id
      * @format GUID
@@ -404,19 +411,19 @@ export interface Carrier {
      */
     code?: string;
 }
-export interface Region {
+interface Region {
     /**
      * The delivery region id.
      * @format GUID
      */
-    id?: string | null;
+    _id?: string | null;
     /**
      * The delivery region name.
      * @maxLength 100
      */
     name?: string | null;
 }
-export interface ApplicableLineItems {
+interface ApplicableLineItems {
     /**
      * Line items that the delivery solution is for.
      * @maxSize 300
@@ -425,7 +432,7 @@ export interface ApplicableLineItems {
      */
     lineItemIds?: string[];
 }
-export interface DeliveryCarrierError {
+interface DeliveryCarrierError {
     /**
      * The carrier app id
      * @format GUID
@@ -434,7 +441,7 @@ export interface DeliveryCarrierError {
     /** The error details */
     errorDetails?: Details;
 }
-export interface Details extends DetailsKindOneOf {
+interface Details extends DetailsKindOneOf {
     applicationError?: ApplicationError;
     validationError?: ValidationError;
     systemError?: SystemError;
@@ -445,12 +452,12 @@ export interface Details extends DetailsKindOneOf {
     tracing?: Record<string, string>;
 }
 /** @oneof */
-export interface DetailsKindOneOf {
+interface DetailsKindOneOf {
     applicationError?: ApplicationError;
     validationError?: ValidationError;
     systemError?: SystemError;
 }
-export interface ApplicationError {
+interface ApplicationError {
     /** Error code. */
     code?: string;
     /** Description of the error. */
@@ -490,10 +497,10 @@ export interface ApplicationError {
  * ]
  * }
  */
-export interface ValidationError {
+interface ValidationError {
     fieldViolations?: FieldViolation[];
 }
-export declare enum RuleType {
+declare enum RuleType {
     VALIDATION = "VALIDATION",
     OTHER = "OTHER",
     MAX = "MAX",
@@ -516,7 +523,7 @@ export declare enum RuleType {
     EXACT_SIZE = "EXACT_SIZE",
     REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
 }
-export interface FieldViolation {
+interface FieldViolation {
     field?: string;
     description?: string;
     violatedRule?: RuleType;
@@ -524,78 +531,38 @@ export interface FieldViolation {
     ruleName?: string | null;
     data?: Record<string, any> | null;
 }
-export interface SystemError {
+interface SystemError {
     /** Error code. */
     errorCode?: string | null;
 }
-interface StreetAddressNonNullableFields {
-    number: string;
-    name: string;
-    apt: string;
-}
-interface SubdivisionNonNullableFields {
-    code: string;
-    name: string;
-    type: SubdivisionType;
-}
-interface AddressNonNullableFields {
-    streetAddress?: StreetAddressNonNullableFields;
-    subdivisions: SubdivisionNonNullableFields[];
-}
-interface PickupDetailsNonNullableFields {
-    address?: AddressNonNullableFields;
-    pickupMethod: PickupMethod;
-}
-interface DeliveryLogisticsNonNullableFields {
-    pickupDetails?: PickupDetailsNonNullableFields;
-}
-interface AdditionalChargeNonNullableFields {
-    type: ChargeType;
-    price: string;
-}
-interface DeliveryCostNonNullableFields {
-    price: string;
-    currency: string;
-    additionalCharges: AdditionalChargeNonNullableFields[];
-}
-interface CarrierNonNullableFields {
-    code: string;
-}
-interface ApplicableLineItemsNonNullableFields {
-    lineItemIds: string[];
-}
-interface DeliveryAllocationNonNullableFields {
-    deliveryCarrier?: CarrierNonNullableFields;
-    applicableLineItems?: ApplicableLineItemsNonNullableFields;
-}
-interface DeliverySolutionNonNullableFields {
-    code: string;
-    title: string;
-    logistics?: DeliveryLogisticsNonNullableFields;
-    cost?: DeliveryCostNonNullableFields;
-    deliveryAllocations: DeliveryAllocationNonNullableFields[];
-}
-interface ApplicationErrorNonNullableFields {
-    code: string;
-    description: string;
-}
-interface FieldViolationNonNullableFields {
-    field: string;
-    description: string;
-    violatedRule: RuleType;
-}
-interface ValidationErrorNonNullableFields {
-    fieldViolations: FieldViolationNonNullableFields[];
-}
-interface DetailsNonNullableFields {
-    applicationError?: ApplicationErrorNonNullableFields;
-    validationError?: ValidationErrorNonNullableFields;
-}
-interface DeliveryCarrierErrorNonNullableFields {
-    errorDetails?: DetailsNonNullableFields;
-}
-export interface GetDeliverySolutionsResponseNonNullableFields {
-    deliverySolutions: DeliverySolutionNonNullableFields[];
-    errors: DeliveryCarrierErrorNonNullableFields[];
+interface GetDeliverySolutionsOptions {
+    /** Destination the items should deliver to */
+    destination: Address;
+    /**
+     * Origin the items should deliver from
+     * @deprecated Origin the items should deliver from
+     * @targetRemovalDate 2025-04-01
+     */
+    origin?: Address;
+    /**
+     * Currency - Defaults to site's currency
+     * @format CURRENCY
+     */
+    currency: string | null;
+    /** Contact details */
+    contactDetails?: FullAddressContactDetails;
+    /** Measure unit - defaults to site's weight unit */
+    weightUnit?: WeightUnit;
+    /**
+     * list of user preferences which are delivery options codes combined with delivery carrier app id
+     * @maxSize 5
+     */
+    userPreferences?: UserPreference[];
+    /**
+     * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+     * @format GUID
+     */
+    purchaseFlowId?: string | null;
 }
-export {};
+
+export { type Address as A, type SystemError as B, ChargeType as C, type DeliverableItem as D, type ExternalReference as E, type FullAddressContactDetails as F, type GetDeliverySolutionsOptions as G, PickupMethod as P, RuleType as R, SubdivisionType as S, type UserPreference as U, VatType as V, WeightUnit as W, type GetDeliverySolutionsResponse as a, type DeliveryRatesGateway as b, type GetDeliverySolutionsRequest as c, type CatalogReference as d, type PhysicalProperties as e, type AddressStreetOneOf as f, type StreetAddress as g, type AddressLocation as h, type Subdivision as i, type VatId as j, type DeliverySolution as k, type DeliveryLogistics as l, type PickupDetails as m, type DeliveryTimeSlot as n, type DeliveryCost as o, type AdditionalCharge as p, type DeliveryAllocation as q, type Carrier as r, type Region as s, type ApplicableLineItems as t, type DeliveryCarrierError as u, type Details as v, type DetailsKindOneOf as w, type ApplicationError as x, type ValidationError as y, type FieldViolation as z };

package/build/internal/index.d.mts

@@ -0,0 +1,18 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { D as DeliverableItem, G as GetDeliverySolutionsOptions, a as GetDeliverySolutionsResponse } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.mjs';
+export { p as AdditionalCharge, A as Address, h as AddressLocation, f as AddressStreetOneOf, t as ApplicableLineItems, x as ApplicationError, r as Carrier, d as CatalogReference, C as ChargeType, q as DeliveryAllocation, u as DeliveryCarrierError, o as DeliveryCost, l as DeliveryLogistics, b as DeliveryRatesGateway, k as DeliverySolution, n as DeliveryTimeSlot, v as Details, w as DetailsKindOneOf, E as ExternalReference, z as FieldViolation, F as FullAddressContactDetails, c as GetDeliverySolutionsRequest, e as PhysicalProperties, m as PickupDetails, P as PickupMethod, s as Region, R as RuleType, g as StreetAddress, i as Subdivision, S as SubdivisionType, B as SystemError, U as UserPreference, y as ValidationError, j as VatId, V as VatType, W as WeightUnit } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.mjs';
+
+declare function getDeliverySolutions$1(httpClient: HttpClient): GetDeliverySolutionsSignature;
+interface GetDeliverySolutionsSignature {
+    /**
+     * Get Delivery Solutions for the given line items from all relevant delivery carriers
+     * @param - list of items to delivery that each of them points to delivery profile and delivery rule.
+     * @returns Each delivery option has a list of items that can be delivered by it - the chosen one
+     * on Errors throw a business error from TC to catch and trigger destination completion
+     */
+    (lineItems: DeliverableItem[], options?: GetDeliverySolutionsOptions | undefined): Promise<GetDeliverySolutionsResponse>;
+}
+
+declare const getDeliverySolutions: MaybeContext<BuildRESTFunction<typeof getDeliverySolutions$1> & typeof getDeliverySolutions$1>;
+
+export { DeliverableItem, GetDeliverySolutionsOptions, GetDeliverySolutionsResponse, getDeliverySolutions };

package/build/internal/index.d.ts

@@ -0,0 +1,18 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { D as DeliverableItem, G as GetDeliverySolutionsOptions, a as GetDeliverySolutionsResponse } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.js';
+export { p as AdditionalCharge, A as Address, h as AddressLocation, f as AddressStreetOneOf, t as ApplicableLineItems, x as ApplicationError, r as Carrier, d as CatalogReference, C as ChargeType, q as DeliveryAllocation, u as DeliveryCarrierError, o as DeliveryCost, l as DeliveryLogistics, b as DeliveryRatesGateway, k as DeliverySolution, n as DeliveryTimeSlot, v as Details, w as DetailsKindOneOf, E as ExternalReference, z as FieldViolation, F as FullAddressContactDetails, c as GetDeliverySolutionsRequest, e as PhysicalProperties, m as PickupDetails, P as PickupMethod, s as Region, R as RuleType, g as StreetAddress, i as Subdivision, S as SubdivisionType, B as SystemError, U as UserPreference, y as ValidationError, j as VatId, V as VatType, W as WeightUnit } from './gateways-ecom-v1-delivery-rates-gateway-delivery-solutions.universal-DMPoOveb.js';
+
+declare function getDeliverySolutions$1(httpClient: HttpClient): GetDeliverySolutionsSignature;
+interface GetDeliverySolutionsSignature {
+    /**
+     * Get Delivery Solutions for the given line items from all relevant delivery carriers
+     * @param - list of items to delivery that each of them points to delivery profile and delivery rule.
+     * @returns Each delivery option has a list of items that can be delivered by it - the chosen one
+     * on Errors throw a business error from TC to catch and trigger destination completion
+     */
+    (lineItems: DeliverableItem[], options?: GetDeliverySolutionsOptions | undefined): Promise<GetDeliverySolutionsResponse>;
+}
+
+declare const getDeliverySolutions: MaybeContext<BuildRESTFunction<typeof getDeliverySolutions$1> & typeof getDeliverySolutions$1>;
+
+export { DeliverableItem, GetDeliverySolutionsOptions, GetDeliverySolutionsResponse, getDeliverySolutions };