@wix/auto_sdk_ecom_orders-settings 1.0.2 → 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 -109
- package/build/{cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts → ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.ts} +26 -109
- 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 -109
- 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 -109
- 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 -208
- 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 -208
- 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 -208
- 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 -208
- 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,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface OrdersSettings {
|
|
2
2
|
/**
|
|
3
3
|
* Defines when to update the store inventory.
|
|
4
4
|
*
|
|
@@ -24,38 +24,38 @@ export interface OrdersSettings {
|
|
|
24
24
|
*/
|
|
25
25
|
_updatedDate?: Date | null;
|
|
26
26
|
}
|
|
27
|
-
|
|
27
|
+
declare enum InventoryUpdateTrigger {
|
|
28
28
|
UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
|
|
29
29
|
/** Stock quantities will update only after the payment is approved. */
|
|
30
30
|
ON_ORDER_PAID = "ON_ORDER_PAID",
|
|
31
31
|
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
32
32
|
ON_ORDER_PLACED = "ON_ORDER_PLACED"
|
|
33
33
|
}
|
|
34
|
-
|
|
34
|
+
interface GetOrdersSettingsRequest {
|
|
35
35
|
}
|
|
36
|
-
|
|
36
|
+
interface GetOrdersSettingsResponse {
|
|
37
37
|
/** Orders settings. */
|
|
38
38
|
ordersSettings?: OrdersSettings;
|
|
39
39
|
}
|
|
40
|
-
|
|
40
|
+
interface UpdateOrdersSettingsRequest {
|
|
41
41
|
/** Orders settings to update. */
|
|
42
42
|
ordersSettings: OrdersSettings;
|
|
43
43
|
}
|
|
44
|
-
|
|
44
|
+
interface UpdateOrdersSettingsResponse {
|
|
45
45
|
/** The updated orders settings. */
|
|
46
46
|
ordersSettings?: OrdersSettings;
|
|
47
47
|
}
|
|
48
|
-
|
|
48
|
+
interface DeleteOrdersSettingsRequest {
|
|
49
49
|
}
|
|
50
|
-
|
|
50
|
+
interface DeleteOrdersSettingsResponse {
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
interface ListOrdersSettingsRequest {
|
|
53
53
|
}
|
|
54
|
-
|
|
54
|
+
interface ListOrdersSettingsResponse {
|
|
55
55
|
/** List of retrieved orders settings. */
|
|
56
56
|
ordersSettings?: OrdersSettings[];
|
|
57
57
|
}
|
|
58
|
-
|
|
58
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
59
59
|
createdEvent?: EntityCreatedEvent;
|
|
60
60
|
updatedEvent?: EntityUpdatedEvent;
|
|
61
61
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -98,19 +98,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
98
98
|
entityEventSequence?: string | null;
|
|
99
99
|
}
|
|
100
100
|
/** @oneof */
|
|
101
|
-
|
|
101
|
+
interface DomainEventBodyOneOf {
|
|
102
102
|
createdEvent?: EntityCreatedEvent;
|
|
103
103
|
updatedEvent?: EntityUpdatedEvent;
|
|
104
104
|
deletedEvent?: EntityDeletedEvent;
|
|
105
105
|
actionEvent?: ActionEvent;
|
|
106
106
|
}
|
|
107
|
-
|
|
107
|
+
interface EntityCreatedEvent {
|
|
108
108
|
entity?: string;
|
|
109
109
|
}
|
|
110
|
-
|
|
110
|
+
interface RestoreInfo {
|
|
111
111
|
deletedDate?: Date | null;
|
|
112
112
|
}
|
|
113
|
-
|
|
113
|
+
interface EntityUpdatedEvent {
|
|
114
114
|
/**
|
|
115
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.
|
|
116
116
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -118,14 +118,14 @@ export interface EntityUpdatedEvent {
|
|
|
118
118
|
*/
|
|
119
119
|
currentEntity?: string;
|
|
120
120
|
}
|
|
121
|
-
|
|
121
|
+
interface EntityDeletedEvent {
|
|
122
122
|
/** Entity that was deleted */
|
|
123
123
|
deletedEntity?: string | null;
|
|
124
124
|
}
|
|
125
|
-
|
|
125
|
+
interface ActionEvent {
|
|
126
126
|
body?: string;
|
|
127
127
|
}
|
|
128
|
-
|
|
128
|
+
interface MessageEnvelope {
|
|
129
129
|
/**
|
|
130
130
|
* App instance ID.
|
|
131
131
|
* @format GUID
|
|
@@ -141,7 +141,7 @@ export interface MessageEnvelope {
|
|
|
141
141
|
/** Stringify payload. */
|
|
142
142
|
data?: string;
|
|
143
143
|
}
|
|
144
|
-
|
|
144
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
145
145
|
/**
|
|
146
146
|
* ID of a site visitor that has not logged in to the site.
|
|
147
147
|
* @format GUID
|
|
@@ -166,7 +166,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
166
|
identityType?: WebhookIdentityType;
|
|
167
167
|
}
|
|
168
168
|
/** @oneof */
|
|
169
|
-
|
|
169
|
+
interface IdentificationDataIdOneOf {
|
|
170
170
|
/**
|
|
171
171
|
* ID of a site visitor that has not logged in to the site.
|
|
172
172
|
* @format GUID
|
|
@@ -188,23 +188,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
188
188
|
*/
|
|
189
189
|
appId?: string;
|
|
190
190
|
}
|
|
191
|
-
|
|
191
|
+
declare enum WebhookIdentityType {
|
|
192
192
|
UNKNOWN = "UNKNOWN",
|
|
193
193
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
194
194
|
MEMBER = "MEMBER",
|
|
195
195
|
WIX_USER = "WIX_USER",
|
|
196
196
|
APP = "APP"
|
|
197
197
|
}
|
|
198
|
-
interface
|
|
199
|
-
inventoryUpdateTrigger: InventoryUpdateTrigger;
|
|
200
|
-
}
|
|
201
|
-
export interface GetOrdersSettingsResponseNonNullableFields {
|
|
202
|
-
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
203
|
-
}
|
|
204
|
-
export interface UpdateOrdersSettingsResponseNonNullableFields {
|
|
205
|
-
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
206
|
-
}
|
|
207
|
-
export interface BaseEventMetadata {
|
|
198
|
+
interface BaseEventMetadata {
|
|
208
199
|
/**
|
|
209
200
|
* App instance ID.
|
|
210
201
|
* @format GUID
|
|
@@ -218,7 +209,7 @@ export interface BaseEventMetadata {
|
|
|
218
209
|
/** The identification type and identity data. */
|
|
219
210
|
identity?: IdentificationData;
|
|
220
211
|
}
|
|
221
|
-
|
|
212
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
222
213
|
/**
|
|
223
214
|
* Unique event ID.
|
|
224
215
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -256,83 +247,9 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
256
247
|
*/
|
|
257
248
|
entityEventSequence?: string | null;
|
|
258
249
|
}
|
|
259
|
-
|
|
250
|
+
interface OrdersSettingsUpdatedEnvelope {
|
|
260
251
|
entity: OrdersSettings;
|
|
261
252
|
metadata: EventMetadata;
|
|
262
253
|
}
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
* @permissionScope Manage Stores - all permissions
|
|
266
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
267
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
268
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
269
|
-
* @permissionScope Read Orders
|
|
270
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
271
|
-
* @permissionScope Read Stores - all read permissions
|
|
272
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
273
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
274
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
275
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
276
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
277
|
-
* @permissionScope Manage Orders
|
|
278
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
279
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
280
|
-
* @webhook
|
|
281
|
-
* @eventType wix.ecom.v1.orders_settings_updated
|
|
282
|
-
* @serviceIdentifier wix.ecom.orders_settings.api.v1.OrdersSettingsService
|
|
283
|
-
* @slug updated
|
|
284
|
-
* @documentationMaturity preview
|
|
285
|
-
*/
|
|
286
|
-
export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
|
|
287
|
-
/**
|
|
288
|
-
* Retrieves the sites' order settings.
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
292
|
-
* @public
|
|
293
|
-
* @documentationMaturity preview
|
|
294
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
295
|
-
* @permissionScope Manage Stores - all permissions
|
|
296
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
297
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
298
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
299
|
-
* @permissionScope Read Orders
|
|
300
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
301
|
-
* @permissionScope Read Stores - all read permissions
|
|
302
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
303
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
304
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
305
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
306
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
307
|
-
* @permissionScope Manage Orders
|
|
308
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
309
|
-
* @applicableIdentity APP
|
|
310
|
-
* @applicableIdentity VISITOR
|
|
311
|
-
* @returns The requested orders settings.
|
|
312
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
313
|
-
*/
|
|
314
|
-
export declare function getOrdersSettings(): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
|
|
315
|
-
/**
|
|
316
|
-
* Updates the sites' orders settings.
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
320
|
-
* @public
|
|
321
|
-
* @documentationMaturity preview
|
|
322
|
-
* @requiredField ordersSettings
|
|
323
|
-
* @param ordersSettings - Orders settings to update.
|
|
324
|
-
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
325
|
-
* @permissionScope Manage Stores - all permissions
|
|
326
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
327
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
328
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
329
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
330
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
331
|
-
* @permissionScope Manage Orders
|
|
332
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
333
|
-
* @applicableIdentity APP
|
|
334
|
-
* @returns The updated orders settings.
|
|
335
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
336
|
-
*/
|
|
337
|
-
export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
|
|
338
|
-
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,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface OrdersSettings {
|
|
2
2
|
/**
|
|
3
3
|
* Defines when to update the store inventory.
|
|
4
4
|
*
|
|
@@ -24,38 +24,38 @@ export interface OrdersSettings {
|
|
|
24
24
|
*/
|
|
25
25
|
_updatedDate?: Date | null;
|
|
26
26
|
}
|
|
27
|
-
|
|
27
|
+
declare enum InventoryUpdateTrigger {
|
|
28
28
|
UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
|
|
29
29
|
/** Stock quantities will update only after the payment is approved. */
|
|
30
30
|
ON_ORDER_PAID = "ON_ORDER_PAID",
|
|
31
31
|
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
32
32
|
ON_ORDER_PLACED = "ON_ORDER_PLACED"
|
|
33
33
|
}
|
|
34
|
-
|
|
34
|
+
interface GetOrdersSettingsRequest {
|
|
35
35
|
}
|
|
36
|
-
|
|
36
|
+
interface GetOrdersSettingsResponse {
|
|
37
37
|
/** Orders settings. */
|
|
38
38
|
ordersSettings?: OrdersSettings;
|
|
39
39
|
}
|
|
40
|
-
|
|
40
|
+
interface UpdateOrdersSettingsRequest {
|
|
41
41
|
/** Orders settings to update. */
|
|
42
42
|
ordersSettings: OrdersSettings;
|
|
43
43
|
}
|
|
44
|
-
|
|
44
|
+
interface UpdateOrdersSettingsResponse {
|
|
45
45
|
/** The updated orders settings. */
|
|
46
46
|
ordersSettings?: OrdersSettings;
|
|
47
47
|
}
|
|
48
|
-
|
|
48
|
+
interface DeleteOrdersSettingsRequest {
|
|
49
49
|
}
|
|
50
|
-
|
|
50
|
+
interface DeleteOrdersSettingsResponse {
|
|
51
51
|
}
|
|
52
|
-
|
|
52
|
+
interface ListOrdersSettingsRequest {
|
|
53
53
|
}
|
|
54
|
-
|
|
54
|
+
interface ListOrdersSettingsResponse {
|
|
55
55
|
/** List of retrieved orders settings. */
|
|
56
56
|
ordersSettings?: OrdersSettings[];
|
|
57
57
|
}
|
|
58
|
-
|
|
58
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
59
59
|
createdEvent?: EntityCreatedEvent;
|
|
60
60
|
updatedEvent?: EntityUpdatedEvent;
|
|
61
61
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -98,19 +98,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
98
98
|
entityEventSequence?: string | null;
|
|
99
99
|
}
|
|
100
100
|
/** @oneof */
|
|
101
|
-
|
|
101
|
+
interface DomainEventBodyOneOf {
|
|
102
102
|
createdEvent?: EntityCreatedEvent;
|
|
103
103
|
updatedEvent?: EntityUpdatedEvent;
|
|
104
104
|
deletedEvent?: EntityDeletedEvent;
|
|
105
105
|
actionEvent?: ActionEvent;
|
|
106
106
|
}
|
|
107
|
-
|
|
107
|
+
interface EntityCreatedEvent {
|
|
108
108
|
entity?: string;
|
|
109
109
|
}
|
|
110
|
-
|
|
110
|
+
interface RestoreInfo {
|
|
111
111
|
deletedDate?: Date | null;
|
|
112
112
|
}
|
|
113
|
-
|
|
113
|
+
interface EntityUpdatedEvent {
|
|
114
114
|
/**
|
|
115
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.
|
|
116
116
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -118,14 +118,14 @@ export interface EntityUpdatedEvent {
|
|
|
118
118
|
*/
|
|
119
119
|
currentEntity?: string;
|
|
120
120
|
}
|
|
121
|
-
|
|
121
|
+
interface EntityDeletedEvent {
|
|
122
122
|
/** Entity that was deleted */
|
|
123
123
|
deletedEntity?: string | null;
|
|
124
124
|
}
|
|
125
|
-
|
|
125
|
+
interface ActionEvent {
|
|
126
126
|
body?: string;
|
|
127
127
|
}
|
|
128
|
-
|
|
128
|
+
interface MessageEnvelope {
|
|
129
129
|
/**
|
|
130
130
|
* App instance ID.
|
|
131
131
|
* @format GUID
|
|
@@ -141,7 +141,7 @@ export interface MessageEnvelope {
|
|
|
141
141
|
/** Stringify payload. */
|
|
142
142
|
data?: string;
|
|
143
143
|
}
|
|
144
|
-
|
|
144
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
145
145
|
/**
|
|
146
146
|
* ID of a site visitor that has not logged in to the site.
|
|
147
147
|
* @format GUID
|
|
@@ -166,7 +166,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
166
166
|
identityType?: WebhookIdentityType;
|
|
167
167
|
}
|
|
168
168
|
/** @oneof */
|
|
169
|
-
|
|
169
|
+
interface IdentificationDataIdOneOf {
|
|
170
170
|
/**
|
|
171
171
|
* ID of a site visitor that has not logged in to the site.
|
|
172
172
|
* @format GUID
|
|
@@ -188,23 +188,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
188
188
|
*/
|
|
189
189
|
appId?: string;
|
|
190
190
|
}
|
|
191
|
-
|
|
191
|
+
declare enum WebhookIdentityType {
|
|
192
192
|
UNKNOWN = "UNKNOWN",
|
|
193
193
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
194
194
|
MEMBER = "MEMBER",
|
|
195
195
|
WIX_USER = "WIX_USER",
|
|
196
196
|
APP = "APP"
|
|
197
197
|
}
|
|
198
|
-
interface
|
|
199
|
-
inventoryUpdateTrigger: InventoryUpdateTrigger;
|
|
200
|
-
}
|
|
201
|
-
export interface GetOrdersSettingsResponseNonNullableFields {
|
|
202
|
-
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
203
|
-
}
|
|
204
|
-
export interface UpdateOrdersSettingsResponseNonNullableFields {
|
|
205
|
-
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
206
|
-
}
|
|
207
|
-
export interface BaseEventMetadata {
|
|
198
|
+
interface BaseEventMetadata {
|
|
208
199
|
/**
|
|
209
200
|
* App instance ID.
|
|
210
201
|
* @format GUID
|
|
@@ -218,7 +209,7 @@ export interface BaseEventMetadata {
|
|
|
218
209
|
/** The identification type and identity data. */
|
|
219
210
|
identity?: IdentificationData;
|
|
220
211
|
}
|
|
221
|
-
|
|
212
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
222
213
|
/**
|
|
223
214
|
* Unique event ID.
|
|
224
215
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -256,83 +247,9 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
256
247
|
*/
|
|
257
248
|
entityEventSequence?: string | null;
|
|
258
249
|
}
|
|
259
|
-
|
|
250
|
+
interface OrdersSettingsUpdatedEnvelope {
|
|
260
251
|
entity: OrdersSettings;
|
|
261
252
|
metadata: EventMetadata;
|
|
262
253
|
}
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
* @permissionScope Manage Stores - all permissions
|
|
266
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
267
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
268
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
269
|
-
* @permissionScope Read Orders
|
|
270
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
271
|
-
* @permissionScope Read Stores - all read permissions
|
|
272
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
273
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
274
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
275
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
276
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
277
|
-
* @permissionScope Manage Orders
|
|
278
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
279
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
280
|
-
* @webhook
|
|
281
|
-
* @eventType wix.ecom.v1.orders_settings_updated
|
|
282
|
-
* @serviceIdentifier wix.ecom.orders_settings.api.v1.OrdersSettingsService
|
|
283
|
-
* @slug updated
|
|
284
|
-
* @documentationMaturity preview
|
|
285
|
-
*/
|
|
286
|
-
export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
|
|
287
|
-
/**
|
|
288
|
-
* Retrieves the sites' order settings.
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
292
|
-
* @public
|
|
293
|
-
* @documentationMaturity preview
|
|
294
|
-
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
295
|
-
* @permissionScope Manage Stores - all permissions
|
|
296
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
297
|
-
* @permissionScope Read eCommerce - all read permissions
|
|
298
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
299
|
-
* @permissionScope Read Orders
|
|
300
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
301
|
-
* @permissionScope Read Stores - all read permissions
|
|
302
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
303
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
304
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
305
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
306
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
307
|
-
* @permissionScope Manage Orders
|
|
308
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
309
|
-
* @applicableIdentity APP
|
|
310
|
-
* @applicableIdentity VISITOR
|
|
311
|
-
* @returns The requested orders settings.
|
|
312
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
313
|
-
*/
|
|
314
|
-
export declare function getOrdersSettings(): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
|
|
315
|
-
/**
|
|
316
|
-
* Updates the sites' orders settings.
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
320
|
-
* @public
|
|
321
|
-
* @documentationMaturity preview
|
|
322
|
-
* @requiredField ordersSettings
|
|
323
|
-
* @param ordersSettings - Orders settings to update.
|
|
324
|
-
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
325
|
-
* @permissionScope Manage Stores - all permissions
|
|
326
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
327
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
328
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
329
|
-
* @permissionScope Manage eCommerce - all permissions
|
|
330
|
-
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
331
|
-
* @permissionScope Manage Orders
|
|
332
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
333
|
-
* @applicableIdentity APP
|
|
334
|
-
* @returns The updated orders settings.
|
|
335
|
-
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
336
|
-
*/
|
|
337
|
-
export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
|
|
338
|
-
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 };
|