@wix/auto_sdk_ecom_orders-settings 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts → ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.mts} +26 -106
- package/build/{cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts → ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.ts} +26 -106
- package/build/index.d.mts +37 -0
- package/build/index.d.ts +37 -0
- package/build/index.js +249 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +221 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts → internal/ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.mts} +26 -106
- package/build/internal/{es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts → ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.ts} +26 -106
- package/build/internal/index.d.mts +37 -0
- package/build/internal/index.d.ts +37 -0
- package/build/internal/index.js +249 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +221 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +63 -0
- package/build/internal/meta.d.ts +63 -0
- package/build/internal/meta.js +169 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +141 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +63 -0
- package/build/meta.d.ts +63 -0
- package/build/meta.js +169 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +141 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.d.ts +0 -12
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.js +0 -17
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.d.ts +0 -15
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.js +0 -115
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +0 -14
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js +0 -66
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.d.ts +0 -30
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.js +0 -35
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +0 -198
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.js +0 -20
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +0 -141
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.d.ts +0 -12
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.js +0 -12
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.js.map +0 -1
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.d.ts +0 -15
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.js +0 -110
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.js.map +0 -1
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +0 -14
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js +0 -38
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js.map +0 -1
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.d.ts +0 -30
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js +0 -28
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js.map +0 -1
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +0 -198
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js +0 -17
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +0 -1
- package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js +0 -113
- package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.d.ts +0 -12
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.js +0 -17
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.d.ts +0 -15
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.js +0 -115
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +0 -14
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js +0 -66
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.d.ts +0 -30
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.js +0 -35
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +0 -198
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.js +0 -20
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +0 -141
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.d.ts +0 -12
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.js +0 -12
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.d.ts +0 -15
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.js +0 -110
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +0 -14
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.js +0 -38
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.d.ts +0 -30
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.js +0 -28
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +0 -198
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.js +0 -17
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js +0 -113
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface OrdersSettings {
|
|
1
|
+
interface OrdersSettings {
|
|
3
2
|
/**
|
|
4
3
|
* Defines when to update the store inventory.
|
|
5
4
|
*
|
|
@@ -25,38 +24,38 @@ export interface OrdersSettings {
|
|
|
25
24
|
*/
|
|
26
25
|
_updatedDate?: Date | null;
|
|
27
26
|
}
|
|
28
|
-
|
|
27
|
+
declare enum InventoryUpdateTrigger {
|
|
29
28
|
UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
|
|
30
29
|
/** Stock quantities will update only after the payment is approved. */
|
|
31
30
|
ON_ORDER_PAID = "ON_ORDER_PAID",
|
|
32
31
|
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
33
32
|
ON_ORDER_PLACED = "ON_ORDER_PLACED"
|
|
34
33
|
}
|
|
35
|
-
|
|
34
|
+
interface GetOrdersSettingsRequest {
|
|
36
35
|
}
|
|
37
|
-
|
|
36
|
+
interface GetOrdersSettingsResponse {
|
|
38
37
|
/** Orders settings. */
|
|
39
38
|
ordersSettings?: OrdersSettings;
|
|
40
39
|
}
|
|
41
|
-
|
|
40
|
+
interface UpdateOrdersSettingsRequest {
|
|
42
41
|
/** Orders settings to update. */
|
|
43
42
|
ordersSettings: OrdersSettings;
|
|
44
43
|
}
|
|
45
|
-
|
|
44
|
+
interface UpdateOrdersSettingsResponse {
|
|
46
45
|
/** The updated orders settings. */
|
|
47
46
|
ordersSettings?: OrdersSettings;
|
|
48
47
|
}
|
|
49
|
-
|
|
48
|
+
interface DeleteOrdersSettingsRequest {
|
|
50
49
|
}
|
|
51
|
-
|
|
50
|
+
interface DeleteOrdersSettingsResponse {
|
|
52
51
|
}
|
|
53
|
-
|
|
52
|
+
interface ListOrdersSettingsRequest {
|
|
54
53
|
}
|
|
55
|
-
|
|
54
|
+
interface ListOrdersSettingsResponse {
|
|
56
55
|
/** List of retrieved orders settings. */
|
|
57
56
|
ordersSettings?: OrdersSettings[];
|
|
58
57
|
}
|
|
59
|
-
|
|
58
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
60
59
|
createdEvent?: EntityCreatedEvent;
|
|
61
60
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
61
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -99,19 +98,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
99
98
|
entityEventSequence?: string | null;
|
|
100
99
|
}
|
|
101
100
|
/** @oneof */
|
|
102
|
-
|
|
101
|
+
interface DomainEventBodyOneOf {
|
|
103
102
|
createdEvent?: EntityCreatedEvent;
|
|
104
103
|
updatedEvent?: EntityUpdatedEvent;
|
|
105
104
|
deletedEvent?: EntityDeletedEvent;
|
|
106
105
|
actionEvent?: ActionEvent;
|
|
107
106
|
}
|
|
108
|
-
|
|
107
|
+
interface EntityCreatedEvent {
|
|
109
108
|
entity?: string;
|
|
110
109
|
}
|
|
111
|
-
|
|
110
|
+
interface RestoreInfo {
|
|
112
111
|
deletedDate?: Date | null;
|
|
113
112
|
}
|
|
114
|
-
|
|
113
|
+
interface EntityUpdatedEvent {
|
|
115
114
|
/**
|
|
116
115
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
117
116
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -119,14 +118,14 @@ export interface EntityUpdatedEvent {
|
|
|
119
118
|
*/
|
|
120
119
|
currentEntity?: string;
|
|
121
120
|
}
|
|
122
|
-
|
|
121
|
+
interface EntityDeletedEvent {
|
|
123
122
|
/** Entity that was deleted */
|
|
124
123
|
deletedEntity?: string | null;
|
|
125
124
|
}
|
|
126
|
-
|
|
125
|
+
interface ActionEvent {
|
|
127
126
|
body?: string;
|
|
128
127
|
}
|
|
129
|
-
|
|
128
|
+
interface MessageEnvelope {
|
|
130
129
|
/**
|
|
131
130
|
* App instance ID.
|
|
132
131
|
* @format GUID
|
|
@@ -142,7 +141,7 @@ export interface MessageEnvelope {
|
|
|
142
141
|
/** Stringify payload. */
|
|
143
142
|
data?: string;
|
|
144
143
|
}
|
|
145
|
-
|
|
144
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
146
145
|
/**
|
|
147
146
|
* ID of a site visitor that has not logged in to the site.
|
|
148
147
|
* @format GUID
|
|
@@ -167,7 +166,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
167
166
|
identityType?: WebhookIdentityType;
|
|
168
167
|
}
|
|
169
168
|
/** @oneof */
|
|
170
|
-
|
|
169
|
+
interface IdentificationDataIdOneOf {
|
|
171
170
|
/**
|
|
172
171
|
* ID of a site visitor that has not logged in to the site.
|
|
173
172
|
* @format GUID
|
|
@@ -189,14 +188,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
189
188
|
*/
|
|
190
189
|
appId?: string;
|
|
191
190
|
}
|
|
192
|
-
|
|
191
|
+
declare enum WebhookIdentityType {
|
|
193
192
|
UNKNOWN = "UNKNOWN",
|
|
194
193
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
195
194
|
MEMBER = "MEMBER",
|
|
196
195
|
WIX_USER = "WIX_USER",
|
|
197
196
|
APP = "APP"
|
|
198
197
|
}
|
|
199
|
-
|
|
198
|
+
interface BaseEventMetadata {
|
|
200
199
|
/**
|
|
201
200
|
* App instance ID.
|
|
202
201
|
* @format GUID
|
|
@@ -210,7 +209,7 @@ export interface BaseEventMetadata {
|
|
|
210
209
|
/** The identification type and identity data. */
|
|
211
210
|
identity?: IdentificationData;
|
|
212
211
|
}
|
|
213
|
-
|
|
212
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
214
213
|
/**
|
|
215
214
|
* Unique event ID.
|
|
216
215
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -248,88 +247,9 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
248
247
|
*/
|
|
249
248
|
entityEventSequence?: string | null;
|
|
250
249
|
}
|
|
251
|
-
|
|
250
|
+
interface OrdersSettingsUpdatedEnvelope {
|
|
252
251
|
entity: OrdersSettings;
|
|
253
252
|
metadata: EventMetadata;
|
|
254
253
|
}
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
* @permissionScope Manage Stores - all permissions
|
|
258
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
259
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
260
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
261
|
-
* @permissionScope Read Orders
|
|
262
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
263
|
-
* @permissionScope Read Stores - all read permissions
|
|
264
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
265
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
266
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
267
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
268
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
269
|
-
* @permissionScope Manage Orders
|
|
270
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
271
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
272
|
-
* @webhook
|
|
273
|
-
* @eventType wix.ecom.v1.orders_settings_updated
|
|
274
|
-
* @serviceIdentifier wix.ecom.orders_settings.api.v1.OrdersSettingsService
|
|
275
|
-
* @slug updated
|
|
276
|
-
* @documentationMaturity preview
|
|
277
|
-
*/
|
|
278
|
-
export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
|
|
279
|
-
type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
|
|
280
|
-
/**
|
|
281
|
-
* Retrieves the sites' order settings.
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
285
|
-
* @public
|
|
286
|
-
* @documentationMaturity preview
|
|
287
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
288
|
-
* @permissionScope Manage Stores - all permissions
|
|
289
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
290
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
291
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
292
|
-
* @permissionScope Read Orders
|
|
293
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
294
|
-
* @permissionScope Read Stores - all read permissions
|
|
295
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
296
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
297
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
298
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
299
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
300
|
-
* @permissionScope Manage Orders
|
|
301
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
302
|
-
* @applicableIdentity APP
|
|
303
|
-
* @applicableIdentity VISITOR
|
|
304
|
-
* @returns The requested orders settings.
|
|
305
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
306
|
-
*/
|
|
307
|
-
export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersSettingsResponse, {
|
|
308
|
-
[P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
|
|
309
|
-
}[OrdersSettingsNonNullablePaths]>>;
|
|
310
|
-
/**
|
|
311
|
-
* Updates the sites' orders settings.
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
315
|
-
* @public
|
|
316
|
-
* @documentationMaturity preview
|
|
317
|
-
* @requiredField ordersSettings
|
|
318
|
-
* @param ordersSettings - Orders settings to update.
|
|
319
|
-
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
320
|
-
* @permissionScope Manage Stores - all permissions
|
|
321
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
322
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
323
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
324
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
325
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
326
|
-
* @permissionScope Manage Orders
|
|
327
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
328
|
-
* @applicableIdentity APP
|
|
329
|
-
* @returns The updated orders settings.
|
|
330
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
331
|
-
*/
|
|
332
|
-
export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<NonNullablePaths<UpdateOrdersSettingsResponse, {
|
|
333
|
-
[P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
|
|
334
|
-
}[OrdersSettingsNonNullablePaths]>>;
|
|
335
|
-
export {};
|
|
254
|
+
|
|
255
|
+
export { type ActionEvent as A, type BaseEventMetadata as B, type DeleteOrdersSettingsRequest as D, type EntityCreatedEvent as E, type GetOrdersSettingsResponse as G, InventoryUpdateTrigger as I, type ListOrdersSettingsRequest as L, type MessageEnvelope as M, type OrdersSettings as O, type RestoreInfo as R, type UpdateOrdersSettingsResponse as U, WebhookIdentityType as W, type GetOrdersSettingsRequest as a, type UpdateOrdersSettingsRequest as b, type DeleteOrdersSettingsResponse as c, type ListOrdersSettingsResponse as d, type DomainEvent as e, type DomainEventBodyOneOf as f, type EntityUpdatedEvent as g, type EntityDeletedEvent as h, type IdentificationData as i, type IdentificationDataIdOneOf as j, type EventMetadata as k, type OrdersSettingsUpdatedEnvelope as l };
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface OrdersSettings {
|
|
1
|
+
interface OrdersSettings {
|
|
3
2
|
/**
|
|
4
3
|
* Defines when to update the store inventory.
|
|
5
4
|
*
|
|
@@ -25,38 +24,38 @@ export interface OrdersSettings {
|
|
|
25
24
|
*/
|
|
26
25
|
_updatedDate?: Date | null;
|
|
27
26
|
}
|
|
28
|
-
|
|
27
|
+
declare enum InventoryUpdateTrigger {
|
|
29
28
|
UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
|
|
30
29
|
/** Stock quantities will update only after the payment is approved. */
|
|
31
30
|
ON_ORDER_PAID = "ON_ORDER_PAID",
|
|
32
31
|
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
33
32
|
ON_ORDER_PLACED = "ON_ORDER_PLACED"
|
|
34
33
|
}
|
|
35
|
-
|
|
34
|
+
interface GetOrdersSettingsRequest {
|
|
36
35
|
}
|
|
37
|
-
|
|
36
|
+
interface GetOrdersSettingsResponse {
|
|
38
37
|
/** Orders settings. */
|
|
39
38
|
ordersSettings?: OrdersSettings;
|
|
40
39
|
}
|
|
41
|
-
|
|
40
|
+
interface UpdateOrdersSettingsRequest {
|
|
42
41
|
/** Orders settings to update. */
|
|
43
42
|
ordersSettings: OrdersSettings;
|
|
44
43
|
}
|
|
45
|
-
|
|
44
|
+
interface UpdateOrdersSettingsResponse {
|
|
46
45
|
/** The updated orders settings. */
|
|
47
46
|
ordersSettings?: OrdersSettings;
|
|
48
47
|
}
|
|
49
|
-
|
|
48
|
+
interface DeleteOrdersSettingsRequest {
|
|
50
49
|
}
|
|
51
|
-
|
|
50
|
+
interface DeleteOrdersSettingsResponse {
|
|
52
51
|
}
|
|
53
|
-
|
|
52
|
+
interface ListOrdersSettingsRequest {
|
|
54
53
|
}
|
|
55
|
-
|
|
54
|
+
interface ListOrdersSettingsResponse {
|
|
56
55
|
/** List of retrieved orders settings. */
|
|
57
56
|
ordersSettings?: OrdersSettings[];
|
|
58
57
|
}
|
|
59
|
-
|
|
58
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
60
59
|
createdEvent?: EntityCreatedEvent;
|
|
61
60
|
updatedEvent?: EntityUpdatedEvent;
|
|
62
61
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -99,19 +98,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
99
98
|
entityEventSequence?: string | null;
|
|
100
99
|
}
|
|
101
100
|
/** @oneof */
|
|
102
|
-
|
|
101
|
+
interface DomainEventBodyOneOf {
|
|
103
102
|
createdEvent?: EntityCreatedEvent;
|
|
104
103
|
updatedEvent?: EntityUpdatedEvent;
|
|
105
104
|
deletedEvent?: EntityDeletedEvent;
|
|
106
105
|
actionEvent?: ActionEvent;
|
|
107
106
|
}
|
|
108
|
-
|
|
107
|
+
interface EntityCreatedEvent {
|
|
109
108
|
entity?: string;
|
|
110
109
|
}
|
|
111
|
-
|
|
110
|
+
interface RestoreInfo {
|
|
112
111
|
deletedDate?: Date | null;
|
|
113
112
|
}
|
|
114
|
-
|
|
113
|
+
interface EntityUpdatedEvent {
|
|
115
114
|
/**
|
|
116
115
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
117
116
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -119,14 +118,14 @@ export interface EntityUpdatedEvent {
|
|
|
119
118
|
*/
|
|
120
119
|
currentEntity?: string;
|
|
121
120
|
}
|
|
122
|
-
|
|
121
|
+
interface EntityDeletedEvent {
|
|
123
122
|
/** Entity that was deleted */
|
|
124
123
|
deletedEntity?: string | null;
|
|
125
124
|
}
|
|
126
|
-
|
|
125
|
+
interface ActionEvent {
|
|
127
126
|
body?: string;
|
|
128
127
|
}
|
|
129
|
-
|
|
128
|
+
interface MessageEnvelope {
|
|
130
129
|
/**
|
|
131
130
|
* App instance ID.
|
|
132
131
|
* @format GUID
|
|
@@ -142,7 +141,7 @@ export interface MessageEnvelope {
|
|
|
142
141
|
/** Stringify payload. */
|
|
143
142
|
data?: string;
|
|
144
143
|
}
|
|
145
|
-
|
|
144
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
146
145
|
/**
|
|
147
146
|
* ID of a site visitor that has not logged in to the site.
|
|
148
147
|
* @format GUID
|
|
@@ -167,7 +166,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
167
166
|
identityType?: WebhookIdentityType;
|
|
168
167
|
}
|
|
169
168
|
/** @oneof */
|
|
170
|
-
|
|
169
|
+
interface IdentificationDataIdOneOf {
|
|
171
170
|
/**
|
|
172
171
|
* ID of a site visitor that has not logged in to the site.
|
|
173
172
|
* @format GUID
|
|
@@ -189,14 +188,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
189
188
|
*/
|
|
190
189
|
appId?: string;
|
|
191
190
|
}
|
|
192
|
-
|
|
191
|
+
declare enum WebhookIdentityType {
|
|
193
192
|
UNKNOWN = "UNKNOWN",
|
|
194
193
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
195
194
|
MEMBER = "MEMBER",
|
|
196
195
|
WIX_USER = "WIX_USER",
|
|
197
196
|
APP = "APP"
|
|
198
197
|
}
|
|
199
|
-
|
|
198
|
+
interface BaseEventMetadata {
|
|
200
199
|
/**
|
|
201
200
|
* App instance ID.
|
|
202
201
|
* @format GUID
|
|
@@ -210,7 +209,7 @@ export interface BaseEventMetadata {
|
|
|
210
209
|
/** The identification type and identity data. */
|
|
211
210
|
identity?: IdentificationData;
|
|
212
211
|
}
|
|
213
|
-
|
|
212
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
214
213
|
/**
|
|
215
214
|
* Unique event ID.
|
|
216
215
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -248,88 +247,9 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
248
247
|
*/
|
|
249
248
|
entityEventSequence?: string | null;
|
|
250
249
|
}
|
|
251
|
-
|
|
250
|
+
interface OrdersSettingsUpdatedEnvelope {
|
|
252
251
|
entity: OrdersSettings;
|
|
253
252
|
metadata: EventMetadata;
|
|
254
253
|
}
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
* @permissionScope Manage Stores - all permissions
|
|
258
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
259
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
260
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
261
|
-
* @permissionScope Read Orders
|
|
262
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
263
|
-
* @permissionScope Read Stores - all read permissions
|
|
264
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
265
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
266
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
267
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
268
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
269
|
-
* @permissionScope Manage Orders
|
|
270
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
271
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
272
|
-
* @webhook
|
|
273
|
-
* @eventType wix.ecom.v1.orders_settings_updated
|
|
274
|
-
* @serviceIdentifier wix.ecom.orders_settings.api.v1.OrdersSettingsService
|
|
275
|
-
* @slug updated
|
|
276
|
-
* @documentationMaturity preview
|
|
277
|
-
*/
|
|
278
|
-
export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
|
|
279
|
-
type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
|
|
280
|
-
/**
|
|
281
|
-
* Retrieves the sites' order settings.
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
285
|
-
* @public
|
|
286
|
-
* @documentationMaturity preview
|
|
287
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
288
|
-
* @permissionScope Manage Stores - all permissions
|
|
289
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
290
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
291
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
292
|
-
* @permissionScope Read Orders
|
|
293
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
294
|
-
* @permissionScope Read Stores - all read permissions
|
|
295
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
296
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
297
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
298
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
299
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
300
|
-
* @permissionScope Manage Orders
|
|
301
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
302
|
-
* @applicableIdentity APP
|
|
303
|
-
* @applicableIdentity VISITOR
|
|
304
|
-
* @returns The requested orders settings.
|
|
305
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
306
|
-
*/
|
|
307
|
-
export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersSettingsResponse, {
|
|
308
|
-
[P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
|
|
309
|
-
}[OrdersSettingsNonNullablePaths]>>;
|
|
310
|
-
/**
|
|
311
|
-
* Updates the sites' orders settings.
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
315
|
-
* @public
|
|
316
|
-
* @documentationMaturity preview
|
|
317
|
-
* @requiredField ordersSettings
|
|
318
|
-
* @param ordersSettings - Orders settings to update.
|
|
319
|
-
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
320
|
-
* @permissionScope Manage Stores - all permissions
|
|
321
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
322
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
323
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
324
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
325
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
326
|
-
* @permissionScope Manage Orders
|
|
327
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
328
|
-
* @applicableIdentity APP
|
|
329
|
-
* @returns The updated orders settings.
|
|
330
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
331
|
-
*/
|
|
332
|
-
export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<NonNullablePaths<UpdateOrdersSettingsResponse, {
|
|
333
|
-
[P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
|
|
334
|
-
}[OrdersSettingsNonNullablePaths]>>;
|
|
335
|
-
export {};
|
|
254
|
+
|
|
255
|
+
export { type ActionEvent as A, type BaseEventMetadata as B, type DeleteOrdersSettingsRequest as D, type EntityCreatedEvent as E, type GetOrdersSettingsResponse as G, InventoryUpdateTrigger as I, type ListOrdersSettingsRequest as L, type MessageEnvelope as M, type OrdersSettings as O, type RestoreInfo as R, type UpdateOrdersSettingsResponse as U, WebhookIdentityType as W, type GetOrdersSettingsRequest as a, type UpdateOrdersSettingsRequest as b, type DeleteOrdersSettingsResponse as c, type ListOrdersSettingsResponse as d, type DomainEvent as e, type DomainEventBodyOneOf as f, type EntityUpdatedEvent as g, type EntityDeletedEvent as h, type IdentificationData as i, type IdentificationDataIdOneOf as j, type EventMetadata as k, type OrdersSettingsUpdatedEnvelope as l };
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { G as GetOrdersSettingsResponse, O as OrdersSettings, U as UpdateOrdersSettingsResponse } from './ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.mjs';
|
|
3
|
+
export { A as ActionEvent, B as BaseEventMetadata, D as DeleteOrdersSettingsRequest, c as DeleteOrdersSettingsResponse, e as DomainEvent, f as DomainEventBodyOneOf, E as EntityCreatedEvent, h as EntityDeletedEvent, g as EntityUpdatedEvent, k as EventMetadata, a as GetOrdersSettingsRequest, i as IdentificationData, j as IdentificationDataIdOneOf, I as InventoryUpdateTrigger, L as ListOrdersSettingsRequest, d as ListOrdersSettingsResponse, M as MessageEnvelope, l as OrdersSettingsUpdatedEnvelope, R as RestoreInfo, b as UpdateOrdersSettingsRequest, W as WebhookIdentityType } from './ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.mjs';
|
|
4
|
+
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
|
|
5
|
+
|
|
6
|
+
declare function getOrdersSettings$1(httpClient: HttpClient): GetOrdersSettingsSignature;
|
|
7
|
+
interface GetOrdersSettingsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves the sites' order settings.
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
13
|
+
* @returns The requested orders settings.
|
|
14
|
+
*/
|
|
15
|
+
(): Promise<GetOrdersSettingsResponse>;
|
|
16
|
+
}
|
|
17
|
+
declare function updateOrdersSettings$1(httpClient: HttpClient): UpdateOrdersSettingsSignature;
|
|
18
|
+
interface UpdateOrdersSettingsSignature {
|
|
19
|
+
/**
|
|
20
|
+
* Updates the sites' orders settings.
|
|
21
|
+
*
|
|
22
|
+
*
|
|
23
|
+
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
24
|
+
* @param - Orders settings to update.
|
|
25
|
+
* @returns The updated orders settings.
|
|
26
|
+
*/
|
|
27
|
+
(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
declare const getOrdersSettings: MaybeContext<BuildRESTFunction<typeof getOrdersSettings$1> & typeof getOrdersSettings$1>;
|
|
31
|
+
declare const updateOrdersSettings: MaybeContext<BuildRESTFunction<typeof updateOrdersSettings$1> & typeof updateOrdersSettings$1>;
|
|
32
|
+
/**
|
|
33
|
+
* Triggered when orders settings are updated.
|
|
34
|
+
*/
|
|
35
|
+
declare const onOrdersSettingsUpdated: ReturnType<typeof createEventModule<typeof publicOnOrdersSettingsUpdated>>;
|
|
36
|
+
|
|
37
|
+
export { GetOrdersSettingsResponse, OrdersSettings, UpdateOrdersSettingsResponse, getOrdersSettings, onOrdersSettingsUpdated, updateOrdersSettings };
|
package/build/index.d.ts
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
+
import { G as GetOrdersSettingsResponse, O as OrdersSettings, U as UpdateOrdersSettingsResponse } from './ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.js';
|
|
3
|
+
export { A as ActionEvent, B as BaseEventMetadata, D as DeleteOrdersSettingsRequest, c as DeleteOrdersSettingsResponse, e as DomainEvent, f as DomainEventBodyOneOf, E as EntityCreatedEvent, h as EntityDeletedEvent, g as EntityUpdatedEvent, k as EventMetadata, a as GetOrdersSettingsRequest, i as IdentificationData, j as IdentificationDataIdOneOf, I as InventoryUpdateTrigger, L as ListOrdersSettingsRequest, d as ListOrdersSettingsResponse, M as MessageEnvelope, l as OrdersSettingsUpdatedEnvelope, R as RestoreInfo, b as UpdateOrdersSettingsRequest, W as WebhookIdentityType } from './ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.js';
|
|
4
|
+
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
|
|
5
|
+
|
|
6
|
+
declare function getOrdersSettings$1(httpClient: HttpClient): GetOrdersSettingsSignature;
|
|
7
|
+
interface GetOrdersSettingsSignature {
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves the sites' order settings.
|
|
10
|
+
*
|
|
11
|
+
*
|
|
12
|
+
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
13
|
+
* @returns The requested orders settings.
|
|
14
|
+
*/
|
|
15
|
+
(): Promise<GetOrdersSettingsResponse>;
|
|
16
|
+
}
|
|
17
|
+
declare function updateOrdersSettings$1(httpClient: HttpClient): UpdateOrdersSettingsSignature;
|
|
18
|
+
interface UpdateOrdersSettingsSignature {
|
|
19
|
+
/**
|
|
20
|
+
* Updates the sites' orders settings.
|
|
21
|
+
*
|
|
22
|
+
*
|
|
23
|
+
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
24
|
+
* @param - Orders settings to update.
|
|
25
|
+
* @returns The updated orders settings.
|
|
26
|
+
*/
|
|
27
|
+
(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse>;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
declare const getOrdersSettings: MaybeContext<BuildRESTFunction<typeof getOrdersSettings$1> & typeof getOrdersSettings$1>;
|
|
31
|
+
declare const updateOrdersSettings: MaybeContext<BuildRESTFunction<typeof updateOrdersSettings$1> & typeof updateOrdersSettings$1>;
|
|
32
|
+
/**
|
|
33
|
+
* Triggered when orders settings are updated.
|
|
34
|
+
*/
|
|
35
|
+
declare const onOrdersSettingsUpdated: ReturnType<typeof createEventModule<typeof publicOnOrdersSettingsUpdated>>;
|
|
36
|
+
|
|
37
|
+
export { GetOrdersSettingsResponse, OrdersSettings, UpdateOrdersSettingsResponse, getOrdersSettings, onOrdersSettingsUpdated, updateOrdersSettings };
|