@wix/auto_sdk_ecom_delivery-profile 1.0.43 → 1.0.44

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 (134) hide show
  1. package/build/{cjs/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-CQYvMtsF.d.mts} +371 -136
  2. package/build/{internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-CQYvMtsF.d.ts} +371 -136
  3. package/build/index.d.mts +176 -0
  4. package/build/index.d.ts +176 -0
  5. package/build/index.js +1260 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +1213 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → ecom-v1-delivery-profile-delivery-profile.universal-CQYvMtsF.d.mts} +371 -136
  10. package/build/{es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts → internal/ecom-v1-delivery-profile-delivery-profile.universal-CQYvMtsF.d.ts} +371 -136
  11. package/build/internal/index.d.mts +176 -0
  12. package/build/internal/index.d.ts +176 -0
  13. package/build/internal/index.js +1260 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +1213 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +733 -0
  18. package/build/internal/meta.d.ts +733 -0
  19. package/build/internal/meta.js +855 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +813 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +733 -0
  24. package/build/meta.d.ts +733 -0
  25. package/build/meta.js +855 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +813 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
  40. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -31
  41. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
  43. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -567
  44. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
  46. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -344
  47. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
  49. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -111
  50. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -142
  52. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -2011
  54. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -967
  55. package/build/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
  67. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -20
  68. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
  70. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -548
  71. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
  73. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -302
  74. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
  76. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -84
  77. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -139
  79. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -2011
  81. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -925
  82. package/build/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
  93. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -31
  94. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
  96. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -567
  97. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
  99. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -344
  100. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
  102. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -111
  103. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -142
  105. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -2011
  107. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -967
  108. package/build/internal/cjs/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.d.ts +0 -20
  119. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.js +0 -20
  120. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.d.ts +0 -73
  122. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.js +0 -548
  123. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.d.ts +0 -46
  125. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js +0 -302
  126. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.d.ts +0 -159
  128. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.js +0 -84
  129. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.js +0 -139
  131. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.d.ts +0 -2011
  133. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js +0 -925
  134. package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.universal.js.map +0 -1
@@ -0,0 +1,733 @@
1
+ import { O as CreateDeliveryProfileRequest$1, P as CreateDeliveryProfileResponse$1, Q as GetDeliveryProfileRequest$1, T as GetDeliveryProfileResponse$1, V as UpdateDeliveryProfileRequest$1, X as UpdateDeliveryProfileResponse$1, Y as DeleteDeliveryProfileRequest$1, Z as DeleteDeliveryProfileResponse$1, a0 as QueryDeliveryProfilesRequest$1, a5 as QueryDeliveryProfilesResponse$1, a8 as AddDeliveryRegionRequest$1, c as AddDeliveryRegionResponse$1, a9 as UpdateDeliveryRegionRequest$1, g as UpdateDeliveryRegionResponse$1, aa as RemoveDeliveryRegionRequest$1, i as RemoveDeliveryRegionResponse$1, ab as AddDeliveryCarrierRequest$1, k as AddDeliveryCarrierResponse$1, ac as RemoveDeliveryCarrierRequest$1, m as RemoveDeliveryCarrierResponse$1, ad as UpdateDeliveryCarrierRequest$1, o as UpdateDeliveryCarrierResponse$1, ae as ListDeliveryCarrierDetailsRequest$1, L as ListDeliveryCarrierDetailsResponse$1, ag as ListInstalledDeliveryCarriersRequest$1, p as ListInstalledDeliveryCarriersResponse$1, am as ListDeliveryCarriersRequest$1, r as ListDeliveryCarriersResponse$1, av as UpdateCarrierSettingsRequest$1, aw as UpdateCarrierSettingsResponse$1, ax as UpdateExtendedFieldsRequest$1, u as UpdateExtendedFieldsResponse$1 } from './ecom-v1-delivery-profile-delivery-profile.universal-CQYvMtsF.js';
2
+
3
+ /**
4
+ * A DeliveryProfile is a ...
5
+ * You can ...
6
+ * Read more about DeliveryProfiles
7
+ * in this [article](<LINK_TO_KB_ARTICLE>).
8
+ */
9
+ interface DeliveryProfile {
10
+ /**
11
+ * DeliveryProfile ID.
12
+ * @format GUID
13
+ * @readonly
14
+ */
15
+ id?: string | null;
16
+ /**
17
+ * DeliveryProfile name.
18
+ * @minLength 1
19
+ * @maxLength 256
20
+ */
21
+ name?: string | null;
22
+ /**
23
+ * Flags this DeliveryProfile as the default DeliveryProfile.
24
+ * @readonly
25
+ */
26
+ default?: boolean | null;
27
+ /**
28
+ * A list of DeliveryProfile regions.
29
+ * @maxSize 100
30
+ */
31
+ deliveryRegions?: DeliveryRegion[];
32
+ /** ID of the delivery profile's creator. */
33
+ createdBy?: CreatedBy;
34
+ /**
35
+ * DeliveryProfile revision.
36
+ * @readonly
37
+ */
38
+ revision?: string | null;
39
+ /**
40
+ * Date and time the DeliveryProfile was created.
41
+ * @readonly
42
+ */
43
+ createdDate?: Date | null;
44
+ /**
45
+ * Date and time the DeliveryProfile was last updated.
46
+ * @readonly
47
+ */
48
+ updatedDate?: Date | null;
49
+ /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
50
+ extendedFields?: ExtendedFields;
51
+ }
52
+ /** DeliveryRegion can be used to config a Delivery Destinations with its providers */
53
+ interface DeliveryRegion {
54
+ /**
55
+ * The delivery region id.
56
+ * @format GUID
57
+ * @readonly
58
+ */
59
+ id?: string | null;
60
+ /**
61
+ * Optional name of the region, for example: "Domestic".
62
+ * @minLength 1
63
+ * @maxLength 256
64
+ */
65
+ name?: string | null;
66
+ /** Indicates that this rule is active, default value is true. */
67
+ active?: boolean | null;
68
+ /**
69
+ * The spi implementers id of shipping-rates spi, assigned to this rule.
70
+ * @maxSize 25
71
+ * @readonly
72
+ */
73
+ deliveryCarriers?: DeliveryCarrier[];
74
+ /**
75
+ * The operation region of this rule, if empty than it is global.
76
+ * @maxSize 200
77
+ */
78
+ destinations?: Destination[];
79
+ /**
80
+ * Represents the time this Profile was created
81
+ * @readonly
82
+ */
83
+ createdDate?: Date | null;
84
+ }
85
+ interface DeliveryCarrier {
86
+ /**
87
+ * AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api.
88
+ * @format GUID
89
+ */
90
+ appId?: string;
91
+ /** Backup rate to be used in case the cost returned by the provider is empty. */
92
+ backupRate?: BackupRate;
93
+ /**
94
+ * Additional charges to add to the delivery rate for this carrier
95
+ * @maxSize 10
96
+ */
97
+ additionalCharges?: AdditionalCharge[];
98
+ }
99
+ interface BackupRate {
100
+ /**
101
+ * Default rate prefix that will concatenate to the delivery options the provider will offer.
102
+ * @minLength 1
103
+ * @maxLength 256
104
+ * @deprecated Default rate prefix that will concatenate to the delivery options the provider will offer.
105
+ * @replacedBy title
106
+ * @targetRemovalDate 2025-04-01
107
+ */
108
+ prefix?: string | null;
109
+ /**
110
+ * Default rate price for all delivery options that the provider will offer.
111
+ * @decimalValue options { gte:0, maxScale:6 }
112
+ * @deprecated Default rate price for all delivery options that the provider will offer.
113
+ * @replacedBy amount
114
+ * @targetRemovalDate 2025-04-01
115
+ */
116
+ rate?: string | null;
117
+ /**
118
+ * Should the default rate be used. Default value is false.
119
+ * @deprecated Should the default rate be used. Default value is false.
120
+ * @replacedBy active
121
+ * @targetRemovalDate 2025-04-01
122
+ */
123
+ enabled?: boolean | null;
124
+ /**
125
+ * Default rate title that will concatenate to the delivery options the provider will offer.
126
+ * @minLength 1
127
+ * @maxLength 32
128
+ */
129
+ title?: string | null;
130
+ /**
131
+ * Default amount price for all delivery options that the provider will offer.
132
+ * @decimalValue options { gte:0, maxScale:6 }
133
+ */
134
+ amount?: string | null;
135
+ /** Should the default rate be used. Default value is false. */
136
+ active?: boolean;
137
+ }
138
+ interface AdditionalCharge {
139
+ /**
140
+ * Additional charge type.
141
+ * @deprecated Additional charge type.
142
+ * @targetRemovalDate 2025-04-01
143
+ */
144
+ type?: ChargeTypeWithLiterals;
145
+ /**
146
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
147
+ * @maxLength 250
148
+ */
149
+ description?: string | null;
150
+ /**
151
+ * Cost of additional charge. For example, `12.5`.
152
+ * @maxLength 16
153
+ * @deprecated Cost of additional charge. For example, `12.5`.
154
+ * @replacedBy amount
155
+ * @targetRemovalDate 2025-04-01
156
+ */
157
+ price?: string;
158
+ /**
159
+ * Cost of additional charge. For example, `12.5`.
160
+ * @maxLength 16
161
+ */
162
+ amount?: string;
163
+ }
164
+ declare enum ChargeType {
165
+ HANDLING_FEE = "HANDLING_FEE"
166
+ }
167
+ /** @enumType */
168
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE';
169
+ /** Defines the area inside one country that is relevant for this rule. */
170
+ interface Destination {
171
+ /**
172
+ * 2-letters code represents the country of the delivery destinations
173
+ * @format COUNTRY
174
+ */
175
+ countryCode?: string;
176
+ /**
177
+ * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
178
+ * If empty, the rule applies to the entire country.
179
+ * @maxSize 100
180
+ * @minLength 1
181
+ * @maxLength 256
182
+ */
183
+ subdivisions?: string[];
184
+ }
185
+ interface CreatedBy extends CreatedByIdOneOf {
186
+ /**
187
+ * App ID - when the delivery profile was created by an external application or Wix service.
188
+ * @format GUID
189
+ */
190
+ appId?: string | null;
191
+ /**
192
+ * User ID - when the delivery profile was created by a Wix user.
193
+ * @format GUID
194
+ */
195
+ userId?: string | null;
196
+ }
197
+ /** @oneof */
198
+ interface CreatedByIdOneOf {
199
+ /**
200
+ * App ID - when the delivery profile was created by an external application or Wix service.
201
+ * @format GUID
202
+ */
203
+ appId?: string | null;
204
+ /**
205
+ * User ID - when the delivery profile was created by a Wix user.
206
+ * @format GUID
207
+ */
208
+ userId?: string | null;
209
+ }
210
+ interface ExtendedFields {
211
+ /**
212
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
213
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
214
+ *
215
+ * You can only access fields for which you have the appropriate permissions.
216
+ *
217
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
218
+ */
219
+ namespaces?: Record<string, Record<string, any>>;
220
+ }
221
+ interface CreateDeliveryProfileRequest {
222
+ /** DeliveryProfile to be created. */
223
+ deliveryProfile: DeliveryProfile;
224
+ }
225
+ interface CreateDeliveryProfileResponse {
226
+ /** The created DeliveryProfile. */
227
+ deliveryProfile?: DeliveryProfile;
228
+ }
229
+ interface GetDeliveryProfileRequest {
230
+ /**
231
+ * ID of the DeliveryProfile to retrieve.
232
+ * @format GUID
233
+ */
234
+ deliveryProfileId: string;
235
+ }
236
+ interface GetDeliveryProfileResponse {
237
+ /** The requested DeliveryProfile. */
238
+ deliveryProfile?: DeliveryProfile;
239
+ }
240
+ interface UpdateDeliveryProfileRequest {
241
+ /** DeliveryProfile to be updated, may be partial. */
242
+ deliveryProfile: DeliveryProfile;
243
+ }
244
+ interface UpdateDeliveryProfileResponse {
245
+ /** Updated DeliveryProfile. */
246
+ deliveryProfile?: DeliveryProfile;
247
+ }
248
+ interface DeleteDeliveryProfileRequest {
249
+ /**
250
+ * Id of the DeliveryProfile to delete.
251
+ * @format GUID
252
+ */
253
+ deliveryProfileId: string;
254
+ }
255
+ interface DeleteDeliveryProfileResponse {
256
+ }
257
+ interface QueryDeliveryProfilesRequest {
258
+ /** WQL expression. */
259
+ query?: CursorQuery;
260
+ }
261
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
262
+ /** 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`. */
263
+ cursorPaging?: CursorPaging;
264
+ /**
265
+ * Filter object in the following format:
266
+ * `"filter" : {
267
+ * "fieldName1": "value1",
268
+ * "fieldName2":{"$operator":"value2"}
269
+ * }`
270
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
271
+ */
272
+ filter?: Record<string, any> | null;
273
+ /**
274
+ * Sort object in the following format:
275
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
276
+ * @maxSize 5
277
+ */
278
+ sort?: Sorting[];
279
+ }
280
+ /** @oneof */
281
+ interface CursorQueryPagingMethodOneOf {
282
+ /** 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`. */
283
+ cursorPaging?: CursorPaging;
284
+ }
285
+ interface Sorting {
286
+ /**
287
+ * Name of the field to sort by.
288
+ * @maxLength 512
289
+ */
290
+ fieldName?: string;
291
+ /** Sort order. */
292
+ order?: SortOrderWithLiterals;
293
+ }
294
+ declare enum SortOrder {
295
+ ASC = "ASC",
296
+ DESC = "DESC"
297
+ }
298
+ /** @enumType */
299
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
300
+ interface CursorPaging {
301
+ /**
302
+ * Maximum number of items to return in the results.
303
+ * @max 100
304
+ */
305
+ limit?: number | null;
306
+ /**
307
+ * Pointer to the next or previous page in the list of results.
308
+ *
309
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
310
+ * Not relevant for the first request.
311
+ * @maxLength 16000
312
+ */
313
+ cursor?: string | null;
314
+ }
315
+ interface QueryDeliveryProfilesResponse {
316
+ /** List of DeliveryProfiles. */
317
+ deliveryProfiles?: DeliveryProfile[];
318
+ /** Paging metadata */
319
+ pagingMetadata?: CursorPagingMetadata;
320
+ }
321
+ interface CursorPagingMetadata {
322
+ /** Number of items returned in the response. */
323
+ count?: number | null;
324
+ /** Cursor strings that point to the next page, previous page, or both. */
325
+ cursors?: Cursors;
326
+ /**
327
+ * Whether there are more pages to retrieve following the current page.
328
+ *
329
+ * + `true`: Another page of results can be retrieved.
330
+ * + `false`: This is the last page.
331
+ */
332
+ hasNext?: boolean | null;
333
+ }
334
+ interface Cursors {
335
+ /**
336
+ * Cursor string pointing to the next page in the list of results.
337
+ * @maxLength 16000
338
+ */
339
+ next?: string | null;
340
+ /**
341
+ * Cursor pointing to the previous page in the list of results.
342
+ * @maxLength 16000
343
+ */
344
+ prev?: string | null;
345
+ }
346
+ interface AddDeliveryRegionRequest {
347
+ /**
348
+ * delivery profile id to associated with the DeliveryRegion
349
+ * @format GUID
350
+ */
351
+ deliveryProfileId: string;
352
+ /** DeliveryRegion to be created */
353
+ deliveryRegion: DeliveryRegion;
354
+ /**
355
+ * DeliveryProfile revision.
356
+ * @readonly
357
+ */
358
+ revision?: string | null;
359
+ }
360
+ interface AddDeliveryRegionResponse {
361
+ /** The updated DeliveryProfile with the new DeliveryRegion */
362
+ deliveryProfile?: DeliveryProfile;
363
+ }
364
+ interface UpdateDeliveryRegionRequest {
365
+ /**
366
+ * DeliveryProfile id that owns the DeliveryRegion
367
+ * @format GUID
368
+ */
369
+ deliveryProfileId: string;
370
+ /** DeliveryRegion to be updated, may be partial */
371
+ deliveryRegion: DeliveryRegion;
372
+ /**
373
+ * DeliveryProfile revision.
374
+ * @readonly
375
+ */
376
+ revision?: string | null;
377
+ }
378
+ interface UpdateDeliveryRegionResponse {
379
+ /** The updated DeliveryProfile with the updated DeliveryRegion */
380
+ deliveryProfile?: DeliveryProfile;
381
+ }
382
+ interface RemoveDeliveryRegionRequest {
383
+ /**
384
+ * DeliveryProfile id that owns the DeliveryRegion
385
+ * @format GUID
386
+ */
387
+ deliveryProfileId: string;
388
+ /**
389
+ * Id of the DeliveryRegion to delete
390
+ * @format GUID
391
+ */
392
+ deliveryRegionId: string;
393
+ /**
394
+ * DeliveryProfile revision.
395
+ * @readonly
396
+ */
397
+ revision?: string | null;
398
+ }
399
+ interface RemoveDeliveryRegionResponse {
400
+ /** The updated DeliveryProfile without DeliveryRegion */
401
+ deliveryProfile?: DeliveryProfile;
402
+ }
403
+ interface AddDeliveryCarrierRequest {
404
+ /**
405
+ * delivery_region id to associated with the delivery_carrier.
406
+ * @format GUID
407
+ */
408
+ deliveryRegionId: string;
409
+ /** delivery_carrier to be added. */
410
+ deliveryCarrier: DeliveryCarrier;
411
+ }
412
+ interface AddDeliveryCarrierResponse {
413
+ /** The updated DeliveryProfile */
414
+ deliveryProfile?: DeliveryProfile;
415
+ }
416
+ interface RemoveDeliveryCarrierRequest {
417
+ /**
418
+ * Id of the DeliveryRegion
419
+ * @format GUID
420
+ */
421
+ deliveryRegionId: string;
422
+ /**
423
+ * DeliveryCarrier app id to be removed.
424
+ * @format GUID
425
+ */
426
+ appId: string;
427
+ }
428
+ interface RemoveDeliveryCarrierResponse {
429
+ /** The updated DeliveryProfile */
430
+ deliveryProfile?: DeliveryProfile;
431
+ }
432
+ interface UpdateDeliveryCarrierRequest {
433
+ /**
434
+ * DeliveryRegion id
435
+ * @format GUID
436
+ */
437
+ deliveryRegionId: string;
438
+ /** Updated delivery_carrier */
439
+ deliveryCarrier?: DeliveryCarrier;
440
+ }
441
+ interface UpdateDeliveryCarrierResponse {
442
+ /** The updated DeliveryProfile with the updated DeliveryCarrier */
443
+ deliveryProfile?: DeliveryProfile;
444
+ }
445
+ interface ListDeliveryCarrierDetailsRequest {
446
+ }
447
+ interface ListDeliveryCarrierDetailsResponse {
448
+ /**
449
+ * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
450
+ * @maxSize 100
451
+ */
452
+ deliveryCarrierDetails?: DeliveryCarrierDetails[];
453
+ }
454
+ interface DeliveryCarrierDetails {
455
+ /**
456
+ * The id of the provider.
457
+ * @format GUID
458
+ */
459
+ id?: string;
460
+ /**
461
+ * The name of the Provider.
462
+ * @maxLength 256
463
+ */
464
+ displayName?: string;
465
+ /**
466
+ * Provider's description.
467
+ * @maxLength 200
468
+ */
469
+ description?: string | null;
470
+ /**
471
+ * A link to learn more about the provider.
472
+ * @maxLength 200
473
+ */
474
+ learnMoreUrl?: string | null;
475
+ /**
476
+ * Dashboard URL for the provider.
477
+ * @minLength 1
478
+ * @maxLength 2048
479
+ * @format WEB_URL
480
+ */
481
+ dashboardUrl?: string | null;
482
+ /** If the provider fallback definition is mandatory. */
483
+ fallbackDefinitionMandatory?: boolean | null;
484
+ /**
485
+ * Thumbnail image for provider.
486
+ * @format WEB_URL
487
+ */
488
+ thumbnailUrl?: string | null;
489
+ /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
490
+ toggleGetCarrierSettingsEnabled?: boolean;
491
+ /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
492
+ toggleUpdateCarrierActiveStatusEnabled?: boolean;
493
+ }
494
+ interface ListInstalledDeliveryCarriersRequest {
495
+ }
496
+ interface ListInstalledDeliveryCarriersResponse {
497
+ /**
498
+ * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
499
+ * @maxSize 100
500
+ */
501
+ installedDeliveryCarriers?: InstalledDeliveryCarrier[];
502
+ }
503
+ interface InstalledDeliveryCarrier {
504
+ /**
505
+ * The id of the provider.
506
+ * @format GUID
507
+ */
508
+ id?: string;
509
+ /**
510
+ * The name of the Provider.
511
+ * @maxLength 256
512
+ */
513
+ displayName?: string;
514
+ /**
515
+ * Provider's description.
516
+ * @maxLength 200
517
+ */
518
+ description?: string | null;
519
+ /**
520
+ * A link to learn more about the provider.
521
+ * @maxLength 200
522
+ */
523
+ learnMoreUrl?: string | null;
524
+ /**
525
+ * Dashboard URL for the provider.
526
+ * @minLength 1
527
+ * @maxLength 2048
528
+ * @format WEB_URL
529
+ */
530
+ dashboardUrl?: string | null;
531
+ /** If the provider fallback definition is mandatory. */
532
+ fallbackDefinitionMandatory?: boolean | null;
533
+ /**
534
+ * Thumbnail image for provider.
535
+ * @format WEB_URL
536
+ */
537
+ thumbnailUrl?: string | null;
538
+ /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
539
+ toggleGetCarrierSettingsEnabled?: boolean;
540
+ }
541
+ interface ListDeliveryCarriersRequest {
542
+ /**
543
+ * Delivery profile id.
544
+ * @format GUID
545
+ */
546
+ deliveryProfileId: string;
547
+ /**
548
+ * Delivery app ids to get settings for.
549
+ * @format GUID
550
+ * @minSize 1
551
+ * @maxSize 25
552
+ */
553
+ appIds?: string[];
554
+ }
555
+ interface ListDeliveryCarriersResponse {
556
+ /**
557
+ * The list of delivery settings for the given requests
558
+ * @maxSize 100
559
+ */
560
+ results?: ListDeliveryCarriersResult[];
561
+ /** Bulk action metadata. */
562
+ bulkActionMetadata?: BulkActionMetadata;
563
+ }
564
+ interface ListDeliveryCarriersResult {
565
+ /** Information about successful action or error for failure. */
566
+ deliveryCarrierMetadata?: ItemMetadata;
567
+ /** The delivery carrier details */
568
+ deliveryCarrierDetails?: DeliveryCarrierDetails;
569
+ /**
570
+ * The delivery settings for the delivery profile and delivery region.
571
+ * @minSize 1
572
+ * @maxSize 5
573
+ */
574
+ deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
575
+ }
576
+ interface ItemMetadata {
577
+ /**
578
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
579
+ * @format GUID
580
+ */
581
+ id?: string | null;
582
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
583
+ success?: boolean;
584
+ /** Details about the error in case of failure. */
585
+ error?: ApplicationError;
586
+ }
587
+ interface ApplicationError {
588
+ /** Error code. */
589
+ code?: string;
590
+ /** Description of the error. */
591
+ description?: string;
592
+ /** Data related to the error. */
593
+ data?: Record<string, any> | null;
594
+ }
595
+ interface DeliveryCarrierRegionalSettings {
596
+ /**
597
+ * The delivery rule id.
598
+ * @format GUID
599
+ */
600
+ deliveryRegionId?: string;
601
+ /**
602
+ * The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers.
603
+ * @minSize 1
604
+ * @maxSize 5
605
+ */
606
+ dashboardTables?: DashboardTable[];
607
+ }
608
+ interface DashboardTable {
609
+ /**
610
+ * The title of the delivery settings that will be displayed in the UI.
611
+ * @maxLength 256
612
+ */
613
+ title?: string;
614
+ /**
615
+ * The columns of the delivery settings that will be displayed in the UI.
616
+ * @maxSize 200
617
+ */
618
+ columns?: Column[];
619
+ /**
620
+ * The content of the delivery settings. Each row is a map of column name to value.
621
+ * @maxSize 25
622
+ */
623
+ rows?: Row[];
624
+ }
625
+ interface Column {
626
+ /**
627
+ * The name of the column. This is used to get the data from the row.
628
+ * @maxLength 256
629
+ */
630
+ key?: string;
631
+ /**
632
+ * The title of the column that will be displayed in the UI.
633
+ * @maxLength 256
634
+ */
635
+ name?: string;
636
+ }
637
+ interface Row {
638
+ /**
639
+ * The external key of the data presented in a row. This is used to identify the row in the UI for editing.
640
+ * @maxLength 256
641
+ */
642
+ key?: string;
643
+ /**
644
+ * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
645
+ * Data will be in JSON format.
646
+ */
647
+ data?: Record<string, any> | null;
648
+ /** The configuration's status of the current row. */
649
+ active?: boolean;
650
+ }
651
+ interface BulkActionMetadata {
652
+ /** Number of items that were successfully processed. */
653
+ totalSuccesses?: number;
654
+ /** Number of items that couldn't be processed. */
655
+ totalFailures?: number;
656
+ /** Number of failures without details because detailed failure threshold was exceeded. */
657
+ undetailedFailures?: number;
658
+ }
659
+ interface UpdateCarrierSettingsRequest {
660
+ /**
661
+ * Carrier id.
662
+ * @format GUID
663
+ */
664
+ carrierId: string;
665
+ /**
666
+ * Row id triggered the change
667
+ * @format GUID
668
+ */
669
+ rowId: string;
670
+ /** New status */
671
+ active: boolean | null;
672
+ }
673
+ interface UpdateCarrierSettingsResponse {
674
+ }
675
+ interface UpdateExtendedFieldsRequest {
676
+ /** ID of the entity to update. */
677
+ id: string;
678
+ /** Identifier for the app whose extended fields are being updated. */
679
+ namespace: string;
680
+ /** 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. */
681
+ namespaceData: Record<string, any> | null;
682
+ }
683
+ interface UpdateExtendedFieldsResponse {
684
+ /** Updated DeliveryProfile. */
685
+ deliveryProfile?: DeliveryProfile;
686
+ }
687
+
688
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
689
+ getUrl: (context: any) => string;
690
+ httpMethod: K;
691
+ path: string;
692
+ pathParams: M;
693
+ __requestType: T;
694
+ __originalRequestType: S;
695
+ __responseType: Q;
696
+ __originalResponseType: R;
697
+ };
698
+ declare function createDeliveryProfile(): __PublicMethodMetaInfo<'POST', {}, CreateDeliveryProfileRequest$1, CreateDeliveryProfileRequest, CreateDeliveryProfileResponse$1, CreateDeliveryProfileResponse>;
699
+ declare function getDeliveryProfile(): __PublicMethodMetaInfo<'GET', {
700
+ deliveryProfileId: string;
701
+ }, GetDeliveryProfileRequest$1, GetDeliveryProfileRequest, GetDeliveryProfileResponse$1, GetDeliveryProfileResponse>;
702
+ declare function updateDeliveryProfile(): __PublicMethodMetaInfo<'PATCH', {
703
+ deliveryProfileId: string;
704
+ }, UpdateDeliveryProfileRequest$1, UpdateDeliveryProfileRequest, UpdateDeliveryProfileResponse$1, UpdateDeliveryProfileResponse>;
705
+ declare function deleteDeliveryProfile(): __PublicMethodMetaInfo<'DELETE', {
706
+ deliveryProfileId: string;
707
+ }, DeleteDeliveryProfileRequest$1, DeleteDeliveryProfileRequest, DeleteDeliveryProfileResponse$1, DeleteDeliveryProfileResponse>;
708
+ declare function queryDeliveryProfiles(): __PublicMethodMetaInfo<'GET', {}, QueryDeliveryProfilesRequest$1, QueryDeliveryProfilesRequest, QueryDeliveryProfilesResponse$1, QueryDeliveryProfilesResponse>;
709
+ declare function addDeliveryRegion(): __PublicMethodMetaInfo<'POST', {
710
+ deliveryProfileId: string;
711
+ }, AddDeliveryRegionRequest$1, AddDeliveryRegionRequest, AddDeliveryRegionResponse$1, AddDeliveryRegionResponse>;
712
+ declare function updateDeliveryRegion(): __PublicMethodMetaInfo<'PATCH', {
713
+ deliveryProfileId: string;
714
+ deliveryRegionId: string;
715
+ }, UpdateDeliveryRegionRequest$1, UpdateDeliveryRegionRequest, UpdateDeliveryRegionResponse$1, UpdateDeliveryRegionResponse>;
716
+ declare function removeDeliveryRegion(): __PublicMethodMetaInfo<'DELETE', {
717
+ deliveryProfileId: string;
718
+ deliveryRegionId: string;
719
+ }, RemoveDeliveryRegionRequest$1, RemoveDeliveryRegionRequest, RemoveDeliveryRegionResponse$1, RemoveDeliveryRegionResponse>;
720
+ declare function addDeliveryCarrier(): __PublicMethodMetaInfo<'POST', {}, AddDeliveryCarrierRequest$1, AddDeliveryCarrierRequest, AddDeliveryCarrierResponse$1, AddDeliveryCarrierResponse>;
721
+ declare function removeDeliveryCarrier(): __PublicMethodMetaInfo<'POST', {}, RemoveDeliveryCarrierRequest$1, RemoveDeliveryCarrierRequest, RemoveDeliveryCarrierResponse$1, RemoveDeliveryCarrierResponse>;
722
+ declare function updateDeliveryCarrier(): __PublicMethodMetaInfo<'PATCH', {}, UpdateDeliveryCarrierRequest$1, UpdateDeliveryCarrierRequest, UpdateDeliveryCarrierResponse$1, UpdateDeliveryCarrierResponse>;
723
+ declare function listDeliveryCarrierDetails(): __PublicMethodMetaInfo<'GET', {}, ListDeliveryCarrierDetailsRequest$1, ListDeliveryCarrierDetailsRequest, ListDeliveryCarrierDetailsResponse$1, ListDeliveryCarrierDetailsResponse>;
724
+ declare function listInstalledDeliveryCarriers(): __PublicMethodMetaInfo<'GET', {}, ListInstalledDeliveryCarriersRequest$1, ListInstalledDeliveryCarriersRequest, ListInstalledDeliveryCarriersResponse$1, ListInstalledDeliveryCarriersResponse>;
725
+ declare function listDeliveryCarriers(): __PublicMethodMetaInfo<'POST', {
726
+ deliveryProfileId: string;
727
+ }, ListDeliveryCarriersRequest$1, ListDeliveryCarriersRequest, ListDeliveryCarriersResponse$1, ListDeliveryCarriersResponse>;
728
+ declare function updateCarrierSettings(): __PublicMethodMetaInfo<'POST', {}, UpdateCarrierSettingsRequest$1, UpdateCarrierSettingsRequest, UpdateCarrierSettingsResponse$1, UpdateCarrierSettingsResponse>;
729
+ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
730
+ id: string;
731
+ }, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>;
732
+
733
+ export { type __PublicMethodMetaInfo, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryProfile, listDeliveryCarrierDetails, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };