@wix/ecom 1.0.712 → 1.0.713

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.
@@ -1,3 +1,47 @@
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
1
45
  interface CheckoutContentProvider {
2
46
  _id?: string | null;
3
47
  }
@@ -56,52 +100,14 @@ interface GetCheckoutContentOptions {
56
100
  languageCode?: string | null;
57
101
  }
58
102
 
59
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
60
- interface HttpClient {
61
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
62
- fetchWithAuth: typeof fetch;
63
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
64
- }
65
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
66
- type HttpResponse<T = any> = {
67
- data: T;
68
- status: number;
69
- statusText: string;
70
- headers: any;
71
- request?: any;
72
- };
73
- type RequestOptions<_TResponse = any, Data = any> = {
74
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
75
- url: string;
76
- data?: Data;
77
- params?: URLSearchParams;
78
- } & APIMetadata;
79
- type APIMetadata = {
80
- methodFqn?: string;
81
- entityFqdn?: string;
82
- packageName?: string;
83
- };
84
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
85
- type EventDefinition<Payload = unknown, Type extends string = string> = {
86
- __type: 'event-definition';
87
- type: Type;
88
- isDomainEvent?: boolean;
89
- transformations?: (envelope: unknown) => Payload;
90
- __payload: Payload;
91
- };
92
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
93
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
94
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
95
-
96
- declare global {
97
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
98
- interface SymbolConstructor {
99
- readonly observable: symbol;
100
- }
103
+ declare function getCheckoutContent$1(httpClient: HttpClient): GetCheckoutContentSignature;
104
+ interface GetCheckoutContentSignature {
105
+ /**
106
+ * Retrieves a CheckoutContent.
107
+ */
108
+ (identifiers: GetCheckoutContentIdentifiers, options?: GetCheckoutContentOptions | undefined): Promise<GetCheckoutContentResponse>;
101
109
  }
102
110
 
103
- declare function getCheckoutContent$1(httpClient: HttpClient): (identifiers: GetCheckoutContentIdentifiers, options?: GetCheckoutContentOptions) => Promise<GetCheckoutContentResponse>;
104
-
105
111
  declare function createRESTModule$p<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
106
112
 
107
113
  type _publicGetCheckoutContentType = typeof getCheckoutContent$1;
@@ -209,7 +215,13 @@ interface ListTriggersResponseNonNullableFields {
209
215
  triggers: ListTriggersResponseCustomTriggerNonNullableFields[];
210
216
  }
211
217
 
212
- declare function listTriggers$1(httpClient: HttpClient): () => Promise<ListTriggersResponse & ListTriggersResponseNonNullableFields>;
218
+ declare function listTriggers$1(httpClient: HttpClient): ListTriggersSignature;
219
+ interface ListTriggersSignature {
220
+ /**
221
+ * List all custom triggers that are available on a given site
222
+ */
223
+ (): Promise<ListTriggersResponse & ListTriggersResponseNonNullableFields>;
224
+ }
213
225
 
214
226
  declare function createRESTModule$o<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
215
227
 
@@ -1128,11 +1140,77 @@ interface DiscountRulesQueryBuilder {
1128
1140
  find: () => Promise<DiscountRulesQueryResult>;
1129
1141
  }
1130
1142
 
1131
- declare function createDiscountRule$1(httpClient: HttpClient): (discountRule: DiscountRule$7) => Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1132
- declare function getDiscountRule$1(httpClient: HttpClient): (discountRuleId: string) => Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1133
- declare function updateDiscountRule$1(httpClient: HttpClient): (_id: string | null, discountRule: UpdateDiscountRule) => Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1134
- declare function deleteDiscountRule$1(httpClient: HttpClient): (discountRuleId: string) => Promise<void>;
1135
- declare function queryDiscountRules$1(httpClient: HttpClient): () => DiscountRulesQueryBuilder;
1143
+ declare function createDiscountRule$1(httpClient: HttpClient): CreateDiscountRuleSignature;
1144
+ interface CreateDiscountRuleSignature {
1145
+ /**
1146
+ * Creates a new discount rule.
1147
+ *
1148
+ *
1149
+ * The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.
1150
+ * @param - Discount rule info.
1151
+ * @returns Discount rule.
1152
+ */
1153
+ (discountRule: DiscountRule$7): Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1154
+ }
1155
+ declare function getDiscountRule$1(httpClient: HttpClient): GetDiscountRuleSignature;
1156
+ interface GetDiscountRuleSignature {
1157
+ /**
1158
+ * Retrieves a discount rule.
1159
+ *
1160
+ *
1161
+ * The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.
1162
+ * @param - ID of the discount rule to retrieve.
1163
+ * @returns The requested discount rule.
1164
+ */
1165
+ (discountRuleId: string): Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1166
+ }
1167
+ declare function updateDiscountRule$1(httpClient: HttpClient): UpdateDiscountRuleSignature;
1168
+ interface UpdateDiscountRuleSignature {
1169
+ /**
1170
+ * Updates a discount rule's properties.
1171
+ *
1172
+ *
1173
+ * The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.
1174
+ *
1175
+ * Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.
1176
+ * @param - Discount rule ID.
1177
+ * @param - Discount rule info.
1178
+ * @param - Discount rule info.
1179
+ * @returns Updated discount rule.
1180
+ */
1181
+ (_id: string | null, discountRule: UpdateDiscountRule): Promise<DiscountRule$7 & DiscountRuleNonNullableFields$6>;
1182
+ }
1183
+ declare function deleteDiscountRule$1(httpClient: HttpClient): DeleteDiscountRuleSignature;
1184
+ interface DeleteDiscountRuleSignature {
1185
+ /**
1186
+ * Deletes a discount rule.
1187
+ *
1188
+ *
1189
+ * The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.
1190
+ * @param - ID of the discount rule to delete.
1191
+ */
1192
+ (discountRuleId: string): Promise<void>;
1193
+ }
1194
+ declare function queryDiscountRules$1(httpClient: HttpClient): QueryDiscountRulesSignature;
1195
+ interface QueryDiscountRulesSignature {
1196
+ /**
1197
+ * Creates a query to retrieve a list of discount rules.
1198
+ *
1199
+ *
1200
+ * The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.
1201
+ *
1202
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.
1203
+ *
1204
+ * You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.
1205
+ *
1206
+ * By default, `queryDiscountRules()` sorts results by [`ascending("_id")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.
1207
+ *
1208
+ * To learn how to query posts, refer to the table below.
1209
+ *
1210
+ * The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.
1211
+ */
1212
+ (): DiscountRulesQueryBuilder;
1213
+ }
1136
1214
  declare const onDiscountRuleCreated$1: EventDefinition<DiscountRuleCreatedEnvelope, "wix.ecom.discounts.v1.discount_rule_created">;
1137
1215
  declare const onDiscountRuleUpdated$1: EventDefinition<DiscountRuleUpdatedEnvelope, "wix.ecom.discounts.v1.discount_rule_updated">;
1138
1216
  declare const onDiscountRuleDeleted$1: EventDefinition<DiscountRuleDeletedEnvelope, "wix.ecom.discounts.v1.discount_rule_deleted">;
@@ -1153,12 +1231,21 @@ type _publicQueryDiscountRulesType = typeof queryDiscountRules$1;
1153
1231
  declare const queryDiscountRules: ReturnType<typeof createRESTModule$n<_publicQueryDiscountRulesType>>;
1154
1232
 
1155
1233
  type _publicOnDiscountRuleCreatedType = typeof onDiscountRuleCreated$1;
1234
+ /**
1235
+ * Triggered when a discount rule is created.
1236
+ */
1156
1237
  declare const onDiscountRuleCreated: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleCreatedType>>;
1157
1238
 
1158
1239
  type _publicOnDiscountRuleUpdatedType = typeof onDiscountRuleUpdated$1;
1240
+ /**
1241
+ * Triggered when a discount rule is updated.
1242
+ */
1159
1243
  declare const onDiscountRuleUpdated: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleUpdatedType>>;
1160
1244
 
1161
1245
  type _publicOnDiscountRuleDeletedType = typeof onDiscountRuleDeleted$1;
1246
+ /**
1247
+ * Triggered when a discount rule is deleted.
1248
+ */
1162
1249
  declare const onDiscountRuleDeleted: ReturnType<typeof createEventModule$g<_publicOnDiscountRuleDeletedType>>;
1163
1250
 
1164
1251
  type context$n_ActiveTimeInfo = ActiveTimeInfo;
@@ -1468,7 +1555,17 @@ interface ListInvoicesForMultipleOrdersResponseNonNullableFields {
1468
1555
  invoicesForOrder: InvoicesForOrderNonNullableFields[];
1469
1556
  }
1470
1557
 
1471
- declare function listInvoicesForMultipleOrders$1(httpClient: HttpClient): (orderIds: string[]) => Promise<ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields>;
1558
+ declare function listInvoicesForMultipleOrders$1(httpClient: HttpClient): ListInvoicesForMultipleOrdersSignature;
1559
+ interface ListInvoicesForMultipleOrdersSignature {
1560
+ /**
1561
+ * Retrieves the IDs of invoices associated with all specified orders.
1562
+ *
1563
+ *
1564
+ * The `listInvoicesForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
1565
+ * @param - Order IDs for which to retrieve invoices.
1566
+ */
1567
+ (orderIds: string[]): Promise<ListInvoicesForMultipleOrdersResponse$1 & ListInvoicesForMultipleOrdersResponseNonNullableFields>;
1568
+ }
1472
1569
 
1473
1570
  declare function createRESTModule$m<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1474
1571
 
@@ -1639,8 +1736,53 @@ interface GetRecommendationOptions {
1639
1736
  minimumRecommendedItems?: number;
1640
1737
  }
1641
1738
 
1642
- declare function listAvailableAlgorithms$1(httpClient: HttpClient): () => Promise<ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields>;
1643
- declare function getRecommendation$1(httpClient: HttpClient): (algorithms: Algorithm[], options?: GetRecommendationOptions) => Promise<GetRecommendationResponse & GetRecommendationResponseNonNullableFields>;
1739
+ declare function listAvailableAlgorithms$1(httpClient: HttpClient): ListAvailableAlgorithmsSignature;
1740
+ interface ListAvailableAlgorithmsSignature {
1741
+ /**
1742
+ * Returns a list of recommendation algorithms that can be used on your Wix site or project. These algorithms can be used with [`getRecommendation()`](#getRecommendation) to provide item recommendations to the customer.
1743
+ *
1744
+ * Algorithms are run by the apps that provide them, and can only be used on catalogs they support. Apps may provide algorithms for use with their own catalogs and/or catalogs from other apps.
1745
+ *
1746
+ * The app which provides an algorithm is referenced by that algorithm’s `appId`. The apps whose catalogs are supported by an algorithm are referenced by the IDs in that algorithm’s `catalogAppIds` array.
1747
+ *
1748
+ *
1749
+ * For an algorithm to be considered “Available” and returned in this method’s response, the algorithm must meet the following conditions:
1750
+ * 1. The algorithm’s `appId` must match the ID of an installed Wix app.
1751
+ * 2. At least 1 of the IDs in `catalogAppIds` must match the ID of an installed Wix app.
1752
+ *
1753
+ * Wix app IDs are [listed here](https://dev.wix.com/api/rest/getting-started/wix-business-solutions#getting-started_wix-business-solutions_about-wix-business-solutions).
1754
+ */
1755
+ (): Promise<ListAvailableAlgorithmsResponse & ListAvailableAlgorithmsResponseNonNullableFields>;
1756
+ }
1757
+ declare function getRecommendation$1(httpClient: HttpClient): GetRecommendationSignature;
1758
+ interface GetRecommendationSignature {
1759
+ /**
1760
+ * Returns a recommendation object containing a list of items to recommend to the customer.
1761
+ *
1762
+ * `getRecommendation()` determines which items to recommend based on the given recommendation algorithms.
1763
+ *
1764
+ * `getRecommendation()` doesn’t run the algorithms. It calls the installed apps that provide them.
1765
+ *
1766
+ * Apps may provide algorithms for use with their own catalogs, or for use with catalogs from other apps.
1767
+ * For example, Wix Stores provides algorithms that can only be used on its own catalogs.
1768
+ * To run an algorithm, the app providing it must be installed, and an app providing a supported catalog must be installed.
1769
+ * For more information and to see which algorithms are available on your site or project, call [`listAvailableAlgorithms()`](#listavailablealgorithms).
1770
+ *
1771
+ * `getRecommendation()` operates as follows:
1772
+ * 1. `getRecommendation()` receives as input a list of algorithms as an array. These algorithms can be provided by different apps and can apply to different catalogs.
1773
+ * 2. `getRecommendation()` calls the app that corresponds to the `appId` of the first algorithm in the list of algorithms. It passes that algorithm’s ID and the IDs of any subsequent algorithms in the array for the same app.
1774
+ * 3. The app runs the algorithms.
1775
+ * 4. `getRecommendation()` returns items recommendations from the first algorithm (according to its position in the `algorithms` array) that meets the minimum number of recommendations. At that point `getRecommendation()` stops calling other apps.
1776
+ * 5. If none of the algorithms run by the first app meet the minimum recommended items, `getRecommendation()` finds the next algorithm in the array with a new `appId` (an ID of an app that has not yet been called), and repeats the process.
1777
+ * 6. If no algorithms in the `algorithms` array recommend at least the minimum recommended items, `getRecommendation()` returns an empty array.
1778
+ * @param - A list of algorithms checked in a specific order determined by their `appID` and their position in the `algorithms` array.
1779
+ * See the method description for more information.
1780
+ *
1781
+ * If no algorithm is able to return at least `minimumRecommendedItems` items, an empty array is returned.
1782
+ * @param - Get recommendation options.
1783
+ */
1784
+ (algorithms: Algorithm[], options?: GetRecommendationOptions | undefined): Promise<GetRecommendationResponse & GetRecommendationResponseNonNullableFields>;
1785
+ }
1644
1786
 
1645
1787
  declare function createRESTModule$l<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1646
1788
 
@@ -2437,10 +2579,45 @@ interface AbandonedCheckoutsQueryBuilder {
2437
2579
  find: () => Promise<AbandonedCheckoutsQueryResult>;
2438
2580
  }
2439
2581
 
2440
- declare function getAbandonedCheckout$1(httpClient: HttpClient): (abandonedCheckoutId: string) => Promise<AbandonedCheckout & AbandonedCheckoutNonNullableFields>;
2441
- declare function deleteAbandonedCheckout$1(httpClient: HttpClient): (abandonedCheckoutId: string) => Promise<void>;
2442
- declare function queryAbandonedCheckouts$1(httpClient: HttpClient): () => AbandonedCheckoutsQueryBuilder;
2443
- declare function redirectToCheckout$1(httpClient: HttpClient): (abandonedCheckoutId: string, metasiteId: string) => Promise<RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
2582
+ declare function getAbandonedCheckout$1(httpClient: HttpClient): GetAbandonedCheckoutSignature;
2583
+ interface GetAbandonedCheckoutSignature {
2584
+ /**
2585
+ * Retrieves an abandoned checkout.
2586
+ * @param - Abandoned checkout ID.
2587
+ * @returns The requested abandoned checkout.
2588
+ */
2589
+ (abandonedCheckoutId: string): Promise<AbandonedCheckout & AbandonedCheckoutNonNullableFields>;
2590
+ }
2591
+ declare function deleteAbandonedCheckout$1(httpClient: HttpClient): DeleteAbandonedCheckoutSignature;
2592
+ interface DeleteAbandonedCheckoutSignature {
2593
+ /**
2594
+ * Delete an AbandonedCheckout
2595
+ * @param - Id of the abandoned checkout to delete
2596
+ */
2597
+ (abandonedCheckoutId: string): Promise<void>;
2598
+ }
2599
+ declare function queryAbandonedCheckouts$1(httpClient: HttpClient): QueryAbandonedCheckoutsSignature;
2600
+ interface QueryAbandonedCheckoutsSignature {
2601
+ /**
2602
+ * Creates a query to retrieve a list of abandoned checkouts.
2603
+ *
2604
+ * The `queryAbandonedCheckouts()` function builds a query to retrieve a list of abandoned checkouts and returns a `ResultsQueryBuilder` object.
2605
+ *
2606
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
2607
+ *
2608
+ * You can refine the query by chaining `ResultsQueryBuilder` functions onto the query. `ResultsQueryBuilder` functions enable you to sort, filter, and control the results `queryAbandonedCheckouts()` returns.
2609
+ */
2610
+ (): AbandonedCheckoutsQueryBuilder;
2611
+ }
2612
+ declare function redirectToCheckout$1(httpClient: HttpClient): RedirectToCheckoutSignature;
2613
+ interface RedirectToCheckoutSignature {
2614
+ /**
2615
+ * Redirects the abandoned checkout to the checkout page.
2616
+ * @param - abandoned checkout id
2617
+ * @param - Identifier of the metaSite this checkout uses
2618
+ */
2619
+ (abandonedCheckoutId: string, metasiteId: string): Promise<RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
2620
+ }
2444
2621
  declare const onAbandonedCheckoutRecovered$1: EventDefinition<AbandonedCheckoutRecoveredEnvelope, "wix.ecom.v1.abandoned_checkout_recovered">;
2445
2622
 
2446
2623
  declare function createRESTModule$k<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -2457,6 +2634,9 @@ type _publicRedirectToCheckoutType = typeof redirectToCheckout$1;
2457
2634
  declare const redirectToCheckout: ReturnType<typeof createRESTModule$k<_publicRedirectToCheckoutType>>;
2458
2635
 
2459
2636
  type _publicOnAbandonedCheckoutRecoveredType = typeof onAbandonedCheckoutRecovered$1;
2637
+ /**
2638
+ * Triggered when an abandoned checkout is recovered (the customer completes the checkout).
2639
+ */
2460
2640
  declare const onAbandonedCheckoutRecovered: ReturnType<typeof createEventModule$f<_publicOnAbandonedCheckoutRecoveredType>>;
2461
2641
 
2462
2642
  type context$k_AbandonedCheckout = AbandonedCheckout;
@@ -3101,13 +3281,106 @@ interface ReportItemsBackInStockOptions {
3101
3281
  extraAutomationTemplateParameters?: Record<string, string>;
3102
3282
  }
3103
3283
 
3104
- declare function createBackInStockNotificationRequest$1(httpClient: HttpClient): (request: BackInStockNotificationRequest, itemDetails: BackInStockItemDetails) => Promise<BackInStockNotificationRequest & BackInStockNotificationRequestNonNullableFields>;
3105
- declare function getBackInStockNotificationRequest$1(httpClient: HttpClient): (_id: string) => Promise<BackInStockNotificationRequest & BackInStockNotificationRequestNonNullableFields>;
3106
- declare function deleteBackInStockNotificationRequest$1(httpClient: HttpClient): (_id: string) => Promise<void>;
3107
- declare function markAsNotificationSent$1(httpClient: HttpClient): (_id: string) => Promise<MarkAsNotificationSentResponse & MarkAsNotificationSentResponseNonNullableFields>;
3108
- declare function queryBackInStockNotificationRequests$1(httpClient: HttpClient): () => RequestsQueryBuilder;
3109
- declare function getBackInStockNotificationRequestsCountByCatalogReferences$1(httpClient: HttpClient): (catalogReferences: CatalogReference$7[]) => Promise<GetBackInStockNotificationRequestsCountByCatalogReferencesResponse & GetBackInStockNotificationRequestsCountByCatalogReferencesResponseNonNullableFields>;
3110
- declare function reportItemsBackInStock$1(httpClient: HttpClient): (itemDetails: BackInStockItemDetails, options?: ReportItemsBackInStockOptions) => Promise<void>;
3284
+ declare function createBackInStockNotificationRequest$1(httpClient: HttpClient): CreateBackInStockNotificationRequestSignature;
3285
+ interface CreateBackInStockNotificationRequestSignature {
3286
+ /**
3287
+ * Creates a back in stock notification request.
3288
+ *
3289
+ * If a notification request already exists for the same `catalogReference` and `email`,
3290
+ * then a new one isn't created and the existing request is returned.
3291
+ * @param - Notification request information.
3292
+ *
3293
+ * Includes details for the out of stock item and the email address
3294
+ * requesting to be notified when it's back in stock.
3295
+ * @param - Item details to include in the notification when the item is back in stock.
3296
+ * @returns Created back in stock notification request.
3297
+ */
3298
+ (request: BackInStockNotificationRequest, itemDetails: BackInStockItemDetails): Promise<BackInStockNotificationRequest & BackInStockNotificationRequestNonNullableFields>;
3299
+ }
3300
+ declare function getBackInStockNotificationRequest$1(httpClient: HttpClient): GetBackInStockNotificationRequestSignature;
3301
+ interface GetBackInStockNotificationRequestSignature {
3302
+ /**
3303
+ * Retrieves a back in stock notification request.
3304
+ * @param - ID of the notification request to retrieve.
3305
+ * @returns Retrieved back in stock notification request.
3306
+ */
3307
+ (_id: string): Promise<BackInStockNotificationRequest & BackInStockNotificationRequestNonNullableFields>;
3308
+ }
3309
+ declare function deleteBackInStockNotificationRequest$1(httpClient: HttpClient): DeleteBackInStockNotificationRequestSignature;
3310
+ interface DeleteBackInStockNotificationRequestSignature {
3311
+ /**
3312
+ * Deletes a back in stock notification request.
3313
+ * @param - ID of the notification request to delete.
3314
+ */
3315
+ (_id: string): Promise<void>;
3316
+ }
3317
+ declare function markAsNotificationSent$1(httpClient: HttpClient): MarkAsNotificationSentSignature;
3318
+ interface MarkAsNotificationSentSignature {
3319
+ /**
3320
+ * Sets `status` of a back in stock request to `NOTIFICATION_SENT`.
3321
+ *
3322
+ * Use this function if the notification is sent manually offline. If the notification is sent automatically or with the `reportItemsBackInStock()` function, then `status` updates on its own.
3323
+ * @param - ID of the notification request to mark.
3324
+ */
3325
+ (_id: string): Promise<MarkAsNotificationSentResponse & MarkAsNotificationSentResponseNonNullableFields>;
3326
+ }
3327
+ declare function queryBackInStockNotificationRequests$1(httpClient: HttpClient): QueryBackInStockNotificationRequestsSignature;
3328
+ interface QueryBackInStockNotificationRequestsSignature {
3329
+ /**
3330
+ * Creates a query to retrieve a list of back in stock notification requests.
3331
+ *
3332
+ * The `queryBackInStockNotificationRequests()` method builds a query to retrieve a list of back in stock notification requests and returns a `RequestsQueryBuilder` object.
3333
+ *
3334
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` method.
3335
+ *
3336
+ * You can refine the query by chaining `RequestsQueryBuilder` methods onto the query. `RequestsQueryBuilder` methods enable you to sort, filter, and control the results that `queryBackInStockNotificationRequests()` returns.
3337
+ *
3338
+ * The following `RequestsQueryBuilder` methods are supported for `queryBackInStockNotificationRequests()`. For a full description of the Requests object, see the object returned for the `items` property in `RequestsQueryResult`."
3339
+ */
3340
+ (): RequestsQueryBuilder;
3341
+ }
3342
+ declare function getBackInStockNotificationRequestsCountByCatalogReferences$1(httpClient: HttpClient): GetBackInStockNotificationRequestsCountByCatalogReferencesSignature;
3343
+ interface GetBackInStockNotificationRequestsCountByCatalogReferencesSignature {
3344
+ /**
3345
+ * Retrieves the amount of back in stock requests for a given `catalogReference` item.
3346
+ * @param - `catalogReference` items to retrieve the notification request for.
3347
+ */
3348
+ (catalogReferences: CatalogReference$7[]): Promise<GetBackInStockNotificationRequestsCountByCatalogReferencesResponse & GetBackInStockNotificationRequestsCountByCatalogReferencesResponseNonNullableFields>;
3349
+ }
3350
+ declare function reportItemsBackInStock$1(httpClient: HttpClient): ReportItemsBackInStockSignature;
3351
+ interface ReportItemsBackInStockSignature {
3352
+ /**
3353
+ * Sends notifications for back in stock requests.
3354
+ *
3355
+ * > **Important:**
3356
+ * > Automations must be turned on in a [site's dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock) for notifications to send.
3357
+ *
3358
+ * This endpoint triggers notifications for requests in 1 of 2 ways:
3359
+ * 1. For a specific item, with the `catalogReference` information.
3360
+ * 2. For specific requests, with `requestIds`.
3361
+ *
3362
+ * `itemDetails` are required and may populate dynamic values in the notification template, as follows:
3363
+ * + `itemDetails.name` passes to the template as `item.name`
3364
+ * + `itemDetails.price` passes to the template as `item.price`
3365
+ * + `itemDetails.image.url` passes to the template as `item.image.url`
3366
+ *
3367
+ * If the notification template doesn't include `item.price`, `item.name`, or `item.image.url`, values should
3368
+ * be passed in `extraAutomationTemplateParameters`.
3369
+ *
3370
+ * After this endpoint is called, the `status` for the request will update to `NOTIFICATION_SENT` if it sends
3371
+ * successfully, or to `FAILED` if it fails to send.
3372
+ * @param - Item details to use in notifications.
3373
+ *
3374
+ * `itemDetails` may populate dynamic valyes in the notification template, as follows:
3375
+ * + `itemDetails.name` passes to the template as `item.name`
3376
+ * + `itemDetails.price` passes to the template as `item.price`
3377
+ * + `itemDetails.image.url` passes to the template as `item.image.url`
3378
+ *
3379
+ * Use `extraAutomationTemplateParameters` to pass additional dynamic values.
3380
+ * @param - Report options.
3381
+ */
3382
+ (itemDetails: BackInStockItemDetails, options?: ReportItemsBackInStockOptions | undefined): Promise<void>;
3383
+ }
3111
3384
  declare const onBackInStockNotificationRequestCreated$1: EventDefinition<BackInStockNotificationRequestCreatedEnvelope, "wix.ecom.v1.back_in_stock_notification_request_created">;
3112
3385
  declare const onBackInStockNotificationRequestDeleted$1: EventDefinition<BackInStockNotificationRequestDeletedEnvelope, "wix.ecom.v1.back_in_stock_notification_request_deleted">;
3113
3386
  declare const onBackInStockNotificationRequestUpdated$1: EventDefinition<BackInStockNotificationRequestUpdatedEnvelope, "wix.ecom.v1.back_in_stock_notification_request_updated">;
@@ -3132,12 +3405,21 @@ type _publicReportItemsBackInStockType = typeof reportItemsBackInStock$1;
3132
3405
  declare const reportItemsBackInStock: ReturnType<typeof createRESTModule$j<_publicReportItemsBackInStockType>>;
3133
3406
 
3134
3407
  type _publicOnBackInStockNotificationRequestCreatedType = typeof onBackInStockNotificationRequestCreated$1;
3408
+ /**
3409
+ * Triggered when a back in stock notification request is created.
3410
+ */
3135
3411
  declare const onBackInStockNotificationRequestCreated: ReturnType<typeof createEventModule$e<_publicOnBackInStockNotificationRequestCreatedType>>;
3136
3412
 
3137
3413
  type _publicOnBackInStockNotificationRequestDeletedType = typeof onBackInStockNotificationRequestDeleted$1;
3414
+ /**
3415
+ * Triggered when a back in stock notification request is deleted.
3416
+ */
3138
3417
  declare const onBackInStockNotificationRequestDeleted: ReturnType<typeof createEventModule$e<_publicOnBackInStockNotificationRequestDeletedType>>;
3139
3418
 
3140
3419
  type _publicOnBackInStockNotificationRequestUpdatedType = typeof onBackInStockNotificationRequestUpdated$1;
3420
+ /**
3421
+ * Triggered when a back in stock notification request is updated.
3422
+ */
3141
3423
  declare const onBackInStockNotificationRequestUpdated: ReturnType<typeof createEventModule$e<_publicOnBackInStockNotificationRequestUpdatedType>>;
3142
3424
 
3143
3425
  type context$j_BackInStockItemDetails = BackInStockItemDetails;
@@ -3254,9 +3536,36 @@ interface GetSettingsResponseNonNullableFields {
3254
3536
  settings?: BackInStockSettingsNonNullableFields;
3255
3537
  }
3256
3538
 
3257
- declare function startCollectingRequests$1(httpClient: HttpClient): (appId: string) => Promise<StartCollectingRequestsResponse & StartCollectingRequestsResponseNonNullableFields>;
3258
- declare function stopCollectingRequests$1(httpClient: HttpClient): (appId: string) => Promise<StopCollectingRequestsResponse & StopCollectingRequestsResponseNonNullableFields>;
3259
- declare function getSettings$1(httpClient: HttpClient): () => Promise<GetSettingsResponse & GetSettingsResponseNonNullableFields>;
3539
+ declare function startCollectingRequests$1(httpClient: HttpClient): StartCollectingRequestsSignature;
3540
+ interface StartCollectingRequestsSignature {
3541
+ /**
3542
+ * Sets `settings.collectionStates.collectingRequests` to `true` for given `appId`.
3543
+ *
3544
+ * When the collection state is set to `true`, collecting requests is enabled and customers may request
3545
+ * notifications for out of stock products. While collecting is enabled, customers see a "Notify When Available"
3546
+ * button on out-of-stock items. Customers can click the button to enter their email address, which creates the
3547
+ * notification request.
3548
+ * @param - ID of the app to start accepting notification requests for.
3549
+ */
3550
+ (appId: string): Promise<StartCollectingRequestsResponse & StartCollectingRequestsResponseNonNullableFields>;
3551
+ }
3552
+ declare function stopCollectingRequests$1(httpClient: HttpClient): StopCollectingRequestsSignature;
3553
+ interface StopCollectingRequestsSignature {
3554
+ /**
3555
+ * Sets `settings.collectionStates.collectingRequests` to `false` for given `appId`.
3556
+ *
3557
+ * When the collection state is set to `false`, collecting notification requests is disabled.
3558
+ * @param - ID of the app to stop accepting notification requests for.
3559
+ */
3560
+ (appId: string): Promise<StopCollectingRequestsResponse & StopCollectingRequestsResponseNonNullableFields>;
3561
+ }
3562
+ declare function getSettings$1(httpClient: HttpClient): GetSettingsSignature;
3563
+ interface GetSettingsSignature {
3564
+ /**
3565
+ * Retrieves back in stock request settings.
3566
+ */
3567
+ (): Promise<GetSettingsResponse & GetSettingsResponseNonNullableFields>;
3568
+ }
3260
3569
 
3261
3570
  declare function createRESTModule$i<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3262
3571
 
@@ -5637,16 +5946,149 @@ interface EstimateTotalsOptions {
5637
5946
  selectedMemberships?: SelectedMemberships$4;
5638
5947
  }
5639
5948
 
5640
- declare function createCart$1(httpClient: HttpClient): (options?: CreateCartOptions) => Promise<Cart$1 & CartNonNullableFields$1>;
5641
- declare function updateCart$1(httpClient: HttpClient): (_id: string | null, options?: UpdateCartOptions) => Promise<Cart$1 & CartNonNullableFields$1>;
5642
- declare function getCart$1(httpClient: HttpClient): (_id: string) => Promise<Cart$1 & CartNonNullableFields$1>;
5643
- declare function addToCart$1(httpClient: HttpClient): (_id: string, options?: AddToCartOptions) => Promise<AddToCartResponse$1 & AddToCartResponseNonNullableFields$1>;
5644
- declare function removeLineItems$3(httpClient: HttpClient): (_id: string, lineItemIds: string[]) => Promise<RemoveLineItemsResponse$2 & RemoveLineItemsResponseNonNullableFields$2>;
5645
- declare function createCheckout$3(httpClient: HttpClient): (_id: string, options?: CreateCheckoutOptions$1) => Promise<CreateCheckoutResponse$2 & CreateCheckoutResponseNonNullableFields$2>;
5646
- declare function removeCoupon$3(httpClient: HttpClient): (_id: string) => Promise<RemoveCouponResponse$2 & RemoveCouponResponseNonNullableFields$2>;
5647
- declare function updateLineItemsQuantity$3(httpClient: HttpClient): (_id: string, lineItems: LineItemQuantityUpdate$2[]) => Promise<UpdateLineItemsQuantityResponse$2 & UpdateLineItemsQuantityResponseNonNullableFields$2>;
5648
- declare function estimateTotals$1(httpClient: HttpClient): (_id: string, options?: EstimateTotalsOptions) => Promise<EstimateTotalsResponse$1 & EstimateTotalsResponseNonNullableFields$1>;
5649
- declare function deleteCart$1(httpClient: HttpClient): (_id: string) => Promise<void>;
5949
+ declare function createCart$1(httpClient: HttpClient): CreateCartSignature;
5950
+ interface CreateCartSignature {
5951
+ /**
5952
+ * Creates a new cart.
5953
+ *
5954
+ *
5955
+ * The `createCart()` function returns a Promise that resolves to the new cart when it's created.
5956
+ *
5957
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
5958
+ * @param - Cart creation options.
5959
+ * @returns Fulfilled - Cart.
5960
+ */
5961
+ (options?: CreateCartOptions | undefined): Promise<Cart$1 & CartNonNullableFields$1>;
5962
+ }
5963
+ declare function updateCart$1(httpClient: HttpClient): UpdateCartSignature;
5964
+ interface UpdateCartSignature {
5965
+ /**
5966
+ * Updates a specified cart's properties.
5967
+ *
5968
+ *
5969
+ * The `updateCart()` function returns a Promise that resolves when the specified cart's properties are updated.
5970
+ *
5971
+ * > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.
5972
+ * @param - Available options to use when updating a cart.
5973
+ * @param - ID of the cart to be updated.
5974
+ * @returns Fulfilled - Updated cart.
5975
+ */
5976
+ (_id: string | null, options?: UpdateCartOptions | undefined): Promise<Cart$1 & CartNonNullableFields$1>;
5977
+ }
5978
+ declare function getCart$1(httpClient: HttpClient): GetCartSignature;
5979
+ interface GetCartSignature {
5980
+ /**
5981
+ * Retrieves a cart.
5982
+ *
5983
+ *
5984
+ * The `getCart()` function returns a Promise that resolves when the specified cart is retrieved.
5985
+ * @param - ID of the cart to retrieve.
5986
+ * @returns Fulfilled - The specified cart.
5987
+ */
5988
+ (_id: string): Promise<Cart$1 & CartNonNullableFields$1>;
5989
+ }
5990
+ declare function addToCart$1(httpClient: HttpClient): AddToCartSignature;
5991
+ interface AddToCartSignature {
5992
+ /**
5993
+ * Adds catalog line items to a cart.
5994
+ *
5995
+ *
5996
+ * The `addToCart()` function returns a Promise that resolves to the updated cart when the specified items have been added.
5997
+ *
5998
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
5999
+ * @param - Cart ID.
6000
+ * @param - Items to be added to cart.
6001
+ * @returns Fulfilled - Cart.
6002
+ */
6003
+ (_id: string, options?: AddToCartOptions | undefined): Promise<AddToCartResponse$1 & AddToCartResponseNonNullableFields$1>;
6004
+ }
6005
+ declare function removeLineItems$3(httpClient: HttpClient): RemoveLineItemsSignature$1;
6006
+ interface RemoveLineItemsSignature$1 {
6007
+ /**
6008
+ * Removes line items from the specified cart.
6009
+ *
6010
+ *
6011
+ * The `removeLineItems()` function returns a Promise that resolves to the updated cart when the line items are removed from the specified cart.
6012
+ * @param - IDs of the line items to remove from the cart.
6013
+ * @param - ID of the cart to remove line items from.
6014
+ * @returns Fulfilled - Updated cart.
6015
+ */
6016
+ (_id: string, lineItemIds: string[]): Promise<RemoveLineItemsResponse$2 & RemoveLineItemsResponseNonNullableFields$2>;
6017
+ }
6018
+ declare function createCheckout$3(httpClient: HttpClient): CreateCheckoutSignature$1;
6019
+ interface CreateCheckoutSignature$1 {
6020
+ /**
6021
+ * Creates a checkout from a cart.
6022
+ *
6023
+ *
6024
+ * The `createCheckout()` function returns a Promise that resolves to the new checkout's ID when it's created.
6025
+ *
6026
+ * If a checkout was already created from the specified cart, that checkout will be
6027
+ * updated with any new information from the cart.
6028
+ *
6029
+ * > **Note:** `options.channelType` is a required field.
6030
+ * @param - Cart ID.
6031
+ * @param - Checkout creation options.
6032
+ * @returns Fulfilled - ID of the newly created checkout.
6033
+ */
6034
+ (_id: string, options?: CreateCheckoutOptions$1 | undefined): Promise<CreateCheckoutResponse$2 & CreateCheckoutResponseNonNullableFields$2>;
6035
+ }
6036
+ declare function removeCoupon$3(httpClient: HttpClient): RemoveCouponSignature$1;
6037
+ interface RemoveCouponSignature$1 {
6038
+ /**
6039
+ * Removes the coupon from a specified cart.
6040
+ *
6041
+ *
6042
+ * The `removeCoupon()` function returns a Promise that resolves to the updated cart when the coupon is removed from the specified cart.
6043
+ * @param - Cart ID.
6044
+ * @returns Fulfilled - Updated cart.
6045
+ */
6046
+ (_id: string): Promise<RemoveCouponResponse$2 & RemoveCouponResponseNonNullableFields$2>;
6047
+ }
6048
+ declare function updateLineItemsQuantity$3(httpClient: HttpClient): UpdateLineItemsQuantitySignature$1;
6049
+ interface UpdateLineItemsQuantitySignature$1 {
6050
+ /**
6051
+ * Updates the quantity of one or more line items in a specified cart.
6052
+ *
6053
+ *
6054
+ * The `updateLineItemsQuantity()` function returns a Promise that resolves when the quantities of the specified cart's line items are updated.
6055
+ *
6056
+ * This endpoint is only for updating the quantity of line items. To entirely remove a line item from the cart, use [`removeLineItems()`](#removelineitems). To add a new line item to the cart, use [`addToCart()`](#addtocart).
6057
+ *
6058
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
6059
+ * @param - Cart ID.
6060
+ * @param - Line item IDs and their new quantity.
6061
+ * @returns Fulfilled - Updated cart.
6062
+ */
6063
+ (_id: string, lineItems: LineItemQuantityUpdate$2[]): Promise<UpdateLineItemsQuantityResponse$2 & UpdateLineItemsQuantityResponseNonNullableFields$2>;
6064
+ }
6065
+ declare function estimateTotals$1(httpClient: HttpClient): EstimateTotalsSignature;
6066
+ interface EstimateTotalsSignature {
6067
+ /**
6068
+ * Estimates the subtotal and total for current site visitor’s cart. Totals include tax and are based on the selected carrier service, shipping address, and billing information.
6069
+ *
6070
+ *
6071
+ * The `estimateTotals()` function returns a Promise that resolves when the estimated totals are generated.
6072
+ *
6073
+ * > **Note:** Not passing any `options` properties will only estimate the cart items price totals.
6074
+ * @param - Cart ID.
6075
+ * @param - Total estimation options.
6076
+ * @returns Fulfilled - Cart's estimated totals.
6077
+ */
6078
+ (_id: string, options?: EstimateTotalsOptions | undefined): Promise<EstimateTotalsResponse$1 & EstimateTotalsResponseNonNullableFields$1>;
6079
+ }
6080
+ declare function deleteCart$1(httpClient: HttpClient): DeleteCartSignature;
6081
+ interface DeleteCartSignature {
6082
+ /**
6083
+ * Deletes a cart.
6084
+ *
6085
+ *
6086
+ * The `deleteCart()` function returns a Promise that resolves when the specified cart is deleted.
6087
+ * @param - ID of the cart to delete.
6088
+ * @returns Fulfilled - When the cart is deleted. Rejected - Error message.
6089
+ */
6090
+ (_id: string): Promise<void>;
6091
+ }
5650
6092
  declare const onCartUpdated$3: EventDefinition<CartUpdatedEnvelope$1, "wix.ecom.v1.cart_updated">;
5651
6093
  declare const onCartDeleted$3: EventDefinition<CartDeletedEnvelope$1, "wix.ecom.v1.cart_deleted">;
5652
6094
  declare const onCartCreated$3: EventDefinition<CartCreatedEnvelope$1, "wix.ecom.v1.cart_created">;
@@ -5677,12 +6119,21 @@ type _publicDeleteCartType = typeof deleteCart$1;
5677
6119
  declare const deleteCart: ReturnType<typeof createRESTModule$h<_publicDeleteCartType>>;
5678
6120
 
5679
6121
  type _publicOnCartUpdatedType$1 = typeof onCartUpdated$3;
6122
+ /**
6123
+ * Triggered when a cart is updated.
6124
+ */
5680
6125
  declare const onCartUpdated$2: ReturnType<typeof createEventModule$d<_publicOnCartUpdatedType>>;
5681
6126
 
5682
6127
  type _publicOnCartDeletedType$1 = typeof onCartDeleted$3;
6128
+ /**
6129
+ * Triggered when a cart is deleted.
6130
+ */
5683
6131
  declare const onCartDeleted$2: ReturnType<typeof createEventModule$d<_publicOnCartDeletedType>>;
5684
6132
 
5685
6133
  type _publicOnCartCreatedType$1 = typeof onCartCreated$3;
6134
+ /**
6135
+ * Triggered when a cart is created.
6136
+ */
5686
6137
  declare const onCartCreated$2: ReturnType<typeof createEventModule$d<_publicOnCartCreatedType>>;
5687
6138
 
5688
6139
  type context$h_AddToCartOptions = AddToCartOptions;
@@ -7952,26 +8403,131 @@ interface CreateCheckoutFromCurrentCartOptions {
7952
8403
  /** Mandatory when setting a billing or shipping address if the site visitor isn't logged in. */
7953
8404
  email?: string | null;
7954
8405
  }
7955
- interface EstimateCurrentCartTotalsOptions {
7956
- /** Selected shipping option. */
7957
- selectedShippingOption?: SelectedShippingOption$1;
7958
- /** Shipping address. Used for calculating tax and shipping (when applicable). */
7959
- shippingAddress?: Address$8;
7960
- /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
7961
- billingAddress?: Address$8;
7962
- /** The selected membership payment options and which line items they apply to. */
7963
- selectedMemberships?: SelectedMemberships$3;
8406
+ interface EstimateCurrentCartTotalsOptions {
8407
+ /** Selected shipping option. */
8408
+ selectedShippingOption?: SelectedShippingOption$1;
8409
+ /** Shipping address. Used for calculating tax and shipping (when applicable). */
8410
+ shippingAddress?: Address$8;
8411
+ /** Billing address. Used for calculating tax if all the items in the cart are not shippable. */
8412
+ billingAddress?: Address$8;
8413
+ /** The selected membership payment options and which line items they apply to. */
8414
+ selectedMemberships?: SelectedMemberships$3;
8415
+ }
8416
+
8417
+ declare function getCurrentCart$1(httpClient: HttpClient): GetCurrentCartSignature;
8418
+ interface GetCurrentCartSignature {
8419
+ /**
8420
+ * Retrieves the current site visitor's cart.
8421
+ *
8422
+ *
8423
+ * The `getCurrentCart()` function returns a Promise that resolves when the current cart is retrieved.
8424
+ * @returns Current session's active cart.
8425
+ */
8426
+ (): Promise<Cart & CartNonNullableFields>;
8427
+ }
8428
+ declare function updateCurrentCart$1(httpClient: HttpClient): UpdateCurrentCartSignature;
8429
+ interface UpdateCurrentCartSignature {
8430
+ /**
8431
+ * Updates the current site visitor's cart.
8432
+ *
8433
+ *
8434
+ * The `updateCurrentCart()` function returns a Promise that resolves when the current cart's properties are updated.
8435
+ *
8436
+ * > **Note:** When updating catalog items, `options.lineItems.catalogReference` is required.
8437
+ * @param - Current cart update options.
8438
+ * @returns Fulfilled - The updated current cart.
8439
+ */
8440
+ (options?: UpdateCurrentCartOptions | undefined): Promise<Cart & CartNonNullableFields>;
8441
+ }
8442
+ declare function addToCurrentCart$1(httpClient: HttpClient): AddToCurrentCartSignature;
8443
+ interface AddToCurrentCartSignature {
8444
+ /**
8445
+ * Adds catalog line items to the current site visitor's cart.
8446
+ *
8447
+ *
8448
+ * The `addToCurrentCart()` function returns a Promise that resolves to the updated current cart when the specified items have been added.
8449
+ *
8450
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
8451
+ * @param - Items to be added to the current cart.
8452
+ */
8453
+ (options?: AddToCurrentCartOptions | undefined): Promise<AddToCartResponse & AddToCartResponseNonNullableFields>;
8454
+ }
8455
+ declare function removeLineItemsFromCurrentCart$1(httpClient: HttpClient): RemoveLineItemsFromCurrentCartSignature;
8456
+ interface RemoveLineItemsFromCurrentCartSignature {
8457
+ /**
8458
+ * Removes line items from the current site visitor's cart.
8459
+ *
8460
+ *
8461
+ * The `removeLineItemsFromCurrentCart()` function returns a Promise that resolves to the updated current cart when the line items are removed.
8462
+ * @param - IDs of the line items to remove from the cart.
8463
+ */
8464
+ (lineItemIds: string[]): Promise<RemoveLineItemsResponse$1 & RemoveLineItemsResponseNonNullableFields$1>;
8465
+ }
8466
+ declare function createCheckoutFromCurrentCart$1(httpClient: HttpClient): CreateCheckoutFromCurrentCartSignature;
8467
+ interface CreateCheckoutFromCurrentCartSignature {
8468
+ /**
8469
+ * Creates a checkout from the current site visitor’s cart.
8470
+ *
8471
+ *
8472
+ * The `createCheckoutFromCurrentCart()` function returns a Promise that resolves to the new checkout's ID when it's created.
8473
+ *
8474
+ * If a checkout was already created from the current cart, that checkout will be updated with any new information from the cart.
8475
+ *
8476
+ * > **Note:** `options.channelType` is a required field.
8477
+ * @param - Checkout creation options.
8478
+ */
8479
+ (options?: CreateCheckoutFromCurrentCartOptions | undefined): Promise<CreateCheckoutResponse$1 & CreateCheckoutResponseNonNullableFields$1>;
8480
+ }
8481
+ declare function removeCouponFromCurrentCart$1(httpClient: HttpClient): RemoveCouponFromCurrentCartSignature;
8482
+ interface RemoveCouponFromCurrentCartSignature {
8483
+ /**
8484
+ * Removes the coupon from the current site visitor's cart.
8485
+ *
8486
+ *
8487
+ * The `removeCouponFromCurrentCart()` function returns a Promise that resolves to the updated current cart when the coupon is removed.
8488
+ * @returns Fulfilled - Updated current cart.
8489
+ */
8490
+ (): Promise<RemoveCouponResponse$1 & RemoveCouponResponseNonNullableFields$1>;
8491
+ }
8492
+ declare function updateCurrentCartLineItemQuantity$1(httpClient: HttpClient): UpdateCurrentCartLineItemQuantitySignature;
8493
+ interface UpdateCurrentCartLineItemQuantitySignature {
8494
+ /**
8495
+ * Updates the quantity of one or more line items in the current site visitor's cart.
8496
+ *
8497
+ *
8498
+ * The `updateCurrentCartLineItemQuantity()` function returns a Promise that resolves when the quantities of the current cart's line items are updated. This endpoint is only for updating the quantity of line items. To entirely remove a line item from the current cart, use [`removeLineItemsFromCurrentCart()`](#removelineitemsfromcurrentcart).
8499
+ * To add a new line item to the current cart, use [`addToCurrentCart()`](#addtocurrentcart).
8500
+ *
8501
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity` is greater than the remaining stock, then the `quantity` returned in the response is the total amount of remaining stock.
8502
+ * @param - Line item IDs and their new quantity.
8503
+ * @returns Fulfilled - The updated current cart.
8504
+ */
8505
+ (lineItems: LineItemQuantityUpdate$1[]): Promise<UpdateLineItemsQuantityResponse$1 & UpdateLineItemsQuantityResponseNonNullableFields$1>;
8506
+ }
8507
+ declare function estimateCurrentCartTotals$1(httpClient: HttpClient): EstimateCurrentCartTotalsSignature;
8508
+ interface EstimateCurrentCartTotalsSignature {
8509
+ /**
8510
+ * Estimates the current cart's price totals (including tax), based on a selected carrier service, shipping address, and billing information.
8511
+ *
8512
+ *
8513
+ * The `estimateCurrentCartTotals()` function returns a Promise that resolves when the estimated totals are generated.
8514
+ *
8515
+ * > **Note:** Not passing any `options` properties will only estimate the cart items price totals.
8516
+ * @param - Total estimation options.
8517
+ */
8518
+ (options?: EstimateCurrentCartTotalsOptions | undefined): Promise<EstimateTotalsResponse & EstimateTotalsResponseNonNullableFields>;
8519
+ }
8520
+ declare function deleteCurrentCart$1(httpClient: HttpClient): DeleteCurrentCartSignature;
8521
+ interface DeleteCurrentCartSignature {
8522
+ /**
8523
+ * Deletes the current site visitor's cart.
8524
+ *
8525
+ *
8526
+ * The `deleteCurrentCart()` function returns a Promise that resolves when the current cart is deleted.
8527
+ * @returns Fulfilled - When the current cart is deleted. Rejected - Error message.
8528
+ */
8529
+ (): Promise<void>;
7964
8530
  }
7965
-
7966
- declare function getCurrentCart$1(httpClient: HttpClient): () => Promise<Cart & CartNonNullableFields>;
7967
- declare function updateCurrentCart$1(httpClient: HttpClient): (options?: UpdateCurrentCartOptions) => Promise<Cart & CartNonNullableFields>;
7968
- declare function addToCurrentCart$1(httpClient: HttpClient): (options?: AddToCurrentCartOptions) => Promise<AddToCartResponse & AddToCartResponseNonNullableFields>;
7969
- declare function removeLineItemsFromCurrentCart$1(httpClient: HttpClient): (lineItemIds: string[]) => Promise<RemoveLineItemsResponse$1 & RemoveLineItemsResponseNonNullableFields$1>;
7970
- declare function createCheckoutFromCurrentCart$1(httpClient: HttpClient): (options?: CreateCheckoutFromCurrentCartOptions) => Promise<CreateCheckoutResponse$1 & CreateCheckoutResponseNonNullableFields$1>;
7971
- declare function removeCouponFromCurrentCart$1(httpClient: HttpClient): () => Promise<RemoveCouponResponse$1 & RemoveCouponResponseNonNullableFields$1>;
7972
- declare function updateCurrentCartLineItemQuantity$1(httpClient: HttpClient): (lineItems: LineItemQuantityUpdate$1[]) => Promise<UpdateLineItemsQuantityResponse$1 & UpdateLineItemsQuantityResponseNonNullableFields$1>;
7973
- declare function estimateCurrentCartTotals$1(httpClient: HttpClient): (options?: EstimateCurrentCartTotalsOptions) => Promise<EstimateTotalsResponse & EstimateTotalsResponseNonNullableFields>;
7974
- declare function deleteCurrentCart$1(httpClient: HttpClient): () => Promise<void>;
7975
8531
  declare const onCartUpdated$1: EventDefinition<CartUpdatedEnvelope, "wix.ecom.v1.cart_updated">;
7976
8532
  declare const onCartDeleted$1: EventDefinition<CartDeletedEnvelope, "wix.ecom.v1.cart_deleted">;
7977
8533
  declare const onCartCreated$1: EventDefinition<CartCreatedEnvelope, "wix.ecom.v1.cart_created">;
@@ -8000,12 +8556,21 @@ type _publicDeleteCurrentCartType = typeof deleteCurrentCart$1;
8000
8556
  declare const deleteCurrentCart: ReturnType<typeof createRESTModule$g<_publicDeleteCurrentCartType>>;
8001
8557
 
8002
8558
  type _publicOnCartUpdatedType = typeof onCartUpdated$1;
8559
+ /**
8560
+ * Triggered when a cart is updated.
8561
+ */
8003
8562
  declare const onCartUpdated: ReturnType<typeof createEventModule$c<_publicOnCartUpdatedType>>;
8004
8563
 
8005
8564
  type _publicOnCartDeletedType = typeof onCartDeleted$1;
8565
+ /**
8566
+ * Triggered when a cart is deleted.
8567
+ */
8006
8568
  declare const onCartDeleted: ReturnType<typeof createEventModule$c<_publicOnCartDeletedType>>;
8007
8569
 
8008
8570
  type _publicOnCartCreatedType = typeof onCartCreated$1;
8571
+ /**
8572
+ * Triggered when a cart is created.
8573
+ */
8009
8574
  declare const onCartCreated: ReturnType<typeof createEventModule$c<_publicOnCartCreatedType>>;
8010
8575
 
8011
8576
  type context$g_AddToCartRequest = AddToCartRequest;
@@ -11094,19 +11659,183 @@ interface AddToCheckoutOptions {
11094
11659
  customLineItems?: CustomLineItem$2[];
11095
11660
  }
11096
11661
 
11097
- declare function createCheckout$1(httpClient: HttpClient): (options?: CreateCheckoutOptions) => Promise<Checkout$1 & CheckoutNonNullableFields>;
11098
- declare function getCheckout$1(httpClient: HttpClient): (_id: string) => Promise<Checkout$1 & CheckoutNonNullableFields>;
11099
- declare function getCheckoutByCartId$1(httpClient: HttpClient): (_id: string) => Promise<GetCheckoutByCartIdResponse & GetCheckoutByCartIdResponseNonNullableFields>;
11100
- declare function getCheckoutUrl$1(httpClient: HttpClient): (_id: string) => Promise<GetCheckoutURLResponse & GetCheckoutURLResponseNonNullableFields>;
11101
- declare function updateCheckout$1(httpClient: HttpClient): (_id: string | null, checkout: UpdateCheckout, options?: UpdateCheckoutOptions) => Promise<Checkout$1 & CheckoutNonNullableFields>;
11102
- declare function removeCoupon$1(httpClient: HttpClient): (_id: string) => Promise<RemoveCouponResponse & RemoveCouponResponseNonNullableFields>;
11103
- declare function removeGiftCard$1(httpClient: HttpClient): (_id: string) => Promise<RemoveGiftCardResponse & RemoveGiftCardResponseNonNullableFields>;
11104
- declare function removeOverrideCheckoutUrl$1(httpClient: HttpClient): (_id: string) => Promise<RemoveOverrideCheckoutUrlResponse & RemoveOverrideCheckoutUrlResponseNonNullableFields>;
11105
- declare function addToCheckout$1(httpClient: HttpClient): (_id: string, options?: AddToCheckoutOptions) => Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
11106
- declare function removeLineItems$1(httpClient: HttpClient): (_id: string, lineItemIds: string[]) => Promise<RemoveLineItemsResponse & RemoveLineItemsResponseNonNullableFields>;
11107
- declare function createOrder$3(httpClient: HttpClient): (_id: string) => Promise<CreateOrderResponse$1 & CreateOrderResponseNonNullableFields$1>;
11108
- declare function markCheckoutAsCompleted$1(httpClient: HttpClient): (_id: string) => Promise<void>;
11109
- declare function updateLineItemsQuantity$1(httpClient: HttpClient): (_id: string, lineItems: LineItemQuantityUpdate[]) => Promise<UpdateLineItemsQuantityResponse & UpdateLineItemsQuantityResponseNonNullableFields>;
11662
+ declare function createCheckout$1(httpClient: HttpClient): CreateCheckoutSignature;
11663
+ interface CreateCheckoutSignature {
11664
+ /**
11665
+ * Creates a checkout.
11666
+ *
11667
+ *
11668
+ * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
11669
+ *
11670
+ * > **Notes:**
11671
+ * > + Checkout must include at least 1 item in the `options.lineItems` array.
11672
+ * > + `options.channelType` is required.
11673
+ * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
11674
+ * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
11675
+ * @param - Checkout creation options.
11676
+ * @returns Fulfilled - the newly created checkout.
11677
+ */
11678
+ (options?: CreateCheckoutOptions | undefined): Promise<Checkout$1 & CheckoutNonNullableFields>;
11679
+ }
11680
+ declare function getCheckout$1(httpClient: HttpClient): GetCheckoutSignature;
11681
+ interface GetCheckoutSignature {
11682
+ /**
11683
+ * Retrieves a checkout.
11684
+ *
11685
+ *
11686
+ * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
11687
+ * @param - Checkout ID.
11688
+ * @returns Fulfilled - the requested checkout.
11689
+ */
11690
+ (_id: string): Promise<Checkout$1 & CheckoutNonNullableFields>;
11691
+ }
11692
+ declare function getCheckoutByCartId$1(httpClient: HttpClient): GetCheckoutByCartIdSignature;
11693
+ interface GetCheckoutByCartIdSignature {
11694
+ /**
11695
+ * Retrieves the checkout associated with a specified cart.
11696
+ * @param - Cart ID.
11697
+ */
11698
+ (_id: string): Promise<GetCheckoutByCartIdResponse & GetCheckoutByCartIdResponseNonNullableFields>;
11699
+ }
11700
+ declare function getCheckoutUrl$1(httpClient: HttpClient): GetCheckoutUrlSignature;
11701
+ interface GetCheckoutUrlSignature {
11702
+ /**
11703
+ * Retrieves the checkout page URL of a specified checkout.
11704
+ *
11705
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
11706
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
11707
+ * @param - Checkout ID.
11708
+ */
11709
+ (_id: string): Promise<GetCheckoutURLResponse & GetCheckoutURLResponseNonNullableFields>;
11710
+ }
11711
+ declare function updateCheckout$1(httpClient: HttpClient): UpdateCheckoutSignature;
11712
+ interface UpdateCheckoutSignature {
11713
+ /**
11714
+ * Updates a checkout.
11715
+ *
11716
+ *
11717
+ * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
11718
+ *
11719
+ * >**Notes:**
11720
+ * > + If nothing is passed in the request, the call will fail.
11721
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
11722
+ * @param - Checkout ID.
11723
+ * @param - Checkout update options.
11724
+ * @returns Updated checkout.
11725
+ */
11726
+ (_id: string | null, checkout: UpdateCheckout, options?: UpdateCheckoutOptions | undefined): Promise<Checkout$1 & CheckoutNonNullableFields>;
11727
+ }
11728
+ declare function removeCoupon$1(httpClient: HttpClient): RemoveCouponSignature;
11729
+ interface RemoveCouponSignature {
11730
+ /**
11731
+ * Removes the coupon from a specified checkout.
11732
+ *
11733
+ *
11734
+ * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
11735
+ *
11736
+ * >**Note:** A checkout can only hold 1 coupon.
11737
+ * @param - ID of the checkout to remove the coupon from.
11738
+ */
11739
+ (_id: string): Promise<RemoveCouponResponse & RemoveCouponResponseNonNullableFields>;
11740
+ }
11741
+ declare function removeGiftCard$1(httpClient: HttpClient): RemoveGiftCardSignature;
11742
+ interface RemoveGiftCardSignature {
11743
+ /**
11744
+ * Removes the gift card from a specified checkout.
11745
+ *
11746
+ *
11747
+ * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
11748
+ *
11749
+ * >**Note:** A checkout can only hold 1 gift card.
11750
+ * @param - ID of the checkout to remove the gift card from.
11751
+ */
11752
+ (_id: string): Promise<RemoveGiftCardResponse & RemoveGiftCardResponseNonNullableFields>;
11753
+ }
11754
+ declare function removeOverrideCheckoutUrl$1(httpClient: HttpClient): RemoveOverrideCheckoutUrlSignature;
11755
+ interface RemoveOverrideCheckoutUrlSignature {
11756
+ /**
11757
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
11758
+ *
11759
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
11760
+ * Wix checkout page URL.
11761
+ * @param - ID of the checkout to remove the override checkout url from.
11762
+ */
11763
+ (_id: string): Promise<RemoveOverrideCheckoutUrlResponse & RemoveOverrideCheckoutUrlResponseNonNullableFields>;
11764
+ }
11765
+ declare function addToCheckout$1(httpClient: HttpClient): AddToCheckoutSignature;
11766
+ interface AddToCheckoutSignature {
11767
+ /**
11768
+ * Adds catalog line items and/or custom line items to a checkout.
11769
+ *
11770
+ *
11771
+ * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
11772
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
11773
+ * @param - Checkout ID.
11774
+ * @param - Items to be added to checkout.
11775
+ */
11776
+ (_id: string, options?: AddToCheckoutOptions | undefined): Promise<AddToCheckoutResponse & AddToCheckoutResponseNonNullableFields>;
11777
+ }
11778
+ declare function removeLineItems$1(httpClient: HttpClient): RemoveLineItemsSignature;
11779
+ interface RemoveLineItemsSignature {
11780
+ /**
11781
+ * Removes line items from the specified checkout.
11782
+ *
11783
+ *
11784
+ * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
11785
+ * @param - ID of the checkout to remove line items from.
11786
+ * @param - IDs of the line items to be removed.
11787
+ * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
11788
+ */
11789
+ (_id: string, lineItemIds: string[]): Promise<RemoveLineItemsResponse & RemoveLineItemsResponseNonNullableFields>;
11790
+ }
11791
+ declare function createOrder$3(httpClient: HttpClient): CreateOrderSignature$1;
11792
+ interface CreateOrderSignature$1 {
11793
+ /**
11794
+ * Creates an order from a specified checkout.
11795
+ *
11796
+ * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
11797
+ * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
11798
+ *
11799
+ * > **Note:** The following requirements must be met for an order to be created from a checkout.
11800
+ * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
11801
+ * > + A checkout must have at least 1 line item.
11802
+ * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
11803
+ * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
11804
+ * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
11805
+ * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
11806
+ * @param - Checkout ID.
11807
+ * @param - Further order creation options.
11808
+ */
11809
+ (_id: string): Promise<CreateOrderResponse$1 & CreateOrderResponseNonNullableFields$1>;
11810
+ }
11811
+ declare function markCheckoutAsCompleted$1(httpClient: HttpClient): MarkCheckoutAsCompletedSignature;
11812
+ interface MarkCheckoutAsCompletedSignature {
11813
+ /**
11814
+ * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
11815
+ *
11816
+ *
11817
+ * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
11818
+ * @param - Checkout ID.
11819
+ */
11820
+ (_id: string): Promise<void>;
11821
+ }
11822
+ declare function updateLineItemsQuantity$1(httpClient: HttpClient): UpdateLineItemsQuantitySignature;
11823
+ interface UpdateLineItemsQuantitySignature {
11824
+ /**
11825
+ * Updates the quantity of one or more line items in a checkout.
11826
+ *
11827
+ * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
11828
+ * the checkout, use [`removeLineItems()`](#removelineitems).
11829
+ * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
11830
+ *
11831
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
11832
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
11833
+ * of remaining stock.
11834
+ * @param - Checkout ID.
11835
+ * @param - Line item info to update.
11836
+ */
11837
+ (_id: string, lineItems: LineItemQuantityUpdate[]): Promise<UpdateLineItemsQuantityResponse & UpdateLineItemsQuantityResponseNonNullableFields>;
11838
+ }
11110
11839
  declare const onCheckoutCreated$1: EventDefinition<CheckoutCreatedEnvelope, "wix.ecom.v1.checkout_created">;
11111
11840
  declare const onCheckoutUpdated$1: EventDefinition<CheckoutUpdatedEnvelope, "wix.ecom.v1.checkout_updated">;
11112
11841
  declare const onCheckoutCompleted$1: EventDefinition<CheckoutCompletedEnvelope, "wix.ecom.v1.checkout_completed">;
@@ -11143,12 +11872,22 @@ type _publicUpdateLineItemsQuantityType = typeof updateLineItemsQuantity$1;
11143
11872
  declare const updateLineItemsQuantity: ReturnType<typeof createRESTModule$f<_publicUpdateLineItemsQuantityType>>;
11144
11873
 
11145
11874
  type _publicOnCheckoutCreatedType = typeof onCheckoutCreated$1;
11875
+ /**
11876
+ * Triggered when a checkout is created.
11877
+ */
11146
11878
  declare const onCheckoutCreated: ReturnType<typeof createEventModule$b<_publicOnCheckoutCreatedType>>;
11147
11879
 
11148
11880
  type _publicOnCheckoutUpdatedType = typeof onCheckoutUpdated$1;
11881
+ /**
11882
+ * Triggered when a checkout is updated.
11883
+ */
11149
11884
  declare const onCheckoutUpdated: ReturnType<typeof createEventModule$b<_publicOnCheckoutUpdatedType>>;
11150
11885
 
11151
11886
  type _publicOnCheckoutCompletedType = typeof onCheckoutCompleted$1;
11887
+ /**
11888
+ * Triggered when an order created from this checkout is
11889
+ * successfully paid for or when a checkout is marked as completed.
11890
+ */
11152
11891
  declare const onCheckoutCompleted: ReturnType<typeof createEventModule$b<_publicOnCheckoutCompletedType>>;
11153
11892
 
11154
11893
  type context$f_AddToCheckoutOptions = AddToCheckoutOptions;
@@ -11639,8 +12378,29 @@ interface CheckoutSettingsUpdatedEnvelope {
11639
12378
  metadata: EventMetadata$a;
11640
12379
  }
11641
12380
 
11642
- declare function getCheckoutSettings$1(httpClient: HttpClient): () => Promise<GetCheckoutSettingsResponse & GetCheckoutSettingsResponseNonNullableFields>;
11643
- declare function updateCheckoutSettings$1(httpClient: HttpClient): (checkoutSettings: CheckoutSettings) => Promise<UpdateCheckoutSettingsResponse & UpdateCheckoutSettingsResponseNonNullableFields>;
12381
+ declare function getCheckoutSettings$1(httpClient: HttpClient): GetCheckoutSettingsSignature;
12382
+ interface GetCheckoutSettingsSignature {
12383
+ /**
12384
+ * Retrieves the sites' checkout settings.
12385
+ *
12386
+ *
12387
+ * The `getCheckoutSettings()` function returns a Promise that resolves to checkout settings.
12388
+ * @returns The requested checkout settings.
12389
+ */
12390
+ (): Promise<GetCheckoutSettingsResponse & GetCheckoutSettingsResponseNonNullableFields>;
12391
+ }
12392
+ declare function updateCheckoutSettings$1(httpClient: HttpClient): UpdateCheckoutSettingsSignature;
12393
+ interface UpdateCheckoutSettingsSignature {
12394
+ /**
12395
+ * Updates the sites' checkout settings.
12396
+ *
12397
+ *
12398
+ * The `updateCheckoutSettings()` function returns a Promise that resolves to the newly updated checkout settings.
12399
+ * @param - Checkout settings to update.
12400
+ * @returns The updated checkout settings.
12401
+ */
12402
+ (checkoutSettings: CheckoutSettings): Promise<UpdateCheckoutSettingsResponse & UpdateCheckoutSettingsResponseNonNullableFields>;
12403
+ }
11644
12404
  declare const onCheckoutSettingsUpdated$1: EventDefinition<CheckoutSettingsUpdatedEnvelope, "wix.ecom.v1.checkout_settings_updated">;
11645
12405
 
11646
12406
  declare function createRESTModule$e<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -11653,6 +12413,9 @@ type _publicUpdateCheckoutSettingsType = typeof updateCheckoutSettings$1;
11653
12413
  declare const updateCheckoutSettings: ReturnType<typeof createRESTModule$e<_publicUpdateCheckoutSettingsType>>;
11654
12414
 
11655
12415
  type _publicOnCheckoutSettingsUpdatedType = typeof onCheckoutSettingsUpdated$1;
12416
+ /**
12417
+ * Triggered when checkout settings are updated.
12418
+ */
11656
12419
  declare const onCheckoutSettingsUpdated: ReturnType<typeof createEventModule$a<_publicOnCheckoutSettingsUpdatedType>>;
11657
12420
 
11658
12421
  type context$e_Alignment = Alignment;
@@ -13865,13 +14628,107 @@ interface CheckoutTemplatesQueryBuilder {
13865
14628
  find: () => Promise<CheckoutTemplatesQueryResult>;
13866
14629
  }
13867
14630
 
13868
- declare function createCheckoutTemplate$1(httpClient: HttpClient): (checkoutTemplate: CheckoutTemplate) => Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
13869
- declare function getCheckoutTemplate$1(httpClient: HttpClient): (checkoutTemplateId: string) => Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
13870
- declare function updateCheckoutTemplate$1(httpClient: HttpClient): (_id: string | null, checkoutTemplate: UpdateCheckoutTemplate) => Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
13871
- declare function deleteCheckoutTemplate$1(httpClient: HttpClient): (checkoutTemplateId: string) => Promise<void>;
13872
- declare function queryCheckoutTemplates$1(httpClient: HttpClient): () => CheckoutTemplatesQueryBuilder;
13873
- declare function createCheckoutFromTemplate$1(httpClient: HttpClient): (checkoutTemplateId: string, siteId: string) => Promise<CreateCheckoutFromTemplateResponse & CreateCheckoutFromTemplateResponseNonNullableFields>;
13874
- declare function createAndRedirectToCheckout$1(httpClient: HttpClient): (checkoutTemplateId: string, siteId: string) => Promise<RawHttpResponse & RawHttpResponseNonNullableFields>;
14631
+ declare function createCheckoutTemplate$1(httpClient: HttpClient): CreateCheckoutTemplateSignature;
14632
+ interface CreateCheckoutTemplateSignature {
14633
+ /**
14634
+ * Creates a checkout template.
14635
+ *
14636
+ * A checkout template is used to create a new checkout that will include predefined information. For example, a single link with
14637
+ * a `checkoutTemplateId` can be shared with customers and each time the link is clicked, a new checkout page will be created
14638
+ * for that customer with certain checkout information already populated.
14639
+ *
14640
+ * The customizable features include the option to allow or to lock coupon codes or gift cards. For example, if a store owner is
14641
+ * using the checkout template to offer a flash sale to their social media followers, they may want to lock the option to apply an
14642
+ * additional coupon on top of the sale being offered. If so, they can set `customization.lockedCoupon` to `true`.
14643
+ *
14644
+ * A checkout can be created with a checkout template by calling `createCheckoutFromTemplate()`. The site may add further customizations to the new checkout and then redirect the customer using the new checkout's `checkoutUrl`.
14645
+ * @param - Checkout template to create.
14646
+ * @returns Created checkout template.
14647
+ */
14648
+ (checkoutTemplate: CheckoutTemplate): Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
14649
+ }
14650
+ declare function getCheckoutTemplate$1(httpClient: HttpClient): GetCheckoutTemplateSignature;
14651
+ interface GetCheckoutTemplateSignature {
14652
+ /**
14653
+ * Retrieves a checkout template.
14654
+ * @param - ID of the checkout template to retrieve.
14655
+ * @returns Retrieved checkout template.
14656
+ */
14657
+ (checkoutTemplateId: string): Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
14658
+ }
14659
+ declare function updateCheckoutTemplate$1(httpClient: HttpClient): UpdateCheckoutTemplateSignature;
14660
+ interface UpdateCheckoutTemplateSignature {
14661
+ /**
14662
+ * Updates a checkout template.
14663
+ *
14664
+ * If the info in a checkout template is updated, only new checkouts created from this template will include the updated items. Checkouts previously
14665
+ * created from this template before the update will not be affected.
14666
+ * @param - Checkout template ID.
14667
+ * @param - Checkout template info to update.
14668
+ * @returns Updated checkout template.
14669
+ */
14670
+ (_id: string | null, checkoutTemplate: UpdateCheckoutTemplate): Promise<CheckoutTemplate & CheckoutTemplateNonNullableFields>;
14671
+ }
14672
+ declare function deleteCheckoutTemplate$1(httpClient: HttpClient): DeleteCheckoutTemplateSignature;
14673
+ interface DeleteCheckoutTemplateSignature {
14674
+ /**
14675
+ * Deletes a checkout template.
14676
+ *
14677
+ * If a checkout template is deleted and a customer attempts to create a checkout with that `checkoutTemplateId` then
14678
+ * the customer will be redirected to the domain site.
14679
+ * @param - ID of the checkout template to delete.
14680
+ */
14681
+ (checkoutTemplateId: string): Promise<void>;
14682
+ }
14683
+ declare function queryCheckoutTemplates$1(httpClient: HttpClient): QueryCheckoutTemplatesSignature;
14684
+ interface QueryCheckoutTemplatesSignature {
14685
+ /**
14686
+ * Creates a query to retrieve a list of checkout templates.
14687
+ *
14688
+ * The `queryCheckoutTemplates()` function builds a query to retrieve a list of checkout templates and returns a `CheckoutTemplatesQueryBuilder` object.
14689
+ *
14690
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
14691
+ *
14692
+ * You can refine the query by chaining `CheckoutTemplatesQueryBuilder` functions onto the query. `CheckoutTemplatesQueryBuilder` functions enable you to sort, filter, and control the results that `queryCheckoutTemplates()` returns.
14693
+ *
14694
+ * `queryCheckoutTemplates()` runs with the following `CheckoutTemplatesQueryBuilder` default that you can override:
14695
+ * + `ascending("_id")`
14696
+ *
14697
+ * The functions that are chained to `queryCheckoutTemplates()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("_id")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"_id"`.
14698
+ *
14699
+ * The following `CheckoutTemplatesQueryBuilder` functions are supported for the `queryCheckoutTemplates()` function. For a full description of the checkout template object, see the object returned for the `items` property in `CheckoutTemplatesQueryResult`.
14700
+ */
14701
+ (): CheckoutTemplatesQueryBuilder;
14702
+ }
14703
+ declare function createCheckoutFromTemplate$1(httpClient: HttpClient): CreateCheckoutFromTemplateSignature;
14704
+ interface CreateCheckoutFromTemplateSignature {
14705
+ /**
14706
+ * Creates a new checkout based on the checkout template.
14707
+ *
14708
+ * Before using this function, you must have a checkout template available. Create a checkout template with `createCheckoutTemplate()`.
14709
+ *
14710
+ * The customer can be directed to the new checkout using the checkout's `checkoutUrl`.
14711
+ * @param - ID of the checkout template to use to create a checkout from.
14712
+ * @param - ID of the site associated with the checkout template.
14713
+ */
14714
+ (checkoutTemplateId: string, siteId: string): Promise<CreateCheckoutFromTemplateResponse & CreateCheckoutFromTemplateResponseNonNullableFields>;
14715
+ }
14716
+ declare function createAndRedirectToCheckout$1(httpClient: HttpClient): CreateAndRedirectToCheckoutSignature;
14717
+ interface CreateAndRedirectToCheckoutSignature {
14718
+ /**
14719
+ * Creates a new checkout based on the checkout template and redirects to the new checkout page.
14720
+ *
14721
+ * Before using this function, you must have a checkout template available. Create a checkout template with `createCheckoutTemplate()`.
14722
+ *
14723
+ * To build a URL that uses this function, follow this format:
14724
+ * `https://www.wixapis.com/ecom/v1/checkout-templates/{checkoutTemplateId}/create-and-redirect-to-checkout?siteId={siteId}`
14725
+ *
14726
+ * To create a checkout but not automatically redirect to the checkout page, use `createCheckoutFromTemplate()`.
14727
+ * @param - ID of the checkout template to use to create a checkout.
14728
+ * @param - ID of the site associated with the checkout template.
14729
+ */
14730
+ (checkoutTemplateId: string, siteId: string): Promise<RawHttpResponse & RawHttpResponseNonNullableFields>;
14731
+ }
13875
14732
  declare const onCheckoutTemplateCreated$1: EventDefinition<CheckoutTemplateCreatedEnvelope, "wix.ecom.v1.checkout_template_created">;
13876
14733
  declare const onCheckoutTemplateUpdated$1: EventDefinition<CheckoutTemplateUpdatedEnvelope, "wix.ecom.v1.checkout_template_updated">;
13877
14734
  declare const onCheckoutTemplateDeleted$1: EventDefinition<CheckoutTemplateDeletedEnvelope, "wix.ecom.v1.checkout_template_deleted">;
@@ -13897,15 +14754,27 @@ type _publicCreateAndRedirectToCheckoutType = typeof createAndRedirectToCheckout
13897
14754
  declare const createAndRedirectToCheckout: ReturnType<typeof createRESTModule$d<_publicCreateAndRedirectToCheckoutType>>;
13898
14755
 
13899
14756
  type _publicOnCheckoutTemplateCreatedType = typeof onCheckoutTemplateCreated$1;
14757
+ /**
14758
+ * Triggered when a checkout template is created.
14759
+ */
13900
14760
  declare const onCheckoutTemplateCreated: ReturnType<typeof createEventModule$9<_publicOnCheckoutTemplateCreatedType>>;
13901
14761
 
13902
14762
  type _publicOnCheckoutTemplateUpdatedType = typeof onCheckoutTemplateUpdated$1;
14763
+ /**
14764
+ * Triggered when a checkout template is updated.
14765
+ */
13903
14766
  declare const onCheckoutTemplateUpdated: ReturnType<typeof createEventModule$9<_publicOnCheckoutTemplateUpdatedType>>;
13904
14767
 
13905
14768
  type _publicOnCheckoutTemplateDeletedType = typeof onCheckoutTemplateDeleted$1;
14769
+ /**
14770
+ * Triggered when a checkout template is deleted.
14771
+ */
13906
14772
  declare const onCheckoutTemplateDeleted: ReturnType<typeof createEventModule$9<_publicOnCheckoutTemplateDeletedType>>;
13907
14773
 
13908
14774
  type _publicOnCheckoutTemplateUsedType = typeof onCheckoutTemplateUsed$1;
14775
+ /**
14776
+ * Triggered when a checkout is created from a checkout template.
14777
+ */
13909
14778
  declare const onCheckoutTemplateUsed: ReturnType<typeof createEventModule$9<_publicOnCheckoutTemplateUsedType>>;
13910
14779
 
13911
14780
  type context$d_CatalogOverrideFields = CatalogOverrideFields;
@@ -15186,20 +16055,145 @@ interface UpdateExtendedFieldsOptions$3 {
15186
16055
  namespaceData: Record<string, any> | null;
15187
16056
  }
15188
16057
 
15189
- declare function createDeliveryProfile$1(httpClient: HttpClient): (deliveryProfile: DeliveryProfile) => Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
15190
- declare function getDeliveryProfile$1(httpClient: HttpClient): (deliveryProfileId: string) => Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
15191
- declare function updateDeliveryProfile$1(httpClient: HttpClient): (_id: string | null, deliveryProfile: UpdateDeliveryProfile) => Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
15192
- declare function deleteDeliveryProfile$1(httpClient: HttpClient): (deliveryProfileId: string) => Promise<void>;
15193
- declare function queryDeliveryProfiles$1(httpClient: HttpClient): () => DeliveryProfilesQueryBuilder;
15194
- declare function addDeliveryRegion$1(httpClient: HttpClient): (deliveryProfileId: string, deliveryRegion: DeliveryRegion, options?: AddDeliveryRegionOptions) => Promise<AddDeliveryRegionResponse & AddDeliveryRegionResponseNonNullableFields>;
15195
- declare function updateDeliveryRegion$1(httpClient: HttpClient): (identifiers: UpdateDeliveryRegionIdentifiers, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions) => Promise<UpdateDeliveryRegionResponse & UpdateDeliveryRegionResponseNonNullableFields>;
15196
- declare function removeDeliveryRegion$1(httpClient: HttpClient): (identifiers: RemoveDeliveryRegionIdentifiers, options?: RemoveDeliveryRegionOptions) => Promise<RemoveDeliveryRegionResponse & RemoveDeliveryRegionResponseNonNullableFields>;
15197
- declare function addDeliveryCarrier$1(httpClient: HttpClient): (deliveryRegionId: string, options: AddDeliveryCarrierOptions) => Promise<AddDeliveryCarrierResponse & AddDeliveryCarrierResponseNonNullableFields>;
15198
- declare function removeDeliveryCarrier$1(httpClient: HttpClient): (deliveryRegionId: string, options: RemoveDeliveryCarrierOptions) => Promise<RemoveDeliveryCarrierResponse & RemoveDeliveryCarrierResponseNonNullableFields>;
15199
- declare function updateDeliveryCarrier$1(httpClient: HttpClient): (deliveryRegionId: string, options?: UpdateDeliveryCarrierOptions) => Promise<UpdateDeliveryCarrierResponse & UpdateDeliveryCarrierResponseNonNullableFields>;
15200
- declare function listDeliveryCarrierDetails$1(httpClient: HttpClient): () => Promise<ListDeliveryCarrierDetailsResponse & ListDeliveryCarrierDetailsResponseNonNullableFields>;
15201
- declare function listDeliveryCarriers$1(httpClient: HttpClient): (deliveryProfileId: string, options?: ListDeliveryCarriersOptions) => Promise<ListDeliveryCarriersResponse & ListDeliveryCarriersResponseNonNullableFields>;
15202
- declare function updateExtendedFields$7(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$3) => Promise<UpdateExtendedFieldsResponse$4 & UpdateExtendedFieldsResponseNonNullableFields$3>;
16058
+ declare function createDeliveryProfile$1(httpClient: HttpClient): CreateDeliveryProfileSignature;
16059
+ interface CreateDeliveryProfileSignature {
16060
+ /**
16061
+ * Creates a DeliveryProfile.
16062
+ *
16063
+ * The request body must include the DeliveryProfiles name. DeliveryRegions are optional.
16064
+ * @param - DeliveryProfile to be created.
16065
+ * @returns The created DeliveryProfile.
16066
+ */
16067
+ (deliveryProfile: DeliveryProfile): Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
16068
+ }
16069
+ declare function getDeliveryProfile$1(httpClient: HttpClient): GetDeliveryProfileSignature;
16070
+ interface GetDeliveryProfileSignature {
16071
+ /**
16072
+ * Retrieves a DeliveryProfile.
16073
+ * @param - ID of the DeliveryProfile to retrieve.
16074
+ * @returns The requested DeliveryProfile.
16075
+ */
16076
+ (deliveryProfileId: string): Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
16077
+ }
16078
+ declare function updateDeliveryProfile$1(httpClient: HttpClient): UpdateDeliveryProfileSignature;
16079
+ interface UpdateDeliveryProfileSignature {
16080
+ /**
16081
+ * Updates a DeliveryProfile.
16082
+ *
16083
+ *
16084
+ * Each time the DeliveryProfile is updated,
16085
+ * `revision` increments by 1.
16086
+ * The current `revision` must be passed when updating the DeliveryProfile.
16087
+ * This ensures you're working with the latest DeliveryProfile
16088
+ * and prevents unintended overwrites.
16089
+ *
16090
+ * This method does not allow updating the DeliveryRegions in this DeliveryProfile.
16091
+ * Use AddDeliveryRegion, UpdateDeliveryRegion and RemoveDeliveryRegion for these functionalities.
16092
+ * @param - DeliveryProfile ID.
16093
+ * @returns Updated DeliveryProfile.
16094
+ */
16095
+ (_id: string | null, deliveryProfile: UpdateDeliveryProfile): Promise<DeliveryProfile & DeliveryProfileNonNullableFields>;
16096
+ }
16097
+ declare function deleteDeliveryProfile$1(httpClient: HttpClient): DeleteDeliveryProfileSignature;
16098
+ interface DeleteDeliveryProfileSignature {
16099
+ /**
16100
+ * Deletes a DeliveryProfile.
16101
+ *
16102
+ * Deleting a DeliveryProfile permanently removes them from the DeliveryProfile List.
16103
+ * @param - Id of the DeliveryProfile to delete.
16104
+ */
16105
+ (deliveryProfileId: string): Promise<void>;
16106
+ }
16107
+ declare function queryDeliveryProfiles$1(httpClient: HttpClient): QueryDeliveryProfilesSignature;
16108
+ interface QueryDeliveryProfilesSignature {
16109
+ /**
16110
+ * Retrieves a list of DeliveryProfiles, given the provided [paging, filtering, and sorting][1].
16111
+ *
16112
+ * Up to 1,000 DeliveryProfiles can be returned per request.
16113
+ *
16114
+ * To learn how to query DeliveryProfiles, see [API Query Language][2].
16115
+ *
16116
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
16117
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
16118
+ */
16119
+ (): DeliveryProfilesQueryBuilder;
16120
+ }
16121
+ declare function addDeliveryRegion$1(httpClient: HttpClient): AddDeliveryRegionSignature;
16122
+ interface AddDeliveryRegionSignature {
16123
+ /**
16124
+ * Creates a new DeliveryRegion in an existing DeliveryProfile.
16125
+ * @param - delivery profile id to associated with the DeliveryRegion
16126
+ * @param - DeliveryRegion to be created
16127
+ */
16128
+ (deliveryProfileId: string, deliveryRegion: DeliveryRegion, options?: AddDeliveryRegionOptions | undefined): Promise<AddDeliveryRegionResponse & AddDeliveryRegionResponseNonNullableFields>;
16129
+ }
16130
+ declare function updateDeliveryRegion$1(httpClient: HttpClient): UpdateDeliveryRegionSignature;
16131
+ interface UpdateDeliveryRegionSignature {
16132
+ /**
16133
+ * Update a DeliveryRegion, supports partial update
16134
+ * Pass the latest `revision` for a successful update
16135
+ *
16136
+ * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
16137
+ * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.
16138
+ */
16139
+ (identifiers: UpdateDeliveryRegionIdentifiers, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions | undefined): Promise<UpdateDeliveryRegionResponse & UpdateDeliveryRegionResponseNonNullableFields>;
16140
+ }
16141
+ declare function removeDeliveryRegion$1(httpClient: HttpClient): RemoveDeliveryRegionSignature;
16142
+ interface RemoveDeliveryRegionSignature {
16143
+ /**
16144
+ * Delete a DeliveryRegion
16145
+ */
16146
+ (identifiers: RemoveDeliveryRegionIdentifiers, options?: RemoveDeliveryRegionOptions | undefined): Promise<RemoveDeliveryRegionResponse & RemoveDeliveryRegionResponseNonNullableFields>;
16147
+ }
16148
+ declare function addDeliveryCarrier$1(httpClient: HttpClient): AddDeliveryCarrierSignature;
16149
+ interface AddDeliveryCarrierSignature {
16150
+ /**
16151
+ * Add a delivery_carrier to a delivery region
16152
+ * @param - delivery_region id to associated with the delivery_carrier.
16153
+ */
16154
+ (deliveryRegionId: string, options: AddDeliveryCarrierOptions): Promise<AddDeliveryCarrierResponse & AddDeliveryCarrierResponseNonNullableFields>;
16155
+ }
16156
+ declare function removeDeliveryCarrier$1(httpClient: HttpClient): RemoveDeliveryCarrierSignature;
16157
+ interface RemoveDeliveryCarrierSignature {
16158
+ /**
16159
+ * Remove a delivery_carrier from a delivery region
16160
+ * @param - Id of the DeliveryRegion
16161
+ */
16162
+ (deliveryRegionId: string, options: RemoveDeliveryCarrierOptions): Promise<RemoveDeliveryCarrierResponse & RemoveDeliveryCarrierResponseNonNullableFields>;
16163
+ }
16164
+ declare function updateDeliveryCarrier$1(httpClient: HttpClient): UpdateDeliveryCarrierSignature;
16165
+ interface UpdateDeliveryCarrierSignature {
16166
+ /**
16167
+ * Update a delivery carrier in a delivery region
16168
+ * @param - DeliveryRegion id
16169
+ */
16170
+ (deliveryRegionId: string, options?: UpdateDeliveryCarrierOptions | undefined): Promise<UpdateDeliveryCarrierResponse & UpdateDeliveryCarrierResponseNonNullableFields>;
16171
+ }
16172
+ declare function listDeliveryCarrierDetails$1(httpClient: HttpClient): ListDeliveryCarrierDetailsSignature;
16173
+ interface ListDeliveryCarrierDetailsSignature {
16174
+ /**
16175
+ * List all installed delivery carriers in order to set their ids in delivery rules
16176
+ */
16177
+ (): Promise<ListDeliveryCarrierDetailsResponse & ListDeliveryCarrierDetailsResponseNonNullableFields>;
16178
+ }
16179
+ declare function listDeliveryCarriers$1(httpClient: HttpClient): ListDeliveryCarriersSignature;
16180
+ interface ListDeliveryCarriersSignature {
16181
+ /**
16182
+ * Get delivery carrier settings for a delivery profile and delivery region.
16183
+ * These are returned in a table format for the dashboard.
16184
+ * @param - Delivery profile id.
16185
+ */
16186
+ (deliveryProfileId: string, options?: ListDeliveryCarriersOptions | undefined): Promise<ListDeliveryCarriersResponse & ListDeliveryCarriersResponseNonNullableFields>;
16187
+ }
16188
+ declare function updateExtendedFields$7(httpClient: HttpClient): UpdateExtendedFieldsSignature$3;
16189
+ interface UpdateExtendedFieldsSignature$3 {
16190
+ /**
16191
+ * Updates extended fields of a DeliveryProfile without incrementing revision
16192
+ * @param - ID of the entity to update.
16193
+ * @param - Identifier for the app whose extended fields are being updated.
16194
+ */
16195
+ (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$3): Promise<UpdateExtendedFieldsResponse$4 & UpdateExtendedFieldsResponseNonNullableFields$3>;
16196
+ }
15203
16197
  declare const onDeliveryProfileCreated$1: EventDefinition<DeliveryProfileCreatedEnvelope, "wix.ecom.v1.delivery_profile_created">;
15204
16198
  declare const onDeliveryProfileDeliveryRegionAdded$1: EventDefinition<DeliveryProfileDeliveryRegionAddedEnvelope, "wix.ecom.v1.delivery_profile_delivery_region_added">;
15205
16199
  declare const onDeliveryProfileUpdated$1: EventDefinition<DeliveryProfileUpdatedEnvelope, "wix.ecom.v1.delivery_profile_updated">;
@@ -15241,21 +16235,35 @@ type _publicUpdateExtendedFieldsType$3 = typeof updateExtendedFields$7;
15241
16235
  declare const updateExtendedFields$6: ReturnType<typeof createRESTModule$c<_publicUpdateExtendedFieldsType>>;
15242
16236
 
15243
16237
  type _publicOnDeliveryProfileCreatedType = typeof onDeliveryProfileCreated$1;
16238
+ /** */
15244
16239
  declare const onDeliveryProfileCreated: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileCreatedType>>;
15245
16240
 
15246
16241
  type _publicOnDeliveryProfileDeliveryRegionAddedType = typeof onDeliveryProfileDeliveryRegionAdded$1;
16242
+ /**
16243
+ * Triggered when a delivery_region is added to a delivery_profile.
16244
+ */
15247
16245
  declare const onDeliveryProfileDeliveryRegionAdded: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileDeliveryRegionAddedType>>;
15248
16246
 
15249
16247
  type _publicOnDeliveryProfileUpdatedType = typeof onDeliveryProfileUpdated$1;
16248
+ /**
16249
+ * Triggered when the delivery_carrier updated successfully
16250
+ */
15250
16251
  declare const onDeliveryProfileUpdated: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileUpdatedType>>;
15251
16252
 
15252
16253
  type _publicOnDeliveryProfileDeletedType = typeof onDeliveryProfileDeleted$1;
16254
+ /** */
15253
16255
  declare const onDeliveryProfileDeleted: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileDeletedType>>;
15254
16256
 
15255
16257
  type _publicOnDeliveryProfileDeliveryRegionRemovedType = typeof onDeliveryProfileDeliveryRegionRemoved$1;
16258
+ /**
16259
+ * Triggered for each delivery_region assigned to the deleted delivery_profile
16260
+ */
15256
16261
  declare const onDeliveryProfileDeliveryRegionRemoved: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileDeliveryRegionRemovedType>>;
15257
16262
 
15258
16263
  type _publicOnDeliveryProfileDeliveryRegionUpdatedType = typeof onDeliveryProfileDeliveryRegionUpdated$1;
16264
+ /**
16265
+ * Triggered when the delivery_carrier updated successfully
16266
+ */
15259
16267
  declare const onDeliveryProfileDeliveryRegionUpdated: ReturnType<typeof createEventModule$8<_publicOnDeliveryProfileDeliveryRegionUpdatedType>>;
15260
16268
 
15261
16269
  type context$c_AddDeliveryCarrierOptions = AddDeliveryCarrierOptions;
@@ -18341,33 +19349,155 @@ interface DraftOrdersQueryBuilder {
18341
19349
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
18342
19350
  * @documentationMaturity preview
18343
19351
  */
18344
- descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
18345
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
18346
- * @documentationMaturity preview
19352
+ descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'status'>) => DraftOrdersQueryBuilder;
19353
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
19354
+ * @documentationMaturity preview
19355
+ */
19356
+ limit: (limit: number) => DraftOrdersQueryBuilder;
19357
+ /** @param cursor - A pointer to specific record
19358
+ * @documentationMaturity preview
19359
+ */
19360
+ skipTo: (cursor: string) => DraftOrdersQueryBuilder;
19361
+ /** @documentationMaturity preview */
19362
+ find: () => Promise<DraftOrdersQueryResult>;
19363
+ }
19364
+
19365
+ declare function createDraftOrder$1(httpClient: HttpClient): CreateDraftOrderSignature;
19366
+ interface CreateDraftOrderSignature {
19367
+ /**
19368
+ * Creates or gets a draft order.
19369
+ *
19370
+ * When passing the ID of an order that is already in draft, the existing draft order will be returned.
19371
+ * To complete a draft and update the order, call [Commit Draft Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/commit-draft-order).
19372
+ * @param - To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
19373
+ */
19374
+ (orderId: string | null): Promise<CreateDraftOrderResponse & CreateDraftOrderResponseNonNullableFields>;
19375
+ }
19376
+ declare function addLineItemsToDraftOrder$1(httpClient: HttpClient): AddLineItemsToDraftOrderSignature;
19377
+ interface AddLineItemsToDraftOrderSignature {
19378
+ /**
19379
+ * Adds line items to a draft order.
19380
+ * @param - The draft order id
19381
+ */
19382
+ (draftOrderId: string, options?: AddLineItemsToDraftOrderOptions | undefined): Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
19383
+ }
19384
+ declare function updateLineItems$1(httpClient: HttpClient): UpdateLineItemsSignature;
19385
+ interface UpdateLineItemsSignature {
19386
+ /**
19387
+ * Updates a draft order's line items.
19388
+ *
19389
+ * Using this API, you can update a line item's quantity, price, and description.
19390
+ * > **Notes:**
19391
+ * > + Passing a quantity of `0` will remove the line item.
19392
+ * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
19393
+ * > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
19394
+ * @param - The draft order id
19395
+ */
19396
+ (draftOrderId: string, options?: UpdateLineItemsOptions | undefined): Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
19397
+ }
19398
+ declare function setDiscounts$1(httpClient: HttpClient): SetDiscountsSignature;
19399
+ interface SetDiscountsSignature {
19400
+ /**
19401
+ * Sets and enables or disables discounts on a draft order.
19402
+ *
19403
+ * Any discounts not passed will not change.
19404
+ * @param - The draft order id
19405
+ * @param - The discount ids to opt-in. all existing discounts not listed are to be opted-out.
19406
+ */
19407
+ (draftOrderId: string, discounts: IdAndApplied[]): Promise<SetDiscountsResponse & SetDiscountsResponseNonNullableFields>;
19408
+ }
19409
+ declare function createCustomDiscounts$1(httpClient: HttpClient): CreateCustomDiscountsSignature;
19410
+ interface CreateCustomDiscountsSignature {
19411
+ /**
19412
+ * Adds merchant discounts to the order.
19413
+ * @param - The draft order id
19414
+ */
19415
+ (draftOrderId: string, options?: CreateCustomDiscountsOptions | undefined): Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
19416
+ }
19417
+ declare function deleteCustomDiscounts$1(httpClient: HttpClient): DeleteCustomDiscountsSignature;
19418
+ interface DeleteCustomDiscountsSignature {
19419
+ /**
19420
+ * Remove custom discounts from the order.
19421
+ * @param - The draft order id
19422
+ * @param - The discounts to remove
19423
+ */
19424
+ (draftOrderId: string, discountIds: string[]): Promise<DeleteCustomDiscountsResponse & DeleteCustomDiscountsResponseNonNullableFields>;
19425
+ }
19426
+ declare function setAdditionalFees$1(httpClient: HttpClient): SetAdditionalFeesSignature;
19427
+ interface SetAdditionalFeesSignature {
19428
+ /**
19429
+ * Set which additional fees existing on the draft order are to be opt-in.
19430
+ * All existing additional fees not provided on the call are opted-out.
19431
+ * @param - The draft order id
19432
+ * @param - The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
19433
+ */
19434
+ (draftOrderId: string, additionalFees: IdAndApplied[]): Promise<SetAdditionalFeesResponse & SetAdditionalFeesResponseNonNullableFields>;
19435
+ }
19436
+ declare function createCustomAdditionalFees$1(httpClient: HttpClient): CreateCustomAdditionalFeesSignature;
19437
+ interface CreateCustomAdditionalFeesSignature {
19438
+ /**
19439
+ * Create custom additional fees to the order.
19440
+ * added additional fees are by default opted-out.
19441
+ * To opt-in them, please call SetAdditionalFees with the added additional fee ids.
19442
+ * @param - The draft order id
19443
+ */
19444
+ (draftOrderId: string, options?: CreateCustomAdditionalFeesOptions | undefined): Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
19445
+ }
19446
+ declare function deleteCustomAdditionalFees$1(httpClient: HttpClient): DeleteCustomAdditionalFeesSignature;
19447
+ interface DeleteCustomAdditionalFeesSignature {
19448
+ /**
19449
+ * Remove custom additional fees from the order.
19450
+ * @param - The draft order id
19451
+ * @param - The additional fees to remove
19452
+ */
19453
+ (draftOrderId: string, customAdditionalFees: string[]): Promise<DeleteCustomAdditionalFeesResponse & DeleteCustomAdditionalFeesResponseNonNullableFields>;
19454
+ }
19455
+ declare function getDraftOrder$1(httpClient: HttpClient): GetDraftOrderSignature;
19456
+ interface GetDraftOrderSignature {
19457
+ /**
19458
+ * Get an order.
19459
+ * When order is in draft status, it's re-estimated and return with latest tax and totals
19460
+ * Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.
19461
+ * Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.
19462
+ * When order is in committed status, it's returned with it's calculation at the moment it was committed.
19463
+ * @param - The draft order id
19464
+ */
19465
+ (draftOrderId: string): Promise<GetDraftOrderResponse & GetDraftOrderResponseNonNullableFields>;
19466
+ }
19467
+ declare function getOrderDraftabilityStatus$1(httpClient: HttpClient): GetOrderDraftabilityStatusSignature;
19468
+ interface GetOrderDraftabilityStatusSignature {
19469
+ /**
19470
+ * Checks whether a draft can be created for thos order
19471
+ * @param - Order ID.
19472
+ */
19473
+ (orderId: string): Promise<GetOrderDraftabilityStatusResponse & GetOrderDraftabilityStatusResponseNonNullableFields>;
19474
+ }
19475
+ declare function commitDraftOrder$1(httpClient: HttpClient): CommitDraftOrderSignature;
19476
+ interface CommitDraftOrderSignature {
19477
+ /**
19478
+ * Commit latest changes to the baseline order and control what side-effects will be applied.
19479
+ * Commit cannot be undone or reverted.
19480
+ * Order-edit become closed for editing, however it's kept for reference and can be retrieved.
19481
+ * @param - The draft order id
18347
19482
  */
18348
- limit: (limit: number) => DraftOrdersQueryBuilder;
18349
- /** @param cursor - A pointer to specific record
18350
- * @documentationMaturity preview
19483
+ (draftOrderId: string, options?: CommitDraftOrderOptions | undefined): Promise<CommitDraftOrderResponse & CommitDraftOrderResponseNonNullableFields>;
19484
+ }
19485
+ declare function deleteDraftOrder$1(httpClient: HttpClient): DeleteDraftOrderSignature;
19486
+ interface DeleteDraftOrderSignature {
19487
+ /**
19488
+ * Delete order-edit entity with all pending changes.
19489
+ * Order-edit in status 'COMMITTED' cannot be deleted.
19490
+ * @param - The draft order id
18351
19491
  */
18352
- skipTo: (cursor: string) => DraftOrdersQueryBuilder;
18353
- /** @documentationMaturity preview */
18354
- find: () => Promise<DraftOrdersQueryResult>;
19492
+ (draftOrderId: string): Promise<void>;
19493
+ }
19494
+ declare function queryDraftOrders$1(httpClient: HttpClient): QueryDraftOrdersSignature;
19495
+ interface QueryDraftOrdersSignature {
19496
+ /**
19497
+ * Query draft orders by order id or by date range or status.
19498
+ */
19499
+ (): DraftOrdersQueryBuilder;
18355
19500
  }
18356
-
18357
- declare function createDraftOrder$1(httpClient: HttpClient): (orderId: string | null) => Promise<CreateDraftOrderResponse & CreateDraftOrderResponseNonNullableFields>;
18358
- declare function addLineItemsToDraftOrder$1(httpClient: HttpClient): (draftOrderId: string, options?: AddLineItemsToDraftOrderOptions) => Promise<AddLineItemsToDraftOrderResponse & AddLineItemsToDraftOrderResponseNonNullableFields>;
18359
- declare function updateLineItems$1(httpClient: HttpClient): (draftOrderId: string, options?: UpdateLineItemsOptions) => Promise<UpdateLineItemsResponse & UpdateLineItemsResponseNonNullableFields>;
18360
- declare function setDiscounts$1(httpClient: HttpClient): (draftOrderId: string, discounts: IdAndApplied[]) => Promise<SetDiscountsResponse & SetDiscountsResponseNonNullableFields>;
18361
- declare function createCustomDiscounts$1(httpClient: HttpClient): (draftOrderId: string, options?: CreateCustomDiscountsOptions) => Promise<CreateCustomDiscountsResponse & CreateCustomDiscountsResponseNonNullableFields>;
18362
- declare function deleteCustomDiscounts$1(httpClient: HttpClient): (draftOrderId: string, discountIds: string[]) => Promise<DeleteCustomDiscountsResponse & DeleteCustomDiscountsResponseNonNullableFields>;
18363
- declare function setAdditionalFees$1(httpClient: HttpClient): (draftOrderId: string, additionalFees: IdAndApplied[]) => Promise<SetAdditionalFeesResponse & SetAdditionalFeesResponseNonNullableFields>;
18364
- declare function createCustomAdditionalFees$1(httpClient: HttpClient): (draftOrderId: string, options?: CreateCustomAdditionalFeesOptions) => Promise<CreateCustomAdditionalFeesResponse & CreateCustomAdditionalFeesResponseNonNullableFields>;
18365
- declare function deleteCustomAdditionalFees$1(httpClient: HttpClient): (draftOrderId: string, customAdditionalFees: string[]) => Promise<DeleteCustomAdditionalFeesResponse & DeleteCustomAdditionalFeesResponseNonNullableFields>;
18366
- declare function getDraftOrder$1(httpClient: HttpClient): (draftOrderId: string) => Promise<GetDraftOrderResponse & GetDraftOrderResponseNonNullableFields>;
18367
- declare function getOrderDraftabilityStatus$1(httpClient: HttpClient): (orderId: string) => Promise<GetOrderDraftabilityStatusResponse & GetOrderDraftabilityStatusResponseNonNullableFields>;
18368
- declare function commitDraftOrder$1(httpClient: HttpClient): (draftOrderId: string, options?: CommitDraftOrderOptions) => Promise<CommitDraftOrderResponse & CommitDraftOrderResponseNonNullableFields>;
18369
- declare function deleteDraftOrder$1(httpClient: HttpClient): (draftOrderId: string) => Promise<void>;
18370
- declare function queryDraftOrders$1(httpClient: HttpClient): () => DraftOrdersQueryBuilder;
18371
19501
 
18372
19502
  declare function createRESTModule$b<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
18373
19503
 
@@ -19066,12 +20196,79 @@ interface DeleteFulfillmentIdentifiers {
19066
20196
  orderId: string;
19067
20197
  }
19068
20198
 
19069
- declare function listFulfillmentsForSingleOrder$1(httpClient: HttpClient): (orderId: string) => Promise<ListFulfillmentsForSingleOrderResponse & ListFulfillmentsForSingleOrderResponseNonNullableFields>;
19070
- declare function listFulfillmentsForMultipleOrders$1(httpClient: HttpClient): (orderIds: string[]) => Promise<ListFulfillmentsForMultipleOrdersResponse & ListFulfillmentsForMultipleOrdersResponseNonNullableFields>;
19071
- declare function createFulfillment$1(httpClient: HttpClient): (orderId: string, fulfillment: Fulfillment$1) => Promise<CreateFulfillmentResponse & CreateFulfillmentResponseNonNullableFields>;
19072
- declare function updateFulfillment$1(httpClient: HttpClient): (identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions) => Promise<OrderWithFulfillments & OrderWithFulfillmentsNonNullableFields>;
19073
- declare function deleteFulfillment$1(httpClient: HttpClient): (identifiers: DeleteFulfillmentIdentifiers) => Promise<DeleteFulfillmentResponse & DeleteFulfillmentResponseNonNullableFields>;
19074
- declare function bulkCreateFulfillments$1(httpClient: HttpClient): (ordersWithFulfillments: BulkCreateOrderWithFulfillments[]) => Promise<BulkCreateFulfillmentResponse & BulkCreateFulfillmentResponseNonNullableFields>;
20199
+ declare function listFulfillmentsForSingleOrder$1(httpClient: HttpClient): ListFulfillmentsForSingleOrderSignature;
20200
+ interface ListFulfillmentsForSingleOrderSignature {
20201
+ /**
20202
+ * Retrieves fulfillments associated with a specified order.
20203
+ *
20204
+ *
20205
+ * The `listFulfillmentsForSingleOrder()` function returns a Promise that resolves when the fulfillments are retrieved.
20206
+ * @param - Order ID for which to retrieve fulfillments.
20207
+ */
20208
+ (orderId: string): Promise<ListFulfillmentsForSingleOrderResponse & ListFulfillmentsForSingleOrderResponseNonNullableFields>;
20209
+ }
20210
+ declare function listFulfillmentsForMultipleOrders$1(httpClient: HttpClient): ListFulfillmentsForMultipleOrdersSignature;
20211
+ interface ListFulfillmentsForMultipleOrdersSignature {
20212
+ /**
20213
+ * Retrieves fulfillments associated with multiple specified orders.
20214
+ *
20215
+ *
20216
+ * The `listFulfillmentsForMultipleOrders()` function returns a Promise that resolves when the fulfillments are retrieved.
20217
+ * @param - List of order IDs for which to retrieve fulfillments.
20218
+ */
20219
+ (orderIds: string[]): Promise<ListFulfillmentsForMultipleOrdersResponse & ListFulfillmentsForMultipleOrdersResponseNonNullableFields>;
20220
+ }
20221
+ declare function createFulfillment$1(httpClient: HttpClient): CreateFulfillmentSignature;
20222
+ interface CreateFulfillmentSignature {
20223
+ /**
20224
+ * Creates an order fulfillment.
20225
+ *
20226
+ *
20227
+ * The `createFulfillment()` function returns a Promise that resolves when the fulfillment is created.
20228
+ * @param - Order ID.
20229
+ * @param - Fulfillment info.
20230
+ */
20231
+ (orderId: string, fulfillment: Fulfillment$1): Promise<CreateFulfillmentResponse & CreateFulfillmentResponseNonNullableFields>;
20232
+ }
20233
+ declare function updateFulfillment$1(httpClient: HttpClient): UpdateFulfillmentSignature;
20234
+ interface UpdateFulfillmentSignature {
20235
+ /**
20236
+ * Updates a fulfillment's properties.
20237
+ * To update a field's value, include the new value in the `fulfillment` field in the body params.
20238
+ * To remove a field's value, pass `null`.
20239
+ *
20240
+ *
20241
+ * The `updateFulfillment()` function returns a Promise that resolves when the fulfillment is updated.
20242
+ *
20243
+ * > **Note:** Updating line item IDs or fulfilled quantities is not allowed. To update line item IDs or quantities, delete the fulfillment and create it again.
20244
+ * @param - Order and fulfillment IDs to be updated.
20245
+ * @param - Available options to use when updating a fulfillment.
20246
+ * @returns Order ID and the orders' associated fulfillments after update.
20247
+ */
20248
+ (identifiers: UpdateFulfillmentIdentifiers, options?: UpdateFulfillmentOptions | undefined): Promise<OrderWithFulfillments & OrderWithFulfillmentsNonNullableFields>;
20249
+ }
20250
+ declare function deleteFulfillment$1(httpClient: HttpClient): DeleteFulfillmentSignature;
20251
+ interface DeleteFulfillmentSignature {
20252
+ /**
20253
+ * Deletes an existing order fulfillment.
20254
+ *
20255
+ *
20256
+ * The `deleteFulfillment()` function returns a Promise that resolves when the fulfillment is deleted.
20257
+ * @param - Order and fulfillment IDs.
20258
+ */
20259
+ (identifiers: DeleteFulfillmentIdentifiers): Promise<DeleteFulfillmentResponse & DeleteFulfillmentResponseNonNullableFields>;
20260
+ }
20261
+ declare function bulkCreateFulfillments$1(httpClient: HttpClient): BulkCreateFulfillmentsSignature;
20262
+ interface BulkCreateFulfillmentsSignature {
20263
+ /**
20264
+ * Creates multiple fulfillments for one or more orders.
20265
+ *
20266
+ *
20267
+ * The `bulkCreateFulfillments()` function returns a Promise that resolves when the fulfillments are created.
20268
+ * @param - List of order IDs and their associated fulfillments' info.
20269
+ */
20270
+ (ordersWithFulfillments: BulkCreateOrderWithFulfillments[]): Promise<BulkCreateFulfillmentResponse & BulkCreateFulfillmentResponseNonNullableFields>;
20271
+ }
19075
20272
  declare const onFulfillmentsUpdated$1: EventDefinition<FulfillmentsUpdatedEnvelope, "wix.ecom.v1.fulfillments_updated">;
19076
20273
 
19077
20274
  declare function createRESTModule$a<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -19092,6 +20289,11 @@ type _publicBulkCreateFulfillmentsType = typeof bulkCreateFulfillments$1;
19092
20289
  declare const bulkCreateFulfillments: ReturnType<typeof createRESTModule$a<_publicBulkCreateFulfillmentsType>>;
19093
20290
 
19094
20291
  type _publicOnFulfillmentsUpdatedType = typeof onFulfillmentsUpdated$1;
20292
+ /**
20293
+ * Triggered when one or more of an order's fulfillments are created, updated, or deleted.
20294
+ *
20295
+ * The response contains the order's ID and details about all of its fulfillments following the change.
20296
+ */
19095
20297
  declare const onFulfillmentsUpdated: ReturnType<typeof createEventModule$7<_publicOnFulfillmentsUpdatedType>>;
19096
20298
 
19097
20299
  type context$a_BulkCreateFulfillmentRequest = BulkCreateFulfillmentRequest;
@@ -19650,14 +20852,46 @@ interface UpdateLocalDeliveryOption {
19650
20852
  _createdDate?: Date;
19651
20853
  }
19652
20854
 
19653
- declare function createLocalDeliveryOption$1(httpClient: HttpClient): (localDeliveryOption: LocalDeliveryOption) => Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
19654
- declare function getLocalDeliveryOption$1(httpClient: HttpClient): (_id: string) => Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
19655
- declare function listLocalDeliveryOptions$1(httpClient: HttpClient): (externalId: string) => Promise<ListLocalDeliveryOptionsResponse & ListLocalDeliveryOptionsResponseNonNullableFields>;
19656
- declare function updateLocalDeliveryOption$1(httpClient: HttpClient): (_id: string | null, localDeliveryOption: UpdateLocalDeliveryOption) => Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
19657
- declare function deleteLocalDeliveryOption$1(httpClient: HttpClient): (_id: string) => Promise<void>;
19658
- declare function bulkCreateLocalDeliveryOption$1(httpClient: HttpClient): (localDeliveryOptions: LocalDeliveryOption[]) => Promise<BulkCreateLocalDeliveryOptionResponse & BulkCreateLocalDeliveryOptionResponseNonNullableFields>;
19659
- declare function bulkUpdateLocalDeliveryOption$1(httpClient: HttpClient): (localDeliveryOptions: LocalDeliveryOption[]) => Promise<BulkUpdateLocalDeliveryOptionResponse & BulkUpdateLocalDeliveryOptionResponseNonNullableFields>;
19660
- declare function bulkDeleteLocalDeliveryOption$1(httpClient: HttpClient): (ids: string[]) => Promise<void>;
20855
+ declare function createLocalDeliveryOption$1(httpClient: HttpClient): CreateLocalDeliveryOptionSignature;
20856
+ interface CreateLocalDeliveryOptionSignature {
20857
+ /** */
20858
+ (localDeliveryOption: LocalDeliveryOption): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
20859
+ }
20860
+ declare function getLocalDeliveryOption$1(httpClient: HttpClient): GetLocalDeliveryOptionSignature;
20861
+ interface GetLocalDeliveryOptionSignature {
20862
+ /** */
20863
+ (_id: string): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
20864
+ }
20865
+ declare function listLocalDeliveryOptions$1(httpClient: HttpClient): ListLocalDeliveryOptionsSignature;
20866
+ interface ListLocalDeliveryOptionsSignature {
20867
+ /** */
20868
+ (externalId: string): Promise<ListLocalDeliveryOptionsResponse & ListLocalDeliveryOptionsResponseNonNullableFields>;
20869
+ }
20870
+ declare function updateLocalDeliveryOption$1(httpClient: HttpClient): UpdateLocalDeliveryOptionSignature;
20871
+ interface UpdateLocalDeliveryOptionSignature {
20872
+ /** @param - LocalDeliveryOptionId - unique identifier of local delivery option */
20873
+ (_id: string | null, localDeliveryOption: UpdateLocalDeliveryOption): Promise<LocalDeliveryOption & LocalDeliveryOptionNonNullableFields>;
20874
+ }
20875
+ declare function deleteLocalDeliveryOption$1(httpClient: HttpClient): DeleteLocalDeliveryOptionSignature;
20876
+ interface DeleteLocalDeliveryOptionSignature {
20877
+ /** */
20878
+ (_id: string): Promise<void>;
20879
+ }
20880
+ declare function bulkCreateLocalDeliveryOption$1(httpClient: HttpClient): BulkCreateLocalDeliveryOptionSignature;
20881
+ interface BulkCreateLocalDeliveryOptionSignature {
20882
+ /** */
20883
+ (localDeliveryOptions: LocalDeliveryOption[]): Promise<BulkCreateLocalDeliveryOptionResponse & BulkCreateLocalDeliveryOptionResponseNonNullableFields>;
20884
+ }
20885
+ declare function bulkUpdateLocalDeliveryOption$1(httpClient: HttpClient): BulkUpdateLocalDeliveryOptionSignature;
20886
+ interface BulkUpdateLocalDeliveryOptionSignature {
20887
+ /** */
20888
+ (localDeliveryOptions: LocalDeliveryOption[]): Promise<BulkUpdateLocalDeliveryOptionResponse & BulkUpdateLocalDeliveryOptionResponseNonNullableFields>;
20889
+ }
20890
+ declare function bulkDeleteLocalDeliveryOption$1(httpClient: HttpClient): BulkDeleteLocalDeliveryOptionSignature;
20891
+ interface BulkDeleteLocalDeliveryOptionSignature {
20892
+ /** */
20893
+ (ids: string[]): Promise<void>;
20894
+ }
19661
20895
  declare const onLocalDeliveryOptionCreated$1: EventDefinition<LocalDeliveryOptionCreatedEnvelope, "wix.ecom.v1.local_delivery_option_created">;
19662
20896
  declare const onLocalDeliveryOptionUpdated$1: EventDefinition<LocalDeliveryOptionUpdatedEnvelope, "wix.ecom.v1.local_delivery_option_updated">;
19663
20897
  declare const onLocalDeliveryOptionDeleted$1: EventDefinition<LocalDeliveryOptionDeletedEnvelope, "wix.ecom.v1.local_delivery_option_deleted">;
@@ -19684,12 +20918,15 @@ type _publicBulkDeleteLocalDeliveryOptionType = typeof bulkDeleteLocalDeliveryOp
19684
20918
  declare const bulkDeleteLocalDeliveryOption: ReturnType<typeof createRESTModule$9<_publicBulkDeleteLocalDeliveryOptionType>>;
19685
20919
 
19686
20920
  type _publicOnLocalDeliveryOptionCreatedType = typeof onLocalDeliveryOptionCreated$1;
20921
+ /** */
19687
20922
  declare const onLocalDeliveryOptionCreated: ReturnType<typeof createEventModule$6<_publicOnLocalDeliveryOptionCreatedType>>;
19688
20923
 
19689
20924
  type _publicOnLocalDeliveryOptionUpdatedType = typeof onLocalDeliveryOptionUpdated$1;
20925
+ /** */
19690
20926
  declare const onLocalDeliveryOptionUpdated: ReturnType<typeof createEventModule$6<_publicOnLocalDeliveryOptionUpdatedType>>;
19691
20927
 
19692
20928
  type _publicOnLocalDeliveryOptionDeletedType = typeof onLocalDeliveryOptionDeleted$1;
20929
+ /** */
19693
20930
  declare const onLocalDeliveryOptionDeleted: ReturnType<typeof createEventModule$6<_publicOnLocalDeliveryOptionDeletedType>>;
19694
20931
 
19695
20932
  type context$9_BulkCreateLocalDeliveryOptionRequest = BulkCreateLocalDeliveryOptionRequest;
@@ -24527,13 +25764,142 @@ interface CancelOrderOptions {
24527
25764
  restockAllItems?: boolean;
24528
25765
  }
24529
25766
 
24530
- declare function getPaymentCollectabilityStatus$1(httpClient: HttpClient): (ecomOrderId: string) => Promise<GetPaymentCollectabilityStatusResponse & GetPaymentCollectabilityStatusResponseNonNullableFields>;
24531
- declare function getOrder$1(httpClient: HttpClient): (_id: string) => Promise<Order$1 & OrderNonNullableFields>;
24532
- declare function searchOrders$1(httpClient: HttpClient): (options?: SearchOrdersOptions) => Promise<SearchOrdersResponse & SearchOrdersResponseNonNullableFields>;
24533
- declare function createOrder$1(httpClient: HttpClient): (order: Order$1) => Promise<Order$1 & OrderNonNullableFields>;
24534
- declare function updateOrder$1(httpClient: HttpClient): (_id: string | null, order: UpdateOrder) => Promise<Order$1 & OrderNonNullableFields>;
24535
- declare function bulkUpdateOrders$1(httpClient: HttpClient): (orders: MaskedOrder[], options?: BulkUpdateOrdersOptions) => Promise<BulkUpdateOrdersResponse & BulkUpdateOrdersResponseNonNullableFields>;
24536
- declare function cancelOrder$1(httpClient: HttpClient): (_id: string, options?: CancelOrderOptions) => Promise<CancelOrderResponse & CancelOrderResponseNonNullableFields>;
25767
+ declare function getPaymentCollectabilityStatus$1(httpClient: HttpClient): GetPaymentCollectabilityStatusSignature;
25768
+ interface GetPaymentCollectabilityStatusSignature {
25769
+ /**
25770
+ * Provides payment collectability status for given order. If payment collection is possible
25771
+ * response will contain collectable amount for given ecom order. If not - response will contain
25772
+ * reason why payment collection is not possible.
25773
+ * @param - Ecom order ID.
25774
+ */
25775
+ (ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse & GetPaymentCollectabilityStatusResponseNonNullableFields>;
25776
+ }
25777
+ declare function getOrder$1(httpClient: HttpClient): GetOrderSignature;
25778
+ interface GetOrderSignature {
25779
+ /**
25780
+ * Retrieves an order.
25781
+ *
25782
+ *
25783
+ * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
25784
+ *
25785
+ * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
25786
+ * @param - ID of the order to retrieve.
25787
+ * @returns Fulfilled - The requested order.
25788
+ */
25789
+ (_id: string): Promise<Order$1 & OrderNonNullableFields>;
25790
+ }
25791
+ declare function searchOrders$1(httpClient: HttpClient): SearchOrdersSignature;
25792
+ interface SearchOrdersSignature {
25793
+ /**
25794
+ * Retrieves a list of orders, given the provided paging, filtering, and sorting.
25795
+ *
25796
+ *
25797
+ * Search Orders runs with these defaults, which you can override:
25798
+ *
25799
+ * - `createdDate` is sorted in `DESC` order
25800
+ * - `cursorPaging.limit` is `100`
25801
+ * - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
25802
+ *
25803
+ * For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
25804
+ *
25805
+ * To learn about working with _Search_ endpoints, see
25806
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
25807
+ * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
25808
+ */
25809
+ (options?: SearchOrdersOptions | undefined): Promise<SearchOrdersResponse & SearchOrdersResponseNonNullableFields>;
25810
+ }
25811
+ declare function createOrder$1(httpClient: HttpClient): CreateOrderSignature;
25812
+ interface CreateOrderSignature {
25813
+ /**
25814
+ * Creates an order.
25815
+ *
25816
+ *
25817
+ * The `createOrder()` function returns a Promise that resolves when the order is created.
25818
+ *
25819
+ * > **Notes:**
25820
+ * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
25821
+ * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
25822
+ * @param - Order info.
25823
+ * @returns Newly created order.
25824
+ */
25825
+ (order: Order$1): Promise<Order$1 & OrderNonNullableFields>;
25826
+ }
25827
+ declare function updateOrder$1(httpClient: HttpClient): UpdateOrderSignature;
25828
+ interface UpdateOrderSignature {
25829
+ /**
25830
+ * Updates an order.
25831
+ *
25832
+ *
25833
+ * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
25834
+ *
25835
+ * Currently, the following fields can be updated:
25836
+ * + `order.buyerInfo.email`
25837
+ * + `order.buyerLanguage`
25838
+ * + `order.weightUnit`
25839
+ * + `order.billingInfo.address`
25840
+ * + `order.billingInfo.contactDetails`
25841
+ * + `order.archived`
25842
+ * + `order.attributionSource`
25843
+ * + `order.seenByAHuman`
25844
+ * + `order.recipientInfo.address`
25845
+ * + `order.recipientInfo.contactDetails`
25846
+ * + `order.shippingInfo.logistics.shippingDestination.address`
25847
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
25848
+ *
25849
+ * To update a field's value, include the new value in the `order` object in the method parameters.
25850
+ * To remove a field's value, pass `null`.
25851
+ *
25852
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
25853
+ *
25854
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
25855
+ * @param - Order ID.
25856
+ * @returns Newly created order.
25857
+ */
25858
+ (_id: string | null, order: UpdateOrder): Promise<Order$1 & OrderNonNullableFields>;
25859
+ }
25860
+ declare function bulkUpdateOrders$1(httpClient: HttpClient): BulkUpdateOrdersSignature;
25861
+ interface BulkUpdateOrdersSignature {
25862
+ /**
25863
+ * Updates up to 100 orders.
25864
+ *
25865
+ *
25866
+ * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
25867
+ *
25868
+ * Currently, the following fields can be updated:
25869
+ * + `order.buyerInfo.email`
25870
+ * + `order.buyerLanguage`
25871
+ * + `order.weightUnit`
25872
+ * + `order.billingInfo.address`
25873
+ * + `order.billingInfo.contactDetails`
25874
+ * + `order.archived`
25875
+ * + `order.attributionSource`
25876
+ * + `order.seenByAHuman`
25877
+ * + `order.recipientInfo.address`
25878
+ * + `order.recipientInfo.contactDetails`
25879
+ * + `order.shippingInfo.logistics.shippingDestination.address`
25880
+ * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
25881
+ *
25882
+ * To update a field's value, include the new value in the `orders.order` object in the method parameters.
25883
+ * To remove a field's value, pass `null`.
25884
+ *
25885
+ * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
25886
+ *
25887
+ * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
25888
+ * @param - Orders to update.
25889
+ */
25890
+ (orders: MaskedOrder[], options?: BulkUpdateOrdersOptions | undefined): Promise<BulkUpdateOrdersResponse & BulkUpdateOrdersResponseNonNullableFields>;
25891
+ }
25892
+ declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
25893
+ interface CancelOrderSignature {
25894
+ /**
25895
+ * Cancels an order.
25896
+ *
25897
+ *
25898
+ * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
25899
+ * @param - Order ID.
25900
+ */
25901
+ (_id: string, options?: CancelOrderOptions | undefined): Promise<CancelOrderResponse & CancelOrderResponseNonNullableFields>;
25902
+ }
24537
25903
  declare const onOrderPaymentStatusUpdated$1: EventDefinition<OrderPaymentStatusUpdatedEnvelope, "wix.ecom.v1.order_payment_status_updated">;
24538
25904
  declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.ecom.v1.order_created">;
24539
25905
  declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.ecom.v1.order_canceled">;
@@ -24559,15 +25925,30 @@ type _publicCancelOrderType = typeof cancelOrder$1;
24559
25925
  declare const cancelOrder: ReturnType<typeof createRESTModule$8<_publicCancelOrderType>>;
24560
25926
 
24561
25927
  type _publicOnOrderPaymentStatusUpdatedType = typeof onOrderPaymentStatusUpdated$1;
25928
+ /**
25929
+ * Triggered when an order's payment status is updated to `"PAID"`.
25930
+ */
24562
25931
  declare const onOrderPaymentStatusUpdated: ReturnType<typeof createEventModule$5<_publicOnOrderPaymentStatusUpdatedType>>;
24563
25932
 
24564
25933
  type _publicOnOrderCreatedType = typeof onOrderCreated$1;
25934
+ /**
25935
+ * Triggered when an order is created.
25936
+ * Learn more about [webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
25937
+ */
24565
25938
  declare const onOrderCreated: ReturnType<typeof createEventModule$5<_publicOnOrderCreatedType>>;
24566
25939
 
24567
25940
  type _publicOnOrderCanceledType = typeof onOrderCanceled$1;
25941
+ /**
25942
+ * Triggered when an order is canceled.
25943
+ * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
25944
+ */
24568
25945
  declare const onOrderCanceled: ReturnType<typeof createEventModule$5<_publicOnOrderCanceledType>>;
24569
25946
 
24570
25947
  type _publicOnOrderApprovedType = typeof onOrderApproved$1;
25948
+ /**
25949
+ * Triggered when an order is created and its status is updated to `"APPROVED"`.
25950
+ * Learn more about [eCommerce webhook payload structure](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/order-object-conversion#webhook-conversion-table).
25951
+ */
24571
25952
  declare const onOrderApproved: ReturnType<typeof createEventModule$5<_publicOnOrderApprovedType>>;
24572
25953
 
24573
25954
  type context$8_ActivityContentOneOf = ActivityContentOneOf;
@@ -25493,13 +26874,76 @@ interface UpdateExtendedFieldsOptions$2 {
25493
26874
  namespaceData: Record<string, any> | null;
25494
26875
  }
25495
26876
 
25496
- declare function createOrderPaymentRequest$1(httpClient: HttpClient): (options?: CreateOrderPaymentRequestOptions) => Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
25497
- declare function getOrderPaymentRequest$1(httpClient: HttpClient): (orderPaymentRequestId: string) => Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
25498
- declare function updateOrderPaymentRequest$1(httpClient: HttpClient): (_id: string | null, orderPaymentRequest: UpdateOrderPaymentRequest) => Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
25499
- declare function deleteOrderPaymentRequest$1(httpClient: HttpClient): (orderPaymentRequestId: string) => Promise<void>;
25500
- declare function queryOrderPaymentRequests$1(httpClient: HttpClient): () => OrderPaymentRequestsQueryBuilder;
25501
- declare function getOrderPaymentRequestUrl$1(httpClient: HttpClient): (orderPaymentRequestId: string) => Promise<GetOrderPaymentRequestURLResponse & GetOrderPaymentRequestURLResponseNonNullableFields>;
25502
- declare function updateExtendedFields$5(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$2) => Promise<UpdateExtendedFieldsResponse$2 & UpdateExtendedFieldsResponseNonNullableFields$2>;
26877
+ declare function createOrderPaymentRequest$1(httpClient: HttpClient): CreateOrderPaymentRequestSignature;
26878
+ interface CreateOrderPaymentRequestSignature {
26879
+ /**
26880
+ * Creates a order payment request.
26881
+ * @returns The created OrderPaymentRequest.
26882
+ */
26883
+ (options?: CreateOrderPaymentRequestOptions | undefined): Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
26884
+ }
26885
+ declare function getOrderPaymentRequest$1(httpClient: HttpClient): GetOrderPaymentRequestSignature;
26886
+ interface GetOrderPaymentRequestSignature {
26887
+ /**
26888
+ * Retrieves a order payment request.
26889
+ * @param - ID of the OrderPaymentRequest to retrieve.
26890
+ * @returns The requested OrderPaymentRequest.
26891
+ */
26892
+ (orderPaymentRequestId: string): Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
26893
+ }
26894
+ declare function updateOrderPaymentRequest$1(httpClient: HttpClient): UpdateOrderPaymentRequestSignature;
26895
+ interface UpdateOrderPaymentRequestSignature {
26896
+ /**
26897
+ * Updates a order payment request.
26898
+ *
26899
+ * Please note that only `UNPAID` payment requests can be updated.
26900
+ * @param - Order payment request ID.
26901
+ * @returns Updated OrderPaymentRequest.
26902
+ */
26903
+ (_id: string | null, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<OrderPaymentRequest & OrderPaymentRequestNonNullableFields>;
26904
+ }
26905
+ declare function deleteOrderPaymentRequest$1(httpClient: HttpClient): DeleteOrderPaymentRequestSignature;
26906
+ interface DeleteOrderPaymentRequestSignature {
26907
+ /**
26908
+ * Deletes a order payment request.
26909
+ *
26910
+ * Please note that only `UNPAID` payment requests can be deleted.
26911
+ * @param - Id of the OrderPaymentRequest to delete.
26912
+ */
26913
+ (orderPaymentRequestId: string): Promise<void>;
26914
+ }
26915
+ declare function queryOrderPaymentRequests$1(httpClient: HttpClient): QueryOrderPaymentRequestsSignature;
26916
+ interface QueryOrderPaymentRequestsSignature {
26917
+ /**
26918
+ * Retrieves a list of Payment Requests, given the provided [paging, filtering, and sorting][1].
26919
+ *
26920
+ * Query Payment Requests runs with these defaults, which you can override:
26921
+ * - `createdDate` is sorted in DESC order
26922
+ * - `cursorPaging.limit` is 100
26923
+ *
26924
+ * To learn about working with _Query_ endpoints, see
26925
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
26926
+ * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
26927
+ */
26928
+ (): OrderPaymentRequestsQueryBuilder;
26929
+ }
26930
+ declare function getOrderPaymentRequestUrl$1(httpClient: HttpClient): GetOrderPaymentRequestUrlSignature;
26931
+ interface GetOrderPaymentRequestUrlSignature {
26932
+ /**
26933
+ * Retrieves the order payment request page URL of a specified order payment request.
26934
+ * @param - Order Payment Request ID.
26935
+ */
26936
+ (orderPaymentRequestId: string): Promise<GetOrderPaymentRequestURLResponse & GetOrderPaymentRequestURLResponseNonNullableFields>;
26937
+ }
26938
+ declare function updateExtendedFields$5(httpClient: HttpClient): UpdateExtendedFieldsSignature$2;
26939
+ interface UpdateExtendedFieldsSignature$2 {
26940
+ /**
26941
+ * Updates extended fields of a order payment request
26942
+ * @param - ID of the entity to update.
26943
+ * @param - Identifier for the app whose extended fields are being updated.
26944
+ */
26945
+ (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$2): Promise<UpdateExtendedFieldsResponse$2 & UpdateExtendedFieldsResponseNonNullableFields$2>;
26946
+ }
25503
26947
 
25504
26948
  declare function createRESTModule$7<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
25505
26949
 
@@ -27353,11 +28797,63 @@ interface BulkUpdatePaymentStatusesOptions {
27353
28797
  status?: TransactionStatus;
27354
28798
  }
27355
28799
 
27356
- declare function listTransactionsForSingleOrder$1(httpClient: HttpClient): (orderId: string) => Promise<ListTransactionsForSingleOrderResponse & ListTransactionsForSingleOrderResponseNonNullableFields>;
27357
- declare function listTransactionsForMultipleOrders$1(httpClient: HttpClient): (orderIds: string[]) => Promise<ListTransactionsForMultipleOrdersResponse & ListTransactionsForMultipleOrdersResponseNonNullableFields>;
27358
- declare function addPayments$1(httpClient: HttpClient): (orderId: string, payments: Payment[]) => Promise<AddPaymentsResponse & AddPaymentsResponseNonNullableFields>;
27359
- declare function updatePaymentStatus$1(httpClient: HttpClient): (identifiers: UpdatePaymentStatusIdentifiers, options?: UpdatePaymentStatusOptions) => Promise<UpdatePaymentStatusResponse & UpdatePaymentStatusResponseNonNullableFields>;
27360
- declare function bulkUpdatePaymentStatuses$1(httpClient: HttpClient): (paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions) => Promise<BulkUpdatePaymentStatusesResponse & BulkUpdatePaymentStatusesResponseNonNullableFields>;
28800
+ declare function listTransactionsForSingleOrder$1(httpClient: HttpClient): ListTransactionsForSingleOrderSignature;
28801
+ interface ListTransactionsForSingleOrderSignature {
28802
+ /**
28803
+ * Retrieves information about payments and refunds associated with a specified order.
28804
+ *
28805
+ *
28806
+ * The `listTransactionsForSingleOrder()` function returns a Promise that resolves when the specified order's transaction records are retrieved.
28807
+ * @param - Order ID.
28808
+ */
28809
+ (orderId: string): Promise<ListTransactionsForSingleOrderResponse & ListTransactionsForSingleOrderResponseNonNullableFields>;
28810
+ }
28811
+ declare function listTransactionsForMultipleOrders$1(httpClient: HttpClient): ListTransactionsForMultipleOrdersSignature;
28812
+ interface ListTransactionsForMultipleOrdersSignature {
28813
+ /**
28814
+ * Retrieves information about payments and refunds associated with all specified orders.
28815
+ *
28816
+ *
28817
+ * The `listTransactionsForMultipleOrders()` function returns a Promise that resolves when the specified orders' transaction records are retrieved.
28818
+ * @param - Order IDs for which to retrieve transactions.
28819
+ */
28820
+ (orderIds: string[]): Promise<ListTransactionsForMultipleOrdersResponse & ListTransactionsForMultipleOrdersResponseNonNullableFields>;
28821
+ }
28822
+ declare function addPayments$1(httpClient: HttpClient): AddPaymentsSignature;
28823
+ interface AddPaymentsSignature {
28824
+ /**
28825
+ * Adds up to 50 payment records to an order.
28826
+ *
28827
+ *
28828
+ * The `addPayments()` function returns a Promise that resolves when the payment records are added to an order.
28829
+ *
28830
+ * > **Note:** This does **NOT** perform the actual charging - the order is only updated with records of the payments.
28831
+ * @param - Order ID.
28832
+ * @param - Payments to be added to order.
28833
+ */
28834
+ (orderId: string, payments: Payment[]): Promise<AddPaymentsResponse & AddPaymentsResponseNonNullableFields>;
28835
+ }
28836
+ declare function updatePaymentStatus$1(httpClient: HttpClient): UpdatePaymentStatusSignature;
28837
+ interface UpdatePaymentStatusSignature {
28838
+ /**
28839
+ * Updates the status of an order's payment.
28840
+ *
28841
+ *
28842
+ * The `updatePaymentStatus()` function returns a Promise that resolves when the payment status is updated.
28843
+ */
28844
+ (identifiers: UpdatePaymentStatusIdentifiers, options?: UpdatePaymentStatusOptions | undefined): Promise<UpdatePaymentStatusResponse & UpdatePaymentStatusResponseNonNullableFields>;
28845
+ }
28846
+ declare function bulkUpdatePaymentStatuses$1(httpClient: HttpClient): BulkUpdatePaymentStatusesSignature;
28847
+ interface BulkUpdatePaymentStatusesSignature {
28848
+ /**
28849
+ * Updates multiple order payments with a specified status.
28850
+ *
28851
+ *
28852
+ * The `bulkUpdatePaymentStatus()` function returns a Promise that resolves when the payment statuses are updated.
28853
+ * @param - Order and payment IDs for which to update payment status.
28854
+ */
28855
+ (paymentAndOrderIds: PaymentAndOrderId[], options?: BulkUpdatePaymentStatusesOptions | undefined): Promise<BulkUpdatePaymentStatusesResponse & BulkUpdatePaymentStatusesResponseNonNullableFields>;
28856
+ }
27361
28857
  declare const onOrderTransactionsUpdated$1: EventDefinition<OrderTransactionsUpdatedEnvelope, "wix.ecom.v1.order_transactions_updated">;
27362
28858
 
27363
28859
  declare function createRESTModule$6<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -27376,6 +28872,7 @@ type _publicBulkUpdatePaymentStatusesType = typeof bulkUpdatePaymentStatuses$1;
27376
28872
  declare const bulkUpdatePaymentStatuses: ReturnType<typeof createRESTModule$6<_publicBulkUpdatePaymentStatusesType>>;
27377
28873
 
27378
28874
  type _publicOnOrderTransactionsUpdatedType = typeof onOrderTransactionsUpdated$1;
28875
+ /** */
27379
28876
  declare const onOrderTransactionsUpdated: ReturnType<typeof createEventModule$4<_publicOnOrderTransactionsUpdatedType>>;
27380
28877
 
27381
28878
  type context$6_ActionType = ActionType;
@@ -27781,8 +29278,29 @@ interface OrdersSettingsUpdatedEnvelope {
27781
29278
  metadata: EventMetadata$3;
27782
29279
  }
27783
29280
 
27784
- declare function getOrdersSettings$1(httpClient: HttpClient): () => Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
27785
- declare function updateOrdersSettings$1(httpClient: HttpClient): (ordersSettings: OrdersSettings) => Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
29281
+ declare function getOrdersSettings$1(httpClient: HttpClient): GetOrdersSettingsSignature;
29282
+ interface GetOrdersSettingsSignature {
29283
+ /**
29284
+ * Retrieves the sites' order settings.
29285
+ *
29286
+ *
29287
+ * The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
29288
+ * @returns The requested orders settings.
29289
+ */
29290
+ (): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
29291
+ }
29292
+ declare function updateOrdersSettings$1(httpClient: HttpClient): UpdateOrdersSettingsSignature;
29293
+ interface UpdateOrdersSettingsSignature {
29294
+ /**
29295
+ * Updates the sites' orders settings.
29296
+ *
29297
+ *
29298
+ * The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
29299
+ * @param - Orders settings to update.
29300
+ * @returns The updated orders settings.
29301
+ */
29302
+ (ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
29303
+ }
27786
29304
  declare const onOrdersSettingsUpdated$1: EventDefinition<OrdersSettingsUpdatedEnvelope, "wix.ecom.v1.orders_settings_updated">;
27787
29305
 
27788
29306
  declare function createRESTModule$5<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -27795,6 +29313,9 @@ type _publicUpdateOrdersSettingsType = typeof updateOrdersSettings$1;
27795
29313
  declare const updateOrdersSettings: ReturnType<typeof createRESTModule$5<_publicUpdateOrdersSettingsType>>;
27796
29314
 
27797
29315
  type _publicOnOrdersSettingsUpdatedType = typeof onOrdersSettingsUpdated$1;
29316
+ /**
29317
+ * Triggered when orders settings are updated.
29318
+ */
27798
29319
  declare const onOrdersSettingsUpdated: ReturnType<typeof createEventModule$3<_publicOnOrdersSettingsUpdatedType>>;
27799
29320
 
27800
29321
  type context$5_DeleteOrdersSettingsRequest = DeleteOrdersSettingsRequest;
@@ -28403,14 +29924,69 @@ interface PickupLocationsQueryBuilder {
28403
29924
  find: () => Promise<PickupLocationsQueryResult>;
28404
29925
  }
28405
29926
 
28406
- declare function createPickupLocation$1(httpClient: HttpClient): (pickupLocation: PickupLocation) => Promise<PickupLocation & PickupLocationNonNullableFields>;
28407
- declare function getPickupLocation$1(httpClient: HttpClient): (pickupLocationId: string) => Promise<PickupLocation & PickupLocationNonNullableFields>;
28408
- declare function updatePickupLocation$1(httpClient: HttpClient): (_id: string | null, pickupLocation: UpdatePickupLocation) => Promise<PickupLocation & PickupLocationNonNullableFields>;
28409
- declare function deletePickupLocation$1(httpClient: HttpClient): (pickupLocationId: string) => Promise<void>;
28410
- declare function queryPickupLocation$1(httpClient: HttpClient): () => PickupLocationsQueryBuilder;
28411
- declare function bulkCreatePickupLocation$1(httpClient: HttpClient): (pickupLocations: PickupLocation[]) => Promise<BulkCreatePickupLocationResponse & BulkCreatePickupLocationResponseNonNullableFields>;
28412
- declare function bulkUpdatePickupLocation$1(httpClient: HttpClient): (pickupLocations: PickupLocation[]) => Promise<BulkUpdatePickupLocationResponse & BulkUpdatePickupLocationResponseNonNullableFields>;
28413
- declare function bulkDeletePickupLocation$1(httpClient: HttpClient): (pickupLocationIds: string[]) => Promise<BulkDeletePickupLocationResponse & BulkDeletePickupLocationResponseNonNullableFields>;
29927
+ declare function createPickupLocation$1(httpClient: HttpClient): CreatePickupLocationSignature;
29928
+ interface CreatePickupLocationSignature {
29929
+ /**
29930
+ * Creates a new PickupLocation
29931
+ * @param - PickupLocation to be created
29932
+ * @returns The created PickupLocation
29933
+ */
29934
+ (pickupLocation: PickupLocation): Promise<PickupLocation & PickupLocationNonNullableFields>;
29935
+ }
29936
+ declare function getPickupLocation$1(httpClient: HttpClient): GetPickupLocationSignature;
29937
+ interface GetPickupLocationSignature {
29938
+ /**
29939
+ * Get a PickupLocation by id
29940
+ * @param - Id of the PickupLocation to retrieve
29941
+ * @returns The retrieved PickupLocation
29942
+ */
29943
+ (pickupLocationId: string): Promise<PickupLocation & PickupLocationNonNullableFields>;
29944
+ }
29945
+ declare function updatePickupLocation$1(httpClient: HttpClient): UpdatePickupLocationSignature;
29946
+ interface UpdatePickupLocationSignature {
29947
+ /**
29948
+ * Update a PickupLocation
29949
+ * @param - PickupLocation ID
29950
+ * @returns The updated PickupLocation
29951
+ */
29952
+ (_id: string | null, pickupLocation: UpdatePickupLocation): Promise<PickupLocation & PickupLocationNonNullableFields>;
29953
+ }
29954
+ declare function deletePickupLocation$1(httpClient: HttpClient): DeletePickupLocationSignature;
29955
+ interface DeletePickupLocationSignature {
29956
+ /**
29957
+ * Delete a PickupLocation
29958
+ * @param - Id of the PickupLocation to delete
29959
+ */
29960
+ (pickupLocationId: string): Promise<void>;
29961
+ }
29962
+ declare function queryPickupLocation$1(httpClient: HttpClient): QueryPickupLocationSignature;
29963
+ interface QueryPickupLocationSignature {
29964
+ /**
29965
+ * Query PickupLocations using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
29966
+ */
29967
+ (): PickupLocationsQueryBuilder;
29968
+ }
29969
+ declare function bulkCreatePickupLocation$1(httpClient: HttpClient): BulkCreatePickupLocationSignature;
29970
+ interface BulkCreatePickupLocationSignature {
29971
+ /**
29972
+ * Bulk Create for new PickupLocation
29973
+ */
29974
+ (pickupLocations: PickupLocation[]): Promise<BulkCreatePickupLocationResponse & BulkCreatePickupLocationResponseNonNullableFields>;
29975
+ }
29976
+ declare function bulkUpdatePickupLocation$1(httpClient: HttpClient): BulkUpdatePickupLocationSignature;
29977
+ interface BulkUpdatePickupLocationSignature {
29978
+ /**
29979
+ * Update a PickupLocation
29980
+ */
29981
+ (pickupLocations: PickupLocation[]): Promise<BulkUpdatePickupLocationResponse & BulkUpdatePickupLocationResponseNonNullableFields>;
29982
+ }
29983
+ declare function bulkDeletePickupLocation$1(httpClient: HttpClient): BulkDeletePickupLocationSignature;
29984
+ interface BulkDeletePickupLocationSignature {
29985
+ /**
29986
+ * Delete a PickupLocation
29987
+ */
29988
+ (pickupLocationIds: string[]): Promise<BulkDeletePickupLocationResponse & BulkDeletePickupLocationResponseNonNullableFields>;
29989
+ }
28414
29990
  declare const onPickupLocationCreated$1: EventDefinition<PickupLocationCreatedEnvelope, "wix.ecom.v1.pickup_location_created">;
28415
29991
  declare const onPickupLocationUpdated$1: EventDefinition<PickupLocationUpdatedEnvelope, "wix.ecom.v1.pickup_location_updated">;
28416
29992
  declare const onPickupLocationDeleted$1: EventDefinition<PickupLocationDeletedEnvelope, "wix.ecom.v1.pickup_location_deleted">;
@@ -28437,12 +30013,15 @@ type _publicBulkDeletePickupLocationType = typeof bulkDeletePickupLocation$1;
28437
30013
  declare const bulkDeletePickupLocation: ReturnType<typeof createRESTModule$4<_publicBulkDeletePickupLocationType>>;
28438
30014
 
28439
30015
  type _publicOnPickupLocationCreatedType = typeof onPickupLocationCreated$1;
30016
+ /** */
28440
30017
  declare const onPickupLocationCreated: ReturnType<typeof createEventModule$2<_publicOnPickupLocationCreatedType>>;
28441
30018
 
28442
30019
  type _publicOnPickupLocationUpdatedType = typeof onPickupLocationUpdated$1;
30020
+ /** */
28443
30021
  declare const onPickupLocationUpdated: ReturnType<typeof createEventModule$2<_publicOnPickupLocationUpdatedType>>;
28444
30022
 
28445
30023
  type _publicOnPickupLocationDeletedType = typeof onPickupLocationDeleted$1;
30024
+ /** */
28446
30025
  declare const onPickupLocationDeleted: ReturnType<typeof createEventModule$2<_publicOnPickupLocationDeletedType>>;
28447
30026
 
28448
30027
  type context$4_AddressStreetOneOf = AddressStreetOneOf;
@@ -28998,12 +30577,74 @@ interface UpdateExtendedFieldsOptions$1 {
28998
30577
  namespaceData: Record<string, any> | null;
28999
30578
  }
29000
30579
 
29001
- declare function createShippingOption$1(httpClient: HttpClient): (shippingOption: ShippingOption$1) => Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
29002
- declare function getShippingOption$1(httpClient: HttpClient): (shippingOptionId: string) => Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
29003
- declare function updateShippingOption$1(httpClient: HttpClient): (_id: string | null, shippingOption: UpdateShippingOption) => Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
29004
- declare function deleteShippingOption$1(httpClient: HttpClient): (shippingOptionId: string) => Promise<void>;
29005
- declare function queryShippingOptions$1(httpClient: HttpClient): () => ShippingOptionsQueryBuilder;
29006
- declare function updateExtendedFields$3(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$1) => Promise<UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
30580
+ declare function createShippingOption$1(httpClient: HttpClient): CreateShippingOptionSignature;
30581
+ interface CreateShippingOptionSignature {
30582
+ /**
30583
+ * Creates a ShippingOption.
30584
+ *
30585
+ * The request body must include shipping option and delivery region associated to.
30586
+ * @param - ShippingOption to be created.
30587
+ * @returns The created ShippingOption.
30588
+ */
30589
+ (shippingOption: ShippingOption$1): Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
30590
+ }
30591
+ declare function getShippingOption$1(httpClient: HttpClient): GetShippingOptionSignature;
30592
+ interface GetShippingOptionSignature {
30593
+ /**
30594
+ * Retrieves a ShippingOption.
30595
+ * @param - ID of the ShippingOption to retrieve.
30596
+ * @returns The requested ShippingOption.
30597
+ */
30598
+ (shippingOptionId: string): Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
30599
+ }
30600
+ declare function updateShippingOption$1(httpClient: HttpClient): UpdateShippingOptionSignature;
30601
+ interface UpdateShippingOptionSignature {
30602
+ /**
30603
+ * Updates a ShippingOption.
30604
+ *
30605
+ *
30606
+ * Each time the ShippingOption is updated,
30607
+ * `revision` increments by 1.
30608
+ * The current `revision` must be passed when updating the ShippingOption.
30609
+ * This ensures you're working with the latest ShippingOption
30610
+ * and prevents unintended overwrites.
30611
+ * @param - ShippingOption ID.
30612
+ * @returns Updated ShippingOption.
30613
+ */
30614
+ (_id: string | null, shippingOption: UpdateShippingOption): Promise<ShippingOption$1 & ShippingOptionNonNullableFields$1>;
30615
+ }
30616
+ declare function deleteShippingOption$1(httpClient: HttpClient): DeleteShippingOptionSignature;
30617
+ interface DeleteShippingOptionSignature {
30618
+ /**
30619
+ * Deletes a ShippingOption.
30620
+ * Deleting a ShippingOption permanently removes them from the ShippingOption List.
30621
+ * @param - Id of the ShippingOption to delete.
30622
+ */
30623
+ (shippingOptionId: string): Promise<void>;
30624
+ }
30625
+ declare function queryShippingOptions$1(httpClient: HttpClient): QueryShippingOptionsSignature;
30626
+ interface QueryShippingOptionsSignature {
30627
+ /**
30628
+ * Retrieves a list of ShippingOptions, given the provided [paging, filtering, and sorting][1].
30629
+ *
30630
+ * Up to 1,000 ShippingOptions can be returned per request.
30631
+ *
30632
+ * To learn how to query ShippingOptions, see [API Query Language][2].
30633
+ *
30634
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
30635
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
30636
+ */
30637
+ (): ShippingOptionsQueryBuilder;
30638
+ }
30639
+ declare function updateExtendedFields$3(httpClient: HttpClient): UpdateExtendedFieldsSignature$1;
30640
+ interface UpdateExtendedFieldsSignature$1 {
30641
+ /**
30642
+ * Updates extended fields of a ShippingOption without incrementing revision
30643
+ * @param - ID of the entity to update.
30644
+ * @param - Identifier for the app whose extended fields are being updated.
30645
+ */
30646
+ (_id: string, namespace: string, options: UpdateExtendedFieldsOptions$1): Promise<UpdateExtendedFieldsResponse$1 & UpdateExtendedFieldsResponseNonNullableFields$1>;
30647
+ }
29007
30648
  declare const onShippingOptionCreated$1: EventDefinition<ShippingOptionCreatedEnvelope, "wix.ecom.v1.shipping_option_created">;
29008
30649
  declare const onShippingOptionUpdated$1: EventDefinition<ShippingOptionUpdatedEnvelope, "wix.ecom.v1.shipping_option_updated">;
29009
30650
  declare const onShippingOptionDeleted$1: EventDefinition<ShippingOptionDeletedEnvelope, "wix.ecom.v1.shipping_option_deleted">;
@@ -29026,12 +30667,15 @@ type _publicUpdateExtendedFieldsType$1 = typeof updateExtendedFields$3;
29026
30667
  declare const updateExtendedFields$2: ReturnType<typeof createRESTModule$3<_publicUpdateExtendedFieldsType>>;
29027
30668
 
29028
30669
  type _publicOnShippingOptionCreatedType = typeof onShippingOptionCreated$1;
30670
+ /** */
29029
30671
  declare const onShippingOptionCreated: ReturnType<typeof createEventModule$1<_publicOnShippingOptionCreatedType>>;
29030
30672
 
29031
30673
  type _publicOnShippingOptionUpdatedType = typeof onShippingOptionUpdated$1;
30674
+ /** */
29032
30675
  declare const onShippingOptionUpdated: ReturnType<typeof createEventModule$1<_publicOnShippingOptionUpdatedType>>;
29033
30676
 
29034
30677
  type _publicOnShippingOptionDeletedType = typeof onShippingOptionDeleted$1;
30678
+ /** */
29035
30679
  declare const onShippingOptionDeleted: ReturnType<typeof createEventModule$1<_publicOnShippingOptionDeletedType>>;
29036
30680
 
29037
30681
  type context$3_Condition = Condition;
@@ -29685,12 +31329,64 @@ interface UpdateExtendedFieldsOptions {
29685
31329
  namespaceData: Record<string, any> | null;
29686
31330
  }
29687
31331
 
29688
- declare function createShippoConfiguration$1(httpClient: HttpClient): (shippoConfiguration: ShippoConfiguration, options?: CreateShippoConfigurationOptions) => Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
29689
- declare function getShippoConfiguration$1(httpClient: HttpClient): (shippoConfigurationId: string) => Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
29690
- declare function updateShippoConfiguration$1(httpClient: HttpClient): (_id: string | null, shippoConfiguration: UpdateShippoConfiguration) => Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
29691
- declare function deleteShippoConfiguration$1(httpClient: HttpClient): (shippoConfigurationId: string) => Promise<void>;
29692
- declare function queryShippoConfigurations$1(httpClient: HttpClient): () => ShippoConfigurationsQueryBuilder;
29693
- declare function updateExtendedFields$1(httpClient: HttpClient): (_id: string, namespace: string, options: UpdateExtendedFieldsOptions) => Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
31332
+ declare function createShippoConfiguration$1(httpClient: HttpClient): CreateShippoConfigurationSignature;
31333
+ interface CreateShippoConfigurationSignature {
31334
+ /**
31335
+ * Creates a ShippoConfiguration.
31336
+ * @param - ShippoConfiguration to be created.
31337
+ * @returns The created ShippoConfiguration.
31338
+ */
31339
+ (shippoConfiguration: ShippoConfiguration, options?: CreateShippoConfigurationOptions | undefined): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
31340
+ }
31341
+ declare function getShippoConfiguration$1(httpClient: HttpClient): GetShippoConfigurationSignature;
31342
+ interface GetShippoConfigurationSignature {
31343
+ /**
31344
+ * Retrieves a ShippoConfiguration.
31345
+ * @param - ID of the ShippoConfiguration to retrieve.
31346
+ * @returns The requested ShippoConfiguration.
31347
+ */
31348
+ (shippoConfigurationId: string): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
31349
+ }
31350
+ declare function updateShippoConfiguration$1(httpClient: HttpClient): UpdateShippoConfigurationSignature;
31351
+ interface UpdateShippoConfigurationSignature {
31352
+ /**
31353
+ * Updates a ShippoConfiguration.
31354
+ * @param - ShippoConfiguration ID.
31355
+ * @returns Updated ShippoConfiguration.
31356
+ */
31357
+ (_id: string | null, shippoConfiguration: UpdateShippoConfiguration): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
31358
+ }
31359
+ declare function deleteShippoConfiguration$1(httpClient: HttpClient): DeleteShippoConfigurationSignature;
31360
+ interface DeleteShippoConfigurationSignature {
31361
+ /**
31362
+ * Deletes a ShippoConfiguration.
31363
+ * @param - ID of the ShippoConfiguration to delete.
31364
+ */
31365
+ (shippoConfigurationId: string): Promise<void>;
31366
+ }
31367
+ declare function queryShippoConfigurations$1(httpClient: HttpClient): QueryShippoConfigurationsSignature;
31368
+ interface QueryShippoConfigurationsSignature {
31369
+ /**
31370
+ * Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
31371
+ *
31372
+ * Up to 1,000 ShippoConfigurations can be returned per request.
31373
+ *
31374
+ * To learn how to query ShippoConfigurations, see [API Query Language][2].
31375
+ *
31376
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
31377
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
31378
+ */
31379
+ (): ShippoConfigurationsQueryBuilder;
31380
+ }
31381
+ declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
31382
+ interface UpdateExtendedFieldsSignature {
31383
+ /**
31384
+ * Updates extended fields of a ShippoConfiguration without incrementing revision
31385
+ * @param - ID of the entity to update.
31386
+ * @param - Identifier for the app whose extended fields are being updated.
31387
+ */
31388
+ (_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
31389
+ }
29694
31390
  declare const onShippoConfigurationCreated$1: EventDefinition<ShippoConfigurationCreatedEnvelope, "wix.ecom.v1.shippo_configuration_created">;
29695
31391
  declare const onShippoConfigurationUpdated$1: EventDefinition<ShippoConfigurationUpdatedEnvelope, "wix.ecom.v1.shippo_configuration_updated">;
29696
31392
  declare const onShippoConfigurationDeleted$1: EventDefinition<ShippoConfigurationDeletedEnvelope, "wix.ecom.v1.shippo_configuration_deleted">;
@@ -29713,12 +31409,15 @@ type _publicUpdateExtendedFieldsType = typeof updateExtendedFields$1;
29713
31409
  declare const updateExtendedFields: ReturnType<typeof createRESTModule$2<_publicUpdateExtendedFieldsType>>;
29714
31410
 
29715
31411
  type _publicOnShippoConfigurationCreatedType = typeof onShippoConfigurationCreated$1;
31412
+ /** */
29716
31413
  declare const onShippoConfigurationCreated: ReturnType<typeof createEventModule<_publicOnShippoConfigurationCreatedType>>;
29717
31414
 
29718
31415
  type _publicOnShippoConfigurationUpdatedType = typeof onShippoConfigurationUpdated$1;
31416
+ /** */
29719
31417
  declare const onShippoConfigurationUpdated: ReturnType<typeof createEventModule<_publicOnShippoConfigurationUpdatedType>>;
29720
31418
 
29721
31419
  type _publicOnShippoConfigurationDeletedType = typeof onShippoConfigurationDeleted$1;
31420
+ /** */
29722
31421
  declare const onShippoConfigurationDeleted: ReturnType<typeof createEventModule<_publicOnShippoConfigurationDeletedType>>;
29723
31422
 
29724
31423
  type context$2_ActionEvent = ActionEvent;
@@ -31094,7 +32793,13 @@ interface CalculateTotalsOptions extends CalculateTotalsRequestCouponOneOf, Calc
31094
32793
  purchaseFlowId?: string | null;
31095
32794
  }
31096
32795
 
31097
- declare function calculateTotals$1(httpClient: HttpClient): (options?: CalculateTotalsOptions) => Promise<CalculateTotalsResponse & CalculateTotalsResponseNonNullableFields>;
32796
+ declare function calculateTotals$1(httpClient: HttpClient): CalculateTotalsSignature;
32797
+ interface CalculateTotalsSignature {
32798
+ /**
32799
+ * Returns a totals calculation for specified line items.
32800
+ */
32801
+ (options?: CalculateTotalsOptions | undefined): Promise<CalculateTotalsResponse & CalculateTotalsResponseNonNullableFields>;
32802
+ }
31098
32803
 
31099
32804
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
31100
32805
 
@@ -31283,9 +32988,37 @@ interface GetConversionRateIdentifiers {
31283
32988
  to: string;
31284
32989
  }
31285
32990
 
31286
- declare function listCurrencies$1(httpClient: HttpClient): () => Promise<ListCurrenciesResponse & ListCurrenciesResponseNonNullableFields>;
31287
- declare function convertCurrency$1(httpClient: HttpClient): (identifiers: ConvertCurrencyIdentifiers, amounts: DecimalValue[]) => Promise<ConvertCurrencyResponse & ConvertCurrencyResponseNonNullableFields>;
31288
- declare function getConversionRate$1(httpClient: HttpClient): (identifiers: GetConversionRateIdentifiers) => Promise<ConversionRateResponse & ConversionRateResponseNonNullableFields>;
32991
+ declare function listCurrencies$1(httpClient: HttpClient): ListCurrenciesSignature;
32992
+ interface ListCurrenciesSignature {
32993
+ /**
32994
+ * Returns an array of currencies. The array lists all currencies for which Wix supports conversion and their symbols.
32995
+ */
32996
+ (): Promise<ListCurrenciesResponse & ListCurrenciesResponseNonNullableFields>;
32997
+ }
32998
+ declare function convertCurrency$1(httpClient: HttpClient): ConvertCurrencySignature;
32999
+ interface ConvertCurrencySignature {
33000
+ /**
33001
+ * Returns an array of amounts converted from the original (`from`) currency to the target (`to`) currency and the timestamp for the conversion rate used.
33002
+ *
33003
+ *
33004
+ * Use the `convertCurrency()` function to convert an array of one or more amounts between two currencies. The `convertCurrency()` function returns an array of converted amounts and the timestamp for the conversion rate used.
33005
+ *
33006
+ * > **Note**: The currency codes used must exist in the array of supported currencies returned by the [`listCurrencies()`](#listcurrencies) function.
33007
+ *
33008
+ * @param - Amounts to convert.
33009
+ * @param - Identifying details needed to determine which currency rate to convert. The combination of the `from` and `to` properties together comprise the unique ID.
33010
+ * @param - Options to use when converting currency.
33011
+ */
33012
+ (identifiers: ConvertCurrencyIdentifiers, amounts: DecimalValue[]): Promise<ConvertCurrencyResponse & ConvertCurrencyResponseNonNullableFields>;
33013
+ }
33014
+ declare function getConversionRate$1(httpClient: HttpClient): GetConversionRateSignature;
33015
+ interface GetConversionRateSignature {
33016
+ /**
33017
+ * Returns the conversion rate between 2 currencies.
33018
+ * @param - Identifying details needed to get the conversion rate. The combination of the `from` and `to` properties together comprise the unique ID.
33019
+ */
33020
+ (identifiers: GetConversionRateIdentifiers): Promise<ConversionRateResponse & ConversionRateResponseNonNullableFields>;
33021
+ }
31289
33022
 
31290
33023
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
31291
33024