@wix/auto_sdk_ecom_local-delivery-options 1.0.0 → 1.0.2

package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.d.ts

@@ -4,18 +4,26 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
     customAreaConfig?: CustomAreaConfig;
     /**
      * LocalDeliveryOptionId - unique identifier of local delivery option
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Area name of Local Delivery Option */
+    /**
+     * Area name of Local Delivery Option
+     * @maxLength 100
+     */
     areaName?: string | null;
     /**
      * Flat price of local delivery
+     * @format DECIMAL_VALUE
      * @deprecated Flat price of local delivery
      * @targetRemovalDate 2025-01-12
      */
     rate?: string | null;
-    /** Estimated delivery time description text */
+    /**
+     * Estimated delivery time description text
+     * @maxLength 40
+     */
     estimatedDeliveryTime?: string | null;
     /**
      * Minimum order total to be eligible for free delivery
@@ -23,7 +31,10 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
      * @targetRemovalDate 2025-01-12
      */
     minimumFreeDeliveryOrderAmount?: number | null;
-    /** List of countries with subdivisions */
+    /**
+     * List of countries with subdivisions
+     * @maxSize 100
+     */
     destinations?: Destination[];
     /**
      * Database revision of LocalDeliveryOption entity. Incremented on each modification
@@ -31,7 +42,10 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
      */
     revision?: string | null;
     scheduledDeliveryConfig?: ScheduledDelivery;
-    /** at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one. */
+    /**
+     * at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one.
+     * @maxSize 50
+     */
     rates?: ConditionalRates[];
     /**
      * Date and time the LocalDeliveryOption was created.
@@ -43,7 +57,11 @@ export interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
      * @readonly
      */
     updatedDate?: Date | null;
-    /** This local delivery is active for the following delivery regions. */
+    /**
+     * This local delivery is active for the following delivery regions.
+     * @maxSize 5
+     * @format GUID
+     */
     deliveryRegionIds?: string[];
 }
 /** @oneof */
@@ -53,19 +71,33 @@ export interface LocalDeliveryOptionConfigOneOf {
     customAreaConfig?: CustomAreaConfig;
 }
 export interface Destination {
-    /** Country ISO code */
+    /**
+     * Country ISO code
+     * @format COUNTRY
+     */
     code?: string;
-    /** List of subdivisions, empty means all */
+    /**
+     * List of subdivisions, empty means all
+     * @maxSize 200
+     */
     subdivisions?: string[];
 }
 export interface ZipCodeConfig {
-    /** List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000* */
+    /**
+     * List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*
+     * @minLength 1
+     * @maxLength 300
+     */
     zipCodes?: string[];
 }
 export interface RadiusConfig {
     /** Delivery-from address */
     address?: LocalDeliveryAddress;
-    /** Delivery circle's radius */
+    /**
+     * Delivery circle's radius
+     * @min 0.1
+     * @max 50
+     */
     radius?: number;
     /**
      * Radius' unit, taken from site properties
@@ -74,7 +106,10 @@ export interface RadiusConfig {
     lengthUnit?: LengthUnit;
 }
 export interface LocalDeliveryAddress {
-    /** A string containing the human-readable address of this location */
+    /**
+     * A string containing the human-readable address of this location
+     * @maxLength 400
+     */
     formattedAddress?: string | null;
     /** coordinates of the physical address */
     geocode?: AddressLocation;
@@ -94,7 +129,10 @@ export declare enum LengthUnit {
     MI = "MI"
 }
 export interface CustomAreaConfig {
-    /** Geocodes of the polygon defining the delivery area. */
+    /**
+     * Geocodes of the polygon defining the delivery area.
+     * @maxSize 300
+     */
     geocodes?: AddressLocation[];
 }
 export interface ScheduledDelivery {
@@ -105,11 +143,17 @@ export interface ScheduledDelivery {
      * @targetRemovalDate 2025-01-01
      */
     days?: Days;
-    /** Amount of days before first delivery option date */
+    /**
+     * Amount of days before first delivery option date
+     * @max 30
+     */
     handlingDays?: number | null;
     /** Cut off time after which first delivery option would be for next day */
     cutOffTime?: TimePoint;
-    /** availability times configuration. */
+    /**
+     * availability times configuration.
+     * @maxSize 100
+     */
     timeWindows?: TimeWindow[];
 }
 export interface Days {
@@ -124,7 +168,10 @@ export interface Days {
 export interface DaySlot {
     /** Shows whether this day slot is enabled for delivery */
     enabledForDelivery?: boolean | null;
-    /** Time slots for scheduled delivery during day */
+    /**
+     * Time slots for scheduled delivery during day
+     * @maxSize 8
+     */
     timeSlots?: TimeSlot[];
 }
 export interface TimeSlot {
@@ -134,9 +181,15 @@ export interface TimeSlot {
     to?: TimePoint;
 }
 export interface TimePoint {
-    /** Hours in format 0-23 */
+    /**
+     * Hours in format 0-23
+     * @max 23
+     */
     hours?: number | null;
-    /** Minutes 0-59 */
+    /**
+     * Minutes 0-59
+     * @max 59
+     */
     minutes?: number | null;
 }
 export interface TimeWindow {
@@ -166,18 +219,31 @@ export declare enum DayOfWeek {
     SUN = "SUN"
 }
 export interface TimeOfDay {
-    /** Hours */
+    /**
+     * Hours
+     * @max 23
+     */
     hours?: number;
-    /** Minutes */
+    /**
+     * Minutes
+     * @max 59
+     */
     minutes?: number;
 }
 export interface ConditionalRates {
     /**
      * there is an AND logic between all the conditions. Empty conditions means true.
      * For example: weight > 0 and weight <= 10
+     * @maxSize 10
      */
     conditions?: Condition[];
+    /**
+     * The amount of the rate that will be returned if all conditions are met.
+     * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
+     */
     amount?: string;
+    /** When this flag is set to true, multiply the amount by the number of line items passed on the request. */
+    multiplyByQuantity?: boolean;
 }
 export interface Condition {
     type?: ConditionType;
@@ -186,6 +252,7 @@ export interface Condition {
      * Weight values should be in the same weight units of the store: KG / LB
      * Total price is according to the store currency
      * Quantity of items should be integers
+     * @decimalValue options { gte:0, lte:999999999, maxScale:6 }
      */
     value?: string;
     operator?: LogicalOperator;
@@ -212,16 +279,19 @@ export interface CreateLocalDeliveryOptionResponse {
 }
 export interface GetLocalDeliveryOptionRequest {
     /**
+     * @maxLength 50
      * @deprecated
      * @targetRemovalDate 2025-01-12
      */
     id?: string;
+    /** @maxLength 50 */
     localDeliveryOptionId: string;
 }
 export interface GetLocalDeliveryOptionResponse {
     localDeliveryOption?: LocalDeliveryOption;
 }
 export interface ListLocalDeliveryOptionsRequest {
+    /** @format GUID */
     externalId: string;
 }
 export interface ListLocalDeliveryOptionsResponse {
@@ -246,11 +316,20 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
      * Sort object.
      *
      * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
      */
     sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxSize 100
+     * @maxLength 20
+     */
     fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    /**
+     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxSize 100
+     * @maxLength 20
+     */
     fieldsets?: string[];
 }
 /** @oneof */
@@ -261,7 +340,10 @@ export interface QueryV2PagingMethodOneOf {
     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;
@@ -277,13 +359,17 @@ export interface Paging {
     offset?: number | null;
 }
 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;
 }
@@ -307,9 +393,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 UpdateLocalDeliveryOptionRequest {
@@ -321,15 +413,21 @@ export interface UpdateLocalDeliveryOptionResponse {
 }
 export interface DeleteLocalDeliveryOptionRequest {
     /**
+     * @maxLength 50
      * @deprecated
      * @targetRemovalDate 2025-01-12
      */
     id?: string;
+    /** @maxLength 50 */
     localDeliveryOptionId: string;
 }
 export interface DeleteLocalDeliveryOptionResponse {
 }
 export interface BulkCreateLocalDeliveryOptionRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
     localDeliveryOptions: LocalDeliveryOption[];
 }
 export interface BulkCreateLocalDeliveryOptionResponse {
@@ -341,6 +439,10 @@ export interface LocalDeliveryOptionError {
     error?: string;
 }
 export interface BulkUpdateLocalDeliveryOptionRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
     localDeliveryOptions: LocalDeliveryOption[];
 }
 export interface BulkUpdateLocalDeliveryOptionResponse {
@@ -348,6 +450,11 @@ export interface BulkUpdateLocalDeliveryOptionResponse {
     errors?: LocalDeliveryOptionError[];
 }
 export interface BulkDeleteLocalDeliveryOptionRequest {
+    /**
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
     ids: string[];
 }
 export interface BulkDeleteLocalDeliveryOptionResponse {
@@ -427,7 +534,9 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface AddDeliveryRegionRequest {
+    /** @format GUID */
     deliveryRegionId: string;
+    /** @format GUID */
     localDeliveryOptionId: string;
     /** Revision of the PickupLocation */
     revision?: string | null;
@@ -436,7 +545,9 @@ export interface AddDeliveryRegionResponse {
     localDeliveryOption?: LocalDeliveryOption;
 }
 export interface RemoveDeliveryRegionRequest {
+    /** @format GUID */
     deliveryRegionId: string;
+    /** @format GUID */
     localDeliveryOptionId: string;
     /** Revision of the PickupLocation */
     revision?: string | null;
@@ -445,9 +556,15 @@ export interface RemoveDeliveryRegionResponse {
     localDeliveryOption?: LocalDeliveryOption;
 }
 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;
@@ -455,26 +572,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 {
@@ -515,6 +656,7 @@ interface ConditionNonNullableFields {
 interface ConditionalRatesNonNullableFields {
     conditions: ConditionNonNullableFields[];
     amount: string;
+    multiplyByQuantity: boolean;
 }
 interface LocalDeliveryOptionNonNullableFields {
     zipConfig?: ZipCodeConfigNonNullableFields;

package/build/cjs/src/ecom-v1-local-delivery-option-local-delivery-options.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-v1-local-delivery-option-local-delivery-options.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-local-delivery-option-local-delivery-options.types.ts"],"names":[],"mappings":";;;AA8FA,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,YAAY;IACZ,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAiED,IAAY,SAeX;AAfD,WAAY,SAAS;IACnB,cAAc;IACd,wBAAW,CAAA;IACX,eAAe;IACf,wBAAW,CAAA;IACX,iBAAiB;IACjB,wBAAW,CAAA;IACX,gBAAgB;IAChB,wBAAW,CAAA;IACX,cAAc;IACd,wBAAW,CAAA;IACX,gBAAgB;IAChB,wBAAW,CAAA;IACX,cAAc;IACd,wBAAW,CAAA;AACb,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB;AA8BD,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,8CAA6B,CAAA;IAC7B,oDAAmC,CAAA;IACnC,kDAAiC,CAAA;IACjC,wDAAuC,CAAA;AACzC,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAED,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,kFAA+D,CAAA;IAC/D,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,8BAAW,CAAA;AACb,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AA0ED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA6OD,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-local-delivery-option-local-delivery-options.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-local-delivery-option-local-delivery-options.types.ts"],"names":[],"mappings":";;;AAiIA,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,uDAAuD;IACvD,iEAAmD,CAAA;IACnD,iBAAiB;IACjB,uBAAS,CAAA;IACT,YAAY;IACZ,uBAAS,CAAA;AACX,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAmFD,IAAY,SAeX;AAfD,WAAY,SAAS;IACnB,cAAc;IACd,wBAAW,CAAA;IACX,eAAe;IACf,wBAAW,CAAA;IACX,iBAAiB;IACjB,wBAAW,CAAA;IACX,gBAAgB;IAChB,wBAAW,CAAA;IACX,cAAc;IACd,wBAAW,CAAA;IACX,gBAAgB;IAChB,wBAAW,CAAA;IACX,cAAc;IACd,wBAAW,CAAA;AACb,CAAC,EAfW,SAAS,yBAAT,SAAS,QAepB;AA4CD,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,8CAA6B,CAAA;IAC7B,oDAAmC,CAAA;IACnC,kDAAiC,CAAA;IACjC,wDAAuC,CAAA;AACzC,CAAC,EALW,aAAa,6BAAb,aAAa,QAKxB;AAED,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,kFAA+D,CAAA;IAC/D,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,8BAAW,CAAA;IACX,4BAAS,CAAA;IACT,8BAAW,CAAA;AACb,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AAyFD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAwSD,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"}