@wix/auto_sdk_ecom_delivery-profile 1.0.83 → 1.0.84

package/build/internal/cjs/meta.d.ts

@@ -2,10 +2,9 @@ import { CreateDeliveryProfileRequest as CreateDeliveryProfileRequest$1, CreateD
 import '@wix/sdk-types';
 
 /**
- * A DeliveryProfile is a ...
- * You can ...
- * Read more about DeliveryProfiles
- * in this [article](<LINK_TO_KB_ARTICLE>).
+ * A DeliveryProfile is a collection of delivery configurations that define shipping options for products.
+ * Each profile contains delivery regions, which specify where products can be shipped and which carriers can deliver
+ * to those destinations. Use delivery profiles to organize and manage different shipping strategies for your store.
  */
 interface DeliveryProfile {
     /**
@@ -21,7 +20,10 @@ interface DeliveryProfile {
      */
     name?: string | null;
     /**
-     * Flags this DeliveryProfile as the default DeliveryProfile.
+     * Indicates whether this is the default DeliveryProfile.
+     * The first delivery profile is automatically created and marked as default when the Wix Stores app is installed.
+     * Default status cannot be changed or transferred to another profile.
+     * The default profile cannot be deleted because every site requires one for core delivery functionality.
      * @readonly
      */
     default?: boolean | null;
@@ -30,7 +32,10 @@ interface DeliveryProfile {
      * @maxSize 100
      */
     deliveryRegions?: DeliveryRegion[];
-    /** ID of the delivery profile's creator. */
+    /**
+     * Information about who created the delivery profile.
+     * Contains either an app ID (for profiles created by apps) or a user ID (for profiles created by site users).
+     */
     createdBy?: CreatedBy;
     /**
      * DeliveryProfile revision.
@@ -50,7 +55,11 @@ interface DeliveryProfile {
     /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
     extendedFields?: ExtendedFields;
 }
-/** DeliveryRegion can be used to config a Delivery Destinations with its providers */
+/**
+ * A DeliveryRegion defines a geographic area and its associated delivery carriers.
+ * Each region specifies destinations (countries and subdivisions) where products
+ * can be shipped and the carriers available for those deliveries.
+ */
 interface DeliveryRegion {
     /**
      * The delivery region id.
@@ -64,16 +73,16 @@ interface DeliveryRegion {
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this rule is active, default value is true. */
+    /** Indicates that this delivery region is active, default value is true. */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this rule, if empty than it is global.
+     * The operation region of this delivery region, if empty than it is global.
      * @maxSize 250
      */
     destinations?: Destination[];
@@ -85,7 +94,11 @@ interface DeliveryRegion {
 }
 interface DeliveryCarrier {
     /**
-     * AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api.
+     * ID of the app providing the content.
+     *
+     * You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
+     *
+     * Can be fetched by ListDeliveryCarriers api.
      * @format GUID
      */
     appId?: string;
@@ -167,7 +180,7 @@ declare enum ChargeType {
 }
 /** @enumType */
 type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE';
-/** Defines the area inside one country that is relevant for this rule. */
+/** Defines the area inside one country that is relevant for this delivery region. */
 interface Destination {
     /**
      * 2-letters code represents the country of the delivery destinations
@@ -176,7 +189,7 @@ interface Destination {
     countryCode?: string;
     /**
      * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
-     * If empty, the rule applies to the entire country.
+     * If empty, the delivery region applies to the entire country.
      * @maxSize 100
      * @minLength 1
      * @maxLength 256
@@ -232,21 +245,21 @@ interface DeliveryRegionAdded {
      */
     deliveryRegionId?: string | null;
     /**
-     * Optional name of the rule, for example: "Domestic".
+     * Optional name of the delivery region, for example: "Domestic".
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this rule is active, default value is true. */
+    /** Indicates that this delivery region is active, default value is true. */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this rule, if empty than it is global.
+     * The operation region of this delivery region, if empty than it is global.
      * @maxSize 200
      */
     destinations?: Destination[];
@@ -262,7 +275,10 @@ interface DeliveryRegionRemoved {
      * @format GUID
      */
     deliveryProfileId?: string;
-    /** The removed DeliveryRegion id. */
+    /**
+     * The removed DeliveryRegion id.
+     * @format GUID
+     */
     deliveryRegionId?: string;
 }
 interface DeliveryRegionUpdated {
@@ -278,21 +294,21 @@ interface DeliveryRegionUpdated {
      */
     deliveryRegionId?: string | null;
     /**
-     * Optional name of the rule, for example: "Domestic".
+     * Optional name of the delivery region, for example: "Domestic".
      * @minLength 1
      * @maxLength 256
      */
     name?: string | null;
-    /** Indicates that this rule is active, default value is true. */
+    /** Indicates that this delivery region is active, default value is true. */
     active?: boolean | null;
     /**
-     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * The spi implementers id of shipping-rates spi, assigned to this delivery region.
      * @maxSize 25
      * @readonly
      */
     deliveryCarriers?: DeliveryCarrier[];
     /**
-     * The operation region of this rule, if empty than it is global.
+     * The operation region of this delivery region, if empty than it is global.
      * @maxSize 200
      */
     destinations?: Destination[];
@@ -1132,10 +1148,12 @@ declare enum Namespace {
     /** Wix Twins platform. */
     TWINS = "TWINS",
     /** Wix Nano. */
-    NANO = "NANO"
+    NANO = "NANO",
+    /** Base44 headless sites. */
+    BASE44 = "BASE44"
 }
 /** @enumType */
-type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
+type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44';
 /** Site transferred to another user. */
 interface SiteTransferred {
     /**

package/build/internal/cjs/meta.js

@@ -703,6 +703,7 @@ var Namespace = /* @__PURE__ */ ((Namespace2) => {
   Namespace2["MIMIR"] = "MIMIR";
   Namespace2["TWINS"] = "TWINS";
   Namespace2["NANO"] = "NANO";
+  Namespace2["BASE44"] = "BASE44";
   return Namespace2;
 })(Namespace || {});
 var DeleteStatus = /* @__PURE__ */ ((DeleteStatus2) => {