@wix/auto_sdk_ecom_local-delivery-options 1.0.2 → 1.0.4

package/build/internal/meta.d.mts

@@ -0,0 +1,515 @@
+import { w as CreateLocalDeliveryOptionRequest$1, x as CreateLocalDeliveryOptionResponse$1, y as GetLocalDeliveryOptionRequest$1, z as GetLocalDeliveryOptionResponse$1, E as ListLocalDeliveryOptionsRequest$1, a as ListLocalDeliveryOptionsResponse$1, Q as QueryLocalDeliveryOptionsRequest$1, K as QueryLocalDeliveryOptionsResponse$1, O as UpdateLocalDeliveryOptionRequest$1, V as UpdateLocalDeliveryOptionResponse$1, X as DeleteLocalDeliveryOptionRequest$1, Y as DeleteLocalDeliveryOptionResponse$1, _ as BulkCreateLocalDeliveryOptionRequest$1, B as BulkCreateLocalDeliveryOptionResponse$1, a0 as BulkUpdateLocalDeliveryOptionRequest$1, c as BulkUpdateLocalDeliveryOptionResponse$1, a1 as BulkDeleteLocalDeliveryOptionRequest$1, a2 as BulkDeleteLocalDeliveryOptionResponse$1, ab as AddDeliveryRegionRequest$1, d as AddDeliveryRegionResponse$1, ac as RemoveDeliveryRegionRequest$1, e as RemoveDeliveryRegionResponse$1 } from './ecom-v1-local-delivery-option-local-delivery-options.universal-D5yj1G8h.mjs';
+
+interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
+    zipConfig?: ZipCodeConfig;
+    radiusConfig?: RadiusConfig;
+    customAreaConfig?: CustomAreaConfig;
+    /**
+     * LocalDeliveryOptionId - unique identifier of local delivery option
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * 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
+     * @maxLength 40
+     */
+    estimatedDeliveryTime?: string | null;
+    /**
+     * Minimum order total to be eligible for free delivery
+     * @deprecated Minimum order total to be eligible for free delivery
+     * @targetRemovalDate 2025-01-12
+     */
+    minimumFreeDeliveryOrderAmount?: number | null;
+    /**
+     * List of countries with subdivisions
+     * @maxSize 100
+     */
+    destinations?: Destination[];
+    /**
+     * Database revision of LocalDeliveryOption entity. Incremented on each modification
+     * @readonly
+     */
+    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.
+     * @maxSize 50
+     */
+    rates?: ConditionalRates[];
+    /**
+     * Date and time the LocalDeliveryOption was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the LocalDeliveryOption was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * This local delivery is active for the following delivery regions.
+     * @maxSize 5
+     * @format GUID
+     */
+    deliveryRegionIds?: string[];
+}
+/** @oneof */
+interface LocalDeliveryOptionConfigOneOf {
+    zipConfig?: ZipCodeConfig;
+    radiusConfig?: RadiusConfig;
+    customAreaConfig?: CustomAreaConfig;
+}
+interface Destination {
+    /**
+     * Country ISO code
+     * @format COUNTRY
+     */
+    code?: string;
+    /**
+     * List of subdivisions, empty means all
+     * @maxSize 200
+     */
+    subdivisions?: string[];
+}
+interface ZipCodeConfig {
+    /**
+     * List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*
+     * @minLength 1
+     * @maxLength 300
+     */
+    zipCodes?: string[];
+}
+interface RadiusConfig {
+    /** Delivery-from address */
+    address?: LocalDeliveryAddress;
+    /**
+     * Delivery circle's radius
+     * @min 0.1
+     * @max 50
+     */
+    radius?: number;
+    /**
+     * Radius' unit, taken from site properties
+     * @readonly
+     */
+    lengthUnit?: LengthUnit;
+}
+interface LocalDeliveryAddress {
+    /**
+     * A string containing the human-readable address of this location
+     * @maxLength 400
+     */
+    formattedAddress?: string | null;
+    /** coordinates of the physical address */
+    geocode?: AddressLocation;
+}
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+declare enum LengthUnit {
+    /** Length unit can't be classified, due to an error */
+    UNSPECIFIED_LENGTH_UNIT = "UNSPECIFIED_LENGTH_UNIT",
+    /** Kilometers */
+    KM = "KM",
+    /** Miles */
+    MI = "MI"
+}
+interface CustomAreaConfig {
+    /**
+     * Geocodes of the polygon defining the delivery area.
+     * @maxSize 300
+     */
+    geocodes?: AddressLocation[];
+}
+interface ScheduledDelivery {
+    /**
+     * Days config which contain days when delivery is enabled with it's time slots
+     * @deprecated Days config which contain days when delivery is enabled with it's time slots
+     * @replacedBy time_windows
+     * @targetRemovalDate 2025-01-01
+     */
+    days?: Days;
+    /**
+     * 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.
+     * @maxSize 100
+     */
+    timeWindows?: TimeWindow[];
+}
+interface Days {
+    monday?: DaySlot;
+    tuesday?: DaySlot;
+    wednesday?: DaySlot;
+    thursday?: DaySlot;
+    friday?: DaySlot;
+    saturday?: DaySlot;
+    sunday?: DaySlot;
+}
+interface DaySlot {
+    /** Shows whether this day slot is enabled for delivery */
+    enabledForDelivery?: boolean | null;
+    /**
+     * Time slots for scheduled delivery during day
+     * @maxSize 8
+     */
+    timeSlots?: TimeSlot[];
+}
+interface TimeSlot {
+    /** Starting time point of time slot */
+    from?: TimePoint;
+    /** End time point of time slot */
+    to?: TimePoint;
+}
+interface TimePoint {
+    /**
+     * Hours in format 0-23
+     * @max 23
+     */
+    hours?: number | null;
+    /**
+     * Minutes 0-59
+     * @max 59
+     */
+    minutes?: number | null;
+}
+interface TimeWindow {
+    /** The day of week this availability relates to. */
+    day?: DayOfWeek;
+    /** The start time in time of day representation. */
+    start?: TimeOfDay;
+    /** The end time in time of day representation. */
+    end?: TimeOfDay;
+    /** Whether this timeWindow availability is enabled. */
+    enabled?: boolean | null;
+}
+declare enum DayOfWeek {
+    /** Monday. */
+    MON = "MON",
+    /** Tuesday. */
+    TUE = "TUE",
+    /** Wednesday. */
+    WED = "WED",
+    /** Thursday. */
+    THU = "THU",
+    /** Friday. */
+    FRI = "FRI",
+    /** Saturday. */
+    SAT = "SAT",
+    /** Sunday. */
+    SUN = "SUN"
+}
+interface TimeOfDay {
+    /**
+     * Hours
+     * @max 23
+     */
+    hours?: number;
+    /**
+     * Minutes
+     * @max 59
+     */
+    minutes?: number;
+}
+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;
+}
+interface Condition {
+    type?: ConditionType;
+    /**
+     * The value in respective to the condition type
+     * 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;
+}
+declare enum ConditionType {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    BY_TOTAL_WEIGHT = "BY_TOTAL_WEIGHT",
+    BY_TOTAL_PRICE = "BY_TOTAL_PRICE",
+    BY_TOTAL_QUANTITY = "BY_TOTAL_QUANTITY"
+}
+declare enum LogicalOperator {
+    UNKNOWN_LOGICAL_OPERATOR_TYPE = "UNKNOWN_LOGICAL_OPERATOR_TYPE",
+    EQ = "EQ",
+    GT = "GT",
+    GTE = "GTE",
+    LT = "LT",
+    LTE = "LTE"
+}
+interface CreateLocalDeliveryOptionRequest {
+    localDeliveryOption: LocalDeliveryOption;
+}
+interface CreateLocalDeliveryOptionResponse {
+    localDeliveryOption?: LocalDeliveryOption;
+}
+interface GetLocalDeliveryOptionRequest {
+    /**
+     * @maxLength 50
+     * @deprecated
+     * @targetRemovalDate 2025-01-12
+     */
+    id?: string;
+    /** @maxLength 50 */
+    localDeliveryOptionId: string;
+}
+interface GetLocalDeliveryOptionResponse {
+    localDeliveryOption?: LocalDeliveryOption;
+}
+interface ListLocalDeliveryOptionsRequest {
+    /** @format GUID */
+    externalId: string;
+}
+interface ListLocalDeliveryOptionsResponse {
+    localDeliveryOptions?: LocalDeliveryOption[];
+}
+interface QueryLocalDeliveryOptionsRequest {
+    /** WQL expression */
+    query: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * 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.
+     * @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.
+     * @maxSize 100
+     * @maxLength 20
+     */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * 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;
+}
+interface QueryLocalDeliveryOptionsResponse {
+    /** Retrieved local delivery options. */
+    localDeliveryOptions?: LocalDeliveryOption[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * 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.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface UpdateLocalDeliveryOptionRequest {
+    /** LocalDeliveryOption to be updated, may be partial. */
+    localDeliveryOption: LocalDeliveryOption;
+}
+interface UpdateLocalDeliveryOptionResponse {
+    localDeliveryOption?: LocalDeliveryOption;
+}
+interface DeleteLocalDeliveryOptionRequest {
+    /**
+     * @maxLength 50
+     * @deprecated
+     * @targetRemovalDate 2025-01-12
+     */
+    id?: string;
+    /** @maxLength 50 */
+    localDeliveryOptionId: string;
+}
+interface DeleteLocalDeliveryOptionResponse {
+}
+interface BulkCreateLocalDeliveryOptionRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    localDeliveryOptions: LocalDeliveryOption[];
+}
+interface BulkCreateLocalDeliveryOptionResponse {
+    localDeliveryOptions?: LocalDeliveryOption[];
+    errors?: LocalDeliveryOptionError[];
+}
+interface LocalDeliveryOptionError {
+    id?: string;
+    error?: string;
+}
+interface BulkUpdateLocalDeliveryOptionRequest {
+    /**
+     * @minSize 1
+     * @maxSize 100
+     */
+    localDeliveryOptions: LocalDeliveryOption[];
+}
+interface BulkUpdateLocalDeliveryOptionResponse {
+    localDeliveryOptions?: LocalDeliveryOption[];
+    errors?: LocalDeliveryOptionError[];
+}
+interface BulkDeleteLocalDeliveryOptionRequest {
+    /**
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    ids: string[];
+}
+interface BulkDeleteLocalDeliveryOptionResponse {
+}
+interface AddDeliveryRegionRequest {
+    /** @format GUID */
+    deliveryRegionId: string;
+    /** @format GUID */
+    localDeliveryOptionId: string;
+    /** Revision of the PickupLocation */
+    revision?: string | null;
+}
+interface AddDeliveryRegionResponse {
+    localDeliveryOption?: LocalDeliveryOption;
+}
+interface RemoveDeliveryRegionRequest {
+    /** @format GUID */
+    deliveryRegionId: string;
+    /** @format GUID */
+    localDeliveryOptionId: string;
+    /** Revision of the PickupLocation */
+    revision?: string | null;
+}
+interface RemoveDeliveryRegionResponse {
+    localDeliveryOption?: LocalDeliveryOption;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createLocalDeliveryOption(): __PublicMethodMetaInfo<'POST', {}, CreateLocalDeliveryOptionRequest$1, CreateLocalDeliveryOptionRequest, CreateLocalDeliveryOptionResponse$1, CreateLocalDeliveryOptionResponse>;
+declare function getLocalDeliveryOption(): __PublicMethodMetaInfo<'GET', {
+    localDeliveryOptionId: string;
+}, GetLocalDeliveryOptionRequest$1, GetLocalDeliveryOptionRequest, GetLocalDeliveryOptionResponse$1, GetLocalDeliveryOptionResponse>;
+declare function listLocalDeliveryOptions(): __PublicMethodMetaInfo<'GET', {}, ListLocalDeliveryOptionsRequest$1, ListLocalDeliveryOptionsRequest, ListLocalDeliveryOptionsResponse$1, ListLocalDeliveryOptionsResponse>;
+declare function queryLocalDeliveryOptions(): __PublicMethodMetaInfo<'POST', {}, QueryLocalDeliveryOptionsRequest$1, QueryLocalDeliveryOptionsRequest, QueryLocalDeliveryOptionsResponse$1, QueryLocalDeliveryOptionsResponse>;
+declare function updateLocalDeliveryOption(): __PublicMethodMetaInfo<'PATCH', {
+    localDeliveryOptionId: string;
+}, UpdateLocalDeliveryOptionRequest$1, UpdateLocalDeliveryOptionRequest, UpdateLocalDeliveryOptionResponse$1, UpdateLocalDeliveryOptionResponse>;
+declare function deleteLocalDeliveryOption(): __PublicMethodMetaInfo<'DELETE', {
+    localDeliveryOptionId: string;
+}, DeleteLocalDeliveryOptionRequest$1, DeleteLocalDeliveryOptionRequest, DeleteLocalDeliveryOptionResponse$1, DeleteLocalDeliveryOptionResponse>;
+declare function bulkCreateLocalDeliveryOption(): __PublicMethodMetaInfo<'POST', {}, BulkCreateLocalDeliveryOptionRequest$1, BulkCreateLocalDeliveryOptionRequest, BulkCreateLocalDeliveryOptionResponse$1, BulkCreateLocalDeliveryOptionResponse>;
+declare function bulkUpdateLocalDeliveryOption(): __PublicMethodMetaInfo<'PATCH', {}, BulkUpdateLocalDeliveryOptionRequest$1, BulkUpdateLocalDeliveryOptionRequest, BulkUpdateLocalDeliveryOptionResponse$1, BulkUpdateLocalDeliveryOptionResponse>;
+declare function bulkDeleteLocalDeliveryOption(): __PublicMethodMetaInfo<'DELETE', {}, BulkDeleteLocalDeliveryOptionRequest$1, BulkDeleteLocalDeliveryOptionRequest, BulkDeleteLocalDeliveryOptionResponse$1, BulkDeleteLocalDeliveryOptionResponse>;
+declare function addDeliveryRegion(): __PublicMethodMetaInfo<'POST', {}, AddDeliveryRegionRequest$1, AddDeliveryRegionRequest, AddDeliveryRegionResponse$1, AddDeliveryRegionResponse>;
+declare function removeDeliveryRegion(): __PublicMethodMetaInfo<'POST', {}, RemoveDeliveryRegionRequest$1, RemoveDeliveryRegionRequest, RemoveDeliveryRegionResponse$1, RemoveDeliveryRegionResponse>;
+
+export { type __PublicMethodMetaInfo, addDeliveryRegion, bulkCreateLocalDeliveryOption, bulkDeleteLocalDeliveryOption, bulkUpdateLocalDeliveryOption, createLocalDeliveryOption, deleteLocalDeliveryOption, getLocalDeliveryOption, listLocalDeliveryOptions, queryLocalDeliveryOptions, removeDeliveryRegion, updateLocalDeliveryOption };