@wix/auto_sdk_ecom_orders-settings 1.0.8 → 1.0.10

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.
Files changed (21) hide show
  1. package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +15 -19
  2. package/build/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -1
  3. package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +29 -35
  4. package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +4 -0
  5. package/build/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -1
  6. package/build/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +15 -19
  7. package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -1
  8. package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +29 -35
  9. package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js +4 -0
  10. package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -1
  11. package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.d.ts +15 -19
  12. package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -1
  13. package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +29 -35
  14. package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js +4 -0
  15. package/build/internal/cjs/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -1
  16. package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts +15 -19
  17. package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.types.js.map +1 -1
  18. package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts +29 -35
  19. package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js +4 -0
  20. package/build/internal/es/src/ecom-v1-orders-settings-orders-settings.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -3,7 +3,7 @@ export interface OrdersSettings {
3
3
  * Defines when to update the store inventory.
4
4
  * Default: `ON_ORDER_PLACED`
5
5
  */
6
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
6
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
7
7
  /**
8
8
  * Whether to automatically create invoices for every new order paid online.
9
9
  * <br>
@@ -30,6 +30,8 @@ export declare enum InventoryUpdateTrigger {
30
30
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
31
31
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
32
32
  }
33
+ /** @enumType */
34
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
33
35
  export interface GetOrdersSettingsRequest {
34
36
  }
35
37
  export interface GetOrdersSettingsResponse {
@@ -59,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
59
61
  updatedEvent?: EntityUpdatedEvent;
60
62
  deletedEvent?: EntityDeletedEvent;
61
63
  actionEvent?: ActionEvent;
62
- /**
63
- * Unique event ID.
64
- * Allows clients to ignore duplicate webhooks.
65
- */
64
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
66
65
  id?: string;
67
66
  /**
68
- * Assumes actions are also always typed to an entity_type
69
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
67
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
68
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
70
69
  */
71
70
  entityFqdn?: string;
72
71
  /**
73
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
74
- * This is although the created/updated/deleted notion is duplication of the oneof types
75
- * Example: created/updated/deleted/started/completed/email_opened
72
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
73
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
76
74
  */
77
75
  slug?: string;
78
76
  /** ID of the entity associated with the event. */
79
77
  entityId?: string;
80
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
78
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
81
79
  eventTime?: Date | null;
82
80
  /**
83
81
  * Whether the event was triggered as a result of a privacy regulation application
@@ -87,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
87
85
  /** If present, indicates the action that triggered the event. */
88
86
  originatedFrom?: string | null;
89
87
  /**
90
- * A sequence number defining the order of updates to the underlying entity.
91
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
92
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
93
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
94
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
95
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
88
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
89
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
96
90
  */
97
91
  entityEventSequence?: string | null;
98
92
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntityAsJson?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntityAsJson?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,3 +190,5 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":";;;AA0BA,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA+KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":";;;AA0BA,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA8KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -8,7 +8,7 @@ export interface OrdersSettings {
8
8
  *
9
9
  * Default: `ON_ORDER_PLACED`
10
10
  */
11
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
11
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
12
12
  /**
13
13
  * Whether to automatically create invoices for every new order paid online.
14
14
  * Default: `false`
@@ -32,6 +32,8 @@ export declare enum InventoryUpdateTrigger {
32
32
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
33
33
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34
34
  }
35
+ /** @enumType */
36
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
35
37
  export interface GetOrdersSettingsRequest {
36
38
  }
37
39
  export interface GetOrdersSettingsResponse {
@@ -61,25 +63,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
61
63
  updatedEvent?: EntityUpdatedEvent;
62
64
  deletedEvent?: EntityDeletedEvent;
63
65
  actionEvent?: ActionEvent;
64
- /**
65
- * Unique event ID.
66
- * Allows clients to ignore duplicate webhooks.
67
- */
66
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
68
67
  _id?: string;
69
68
  /**
70
- * Assumes actions are also always typed to an entity_type
71
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
69
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
70
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
72
71
  */
73
72
  entityFqdn?: string;
74
73
  /**
75
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
76
- * This is although the created/updated/deleted notion is duplication of the oneof types
77
- * Example: created/updated/deleted/started/completed/email_opened
74
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
75
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
78
76
  */
79
77
  slug?: string;
80
78
  /** ID of the entity associated with the event. */
81
79
  entityId?: string;
82
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
80
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
83
81
  eventTime?: Date | null;
84
82
  /**
85
83
  * Whether the event was triggered as a result of a privacy regulation application
@@ -89,12 +87,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
89
87
  /** If present, indicates the action that triggered the event. */
90
88
  originatedFrom?: string | null;
91
89
  /**
92
- * A sequence number defining the order of updates to the underlying entity.
93
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
94
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
95
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
96
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
97
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
90
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
91
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
98
92
  */
99
93
  entityEventSequence?: string | null;
100
94
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntity?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntity?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,6 +190,8 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
199
195
  export interface BaseEventMetadata {
200
196
  /**
201
197
  * App instance ID.
@@ -211,25 +207,21 @@ export interface BaseEventMetadata {
211
207
  identity?: IdentificationData;
212
208
  }
213
209
  export interface EventMetadata extends BaseEventMetadata {
214
- /**
215
- * Unique event ID.
216
- * Allows clients to ignore duplicate webhooks.
217
- */
210
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
218
211
  _id?: string;
219
212
  /**
220
- * Assumes actions are also always typed to an entity_type
221
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
213
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
214
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
222
215
  */
223
216
  entityFqdn?: string;
224
217
  /**
225
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
226
- * This is although the created/updated/deleted notion is duplication of the oneof types
227
- * Example: created/updated/deleted/started/completed/email_opened
218
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
219
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
228
220
  */
229
221
  slug?: string;
230
222
  /** ID of the entity associated with the event. */
231
223
  entityId?: string;
232
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
224
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
233
225
  eventTime?: Date | null;
234
226
  /**
235
227
  * Whether the event was triggered as a result of a privacy regulation application
@@ -239,12 +231,8 @@ export interface EventMetadata extends BaseEventMetadata {
239
231
  /** If present, indicates the action that triggered the event. */
240
232
  originatedFrom?: string | null;
241
233
  /**
242
- * A sequence number defining the order of updates to the underlying entity.
243
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
244
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
245
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
246
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
247
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
234
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
235
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
248
236
  */
249
237
  entityEventSequence?: string | null;
250
238
  }
@@ -256,6 +244,8 @@ export interface OrdersSettingsUpdatedEnvelope {
256
244
  * Triggered when orders settings are updated.
257
245
  * @permissionScope Manage Stores - all permissions
258
246
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
247
+ * @permissionScope Manage Stores
248
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
259
249
  * @permissionScope Read eCommerce - all read permissions
260
250
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
261
251
  * @permissionScope Read Orders
@@ -287,6 +277,8 @@ type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
287
277
  * @permissionId ECOM.READ_ORDERS_SETTINGS
288
278
  * @permissionScope Manage Stores - all permissions
289
279
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
280
+ * @permissionScope Manage Stores
281
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
290
282
  * @permissionScope Read eCommerce - all read permissions
291
283
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
292
284
  * @permissionScope Read Orders
@@ -319,6 +311,8 @@ export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersS
319
311
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
320
312
  * @permissionScope Manage Stores - all permissions
321
313
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
314
+ * @permissionScope Manage Stores
315
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
322
316
  * @permissionScope Manage Restaurants - all permissions
323
317
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
324
318
  * @permissionScope Manage eCommerce - all permissions
@@ -53,6 +53,8 @@ var WebhookIdentityType;
53
53
  * @permissionId ECOM.READ_ORDERS_SETTINGS
54
54
  * @permissionScope Manage Stores - all permissions
55
55
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
56
+ * @permissionScope Manage Stores
57
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
56
58
  * @permissionScope Read eCommerce - all read permissions
57
59
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
58
60
  * @permissionScope Read Orders
@@ -104,6 +106,8 @@ exports.getOrdersSettings = getOrdersSettings;
104
106
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
105
107
  * @permissionScope Manage Stores - all permissions
106
108
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
109
+ * @permissionScope Manage Stores
110
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
107
111
  * @permissionScope Manage Restaurants - all permissions
108
112
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
109
113
  * @permissionScope Manage eCommerce - all permissions
@@ -1 +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,sEAAuF;AACvF,oFAGiD;AAEjD,qHAAuG;AA6BvG,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA6KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA0FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,UAAU,iBAAiB;IAQrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAtCD,8CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oDA2CC"}
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,sEAAuF;AACvF,oFAGiD;AAEjD,qHAAuG;AA6BvG,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA4KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA6FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,iBAAiB;IAQrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAtCD,8CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oDA2CC"}
@@ -3,7 +3,7 @@ export interface OrdersSettings {
3
3
  * Defines when to update the store inventory.
4
4
  * Default: `ON_ORDER_PLACED`
5
5
  */
6
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
6
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
7
7
  /**
8
8
  * Whether to automatically create invoices for every new order paid online.
9
9
  * <br>
@@ -30,6 +30,8 @@ export declare enum InventoryUpdateTrigger {
30
30
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
31
31
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
32
32
  }
33
+ /** @enumType */
34
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
33
35
  export interface GetOrdersSettingsRequest {
34
36
  }
35
37
  export interface GetOrdersSettingsResponse {
@@ -59,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
59
61
  updatedEvent?: EntityUpdatedEvent;
60
62
  deletedEvent?: EntityDeletedEvent;
61
63
  actionEvent?: ActionEvent;
62
- /**
63
- * Unique event ID.
64
- * Allows clients to ignore duplicate webhooks.
65
- */
64
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
66
65
  id?: string;
67
66
  /**
68
- * Assumes actions are also always typed to an entity_type
69
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
67
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
68
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
70
69
  */
71
70
  entityFqdn?: string;
72
71
  /**
73
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
74
- * This is although the created/updated/deleted notion is duplication of the oneof types
75
- * Example: created/updated/deleted/started/completed/email_opened
72
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
73
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
76
74
  */
77
75
  slug?: string;
78
76
  /** ID of the entity associated with the event. */
79
77
  entityId?: string;
80
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
78
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
81
79
  eventTime?: Date | null;
82
80
  /**
83
81
  * Whether the event was triggered as a result of a privacy regulation application
@@ -87,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
87
85
  /** If present, indicates the action that triggered the event. */
88
86
  originatedFrom?: string | null;
89
87
  /**
90
- * A sequence number defining the order of updates to the underlying entity.
91
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
92
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
93
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
94
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
95
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
88
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
89
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
96
90
  */
97
91
  entityEventSequence?: string | null;
98
92
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntityAsJson?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntityAsJson?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,3 +190,5 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":"AA0BA,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+KD,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"}
1
+ {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":"AA0BA,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;AA8KD,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"}
@@ -8,7 +8,7 @@ export interface OrdersSettings {
8
8
  *
9
9
  * Default: `ON_ORDER_PLACED`
10
10
  */
11
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
11
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
12
12
  /**
13
13
  * Whether to automatically create invoices for every new order paid online.
14
14
  * Default: `false`
@@ -32,6 +32,8 @@ export declare enum InventoryUpdateTrigger {
32
32
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
33
33
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34
34
  }
35
+ /** @enumType */
36
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
35
37
  export interface GetOrdersSettingsRequest {
36
38
  }
37
39
  export interface GetOrdersSettingsResponse {
@@ -61,25 +63,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
61
63
  updatedEvent?: EntityUpdatedEvent;
62
64
  deletedEvent?: EntityDeletedEvent;
63
65
  actionEvent?: ActionEvent;
64
- /**
65
- * Unique event ID.
66
- * Allows clients to ignore duplicate webhooks.
67
- */
66
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
68
67
  _id?: string;
69
68
  /**
70
- * Assumes actions are also always typed to an entity_type
71
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
69
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
70
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
72
71
  */
73
72
  entityFqdn?: string;
74
73
  /**
75
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
76
- * This is although the created/updated/deleted notion is duplication of the oneof types
77
- * Example: created/updated/deleted/started/completed/email_opened
74
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
75
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
78
76
  */
79
77
  slug?: string;
80
78
  /** ID of the entity associated with the event. */
81
79
  entityId?: string;
82
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
80
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
83
81
  eventTime?: Date | null;
84
82
  /**
85
83
  * Whether the event was triggered as a result of a privacy regulation application
@@ -89,12 +87,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
89
87
  /** If present, indicates the action that triggered the event. */
90
88
  originatedFrom?: string | null;
91
89
  /**
92
- * A sequence number defining the order of updates to the underlying entity.
93
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
94
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
95
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
96
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
97
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
90
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
91
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
98
92
  */
99
93
  entityEventSequence?: string | null;
100
94
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntity?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntity?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,6 +190,8 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
199
195
  export interface BaseEventMetadata {
200
196
  /**
201
197
  * App instance ID.
@@ -211,25 +207,21 @@ export interface BaseEventMetadata {
211
207
  identity?: IdentificationData;
212
208
  }
213
209
  export interface EventMetadata extends BaseEventMetadata {
214
- /**
215
- * Unique event ID.
216
- * Allows clients to ignore duplicate webhooks.
217
- */
210
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
218
211
  _id?: string;
219
212
  /**
220
- * Assumes actions are also always typed to an entity_type
221
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
213
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
214
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
222
215
  */
223
216
  entityFqdn?: string;
224
217
  /**
225
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
226
- * This is although the created/updated/deleted notion is duplication of the oneof types
227
- * Example: created/updated/deleted/started/completed/email_opened
218
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
219
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
228
220
  */
229
221
  slug?: string;
230
222
  /** ID of the entity associated with the event. */
231
223
  entityId?: string;
232
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
224
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
233
225
  eventTime?: Date | null;
234
226
  /**
235
227
  * Whether the event was triggered as a result of a privacy regulation application
@@ -239,12 +231,8 @@ export interface EventMetadata extends BaseEventMetadata {
239
231
  /** If present, indicates the action that triggered the event. */
240
232
  originatedFrom?: string | null;
241
233
  /**
242
- * A sequence number defining the order of updates to the underlying entity.
243
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
244
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
245
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
246
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
247
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
234
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
235
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
248
236
  */
249
237
  entityEventSequence?: string | null;
250
238
  }
@@ -256,6 +244,8 @@ export interface OrdersSettingsUpdatedEnvelope {
256
244
  * Triggered when orders settings are updated.
257
245
  * @permissionScope Manage Stores - all permissions
258
246
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
247
+ * @permissionScope Manage Stores
248
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
259
249
  * @permissionScope Read eCommerce - all read permissions
260
250
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
261
251
  * @permissionScope Read Orders
@@ -287,6 +277,8 @@ type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
287
277
  * @permissionId ECOM.READ_ORDERS_SETTINGS
288
278
  * @permissionScope Manage Stores - all permissions
289
279
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
280
+ * @permissionScope Manage Stores
281
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
290
282
  * @permissionScope Read eCommerce - all read permissions
291
283
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
292
284
  * @permissionScope Read Orders
@@ -319,6 +311,8 @@ export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersS
319
311
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
320
312
  * @permissionScope Manage Stores - all permissions
321
313
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
314
+ * @permissionScope Manage Stores
315
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
322
316
  * @permissionScope Manage Restaurants - all permissions
323
317
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
324
318
  * @permissionScope Manage eCommerce - all permissions
@@ -27,6 +27,8 @@ export var WebhookIdentityType;
27
27
  * @permissionId ECOM.READ_ORDERS_SETTINGS
28
28
  * @permissionScope Manage Stores - all permissions
29
29
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
30
+ * @permissionScope Manage Stores
31
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
30
32
  * @permissionScope Read eCommerce - all read permissions
31
33
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
32
34
  * @permissionScope Read Orders
@@ -77,6 +79,8 @@ export async function getOrdersSettings() {
77
79
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
78
80
  * @permissionScope Manage Stores - all permissions
79
81
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
82
+ * @permissionScope Manage Stores
83
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
80
84
  * @permissionScope Manage Restaurants - all permissions
81
85
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
82
86
  * @permissionScope Manage eCommerce - all permissions
@@ -1 +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;AA6KD,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;AA0FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAQrC,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;IAS9B,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"}
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;AA4KD,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;AA6FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAQrC,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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,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"}
@@ -3,7 +3,7 @@ export interface OrdersSettings {
3
3
  * Defines when to update the store inventory.
4
4
  * Default: `ON_ORDER_PLACED`
5
5
  */
6
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
6
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
7
7
  /**
8
8
  * Whether to automatically create invoices for every new order paid online.
9
9
  * <br>
@@ -30,6 +30,8 @@ export declare enum InventoryUpdateTrigger {
30
30
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
31
31
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
32
32
  }
33
+ /** @enumType */
34
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
33
35
  export interface GetOrdersSettingsRequest {
34
36
  }
35
37
  export interface GetOrdersSettingsResponse {
@@ -59,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
59
61
  updatedEvent?: EntityUpdatedEvent;
60
62
  deletedEvent?: EntityDeletedEvent;
61
63
  actionEvent?: ActionEvent;
62
- /**
63
- * Unique event ID.
64
- * Allows clients to ignore duplicate webhooks.
65
- */
64
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
66
65
  id?: string;
67
66
  /**
68
- * Assumes actions are also always typed to an entity_type
69
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
67
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
68
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
70
69
  */
71
70
  entityFqdn?: string;
72
71
  /**
73
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
74
- * This is although the created/updated/deleted notion is duplication of the oneof types
75
- * Example: created/updated/deleted/started/completed/email_opened
72
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
73
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
76
74
  */
77
75
  slug?: string;
78
76
  /** ID of the entity associated with the event. */
79
77
  entityId?: string;
80
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
78
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
81
79
  eventTime?: Date | null;
82
80
  /**
83
81
  * Whether the event was triggered as a result of a privacy regulation application
@@ -87,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
87
85
  /** If present, indicates the action that triggered the event. */
88
86
  originatedFrom?: string | null;
89
87
  /**
90
- * A sequence number defining the order of updates to the underlying entity.
91
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
92
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
93
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
94
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
95
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
88
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
89
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
96
90
  */
97
91
  entityEventSequence?: string | null;
98
92
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntityAsJson?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntityAsJson?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,3 +190,5 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":";;;AA0BA,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA+KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":";;;AA0BA,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA8KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -8,7 +8,7 @@ export interface OrdersSettings {
8
8
  *
9
9
  * Default: `ON_ORDER_PLACED`
10
10
  */
11
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
11
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
12
12
  /**
13
13
  * Whether to automatically create invoices for every new order paid online.
14
14
  * Default: `false`
@@ -32,6 +32,8 @@ export declare enum InventoryUpdateTrigger {
32
32
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
33
33
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34
34
  }
35
+ /** @enumType */
36
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
35
37
  export interface GetOrdersSettingsRequest {
36
38
  }
37
39
  export interface GetOrdersSettingsResponse {
@@ -61,25 +63,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
61
63
  updatedEvent?: EntityUpdatedEvent;
62
64
  deletedEvent?: EntityDeletedEvent;
63
65
  actionEvent?: ActionEvent;
64
- /**
65
- * Unique event ID.
66
- * Allows clients to ignore duplicate webhooks.
67
- */
66
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
68
67
  _id?: string;
69
68
  /**
70
- * Assumes actions are also always typed to an entity_type
71
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
69
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
70
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
72
71
  */
73
72
  entityFqdn?: string;
74
73
  /**
75
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
76
- * This is although the created/updated/deleted notion is duplication of the oneof types
77
- * Example: created/updated/deleted/started/completed/email_opened
74
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
75
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
78
76
  */
79
77
  slug?: string;
80
78
  /** ID of the entity associated with the event. */
81
79
  entityId?: string;
82
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
80
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
83
81
  eventTime?: Date | null;
84
82
  /**
85
83
  * Whether the event was triggered as a result of a privacy regulation application
@@ -89,12 +87,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
89
87
  /** If present, indicates the action that triggered the event. */
90
88
  originatedFrom?: string | null;
91
89
  /**
92
- * A sequence number defining the order of updates to the underlying entity.
93
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
94
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
95
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
96
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
97
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
90
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
91
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
98
92
  */
99
93
  entityEventSequence?: string | null;
100
94
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntity?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntity?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,6 +190,8 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
199
195
  export interface BaseEventMetadata {
200
196
  /**
201
197
  * App instance ID.
@@ -211,25 +207,21 @@ export interface BaseEventMetadata {
211
207
  identity?: IdentificationData;
212
208
  }
213
209
  export interface EventMetadata extends BaseEventMetadata {
214
- /**
215
- * Unique event ID.
216
- * Allows clients to ignore duplicate webhooks.
217
- */
210
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
218
211
  _id?: string;
219
212
  /**
220
- * Assumes actions are also always typed to an entity_type
221
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
213
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
214
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
222
215
  */
223
216
  entityFqdn?: string;
224
217
  /**
225
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
226
- * This is although the created/updated/deleted notion is duplication of the oneof types
227
- * Example: created/updated/deleted/started/completed/email_opened
218
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
219
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
228
220
  */
229
221
  slug?: string;
230
222
  /** ID of the entity associated with the event. */
231
223
  entityId?: string;
232
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
224
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
233
225
  eventTime?: Date | null;
234
226
  /**
235
227
  * Whether the event was triggered as a result of a privacy regulation application
@@ -239,12 +231,8 @@ export interface EventMetadata extends BaseEventMetadata {
239
231
  /** If present, indicates the action that triggered the event. */
240
232
  originatedFrom?: string | null;
241
233
  /**
242
- * A sequence number defining the order of updates to the underlying entity.
243
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
244
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
245
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
246
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
247
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
234
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
235
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
248
236
  */
249
237
  entityEventSequence?: string | null;
250
238
  }
@@ -256,6 +244,8 @@ export interface OrdersSettingsUpdatedEnvelope {
256
244
  * Triggered when orders settings are updated.
257
245
  * @permissionScope Manage Stores - all permissions
258
246
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
247
+ * @permissionScope Manage Stores
248
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
259
249
  * @permissionScope Read eCommerce - all read permissions
260
250
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
261
251
  * @permissionScope Read Orders
@@ -287,6 +277,8 @@ type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
287
277
  * @permissionId ECOM.READ_ORDERS_SETTINGS
288
278
  * @permissionScope Manage Stores - all permissions
289
279
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
280
+ * @permissionScope Manage Stores
281
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
290
282
  * @permissionScope Read eCommerce - all read permissions
291
283
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
292
284
  * @permissionScope Read Orders
@@ -319,6 +311,8 @@ export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersS
319
311
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
320
312
  * @permissionScope Manage Stores - all permissions
321
313
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
314
+ * @permissionScope Manage Stores
315
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
322
316
  * @permissionScope Manage Restaurants - all permissions
323
317
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
324
318
  * @permissionScope Manage eCommerce - all permissions
@@ -53,6 +53,8 @@ var WebhookIdentityType;
53
53
  * @permissionId ECOM.READ_ORDERS_SETTINGS
54
54
  * @permissionScope Manage Stores - all permissions
55
55
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
56
+ * @permissionScope Manage Stores
57
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
56
58
  * @permissionScope Read eCommerce - all read permissions
57
59
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
58
60
  * @permissionScope Read Orders
@@ -104,6 +106,8 @@ exports.getOrdersSettings = getOrdersSettings;
104
106
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
105
107
  * @permissionScope Manage Stores - all permissions
106
108
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
109
+ * @permissionScope Manage Stores
110
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
107
111
  * @permissionScope Manage Restaurants - all permissions
108
112
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
109
113
  * @permissionScope Manage eCommerce - all permissions
@@ -1 +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,sEAAuF;AACvF,oFAGiD;AAEjD,qHAAuG;AA6BvG,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA6KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA0FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,UAAU,iBAAiB;IAQrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAtCD,8CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oDA2CC"}
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,sEAAuF;AACvF,oFAGiD;AAEjD,qHAAuG;AA6BvG,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,sCAAtB,sBAAsB,QAMjC;AA4KD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AA6FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,iBAAiB;IAQrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AAtCD,8CAsCC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC;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,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,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;AA3CD,oDA2CC"}
@@ -3,7 +3,7 @@ export interface OrdersSettings {
3
3
  * Defines when to update the store inventory.
4
4
  * Default: `ON_ORDER_PLACED`
5
5
  */
6
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
6
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
7
7
  /**
8
8
  * Whether to automatically create invoices for every new order paid online.
9
9
  * <br>
@@ -30,6 +30,8 @@ export declare enum InventoryUpdateTrigger {
30
30
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
31
31
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
32
32
  }
33
+ /** @enumType */
34
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
33
35
  export interface GetOrdersSettingsRequest {
34
36
  }
35
37
  export interface GetOrdersSettingsResponse {
@@ -59,25 +61,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
59
61
  updatedEvent?: EntityUpdatedEvent;
60
62
  deletedEvent?: EntityDeletedEvent;
61
63
  actionEvent?: ActionEvent;
62
- /**
63
- * Unique event ID.
64
- * Allows clients to ignore duplicate webhooks.
65
- */
64
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
66
65
  id?: string;
67
66
  /**
68
- * Assumes actions are also always typed to an entity_type
69
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
67
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
68
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
70
69
  */
71
70
  entityFqdn?: string;
72
71
  /**
73
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
74
- * This is although the created/updated/deleted notion is duplication of the oneof types
75
- * Example: created/updated/deleted/started/completed/email_opened
72
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
73
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
76
74
  */
77
75
  slug?: string;
78
76
  /** ID of the entity associated with the event. */
79
77
  entityId?: string;
80
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
78
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
81
79
  eventTime?: Date | null;
82
80
  /**
83
81
  * Whether the event was triggered as a result of a privacy regulation application
@@ -87,12 +85,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
87
85
  /** If present, indicates the action that triggered the event. */
88
86
  originatedFrom?: string | null;
89
87
  /**
90
- * A sequence number defining the order of updates to the underlying entity.
91
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
92
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
93
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
94
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
95
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
88
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
89
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
96
90
  */
97
91
  entityEventSequence?: string | null;
98
92
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntityAsJson?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntityAsJson?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,3 +190,5 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":"AA0BA,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+KD,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"}
1
+ {"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":"AA0BA,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;AA8KD,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"}
@@ -8,7 +8,7 @@ export interface OrdersSettings {
8
8
  *
9
9
  * Default: `ON_ORDER_PLACED`
10
10
  */
11
- inventoryUpdateTrigger?: InventoryUpdateTrigger;
11
+ inventoryUpdateTrigger?: InventoryUpdateTriggerWithLiterals;
12
12
  /**
13
13
  * Whether to automatically create invoices for every new order paid online.
14
14
  * Default: `false`
@@ -32,6 +32,8 @@ export declare enum InventoryUpdateTrigger {
32
32
  /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
33
33
  ON_ORDER_PLACED = "ON_ORDER_PLACED"
34
34
  }
35
+ /** @enumType */
36
+ export type InventoryUpdateTriggerWithLiterals = InventoryUpdateTrigger | 'UNKNOWN_INVENTORY_UPDATE_TRIGGER' | 'ON_ORDER_PAID' | 'ON_ORDER_PLACED';
35
37
  export interface GetOrdersSettingsRequest {
36
38
  }
37
39
  export interface GetOrdersSettingsResponse {
@@ -61,25 +63,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
61
63
  updatedEvent?: EntityUpdatedEvent;
62
64
  deletedEvent?: EntityDeletedEvent;
63
65
  actionEvent?: ActionEvent;
64
- /**
65
- * Unique event ID.
66
- * Allows clients to ignore duplicate webhooks.
67
- */
66
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
68
67
  _id?: string;
69
68
  /**
70
- * Assumes actions are also always typed to an entity_type
71
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
69
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
70
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
72
71
  */
73
72
  entityFqdn?: string;
74
73
  /**
75
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
76
- * This is although the created/updated/deleted notion is duplication of the oneof types
77
- * Example: created/updated/deleted/started/completed/email_opened
74
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
75
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
78
76
  */
79
77
  slug?: string;
80
78
  /** ID of the entity associated with the event. */
81
79
  entityId?: string;
82
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
80
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
83
81
  eventTime?: Date | null;
84
82
  /**
85
83
  * Whether the event was triggered as a result of a privacy regulation application
@@ -89,12 +87,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
89
87
  /** If present, indicates the action that triggered the event. */
90
88
  originatedFrom?: string | null;
91
89
  /**
92
- * A sequence number defining the order of updates to the underlying entity.
93
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
94
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
95
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
96
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
97
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
90
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
91
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
98
92
  */
99
93
  entityEventSequence?: string | null;
100
94
  }
@@ -120,7 +114,7 @@ export interface EntityUpdatedEvent {
120
114
  currentEntity?: string;
121
115
  }
122
116
  export interface EntityDeletedEvent {
123
- /** Entity that was deleted */
117
+ /** Entity that was deleted. */
124
118
  deletedEntity?: string | null;
125
119
  }
126
120
  export interface ActionEvent {
@@ -164,7 +158,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
164
158
  */
165
159
  appId?: string;
166
160
  /** @readonly */
167
- identityType?: WebhookIdentityType;
161
+ identityType?: WebhookIdentityTypeWithLiterals;
168
162
  }
169
163
  /** @oneof */
170
164
  export interface IdentificationDataIdOneOf {
@@ -196,6 +190,8 @@ export declare enum WebhookIdentityType {
196
190
  WIX_USER = "WIX_USER",
197
191
  APP = "APP"
198
192
  }
193
+ /** @enumType */
194
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
199
195
  export interface BaseEventMetadata {
200
196
  /**
201
197
  * App instance ID.
@@ -211,25 +207,21 @@ export interface BaseEventMetadata {
211
207
  identity?: IdentificationData;
212
208
  }
213
209
  export interface EventMetadata extends BaseEventMetadata {
214
- /**
215
- * Unique event ID.
216
- * Allows clients to ignore duplicate webhooks.
217
- */
210
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
218
211
  _id?: string;
219
212
  /**
220
- * Assumes actions are also always typed to an entity_type
221
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
213
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
214
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
222
215
  */
223
216
  entityFqdn?: string;
224
217
  /**
225
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
226
- * This is although the created/updated/deleted notion is duplication of the oneof types
227
- * Example: created/updated/deleted/started/completed/email_opened
218
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
219
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
228
220
  */
229
221
  slug?: string;
230
222
  /** ID of the entity associated with the event. */
231
223
  entityId?: string;
232
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
224
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
233
225
  eventTime?: Date | null;
234
226
  /**
235
227
  * Whether the event was triggered as a result of a privacy regulation application
@@ -239,12 +231,8 @@ export interface EventMetadata extends BaseEventMetadata {
239
231
  /** If present, indicates the action that triggered the event. */
240
232
  originatedFrom?: string | null;
241
233
  /**
242
- * A sequence number defining the order of updates to the underlying entity.
243
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
244
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
245
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
246
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
247
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
234
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
235
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
248
236
  */
249
237
  entityEventSequence?: string | null;
250
238
  }
@@ -256,6 +244,8 @@ export interface OrdersSettingsUpdatedEnvelope {
256
244
  * Triggered when orders settings are updated.
257
245
  * @permissionScope Manage Stores - all permissions
258
246
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
247
+ * @permissionScope Manage Stores
248
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
259
249
  * @permissionScope Read eCommerce - all read permissions
260
250
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
261
251
  * @permissionScope Read Orders
@@ -287,6 +277,8 @@ type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
287
277
  * @permissionId ECOM.READ_ORDERS_SETTINGS
288
278
  * @permissionScope Manage Stores - all permissions
289
279
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
280
+ * @permissionScope Manage Stores
281
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
290
282
  * @permissionScope Read eCommerce - all read permissions
291
283
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
292
284
  * @permissionScope Read Orders
@@ -319,6 +311,8 @@ export declare function getOrdersSettings(): Promise<NonNullablePaths<GetOrdersS
319
311
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
320
312
  * @permissionScope Manage Stores - all permissions
321
313
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
314
+ * @permissionScope Manage Stores
315
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
322
316
  * @permissionScope Manage Restaurants - all permissions
323
317
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
324
318
  * @permissionScope Manage eCommerce - all permissions
@@ -27,6 +27,8 @@ export var WebhookIdentityType;
27
27
  * @permissionId ECOM.READ_ORDERS_SETTINGS
28
28
  * @permissionScope Manage Stores - all permissions
29
29
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
30
+ * @permissionScope Manage Stores
31
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
30
32
  * @permissionScope Read eCommerce - all read permissions
31
33
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
32
34
  * @permissionScope Read Orders
@@ -77,6 +79,8 @@ export async function getOrdersSettings() {
77
79
  * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
78
80
  * @permissionScope Manage Stores - all permissions
79
81
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
82
+ * @permissionScope Manage Stores
83
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
80
84
  * @permissionScope Manage Restaurants - all permissions
81
85
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
82
86
  * @permissionScope Manage eCommerce - all permissions
@@ -1 +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;AA6KD,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;AA0FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAQrC,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;IAS9B,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"}
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;AA4KD,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;AA6FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAQrC,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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_ecom_orders-settings",
3
- "version": "1.0.8",
3
+ "version": "1.0.10",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.ecom.v1.orders_settings"
49
49
  }
50
50
  },
51
- "falconPackageHash": "b5045285f86234147bd8cb8a9a97f65087636a66455431c5abc21ab5"
51
+ "falconPackageHash": "b7dce7c2347f3e975206d5a73a93632a81d0a1ef42c9c4bffcc3ae87"
52
52
  }