@wix/auto_sdk_ecom_shippo-configurations 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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.d.ts +20 -0
  11. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +29 -0
  12. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +22 -0
  14. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +288 -0
  15. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +26 -0
  17. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +144 -0
  18. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +67 -0
  20. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +96 -0
  21. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +1 -0
  22. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts +455 -0
  23. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +48 -0
  24. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +1 -0
  25. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts +711 -0
  26. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +362 -0
  27. package/build/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.d.ts +20 -0
  39. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +20 -0
  40. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +1 -0
  41. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +22 -0
  42. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +279 -0
  43. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +1 -0
  44. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +26 -0
  45. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +112 -0
  46. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +1 -0
  47. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +67 -0
  48. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +81 -0
  49. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +1 -0
  50. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts +455 -0
  51. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +45 -0
  52. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +1 -0
  53. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts +711 -0
  54. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +330 -0
  55. package/build/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.d.ts +20 -0
  66. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +29 -0
  67. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +22 -0
  69. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +288 -0
  70. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +26 -0
  72. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +144 -0
  73. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +67 -0
  75. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +96 -0
  76. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts +455 -0
  78. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +48 -0
  79. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +1 -0
  80. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts +711 -0
  81. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +362 -0
  82. package/build/internal/cjs/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.d.ts +20 -0
  93. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js +20 -0
  94. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.d.ts +22 -0
  96. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js +279 -0
  97. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.d.ts +26 -0
  99. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js +112 -0
  100. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.d.ts +67 -0
  102. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js +81 -0
  103. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.d.ts +455 -0
  105. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js +45 -0
  106. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.types.js.map +1 -0
  107. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.d.ts +711 -0
  108. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js +330 -0
  109. package/build/internal/es/src/ecom-v1-shippo-configuration-shippo-configurations.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,711 @@
1
+ export interface ShippoConfiguration {
2
+ /**
3
+ * ShippoConfiguration ID.
4
+ * @readonly
5
+ */
6
+ _id?: string | null;
7
+ /** @readonly */
8
+ revision?: string | null;
9
+ /**
10
+ * Date and time the ShippoConfiguration was created.
11
+ * @readonly
12
+ */
13
+ _createdDate?: Date | null;
14
+ /**
15
+ * Date and time the ShippoConfiguration was last updated.
16
+ * @readonly
17
+ */
18
+ _updatedDate?: Date | null;
19
+ /** Associated delivery region ID. */
20
+ deliveryRegionId?: string | null;
21
+ /** Settings of USPS domestic services. */
22
+ domesticServices?: DomesticServiceSettings[];
23
+ /** Settings of USPS international services. */
24
+ internationalServices?: InternationalServiceSettings[];
25
+ /** Package type. */
26
+ packageType?: PackageType;
27
+ /** Package details. */
28
+ packageDetails?: PackageDetails;
29
+ /** Location ID from OS location service. */
30
+ osLocationId?: string | null;
31
+ /**
32
+ * Ship from address materialized from OS location.
33
+ * @readonly
34
+ */
35
+ shipFromAddress?: Address;
36
+ /** Backup weight. */
37
+ backupWeight?: string | null;
38
+ /** Data extensions. */
39
+ extendedFields?: ExtendedFields;
40
+ }
41
+ export interface DomesticServiceSettings {
42
+ /** USPS domestic service. */
43
+ service?: DomesticService;
44
+ /** Service settings. */
45
+ serviceSettings?: ServiceSettings;
46
+ }
47
+ export declare enum DomesticService {
48
+ UNKNOWN_DOMESTIC_SERVICE = "UNKNOWN_DOMESTIC_SERVICE",
49
+ GROUND_ADVANTAGE = "GROUND_ADVANTAGE",
50
+ PRIORITY_MAIL = "PRIORITY_MAIL",
51
+ PRIORITY_MAIL_EXPRESS = "PRIORITY_MAIL_EXPRESS"
52
+ }
53
+ export interface ServiceSettings {
54
+ /** Estimated delivery time. */
55
+ estimatedDeliveryTime?: string | null;
56
+ /** Handling fee. */
57
+ handlingFee?: HandlingFee;
58
+ /** Amount above which free delivery is offered. */
59
+ freeDeliveryMinimumAmount?: string | null;
60
+ }
61
+ export interface HandlingFee {
62
+ /** Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee. */
63
+ value?: string;
64
+ /** How to calculate the fee: fixed amount or by percentage. */
65
+ calculationType?: CalculationType;
66
+ }
67
+ export declare enum CalculationType {
68
+ UNKNOWN_TYPE = "UNKNOWN_TYPE",
69
+ FIXED = "FIXED",
70
+ PERCENTAGE = "PERCENTAGE"
71
+ }
72
+ export interface InternationalServiceSettings {
73
+ /** USPS international service. */
74
+ service?: InternationalService;
75
+ /** Service settings. */
76
+ serviceSettings?: ServiceSettings;
77
+ }
78
+ export declare enum InternationalService {
79
+ UNKNOWN_INTERNATIONAL_SERVICE = "UNKNOWN_INTERNATIONAL_SERVICE",
80
+ FIRST_CLASS_PACKAGE_INTERNATIONAL = "FIRST_CLASS_PACKAGE_INTERNATIONAL",
81
+ PRIORITY_MAIL_INTERNATIONAL = "PRIORITY_MAIL_INTERNATIONAL",
82
+ PRIORITY_MAIL_EXPRESS_INTERNATIONAL = "PRIORITY_MAIL_EXPRESS_INTERNATIONAL"
83
+ }
84
+ export declare enum PackageType {
85
+ UNKNOWN_PACKAGE_TYPE = "UNKNOWN_PACKAGE_TYPE",
86
+ CUSTOM = "CUSTOM",
87
+ FLAT_RATE_ENVELOPE = "FLAT_RATE_ENVELOPE",
88
+ PADDED_FLAT_RATE_ENVELOPE = "PADDED_FLAT_RATE_ENVELOPE",
89
+ SMALL_FLAT_RATE_BOX = "SMALL_FLAT_RATE_BOX",
90
+ MEDIUM_FLAT_RATE_BOX_1 = "MEDIUM_FLAT_RATE_BOX_1",
91
+ MEDIUM_FLAT_RATE_BOX_2 = "MEDIUM_FLAT_RATE_BOX_2",
92
+ LARGE_FLAT_RATE_BOX = "LARGE_FLAT_RATE_BOX"
93
+ }
94
+ export interface PackageDetails {
95
+ /**
96
+ * Package name. Must be set when package type is CUSTOM.
97
+ * For other package types, it is read-only, and an exception will be thrown
98
+ * if it set when creating a ShippoConfiguration.
99
+ */
100
+ name?: string | null;
101
+ /**
102
+ * Package dimensions. Can only be set when package type is CUSTOM.
103
+ * For other package types, it is read-only, and an exception will be thrown
104
+ * if it set when creating a ShippoConfiguration.
105
+ */
106
+ dimensions?: PackageDimensions;
107
+ /**
108
+ * Maximum number of products. Must be set when package type is NOT CUSTOM.
109
+ * Otherwise, if the package type is CUSTOM, this field cannot be set and an
110
+ * exception will be thrown if it is set when creating a ShippoConfiguration.
111
+ */
112
+ maxNumberOfProducts?: string | null;
113
+ }
114
+ export interface PackageDimensions {
115
+ /** Package length. */
116
+ length?: string;
117
+ /** Package width. */
118
+ width?: string;
119
+ /** Package height. */
120
+ height?: string;
121
+ }
122
+ /** Physical address */
123
+ export interface Address {
124
+ /** Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format. */
125
+ country?: string | null;
126
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format. */
127
+ subdivision?: string | null;
128
+ /** City name. */
129
+ city?: string | null;
130
+ /** Postal or zip code. */
131
+ postalCode?: string | null;
132
+ /** Street address. */
133
+ streetAddress?: StreetAddress;
134
+ /** Main address line (usually street name and number). */
135
+ addressLine1?: string | null;
136
+ /** Free text providing more detailed address info. Usually contains apt, suite, floor. */
137
+ addressLine2?: string | null;
138
+ /**
139
+ * Country's full name.
140
+ * @readonly
141
+ */
142
+ countryFullname?: string | null;
143
+ /**
144
+ * Subdivision full-name.
145
+ * @readonly
146
+ */
147
+ subdivisionFullname?: string | null;
148
+ }
149
+ export interface StreetAddress {
150
+ /** Street number. */
151
+ number?: string;
152
+ /** Street name. */
153
+ name?: string;
154
+ }
155
+ export interface AddressLocation {
156
+ /** Address latitude. */
157
+ latitude?: number | null;
158
+ /** Address longitude. */
159
+ longitude?: number | null;
160
+ }
161
+ export interface ExtendedFields {
162
+ /**
163
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
164
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
165
+ *
166
+ * You can only access fields for which you have the appropriate permissions.
167
+ *
168
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
169
+ */
170
+ namespaces?: Record<string, Record<string, any>>;
171
+ }
172
+ export interface CreateShippoConfigurationRequest {
173
+ /** ShippoConfiguration to be created. */
174
+ shippoConfiguration: ShippoConfiguration;
175
+ backupRate?: string | null;
176
+ }
177
+ export interface CreateShippoConfigurationResponse {
178
+ /** The created ShippoConfiguration. */
179
+ shippoConfiguration?: ShippoConfiguration;
180
+ }
181
+ export interface GetShippoConfigurationRequest {
182
+ /** ID of the ShippoConfiguration to retrieve. */
183
+ shippoConfigurationId: string;
184
+ }
185
+ export interface GetShippoConfigurationResponse {
186
+ /** The requested ShippoConfiguration. */
187
+ shippoConfiguration?: ShippoConfiguration;
188
+ }
189
+ export interface UpdateShippoConfigurationRequest {
190
+ /** ShippoConfiguration to be updated, may be partial. */
191
+ shippoConfiguration: ShippoConfiguration;
192
+ }
193
+ export interface UpdateShippoConfigurationResponse {
194
+ /** Updated ShippoConfiguration. */
195
+ shippoConfiguration?: ShippoConfiguration;
196
+ }
197
+ export interface DeleteShippoConfigurationRequest {
198
+ /** ID of the ShippoConfiguration to delete. */
199
+ shippoConfigurationId: string;
200
+ }
201
+ export interface DeleteShippoConfigurationResponse {
202
+ }
203
+ export interface QueryShippoConfigurationsRequest {
204
+ /** WQL expression. */
205
+ query?: CursorQuery;
206
+ }
207
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
208
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
209
+ cursorPaging?: CursorPaging;
210
+ /**
211
+ * Filter object in the following format:
212
+ * `"filter" : {
213
+ * "fieldName1": "value1",
214
+ * "fieldName2":{"$operator":"value2"}
215
+ * }`
216
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
217
+ */
218
+ filter?: Record<string, any> | null;
219
+ /**
220
+ * Sort object in the following format:
221
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
222
+ */
223
+ sort?: Sorting[];
224
+ }
225
+ /** @oneof */
226
+ export interface CursorQueryPagingMethodOneOf {
227
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
228
+ cursorPaging?: CursorPaging;
229
+ }
230
+ export interface Sorting {
231
+ /** Name of the field to sort by. */
232
+ fieldName?: string;
233
+ /** Sort order. */
234
+ order?: SortOrder;
235
+ }
236
+ export declare enum SortOrder {
237
+ ASC = "ASC",
238
+ DESC = "DESC"
239
+ }
240
+ export interface CursorPaging {
241
+ /** Maximum number of items to return in the results. */
242
+ limit?: number | null;
243
+ /**
244
+ * Pointer to the next or previous page in the list of results.
245
+ *
246
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
247
+ * Not relevant for the first request.
248
+ */
249
+ cursor?: string | null;
250
+ }
251
+ export interface QueryShippoConfigurationsResponse {
252
+ /** List of ShippoConfigurations. */
253
+ shippoConfigurations?: ShippoConfiguration[];
254
+ /** Paging metadata. */
255
+ pagingMetadata?: CursorPagingMetadata;
256
+ }
257
+ export interface CursorPagingMetadata {
258
+ /** Number of items returned in the response. */
259
+ count?: number | null;
260
+ /** Cursor strings that point to the next page, previous page, or both. */
261
+ cursors?: Cursors;
262
+ /**
263
+ * Whether there are more pages to retrieve following the current page.
264
+ *
265
+ * + `true`: Another page of results can be retrieved.
266
+ * + `false`: This is the last page.
267
+ */
268
+ hasNext?: boolean | null;
269
+ }
270
+ export interface Cursors {
271
+ /** Cursor string pointing to the next page in the list of results. */
272
+ next?: string | null;
273
+ /** Cursor pointing to the previous page in the list of results. */
274
+ prev?: string | null;
275
+ }
276
+ export interface UpdateExtendedFieldsRequest {
277
+ /** ID of the entity to update. */
278
+ _id: string;
279
+ /** Identifier for the app whose extended fields are being updated. */
280
+ namespace: string;
281
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
282
+ namespaceData: Record<string, any> | null;
283
+ }
284
+ export interface UpdateExtendedFieldsResponse {
285
+ /** Updated ShippoConfiguration. */
286
+ shippoConfiguration?: ShippoConfiguration;
287
+ }
288
+ export interface DomainEvent extends DomainEventBodyOneOf {
289
+ createdEvent?: EntityCreatedEvent;
290
+ updatedEvent?: EntityUpdatedEvent;
291
+ deletedEvent?: EntityDeletedEvent;
292
+ actionEvent?: ActionEvent;
293
+ /**
294
+ * Unique event ID.
295
+ * Allows clients to ignore duplicate webhooks.
296
+ */
297
+ _id?: string;
298
+ /**
299
+ * Assumes actions are also always typed to an entity_type
300
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
301
+ */
302
+ entityFqdn?: string;
303
+ /**
304
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
305
+ * This is although the created/updated/deleted notion is duplication of the oneof types
306
+ * Example: created/updated/deleted/started/completed/email_opened
307
+ */
308
+ slug?: string;
309
+ /** ID of the entity associated with the event. */
310
+ entityId?: string;
311
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
312
+ eventTime?: Date | null;
313
+ /**
314
+ * Whether the event was triggered as a result of a privacy regulation application
315
+ * (for example, GDPR).
316
+ */
317
+ triggeredByAnonymizeRequest?: boolean | null;
318
+ /** If present, indicates the action that triggered the event. */
319
+ originatedFrom?: string | null;
320
+ /**
321
+ * A sequence number defining the order of updates to the underlying entity.
322
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
323
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
324
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
325
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
326
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
327
+ */
328
+ entityEventSequence?: string | null;
329
+ }
330
+ /** @oneof */
331
+ export interface DomainEventBodyOneOf {
332
+ createdEvent?: EntityCreatedEvent;
333
+ updatedEvent?: EntityUpdatedEvent;
334
+ deletedEvent?: EntityDeletedEvent;
335
+ actionEvent?: ActionEvent;
336
+ }
337
+ export interface EntityCreatedEvent {
338
+ entity?: string;
339
+ }
340
+ export interface RestoreInfo {
341
+ deletedDate?: Date | null;
342
+ }
343
+ export interface EntityUpdatedEvent {
344
+ /**
345
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
346
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
347
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
348
+ */
349
+ currentEntity?: string;
350
+ }
351
+ export interface EntityDeletedEvent {
352
+ /** Entity that was deleted */
353
+ deletedEntity?: string | null;
354
+ }
355
+ export interface ActionEvent {
356
+ body?: string;
357
+ }
358
+ export interface Empty {
359
+ }
360
+ export interface MessageEnvelope {
361
+ /** App instance ID. */
362
+ instanceId?: string | null;
363
+ /** Event type. */
364
+ eventType?: string;
365
+ /** The identification type and identity data. */
366
+ identity?: IdentificationData;
367
+ /** Stringify payload. */
368
+ data?: string;
369
+ }
370
+ export interface IdentificationData extends IdentificationDataIdOneOf {
371
+ /** ID of a site visitor that has not logged in to the site. */
372
+ anonymousVisitorId?: string;
373
+ /** ID of a site visitor that has logged in to the site. */
374
+ memberId?: string;
375
+ /** ID of a Wix user (site owner, contributor, etc.). */
376
+ wixUserId?: string;
377
+ /** ID of an app. */
378
+ appId?: string;
379
+ /** @readonly */
380
+ identityType?: WebhookIdentityType;
381
+ }
382
+ /** @oneof */
383
+ export interface IdentificationDataIdOneOf {
384
+ /** ID of a site visitor that has not logged in to the site. */
385
+ anonymousVisitorId?: string;
386
+ /** ID of a site visitor that has logged in to the site. */
387
+ memberId?: string;
388
+ /** ID of a Wix user (site owner, contributor, etc.). */
389
+ wixUserId?: string;
390
+ /** ID of an app. */
391
+ appId?: string;
392
+ }
393
+ export declare enum WebhookIdentityType {
394
+ UNKNOWN = "UNKNOWN",
395
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
396
+ MEMBER = "MEMBER",
397
+ WIX_USER = "WIX_USER",
398
+ APP = "APP"
399
+ }
400
+ interface HandlingFeeNonNullableFields {
401
+ value: string;
402
+ calculationType: CalculationType;
403
+ }
404
+ interface ServiceSettingsNonNullableFields {
405
+ handlingFee?: HandlingFeeNonNullableFields;
406
+ }
407
+ interface DomesticServiceSettingsNonNullableFields {
408
+ service: DomesticService;
409
+ serviceSettings?: ServiceSettingsNonNullableFields;
410
+ }
411
+ interface InternationalServiceSettingsNonNullableFields {
412
+ service: InternationalService;
413
+ serviceSettings?: ServiceSettingsNonNullableFields;
414
+ }
415
+ interface PackageDimensionsNonNullableFields {
416
+ length: string;
417
+ width: string;
418
+ height: string;
419
+ }
420
+ interface PackageDetailsNonNullableFields {
421
+ dimensions?: PackageDimensionsNonNullableFields;
422
+ }
423
+ interface StreetAddressNonNullableFields {
424
+ number: string;
425
+ name: string;
426
+ apt: string;
427
+ }
428
+ interface AddressNonNullableFields {
429
+ streetAddress?: StreetAddressNonNullableFields;
430
+ }
431
+ export interface ShippoConfigurationNonNullableFields {
432
+ domesticServices: DomesticServiceSettingsNonNullableFields[];
433
+ internationalServices: InternationalServiceSettingsNonNullableFields[];
434
+ packageType: PackageType;
435
+ packageDetails?: PackageDetailsNonNullableFields;
436
+ shipFromAddress?: AddressNonNullableFields;
437
+ }
438
+ export interface CreateShippoConfigurationResponseNonNullableFields {
439
+ shippoConfiguration?: ShippoConfigurationNonNullableFields;
440
+ }
441
+ export interface GetShippoConfigurationResponseNonNullableFields {
442
+ shippoConfiguration?: ShippoConfigurationNonNullableFields;
443
+ }
444
+ export interface UpdateShippoConfigurationResponseNonNullableFields {
445
+ shippoConfiguration?: ShippoConfigurationNonNullableFields;
446
+ }
447
+ export interface QueryShippoConfigurationsResponseNonNullableFields {
448
+ shippoConfigurations: ShippoConfigurationNonNullableFields[];
449
+ }
450
+ export interface UpdateExtendedFieldsResponseNonNullableFields {
451
+ shippoConfiguration?: ShippoConfigurationNonNullableFields;
452
+ }
453
+ export interface BaseEventMetadata {
454
+ /** App instance ID. */
455
+ instanceId?: string | null;
456
+ /** Event type. */
457
+ eventType?: string;
458
+ /** The identification type and identity data. */
459
+ identity?: IdentificationData;
460
+ }
461
+ export interface EventMetadata extends BaseEventMetadata {
462
+ /**
463
+ * Unique event ID.
464
+ * Allows clients to ignore duplicate webhooks.
465
+ */
466
+ _id?: string;
467
+ /**
468
+ * Assumes actions are also always typed to an entity_type
469
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
470
+ */
471
+ entityFqdn?: string;
472
+ /**
473
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
474
+ * This is although the created/updated/deleted notion is duplication of the oneof types
475
+ * Example: created/updated/deleted/started/completed/email_opened
476
+ */
477
+ slug?: string;
478
+ /** ID of the entity associated with the event. */
479
+ entityId?: string;
480
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
481
+ eventTime?: Date | null;
482
+ /**
483
+ * Whether the event was triggered as a result of a privacy regulation application
484
+ * (for example, GDPR).
485
+ */
486
+ triggeredByAnonymizeRequest?: boolean | null;
487
+ /** If present, indicates the action that triggered the event. */
488
+ originatedFrom?: string | null;
489
+ /**
490
+ * A sequence number defining the order of updates to the underlying entity.
491
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
492
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
493
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
494
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
495
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
496
+ */
497
+ entityEventSequence?: string | null;
498
+ }
499
+ export interface ShippoConfigurationCreatedEnvelope {
500
+ entity: ShippoConfiguration;
501
+ metadata: EventMetadata;
502
+ }
503
+ /** @webhook
504
+ * @eventType wix.ecom.v1.shippo_configuration_created
505
+ * @documentationMaturity preview
506
+ */
507
+ export declare function onShippoConfigurationCreated(handler: (event: ShippoConfigurationCreatedEnvelope) => void | Promise<void>): void;
508
+ export interface ShippoConfigurationDeletedEnvelope {
509
+ entity: ShippoConfiguration;
510
+ metadata: EventMetadata;
511
+ }
512
+ /** @webhook
513
+ * @eventType wix.ecom.v1.shippo_configuration_deleted
514
+ * @documentationMaturity preview
515
+ */
516
+ export declare function onShippoConfigurationDeleted(handler: (event: ShippoConfigurationDeletedEnvelope) => void | Promise<void>): void;
517
+ export interface ShippoConfigurationUpdatedEnvelope {
518
+ entity: ShippoConfiguration;
519
+ metadata: EventMetadata;
520
+ }
521
+ /** @webhook
522
+ * @eventType wix.ecom.v1.shippo_configuration_updated
523
+ * @documentationMaturity preview
524
+ */
525
+ export declare function onShippoConfigurationUpdated(handler: (event: ShippoConfigurationUpdatedEnvelope) => void | Promise<void>): void;
526
+ /**
527
+ * Creates a ShippoConfiguration.
528
+ * @param shippoConfiguration - ShippoConfiguration to be created.
529
+ * @public
530
+ * @documentationMaturity preview
531
+ * @requiredField shippoConfiguration
532
+ * @requiredField shippoConfiguration.deliveryRegionId
533
+ * @requiredField shippoConfiguration.osLocationId
534
+ * @requiredField shippoConfiguration.packageDetails
535
+ * @requiredField shippoConfiguration.packageDetails.dimensions.height
536
+ * @requiredField shippoConfiguration.packageDetails.dimensions.length
537
+ * @requiredField shippoConfiguration.packageDetails.dimensions.width
538
+ * @requiredField shippoConfiguration.packageType
539
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_CREATE
540
+ * @returns The created ShippoConfiguration.
541
+ * @fqn wix.ecom.delivery.v1.ShippoService.CreateShippoConfiguration
542
+ */
543
+ export declare function createShippoConfiguration(shippoConfiguration: ShippoConfiguration, options?: CreateShippoConfigurationOptions): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
544
+ export interface CreateShippoConfigurationOptions {
545
+ backupRate?: string | null;
546
+ }
547
+ /**
548
+ * Retrieves a ShippoConfiguration.
549
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to retrieve.
550
+ * @public
551
+ * @documentationMaturity preview
552
+ * @requiredField shippoConfigurationId
553
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
554
+ * @returns The requested ShippoConfiguration.
555
+ * @fqn wix.ecom.delivery.v1.ShippoService.GetShippoConfiguration
556
+ */
557
+ export declare function getShippoConfiguration(shippoConfigurationId: string): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
558
+ /**
559
+ * Updates a ShippoConfiguration.
560
+ * @param _id - ShippoConfiguration ID.
561
+ * @public
562
+ * @documentationMaturity preview
563
+ * @requiredField _id
564
+ * @requiredField shippoConfiguration
565
+ * @requiredField shippoConfiguration.revision
566
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
567
+ * @returns Updated ShippoConfiguration.
568
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateShippoConfiguration
569
+ */
570
+ export declare function updateShippoConfiguration(_id: string | null, shippoConfiguration: UpdateShippoConfiguration): Promise<ShippoConfiguration & ShippoConfigurationNonNullableFields>;
571
+ export interface UpdateShippoConfiguration {
572
+ /**
573
+ * ShippoConfiguration ID.
574
+ * @readonly
575
+ */
576
+ _id?: string | null;
577
+ /** @readonly */
578
+ revision?: string | null;
579
+ /**
580
+ * Date and time the ShippoConfiguration was created.
581
+ * @readonly
582
+ */
583
+ _createdDate?: Date | null;
584
+ /**
585
+ * Date and time the ShippoConfiguration was last updated.
586
+ * @readonly
587
+ */
588
+ _updatedDate?: Date | null;
589
+ /** Associated delivery region ID. */
590
+ deliveryRegionId?: string | null;
591
+ /** Settings of USPS domestic services. */
592
+ domesticServices?: DomesticServiceSettings[];
593
+ /** Settings of USPS international services. */
594
+ internationalServices?: InternationalServiceSettings[];
595
+ /** Package type. */
596
+ packageType?: PackageType;
597
+ /** Package details. */
598
+ packageDetails?: PackageDetails;
599
+ /** Location ID from OS location service. */
600
+ osLocationId?: string | null;
601
+ /**
602
+ * Ship from address materialized from OS location.
603
+ * @readonly
604
+ */
605
+ shipFromAddress?: Address;
606
+ /** Backup weight. */
607
+ backupWeight?: string | null;
608
+ /** Data extensions. */
609
+ extendedFields?: ExtendedFields;
610
+ }
611
+ /**
612
+ * Deletes a ShippoConfiguration.
613
+ * @param shippoConfigurationId - ID of the ShippoConfiguration to delete.
614
+ * @public
615
+ * @documentationMaturity preview
616
+ * @requiredField shippoConfigurationId
617
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_DELETE
618
+ * @fqn wix.ecom.delivery.v1.ShippoService.DeleteShippoConfiguration
619
+ */
620
+ export declare function deleteShippoConfiguration(shippoConfigurationId: string): Promise<void>;
621
+ /**
622
+ * Retrieves a list of ShippoConfigurations, given the provided [paging, filtering, and sorting][1].
623
+ *
624
+ * Up to 1,000 ShippoConfigurations can be returned per request.
625
+ *
626
+ * To learn how to query ShippoConfigurations, see [API Query Language][2].
627
+ *
628
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
629
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
630
+ * @public
631
+ * @documentationMaturity preview
632
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_READ
633
+ * @fqn wix.ecom.delivery.v1.ShippoService.QueryShippoConfigurations
634
+ */
635
+ export declare function queryShippoConfigurations(): ShippoConfigurationsQueryBuilder;
636
+ interface QueryCursorResult {
637
+ cursors: Cursors;
638
+ hasNext: () => boolean;
639
+ hasPrev: () => boolean;
640
+ length: number;
641
+ pageSize: number;
642
+ }
643
+ export interface ShippoConfigurationsQueryResult extends QueryCursorResult {
644
+ items: ShippoConfiguration[];
645
+ query: ShippoConfigurationsQueryBuilder;
646
+ next: () => Promise<ShippoConfigurationsQueryResult>;
647
+ prev: () => Promise<ShippoConfigurationsQueryResult>;
648
+ }
649
+ export interface ShippoConfigurationsQueryBuilder {
650
+ /** @param propertyName - Property whose value is compared with `value`.
651
+ * @param value - Value to compare against.
652
+ * @documentationMaturity preview
653
+ */
654
+ eq: (propertyName: '_id' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;
655
+ /** @param propertyName - Property whose value is compared with `value`.
656
+ * @param value - Value to compare against.
657
+ * @documentationMaturity preview
658
+ */
659
+ ne: (propertyName: '_id' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;
660
+ /** @param propertyName - Property whose value is compared with `string`.
661
+ * @param string - String to compare against. Case-insensitive.
662
+ * @documentationMaturity preview
663
+ */
664
+ startsWith: (propertyName: '_id' | 'deliveryRegionId', value: string) => ShippoConfigurationsQueryBuilder;
665
+ /** @param propertyName - Property whose value is compared with `values`.
666
+ * @param values - List of values to compare against.
667
+ * @documentationMaturity preview
668
+ */
669
+ hasSome: (propertyName: '_id' | 'deliveryRegionId', value: any[]) => ShippoConfigurationsQueryBuilder;
670
+ /** @documentationMaturity preview */
671
+ in: (propertyName: '_id' | 'deliveryRegionId', value: any) => ShippoConfigurationsQueryBuilder;
672
+ /** @documentationMaturity preview */
673
+ exists: (propertyName: '_id' | 'deliveryRegionId', value: boolean) => ShippoConfigurationsQueryBuilder;
674
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
675
+ * @documentationMaturity preview
676
+ */
677
+ ascending: (...propertyNames: Array<'_id' | 'deliveryRegionId'>) => ShippoConfigurationsQueryBuilder;
678
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
679
+ * @documentationMaturity preview
680
+ */
681
+ descending: (...propertyNames: Array<'_id' | 'deliveryRegionId'>) => ShippoConfigurationsQueryBuilder;
682
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
683
+ * @documentationMaturity preview
684
+ */
685
+ limit: (limit: number) => ShippoConfigurationsQueryBuilder;
686
+ /** @param cursor - A pointer to specific record
687
+ * @documentationMaturity preview
688
+ */
689
+ skipTo: (cursor: string) => ShippoConfigurationsQueryBuilder;
690
+ /** @documentationMaturity preview */
691
+ find: () => Promise<ShippoConfigurationsQueryResult>;
692
+ }
693
+ /**
694
+ * Updates extended fields of a ShippoConfiguration without incrementing revision
695
+ * @param _id - ID of the entity to update.
696
+ * @param namespace - Identifier for the app whose extended fields are being updated.
697
+ * @public
698
+ * @documentationMaturity preview
699
+ * @requiredField _id
700
+ * @requiredField namespace
701
+ * @requiredField options
702
+ * @requiredField options.namespaceData
703
+ * @permissionId ECOM.SHIPPO_CONFIGURATION_UPDATE
704
+ * @fqn wix.ecom.delivery.v1.ShippoService.UpdateExtendedFields
705
+ */
706
+ export declare function updateExtendedFields(_id: string, namespace: string, options: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse & UpdateExtendedFieldsResponseNonNullableFields>;
707
+ export interface UpdateExtendedFieldsOptions {
708
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
709
+ namespaceData: Record<string, any> | null;
710
+ }
711
+ export {};