@wix/auto_sdk_ecom_local-delivery-options 1.0.33 → 1.0.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +9 -9
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +80 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +13 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +9 -9
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +80 -8
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +13 -1
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +9 -9
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +80 -8
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +13 -1
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +9 -9
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +80 -8
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +13 -1
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
|
+
import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
3
|
interface LocalDeliveryOption extends LocalDeliveryOptionConfigOneOf {
|
|
4
4
|
zipConfig?: ZipCodeConfig;
|
|
5
5
|
radiusConfig?: RadiusConfig;
|
|
6
6
|
customAreaConfig?: CustomAreaConfig;
|
|
7
|
+
cityConfig?: CityConfig;
|
|
7
8
|
/**
|
|
8
9
|
* LocalDeliveryOptionId - unique identifier of local delivery option
|
|
9
10
|
* @format GUID
|
|
@@ -71,6 +72,7 @@ interface LocalDeliveryOptionConfigOneOf {
|
|
|
71
72
|
zipConfig?: ZipCodeConfig;
|
|
72
73
|
radiusConfig?: RadiusConfig;
|
|
73
74
|
customAreaConfig?: CustomAreaConfig;
|
|
75
|
+
cityConfig?: CityConfig;
|
|
74
76
|
}
|
|
75
77
|
interface Destination {
|
|
76
78
|
/**
|
|
@@ -139,6 +141,16 @@ interface CustomAreaConfig {
|
|
|
139
141
|
*/
|
|
140
142
|
geocodes?: AddressLocation[];
|
|
141
143
|
}
|
|
144
|
+
interface CityConfig {
|
|
145
|
+
/**
|
|
146
|
+
* Name of the city for delivery
|
|
147
|
+
* @minLength 1
|
|
148
|
+
* @maxLength 100
|
|
149
|
+
* @minSize 1
|
|
150
|
+
* @maxSize 50
|
|
151
|
+
*/
|
|
152
|
+
cities?: string[];
|
|
153
|
+
}
|
|
142
154
|
interface ScheduledDelivery {
|
|
143
155
|
/**
|
|
144
156
|
* Days config which contain days when delivery is enabled with it's time slots
|
|
@@ -711,7 +723,7 @@ type BulkCreateLocalDeliveryOptionApplicationErrors = {
|
|
|
711
723
|
* @applicableIdentity APP
|
|
712
724
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.CreateLocalDeliveryOption
|
|
713
725
|
*/
|
|
714
|
-
declare function createLocalDeliveryOption(localDeliveryOption: NonNullablePaths<LocalDeliveryOption, `areaName` | `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `rate` | `scheduledDeliveryConfig.days.friday` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`, 8>): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6> & {
|
|
726
|
+
declare function createLocalDeliveryOption(localDeliveryOption: NonNullablePaths<LocalDeliveryOption, `areaName` | `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `rate` | `scheduledDeliveryConfig.days.friday` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`, 8>): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `cityConfig.cities` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6> & {
|
|
715
727
|
__applicationErrorsType?: CreateLocalDeliveryOptionApplicationErrors;
|
|
716
728
|
}>;
|
|
717
729
|
/** @public
|
|
@@ -721,7 +733,7 @@ declare function createLocalDeliveryOption(localDeliveryOption: NonNullablePaths
|
|
|
721
733
|
* @applicableIdentity APP
|
|
722
734
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.GetLocalDeliveryOption
|
|
723
735
|
*/
|
|
724
|
-
declare function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6>>;
|
|
736
|
+
declare function getLocalDeliveryOption(localDeliveryOptionId: string, options?: GetLocalDeliveryOptionOptions): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `cityConfig.cities` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6>>;
|
|
725
737
|
interface GetLocalDeliveryOptionOptions {
|
|
726
738
|
/**
|
|
727
739
|
* @maxLength 50
|
|
@@ -836,7 +848,66 @@ interface LocalDeliveryOptionsQueryBuilder {
|
|
|
836
848
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.QueryLocalDeliveryOptions
|
|
837
849
|
* @requiredField query
|
|
838
850
|
*/
|
|
839
|
-
declare function typedQueryLocalDeliveryOptions(query:
|
|
851
|
+
declare function typedQueryLocalDeliveryOptions(query: LocalDeliveryOptionQuery): Promise<NonNullablePaths<QueryLocalDeliveryOptionsResponse, `localDeliveryOptions` | `localDeliveryOptions.${number}.radiusConfig.radius` | `localDeliveryOptions.${number}.radiusConfig.lengthUnit`, 5>>;
|
|
852
|
+
interface LocalDeliveryOptionQuerySpec extends QuerySpec {
|
|
853
|
+
paging: 'cursor';
|
|
854
|
+
wql: [
|
|
855
|
+
{
|
|
856
|
+
fields: ['deliveryRegionIds'];
|
|
857
|
+
operators: ['$hasAll', '$hasSome'];
|
|
858
|
+
sort: 'NONE';
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
fields: ['_id', 'areaName', 'estimatedDeliveryTime'];
|
|
862
|
+
operators: '*';
|
|
863
|
+
sort: 'NONE';
|
|
864
|
+
}
|
|
865
|
+
];
|
|
866
|
+
}
|
|
867
|
+
type CommonQueryWithEntityContext = Query<LocalDeliveryOption, LocalDeliveryOptionQuerySpec>;
|
|
868
|
+
type LocalDeliveryOptionQuery = {
|
|
869
|
+
/**
|
|
870
|
+
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`.
|
|
871
|
+
*/
|
|
872
|
+
cursorPaging?: {
|
|
873
|
+
/**
|
|
874
|
+
Maximum number of items to return in the results.
|
|
875
|
+
@max: 100
|
|
876
|
+
*/
|
|
877
|
+
limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
|
|
878
|
+
/**
|
|
879
|
+
Pointer to the next or previous page in the list of results.
|
|
880
|
+
|
|
881
|
+
Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
882
|
+
Not relevant for the first request.
|
|
883
|
+
@maxLength: 16000
|
|
884
|
+
*/
|
|
885
|
+
cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
886
|
+
};
|
|
887
|
+
/**
|
|
888
|
+
Filter object.
|
|
889
|
+
|
|
890
|
+
Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
891
|
+
*/
|
|
892
|
+
filter?: CommonQueryWithEntityContext['filter'] | null;
|
|
893
|
+
/**
|
|
894
|
+
Sort object.
|
|
895
|
+
|
|
896
|
+
Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
897
|
+
@maxSize: 5
|
|
898
|
+
*/
|
|
899
|
+
sort?: {
|
|
900
|
+
/**
|
|
901
|
+
Name of the field to sort by.
|
|
902
|
+
@maxLength: 512
|
|
903
|
+
*/
|
|
904
|
+
fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
|
|
905
|
+
/**
|
|
906
|
+
Sort order.
|
|
907
|
+
*/
|
|
908
|
+
order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
|
|
909
|
+
}[];
|
|
910
|
+
};
|
|
840
911
|
/** @param _id - LocalDeliveryOptionId - unique identifier of local delivery option
|
|
841
912
|
* @public
|
|
842
913
|
* @documentationMaturity preview
|
|
@@ -899,11 +970,12 @@ declare function typedQueryLocalDeliveryOptions(query: QueryV2): Promise<NonNull
|
|
|
899
970
|
* @applicableIdentity APP
|
|
900
971
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.UpdateLocalDeliveryOption
|
|
901
972
|
*/
|
|
902
|
-
declare function updateLocalDeliveryOption(_id: string, localDeliveryOption: NonNullablePaths<UpdateLocalDeliveryOption, `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`, 8>): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6>>;
|
|
973
|
+
declare function updateLocalDeliveryOption(_id: string, localDeliveryOption: NonNullablePaths<UpdateLocalDeliveryOption, `radiusConfig.address` | `radiusConfig.address.formatted` | `radiusConfig.address.location` | `scheduledDeliveryConfig.days.friday.enabledForDelivery` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.friday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.monday.enabledForDelivery` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.monday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.saturday.enabledForDelivery` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.saturday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.sunday.enabledForDelivery` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.sunday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.thursday.enabledForDelivery` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.thursday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.tuesday.enabledForDelivery` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.tuesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.days.wednesday.enabledForDelivery` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.from.minutes` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.hours` | `scheduledDeliveryConfig.days.wednesday.timeSlots.${number}.to.minutes` | `scheduledDeliveryConfig.handlingDays`, 8>): Promise<NonNullablePaths<LocalDeliveryOption, `zipConfig.zipCodes` | `radiusConfig.radius` | `radiusConfig.lengthUnit` | `customAreaConfig.geocodes` | `cityConfig.cities` | `destinations` | `destinations.${number}.code` | `scheduledDeliveryConfig.days.monday.timeSlots` | `scheduledDeliveryConfig.timeWindows` | `scheduledDeliveryConfig.timeWindows.${number}.day` | `scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `rates` | `rates.${number}.amount` | `rates.${number}.multiplyByQuantity` | `deliveryRegionIds`, 6>>;
|
|
903
974
|
interface UpdateLocalDeliveryOption {
|
|
904
975
|
zipConfig?: ZipCodeConfig;
|
|
905
976
|
radiusConfig?: RadiusConfig;
|
|
906
977
|
customAreaConfig?: CustomAreaConfig;
|
|
978
|
+
cityConfig?: CityConfig;
|
|
907
979
|
/**
|
|
908
980
|
* LocalDeliveryOptionId - unique identifier of local delivery option
|
|
909
981
|
* @format GUID
|
|
@@ -1136,7 +1208,7 @@ declare function bulkDeleteLocalDeliveryOption(ids: string[]): Promise<void>;
|
|
|
1136
1208
|
* @applicableIdentity APP
|
|
1137
1209
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.AddDeliveryRegion
|
|
1138
1210
|
*/
|
|
1139
|
-
declare function addDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<AddDeliveryRegionOptions, `localDeliveryOptionId`, 2>): Promise<NonNullablePaths<AddDeliveryRegionResponse, `localDeliveryOption.zipConfig.zipCodes` | `localDeliveryOption.radiusConfig.radius` | `localDeliveryOption.radiusConfig.lengthUnit` | `localDeliveryOption.customAreaConfig.geocodes` | `localDeliveryOption.destinations` | `localDeliveryOption.destinations.${number}.code` | `localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.day` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `localDeliveryOption.rates` | `localDeliveryOption.rates.${number}.amount` | `localDeliveryOption.rates.${number}.multiplyByQuantity` | `localDeliveryOption.deliveryRegionIds`, 7>>;
|
|
1211
|
+
declare function addDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<AddDeliveryRegionOptions, `localDeliveryOptionId`, 2>): Promise<NonNullablePaths<AddDeliveryRegionResponse, `localDeliveryOption.zipConfig.zipCodes` | `localDeliveryOption.radiusConfig.radius` | `localDeliveryOption.radiusConfig.lengthUnit` | `localDeliveryOption.customAreaConfig.geocodes` | `localDeliveryOption.cityConfig.cities` | `localDeliveryOption.destinations` | `localDeliveryOption.destinations.${number}.code` | `localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.day` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `localDeliveryOption.rates` | `localDeliveryOption.rates.${number}.amount` | `localDeliveryOption.rates.${number}.multiplyByQuantity` | `localDeliveryOption.deliveryRegionIds`, 7>>;
|
|
1140
1212
|
interface AddDeliveryRegionOptions {
|
|
1141
1213
|
/** @format GUID */
|
|
1142
1214
|
localDeliveryOptionId: string;
|
|
@@ -1151,7 +1223,7 @@ interface AddDeliveryRegionOptions {
|
|
|
1151
1223
|
* @applicableIdentity APP
|
|
1152
1224
|
* @fqn com.wix.ecom.shipments.localdelivery.LocalDelivery.RemoveDeliveryRegion
|
|
1153
1225
|
*/
|
|
1154
|
-
declare function removeDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<RemoveDeliveryRegionOptions, `localDeliveryOptionId`, 2>): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `localDeliveryOption.zipConfig.zipCodes` | `localDeliveryOption.radiusConfig.radius` | `localDeliveryOption.radiusConfig.lengthUnit` | `localDeliveryOption.customAreaConfig.geocodes` | `localDeliveryOption.destinations` | `localDeliveryOption.destinations.${number}.code` | `localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.day` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `localDeliveryOption.rates` | `localDeliveryOption.rates.${number}.amount` | `localDeliveryOption.rates.${number}.multiplyByQuantity` | `localDeliveryOption.deliveryRegionIds`, 7>>;
|
|
1226
|
+
declare function removeDeliveryRegion(deliveryRegionId: string, options?: NonNullablePaths<RemoveDeliveryRegionOptions, `localDeliveryOptionId`, 2>): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, `localDeliveryOption.zipConfig.zipCodes` | `localDeliveryOption.radiusConfig.radius` | `localDeliveryOption.radiusConfig.lengthUnit` | `localDeliveryOption.customAreaConfig.geocodes` | `localDeliveryOption.cityConfig.cities` | `localDeliveryOption.destinations` | `localDeliveryOption.destinations.${number}.code` | `localDeliveryOption.scheduledDeliveryConfig.days.monday.timeSlots` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.day` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.hours` | `localDeliveryOption.scheduledDeliveryConfig.timeWindows.${number}.start.minutes` | `localDeliveryOption.rates` | `localDeliveryOption.rates.${number}.amount` | `localDeliveryOption.rates.${number}.multiplyByQuantity` | `localDeliveryOption.deliveryRegionIds`, 7>>;
|
|
1155
1227
|
interface RemoveDeliveryRegionOptions {
|
|
1156
1228
|
/** @format GUID */
|
|
1157
1229
|
localDeliveryOptionId: string;
|
|
@@ -1159,4 +1231,4 @@ interface RemoveDeliveryRegionOptions {
|
|
|
1159
1231
|
revision?: string | null;
|
|
1160
1232
|
}
|
|
1161
1233
|
|
|
1162
|
-
export { type ActionEvent, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddressLocation, type BulkCreateLocalDeliveryOptionApplicationErrors, type BulkCreateLocalDeliveryOptionRequest, type BulkCreateLocalDeliveryOptionResponse, type BulkDeleteLocalDeliveryOptionRequest, type BulkDeleteLocalDeliveryOptionResponse, type BulkUpdateLocalDeliveryOptionRequest, type BulkUpdateLocalDeliveryOptionResponse, type Condition, ConditionType, type ConditionTypeWithLiterals, type ConditionalRates, type CreateLocalDeliveryOptionApplicationErrors, type CreateLocalDeliveryOptionRequest, type CreateLocalDeliveryOptionResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomAreaConfig, DayOfWeek, type DayOfWeekWithLiterals, type DaySlot, type Days, type DeleteLocalDeliveryOptionOptions, type DeleteLocalDeliveryOptionRequest, type DeleteLocalDeliveryOptionResponse, type Destination, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetLocalDeliveryOptionOptions, type GetLocalDeliveryOptionRequest, type GetLocalDeliveryOptionResponse, type IdentificationData, type IdentificationDataIdOneOf, LengthUnit, type LengthUnitWithLiterals, type ListLocalDeliveryOptionsRequest, type ListLocalDeliveryOptionsResponse, type LocalDeliveryAddress, type LocalDeliveryOption, type LocalDeliveryOptionConfigOneOf, type LocalDeliveryOptionError, type LocalDeliveryOptionsQueryBuilder, type LocalDeliveryOptionsQueryResult, LogicalOperator, type LogicalOperatorWithLiterals, type MessageEnvelope, type Paging, type QueryLocalDeliveryOptionsRequest, type QueryLocalDeliveryOptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RadiusConfig, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RestoreInfo, type ScheduledDelivery, SortOrder, type SortOrderWithLiterals, type Sorting, type TimeOfDay, type TimePoint, type TimeSlot, type TimeWindow, type UpdateLocalDeliveryOption, type UpdateLocalDeliveryOptionRequest, type UpdateLocalDeliveryOptionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZipCodeConfig, addDeliveryRegion, bulkCreateLocalDeliveryOption, bulkDeleteLocalDeliveryOption, bulkUpdateLocalDeliveryOption, createLocalDeliveryOption, deleteLocalDeliveryOption, getLocalDeliveryOption, listLocalDeliveryOptions, queryLocalDeliveryOptions, removeDeliveryRegion, typedQueryLocalDeliveryOptions, updateLocalDeliveryOption };
|
|
1234
|
+
export { type ActionEvent, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddressLocation, type BulkCreateLocalDeliveryOptionApplicationErrors, type BulkCreateLocalDeliveryOptionRequest, type BulkCreateLocalDeliveryOptionResponse, type BulkDeleteLocalDeliveryOptionRequest, type BulkDeleteLocalDeliveryOptionResponse, type BulkUpdateLocalDeliveryOptionRequest, type BulkUpdateLocalDeliveryOptionResponse, type CityConfig, type CommonQueryWithEntityContext, type Condition, ConditionType, type ConditionTypeWithLiterals, type ConditionalRates, type CreateLocalDeliveryOptionApplicationErrors, type CreateLocalDeliveryOptionRequest, type CreateLocalDeliveryOptionResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomAreaConfig, DayOfWeek, type DayOfWeekWithLiterals, type DaySlot, type Days, type DeleteLocalDeliveryOptionOptions, type DeleteLocalDeliveryOptionRequest, type DeleteLocalDeliveryOptionResponse, type Destination, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetLocalDeliveryOptionOptions, type GetLocalDeliveryOptionRequest, type GetLocalDeliveryOptionResponse, type IdentificationData, type IdentificationDataIdOneOf, LengthUnit, type LengthUnitWithLiterals, type ListLocalDeliveryOptionsRequest, type ListLocalDeliveryOptionsResponse, type LocalDeliveryAddress, type LocalDeliveryOption, type LocalDeliveryOptionConfigOneOf, type LocalDeliveryOptionError, type LocalDeliveryOptionQuery, type LocalDeliveryOptionQuerySpec, type LocalDeliveryOptionsQueryBuilder, type LocalDeliveryOptionsQueryResult, LogicalOperator, type LogicalOperatorWithLiterals, type MessageEnvelope, type Paging, type QueryLocalDeliveryOptionsRequest, type QueryLocalDeliveryOptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RadiusConfig, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RestoreInfo, type ScheduledDelivery, SortOrder, type SortOrderWithLiterals, type Sorting, type TimeOfDay, type TimePoint, type TimeSlot, type TimeWindow, type UpdateLocalDeliveryOption, type UpdateLocalDeliveryOptionRequest, type UpdateLocalDeliveryOptionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZipCodeConfig, addDeliveryRegion, bulkCreateLocalDeliveryOption, bulkDeleteLocalDeliveryOption, bulkUpdateLocalDeliveryOption, createLocalDeliveryOption, deleteLocalDeliveryOption, getLocalDeliveryOption, listLocalDeliveryOptions, queryLocalDeliveryOptions, removeDeliveryRegion, typedQueryLocalDeliveryOptions, updateLocalDeliveryOption };
|