@wix/auto_sdk_ecom_orders-settings 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.d.ts +12 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.js +17 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.context.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.d.ts +15 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.js +115 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.http.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +14 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js +66 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.d.ts +30 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.js +35 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.public.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +178 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.js +20 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +300 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +141 -0
- package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.d.ts +12 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.js +12 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.context.js.map +1 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.d.ts +15 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.js +110 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.http.js.map +1 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +14 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js +38 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js.map +1 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.d.ts +30 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js +28 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js.map +1 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +178 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js +17 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +300 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js +113 -0
- package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.d.ts +12 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.js +17 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.context.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.d.ts +15 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.js +115 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.http.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +14 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js +66 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.meta.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.d.ts +30 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.js +35 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.public.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +178 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.js +20 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +300 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +141 -0
- package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.d.ts +12 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.js +12 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.context.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.d.ts +15 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.js +110 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.http.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.d.ts +14 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.js +38 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.meta.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.d.ts +30 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.js +28 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.public.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +178 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.js +17 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +300 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js +113 -0
- package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +52 -0
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
export interface OrdersSettings {
|
|
2
|
+
/**
|
|
3
|
+
* Defines when to update the store inventory.
|
|
4
|
+
*
|
|
5
|
+
* - `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.
|
|
6
|
+
* - `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.
|
|
7
|
+
*
|
|
8
|
+
* Default: `ON_ORDER_PLACED`
|
|
9
|
+
*/
|
|
10
|
+
inventoryUpdateTrigger?: InventoryUpdateTrigger;
|
|
11
|
+
/**
|
|
12
|
+
* Whether to automatically create invoices for every new order paid online.
|
|
13
|
+
* Default: `false`
|
|
14
|
+
*/
|
|
15
|
+
createInvoice?: boolean | null;
|
|
16
|
+
/**
|
|
17
|
+
* Date and time the orders settings were created.
|
|
18
|
+
* @readonly
|
|
19
|
+
*/
|
|
20
|
+
_createdDate?: Date | null;
|
|
21
|
+
/**
|
|
22
|
+
* Date and time the orders settings were updated.
|
|
23
|
+
* @readonly
|
|
24
|
+
*/
|
|
25
|
+
_updatedDate?: Date | null;
|
|
26
|
+
}
|
|
27
|
+
export declare enum InventoryUpdateTrigger {
|
|
28
|
+
UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
|
|
29
|
+
/** Stock quantities will update only after the payment is approved. */
|
|
30
|
+
ON_ORDER_PAID = "ON_ORDER_PAID",
|
|
31
|
+
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
32
|
+
ON_ORDER_PLACED = "ON_ORDER_PLACED"
|
|
33
|
+
}
|
|
34
|
+
export interface GetOrdersSettingsRequest {
|
|
35
|
+
}
|
|
36
|
+
export interface GetOrdersSettingsResponse {
|
|
37
|
+
/** Orders settings. */
|
|
38
|
+
ordersSettings?: OrdersSettings;
|
|
39
|
+
}
|
|
40
|
+
export interface UpdateOrdersSettingsRequest {
|
|
41
|
+
/** Orders settings to update. */
|
|
42
|
+
ordersSettings: OrdersSettings;
|
|
43
|
+
}
|
|
44
|
+
export interface UpdateOrdersSettingsResponse {
|
|
45
|
+
/** The updated orders settings. */
|
|
46
|
+
ordersSettings?: OrdersSettings;
|
|
47
|
+
}
|
|
48
|
+
export interface DeleteOrdersSettingsRequest {
|
|
49
|
+
}
|
|
50
|
+
export interface DeleteOrdersSettingsResponse {
|
|
51
|
+
}
|
|
52
|
+
export interface ListOrdersSettingsRequest {
|
|
53
|
+
}
|
|
54
|
+
export interface ListOrdersSettingsResponse {
|
|
55
|
+
/** List of retrieved orders settings. */
|
|
56
|
+
ordersSettings?: OrdersSettings[];
|
|
57
|
+
}
|
|
58
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
59
|
+
createdEvent?: EntityCreatedEvent;
|
|
60
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
61
|
+
deletedEvent?: EntityDeletedEvent;
|
|
62
|
+
actionEvent?: ActionEvent;
|
|
63
|
+
/**
|
|
64
|
+
* Unique event ID.
|
|
65
|
+
* Allows clients to ignore duplicate webhooks.
|
|
66
|
+
*/
|
|
67
|
+
_id?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Assumes actions are also always typed to an entity_type
|
|
70
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
71
|
+
*/
|
|
72
|
+
entityFqdn?: string;
|
|
73
|
+
/**
|
|
74
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
75
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
76
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
77
|
+
*/
|
|
78
|
+
slug?: string;
|
|
79
|
+
/** ID of the entity associated with the event. */
|
|
80
|
+
entityId?: string;
|
|
81
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
82
|
+
eventTime?: Date | null;
|
|
83
|
+
/**
|
|
84
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
85
|
+
* (for example, GDPR).
|
|
86
|
+
*/
|
|
87
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
88
|
+
/** If present, indicates the action that triggered the event. */
|
|
89
|
+
originatedFrom?: string | null;
|
|
90
|
+
/**
|
|
91
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
92
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
93
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
94
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
95
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
96
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
97
|
+
*/
|
|
98
|
+
entityEventSequence?: string | null;
|
|
99
|
+
}
|
|
100
|
+
/** @oneof */
|
|
101
|
+
export interface DomainEventBodyOneOf {
|
|
102
|
+
createdEvent?: EntityCreatedEvent;
|
|
103
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
104
|
+
deletedEvent?: EntityDeletedEvent;
|
|
105
|
+
actionEvent?: ActionEvent;
|
|
106
|
+
}
|
|
107
|
+
export interface EntityCreatedEvent {
|
|
108
|
+
entity?: string;
|
|
109
|
+
}
|
|
110
|
+
export interface RestoreInfo {
|
|
111
|
+
deletedDate?: Date | null;
|
|
112
|
+
}
|
|
113
|
+
export interface EntityUpdatedEvent {
|
|
114
|
+
/**
|
|
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
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
117
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
118
|
+
*/
|
|
119
|
+
currentEntity?: string;
|
|
120
|
+
}
|
|
121
|
+
export interface EntityDeletedEvent {
|
|
122
|
+
/** Entity that was deleted */
|
|
123
|
+
deletedEntity?: string | null;
|
|
124
|
+
}
|
|
125
|
+
export interface ActionEvent {
|
|
126
|
+
body?: string;
|
|
127
|
+
}
|
|
128
|
+
export interface MessageEnvelope {
|
|
129
|
+
/** App instance ID. */
|
|
130
|
+
instanceId?: string | null;
|
|
131
|
+
/** Event type. */
|
|
132
|
+
eventType?: string;
|
|
133
|
+
/** The identification type and identity data. */
|
|
134
|
+
identity?: IdentificationData;
|
|
135
|
+
/** Stringify payload. */
|
|
136
|
+
data?: string;
|
|
137
|
+
}
|
|
138
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
139
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
140
|
+
anonymousVisitorId?: string;
|
|
141
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
142
|
+
memberId?: string;
|
|
143
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
144
|
+
wixUserId?: string;
|
|
145
|
+
/** ID of an app. */
|
|
146
|
+
appId?: string;
|
|
147
|
+
/** @readonly */
|
|
148
|
+
identityType?: WebhookIdentityType;
|
|
149
|
+
}
|
|
150
|
+
/** @oneof */
|
|
151
|
+
export interface IdentificationDataIdOneOf {
|
|
152
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
153
|
+
anonymousVisitorId?: string;
|
|
154
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
155
|
+
memberId?: string;
|
|
156
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
157
|
+
wixUserId?: string;
|
|
158
|
+
/** ID of an app. */
|
|
159
|
+
appId?: string;
|
|
160
|
+
}
|
|
161
|
+
export declare enum WebhookIdentityType {
|
|
162
|
+
UNKNOWN = "UNKNOWN",
|
|
163
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
164
|
+
MEMBER = "MEMBER",
|
|
165
|
+
WIX_USER = "WIX_USER",
|
|
166
|
+
APP = "APP"
|
|
167
|
+
}
|
|
168
|
+
interface OrdersSettingsNonNullableFields {
|
|
169
|
+
inventoryUpdateTrigger: InventoryUpdateTrigger;
|
|
170
|
+
}
|
|
171
|
+
export interface GetOrdersSettingsResponseNonNullableFields {
|
|
172
|
+
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
173
|
+
}
|
|
174
|
+
export interface UpdateOrdersSettingsResponseNonNullableFields {
|
|
175
|
+
ordersSettings?: OrdersSettingsNonNullableFields;
|
|
176
|
+
}
|
|
177
|
+
export interface BaseEventMetadata {
|
|
178
|
+
/** App instance ID. */
|
|
179
|
+
instanceId?: string | null;
|
|
180
|
+
/** Event type. */
|
|
181
|
+
eventType?: string;
|
|
182
|
+
/** The identification type and identity data. */
|
|
183
|
+
identity?: IdentificationData;
|
|
184
|
+
}
|
|
185
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
186
|
+
/**
|
|
187
|
+
* Unique event ID.
|
|
188
|
+
* Allows clients to ignore duplicate webhooks.
|
|
189
|
+
*/
|
|
190
|
+
_id?: string;
|
|
191
|
+
/**
|
|
192
|
+
* Assumes actions are also always typed to an entity_type
|
|
193
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
194
|
+
*/
|
|
195
|
+
entityFqdn?: string;
|
|
196
|
+
/**
|
|
197
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
198
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
199
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
200
|
+
*/
|
|
201
|
+
slug?: string;
|
|
202
|
+
/** ID of the entity associated with the event. */
|
|
203
|
+
entityId?: string;
|
|
204
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
205
|
+
eventTime?: Date | null;
|
|
206
|
+
/**
|
|
207
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
208
|
+
* (for example, GDPR).
|
|
209
|
+
*/
|
|
210
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
211
|
+
/** If present, indicates the action that triggered the event. */
|
|
212
|
+
originatedFrom?: string | null;
|
|
213
|
+
/**
|
|
214
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
215
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
216
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
217
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
218
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
219
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
220
|
+
*/
|
|
221
|
+
entityEventSequence?: string | null;
|
|
222
|
+
}
|
|
223
|
+
export interface OrdersSettingsUpdatedEnvelope {
|
|
224
|
+
entity: OrdersSettings;
|
|
225
|
+
metadata: EventMetadata;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Triggered when orders settings are updated.
|
|
229
|
+
* @permissionScope Manage Stores - all permissions
|
|
230
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
231
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
232
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
233
|
+
* @permissionScope Read Orders
|
|
234
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
235
|
+
* @permissionScope Read Stores - all read permissions
|
|
236
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
237
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
238
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
239
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
240
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
241
|
+
* @permissionScope Manage Orders
|
|
242
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
243
|
+
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
244
|
+
* @webhook
|
|
245
|
+
* @eventType wix.ecom.v1.orders_settings_updated
|
|
246
|
+
* @documentationMaturity preview
|
|
247
|
+
*/
|
|
248
|
+
export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
|
|
249
|
+
/**
|
|
250
|
+
* Retrieves the sites' order settings.
|
|
251
|
+
*
|
|
252
|
+
*
|
|
253
|
+
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
254
|
+
* @public
|
|
255
|
+
* @documentationMaturity preview
|
|
256
|
+
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
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
|
+
* @applicableIdentity APP
|
|
272
|
+
* @applicableIdentity VISITOR
|
|
273
|
+
* @returns The requested orders settings.
|
|
274
|
+
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
275
|
+
*/
|
|
276
|
+
export declare function getOrdersSettings(): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
|
|
277
|
+
/**
|
|
278
|
+
* Updates the sites' orders settings.
|
|
279
|
+
*
|
|
280
|
+
*
|
|
281
|
+
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
282
|
+
* @public
|
|
283
|
+
* @documentationMaturity preview
|
|
284
|
+
* @requiredField ordersSettings
|
|
285
|
+
* @param ordersSettings - Orders settings to update.
|
|
286
|
+
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
287
|
+
* @permissionScope Manage Stores - all permissions
|
|
288
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
289
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
290
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
291
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
292
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
293
|
+
* @permissionScope Manage Orders
|
|
294
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
295
|
+
* @applicableIdentity APP
|
|
296
|
+
* @returns The updated orders settings.
|
|
297
|
+
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
298
|
+
*/
|
|
299
|
+
export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
|
|
300
|
+
export {};
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
|
|
2
|
+
import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
|
|
3
|
+
import * as ambassadorWixEcomV1OrdersSettings from './ecom-v1-orders-settings-orders-settings.http.js';
|
|
4
|
+
export var InventoryUpdateTrigger;
|
|
5
|
+
(function (InventoryUpdateTrigger) {
|
|
6
|
+
InventoryUpdateTrigger["UNKNOWN_INVENTORY_UPDATE_TRIGGER"] = "UNKNOWN_INVENTORY_UPDATE_TRIGGER";
|
|
7
|
+
/** Stock quantities will update only after the payment is approved. */
|
|
8
|
+
InventoryUpdateTrigger["ON_ORDER_PAID"] = "ON_ORDER_PAID";
|
|
9
|
+
/** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
|
|
10
|
+
InventoryUpdateTrigger["ON_ORDER_PLACED"] = "ON_ORDER_PLACED";
|
|
11
|
+
})(InventoryUpdateTrigger || (InventoryUpdateTrigger = {}));
|
|
12
|
+
export var WebhookIdentityType;
|
|
13
|
+
(function (WebhookIdentityType) {
|
|
14
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
15
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
16
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
17
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
18
|
+
WebhookIdentityType["APP"] = "APP";
|
|
19
|
+
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
20
|
+
/**
|
|
21
|
+
* Retrieves the sites' order settings.
|
|
22
|
+
*
|
|
23
|
+
*
|
|
24
|
+
* The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
|
|
25
|
+
* @public
|
|
26
|
+
* @documentationMaturity preview
|
|
27
|
+
* @permissionId ECOM.READ_ORDERS_SETTINGS
|
|
28
|
+
* @permissionScope Manage Stores - all permissions
|
|
29
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
30
|
+
* @permissionScope Read eCommerce - all read permissions
|
|
31
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
|
|
32
|
+
* @permissionScope Read Orders
|
|
33
|
+
* @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
|
|
34
|
+
* @permissionScope Read Stores - all read permissions
|
|
35
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
36
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
37
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
38
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
39
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
40
|
+
* @permissionScope Manage Orders
|
|
41
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
42
|
+
* @applicableIdentity APP
|
|
43
|
+
* @applicableIdentity VISITOR
|
|
44
|
+
* @returns The requested orders settings.
|
|
45
|
+
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
|
|
46
|
+
*/
|
|
47
|
+
export async function getOrdersSettings() {
|
|
48
|
+
// @ts-ignore
|
|
49
|
+
const { httpClient, sideEffects } = arguments[0];
|
|
50
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({});
|
|
51
|
+
const reqOpts = ambassadorWixEcomV1OrdersSettings.getOrdersSettings(payload);
|
|
52
|
+
sideEffects?.onSiteCall?.();
|
|
53
|
+
try {
|
|
54
|
+
const result = await httpClient.request(reqOpts);
|
|
55
|
+
sideEffects?.onSuccess?.(result);
|
|
56
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
|
57
|
+
}
|
|
58
|
+
catch (err) {
|
|
59
|
+
const transformedError = sdkTransformError(err, {
|
|
60
|
+
spreadPathsToArguments: {},
|
|
61
|
+
explicitPathsToArguments: {},
|
|
62
|
+
singleArgumentUnchanged: false,
|
|
63
|
+
}, []);
|
|
64
|
+
sideEffects?.onError?.(err);
|
|
65
|
+
throw transformedError;
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Updates the sites' orders settings.
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
|
|
73
|
+
* @public
|
|
74
|
+
* @documentationMaturity preview
|
|
75
|
+
* @requiredField ordersSettings
|
|
76
|
+
* @param ordersSettings - Orders settings to update.
|
|
77
|
+
* @permissionId ECOM.UPDATE_ORDERS_SETTINGS
|
|
78
|
+
* @permissionScope Manage Stores - all permissions
|
|
79
|
+
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
80
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
81
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
82
|
+
* @permissionScope Manage eCommerce - all permissions
|
|
83
|
+
* @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
|
|
84
|
+
* @permissionScope Manage Orders
|
|
85
|
+
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
86
|
+
* @applicableIdentity APP
|
|
87
|
+
* @returns The updated orders settings.
|
|
88
|
+
* @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
|
|
89
|
+
*/
|
|
90
|
+
export async function updateOrdersSettings(ordersSettings) {
|
|
91
|
+
// @ts-ignore
|
|
92
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
93
|
+
const payload = renameKeysFromSDKRequestToRESTRequest({
|
|
94
|
+
ordersSettings: ordersSettings,
|
|
95
|
+
});
|
|
96
|
+
const reqOpts = ambassadorWixEcomV1OrdersSettings.updateOrdersSettings(payload);
|
|
97
|
+
sideEffects?.onSiteCall?.();
|
|
98
|
+
try {
|
|
99
|
+
const result = await httpClient.request(reqOpts);
|
|
100
|
+
sideEffects?.onSuccess?.(result);
|
|
101
|
+
return renameKeysFromRESTResponseToSDKResponse(result.data);
|
|
102
|
+
}
|
|
103
|
+
catch (err) {
|
|
104
|
+
const transformedError = sdkTransformError(err, {
|
|
105
|
+
spreadPathsToArguments: {},
|
|
106
|
+
explicitPathsToArguments: { ordersSettings: '$[0]' },
|
|
107
|
+
singleArgumentUnchanged: false,
|
|
108
|
+
}, ['ordersSettings']);
|
|
109
|
+
sideEffects?.onError?.(err);
|
|
110
|
+
throw transformedError;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
//# sourceMappingURL=ecom-v1-orders-settings-orders-settings.universal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ecom-v1-orders-settings-orders-settings.universal.js","sourceRoot":"","sources":["../../../../src/ecom-v1-orders-settings-orders-settings.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,iCAAiC,MAAM,mDAAmD,CAAC;AA6BvG,MAAM,CAAN,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,KAAtB,sBAAsB,QAMjC;AA+ID,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AA4FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAGrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,iCAAiC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAI9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,iCAAiC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@wix/auto_sdk_ecom_orders-settings",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"publishConfig": {
|
|
5
|
+
"registry": "https://registry.npmjs.org/",
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"keywords": [],
|
|
9
|
+
"sideEffects": false,
|
|
10
|
+
"main": "./build/cjs/index.js",
|
|
11
|
+
"types": "./build/es/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"import": "./build/es/index.js",
|
|
15
|
+
"require": "./build/cjs/index.js",
|
|
16
|
+
"types": "./build/es/index.d.ts"
|
|
17
|
+
},
|
|
18
|
+
"./package.json": "./package.json",
|
|
19
|
+
"./meta": {
|
|
20
|
+
"import": "./build/es/meta.js",
|
|
21
|
+
"require": "./build/cjs/meta.js",
|
|
22
|
+
"types": "./build/es/meta.d.ts"
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"build",
|
|
27
|
+
"meta",
|
|
28
|
+
"service-plugins"
|
|
29
|
+
],
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"@wix/sdk-runtime": "^0.3.35",
|
|
32
|
+
"@wix/sdk-types": "^1.12.4"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"typescript": "^5.3.2"
|
|
36
|
+
},
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
|
|
39
|
+
"test": ":"
|
|
40
|
+
},
|
|
41
|
+
"wix": {
|
|
42
|
+
"artifact": {
|
|
43
|
+
"artifactId": "auto-sdk-ecom-orders-settings",
|
|
44
|
+
"groupId": "com.wixpress.public-sdk-dependencies"
|
|
45
|
+
},
|
|
46
|
+
"sdkDependency": {
|
|
47
|
+
"fqdnNamespace": "ordersSettings",
|
|
48
|
+
"fqdn": "wix.ecom.v1.orders_settings"
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
"falconPackageHash": "499b40c6172bd083be18d47416ae58c01ec2fcc375f20c571f33745d"
|
|
52
|
+
}
|