@wix/auto_sdk_ecom_shippo-configurations 1.0.0 → 1.0.2

package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts

@@ -1,6 +1,7 @@
 export interface ShippoConfiguration {
     /**
      * ShippoConfiguration ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -16,29 +17,61 @@ export interface ShippoConfiguration {
      * @readonly
      */
     updatedDate?: Date | null;
-    /** Associated delivery region ID. */
+    /**
+     * Associated delivery region ID.
+     * @format GUID
+     * @immutable
+     * @deprecated Associated delivery region ID.
+     * @replacedBy delivery_region_ids
+     * @targetRemovalDate 2025-06-01
+     */
     deliveryRegionId?: string | null;
-    /** Settings of USPS domestic services. */
+    /**
+     * Settings of USPS domestic services.
+     * @maxSize 3
+     */
     domesticServices?: DomesticServiceSettings[];
-    /** Settings of USPS international services. */
+    /**
+     * Settings of USPS international services.
+     * @maxSize 3
+     */
     internationalServices?: InternationalServiceSettings[];
     /** Package type. */
     packageType?: PackageType;
     /** Package details. */
     packageDetails?: PackageDetails;
-    /** Location ID from OS location service. */
+    /**
+     * Location ID from OS location service.
+     * @format GUID
+     */
     osLocationId?: string | null;
     /**
      * Ship from address materialized from OS location.
      * @readonly
      */
     shipFromAddress?: Address;
-    /** Backup weight. */
+    /**
+     * This shippo configuration is active for the following delivery regions.
+     * @maxSize 5
+     * @format GUID
+     * @immutable
+     */
+    deliveryRegionIds?: string[];
+    /**
+     * Backup weight.
+     * @decimalValue options { gte:0, maxScale:3 }
+     */
     backupWeight?: string | null;
     /** Data extensions. */
     extendedFields?: ExtendedFields;
 }
 export interface DomesticServiceSettings {
+    /**
+     * DomesticServiceSettings ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
     /** USPS domestic service. */
     service?: DomesticService;
     /** Service settings. */
@@ -51,15 +84,24 @@ export declare enum DomesticService {
     PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS"
 }
 export interface ServiceSettings {
-    /** Estimated delivery time. */
+    /**
+     * Estimated delivery time.
+     * @maxLength 500
+     */
     estimatedDeliveryTime?: string | null;
     /** Handling fee. */
     handlingFee?: HandlingFee;
-    /** Amount above which free delivery is offered. */
+    /**
+     * Amount above which free delivery is offered.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     freeDeliveryMinimumAmount?: string | null;
 }
 export interface HandlingFee {
-    /** Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee. */
+    /**
+     * Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     value?: string;
     /** How to calculate the fee: fixed amount or by percentage. */
     calculationType?: CalculationType;
@@ -70,6 +112,12 @@ export declare enum CalculationType {
     PERCENTAGE = "PERCENTAGE"
 }
 export interface InternationalServiceSettings {
+    /**
+     * InternationalServiceSettings ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
     /** USPS international service. */
     service?: InternationalService;
     /** Service settings. */
@@ -96,6 +144,7 @@ export interface PackageDetails {
      * Package name. Must be set when package type is CUSTOM.
      * For other package types, it is read-only, and an exception will be thrown
      * if it set when creating a ShippoConfiguration.
+     * @maxLength 255
      */
     name?: string | null;
     /**
@@ -112,28 +161,55 @@ export interface PackageDetails {
     maxNumberOfProducts?: string | null;
 }
 export interface PackageDimensions {
-    /** Package length. */
+    /**
+     * Package length.
+     * @decimalValue options { gte:0, maxScale:3 }
+     */
     length?: string;
-    /** Package width. */
+    /**
+     * Package width.
+     * @decimalValue options { gte:0, maxScale:3 }
+     */
     width?: string;
-    /** Package height. */
+    /**
+     * Package height.
+     * @decimalValue options { gte:0, maxScale:3 }
+     */
     height?: string;
 }
 /** Physical address */
 export interface Address {
-    /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
+    /**
+     * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
+     * @format COUNTRY
+     */
     country?: string | null;
-    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
+    /**
+     * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
+     * @maxLength 50
+     */
     subdivision?: string | null;
-    /** City name. */
+    /**
+     * City name.
+     * @maxLength 50
+     */
     city?: string | null;
-    /** Postal or zip code. */
+    /**
+     * Postal or zip code.
+     * @maxLength 50
+     */
     postalCode?: string | null;
     /** Street address. */
     streetAddress?: StreetAddress;
-    /** Main address line (usually street name and number). */
+    /**
+     * Main address line (usually street name and number).
+     * @maxLength 150
+     */
     addressLine?: string | null;
-    /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
+    /**
+     * Free text providing more detailed address info. Usually contains apt, suite, floor.
+     * @maxLength 100
+     */
     addressLine2?: string | null;
     /**
      * Country's full name.
@@ -172,6 +248,7 @@ export interface ExtendedFields {
 export interface CreateShippoConfigurationRequest {
     /** ShippoConfiguration to be created. */
     shippoConfiguration: ShippoConfiguration;
+    /** @decimalValue options { gte:0, maxScale:6 } */
     backupRate?: string | null;
 }
 export interface CreateShippoConfigurationResponse {
@@ -179,7 +256,10 @@ export interface CreateShippoConfigurationResponse {
     shippoConfiguration?: ShippoConfiguration;
 }
 export interface GetShippoConfigurationRequest {
-    /** ID of the ShippoConfiguration to retrieve. */
+    /**
+     * ID of the ShippoConfiguration to retrieve.
+     * @format GUID
+     */
     shippoConfigurationId: string;
 }
 export interface GetShippoConfigurationResponse {
@@ -195,7 +275,10 @@ export interface UpdateShippoConfigurationResponse {
     shippoConfiguration?: ShippoConfiguration;
 }
 export interface DeleteShippoConfigurationRequest {
-    /** ID of the ShippoConfiguration to delete. */
+    /**
+     * ID of the ShippoConfiguration to delete.
+     * @format GUID
+     */
     shippoConfigurationId: string;
 }
 export interface DeleteShippoConfigurationResponse {
@@ -219,6 +302,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -228,7 +312,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -238,13 +325,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -268,9 +359,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface UpdateExtendedFieldsRequest {
@@ -360,9 +457,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -370,26 +473,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -436,6 +563,7 @@ interface ShippoConfigurationNonNullableFields {
     packageType: PackageType;
     packageDetails?: PackageDetailsNonNullableFields;
     shipFromAddress?: AddressNonNullableFields;
+    deliveryRegionIds: string[];
 }
 export interface CreateShippoConfigurationResponseNonNullableFields {
     shippoConfiguration?: ShippoConfigurationNonNullableFields;

package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-shippo-configuration-shippo-configurations.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-shippo-configuration-shippo-configurations.types.ts"],"names":[],"mappings":";;;AAgDA,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,wDAAqC,CAAA;IACrC,kDAA+B,CAAA;IAC/B,kEAA+C,CAAA;AACjD,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AAkBD,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gDAA6B,CAAA;IAC7B,kCAAe,CAAA;IACf,4CAAyB,CAAA;AAC3B,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AASD,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,uFAA+D,CAAA;IAC/D,+FAAuE,CAAA;IACvE,mFAA2D,CAAA;IAC3D,mGAA2E,CAAA;AAC7E,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED,IAAY,WASX;AATD,WAAY,WAAW;IACrB,4DAA6C,CAAA;IAC7C,gCAAiB,CAAA;IACjB,wDAAyC,CAAA;IACzC,sEAAuD,CAAA;IACvD,0DAA2C,CAAA;IAC3C,gEAAiD,CAAA;IACjD,gEAAiD,CAAA;IACjD,0DAA2C,CAAA;AAC7C,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAiKD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA6KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"ecom-v1-shippo-configuration-shippo-configurations.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-shippo-configuration-shippo-configurations.types.ts"],"names":[],"mappings":";;;AAiFA,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,wDAAqC,CAAA;IACrC,kDAA+B,CAAA;IAC/B,kEAA+C,CAAA;AACjD,CAAC,EALW,eAAe,+BAAf,eAAe,QAK1B;AA2BD,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gDAA6B,CAAA;IAC7B,kCAAe,CAAA;IACf,4CAAyB,CAAA;AAC3B,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAeD,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,uFAA+D,CAAA;IAC/D,+FAAuE,CAAA;IACvE,mFAA2D,CAAA;IAC3D,mGAA2E,CAAA;AAC7E,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED,IAAY,WASX;AATD,WAAY,WAAW;IACrB,4DAA6C,CAAA;IAC7C,gCAAiB,CAAA;IACjB,wDAAyC,CAAA;IACzC,sEAAuD,CAAA;IACvD,0DAA2C,CAAA;IAC3C,gEAAiD,CAAA;IACjD,gEAAiD,CAAA;IACjD,0DAA2C,CAAA;AAC7C,CAAC,EATW,WAAW,2BAAX,WAAW,QAStB;AAwMD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAqND,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}