@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
@@ -1,2011 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * A DeliveryProfile is a ...
4
- * You can ...
5
- * Read more about DeliveryProfiles
6
- * in this [article](<LINK_TO_KB_ARTICLE>).
7
- */
8
- export interface DeliveryProfile {
9
- /**
10
- * DeliveryProfile ID.
11
- * @format GUID
12
- * @readonly
13
- */
14
- _id?: string | null;
15
- /**
16
- * DeliveryProfile name.
17
- * @minLength 1
18
- * @maxLength 256
19
- */
20
- name?: string | null;
21
- /**
22
- * Flags this DeliveryProfile as the default DeliveryProfile.
23
- * @readonly
24
- */
25
- default?: boolean | null;
26
- /**
27
- * A list of DeliveryProfile regions.
28
- * @maxSize 100
29
- */
30
- deliveryRegions?: DeliveryRegion[];
31
- /** ID of the delivery profile's creator. */
32
- createdBy?: CreatedBy;
33
- /**
34
- * DeliveryProfile revision.
35
- * @readonly
36
- */
37
- revision?: string | null;
38
- /**
39
- * Date and time the DeliveryProfile was created.
40
- * @readonly
41
- */
42
- _createdDate?: Date | null;
43
- /**
44
- * Date and time the DeliveryProfile was last updated.
45
- * @readonly
46
- */
47
- _updatedDate?: Date | null;
48
- /** [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. */
49
- extendedFields?: ExtendedFields;
50
- }
51
- /** DeliveryRegion can be used to config a Delivery Destinations with its providers */
52
- export interface DeliveryRegion {
53
- /**
54
- * The delivery region id.
55
- * @format GUID
56
- * @readonly
57
- */
58
- _id?: string | null;
59
- /**
60
- * Optional name of the region, for example: "Domestic".
61
- * @minLength 1
62
- * @maxLength 256
63
- */
64
- name?: string | null;
65
- /** Indicates that this rule is active, default value is true. */
66
- active?: boolean | null;
67
- /**
68
- * The spi implementers id of shipping-rates spi, assigned to this rule.
69
- * @maxSize 25
70
- * @readonly
71
- */
72
- deliveryCarriers?: DeliveryCarrier[];
73
- /**
74
- * The operation region of this rule, if empty than it is global.
75
- * @maxSize 200
76
- */
77
- destinations?: Destination[];
78
- /**
79
- * Represents the time this Profile was created
80
- * @readonly
81
- */
82
- _createdDate?: Date | null;
83
- }
84
- export interface DeliveryCarrier {
85
- /**
86
- * 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.
87
- * @format GUID
88
- */
89
- appId?: string;
90
- /** Backup rate to be used in case the cost returned by the provider is empty. */
91
- backupRate?: BackupRate;
92
- /**
93
- * Additional charges to add to the delivery rate for this carrier
94
- * @maxSize 10
95
- */
96
- additionalCharges?: AdditionalCharge[];
97
- }
98
- export interface BackupRate {
99
- /**
100
- * Default rate prefix that will concatenate to the delivery options the provider will offer.
101
- * @minLength 1
102
- * @maxLength 256
103
- * @deprecated Default rate prefix that will concatenate to the delivery options the provider will offer.
104
- * @replacedBy title
105
- * @targetRemovalDate 2025-04-01
106
- */
107
- prefix?: string | null;
108
- /**
109
- * Default rate price for all delivery options that the provider will offer.
110
- * @decimalValue options { gte:0, maxScale:6 }
111
- * @deprecated Default rate price for all delivery options that the provider will offer.
112
- * @replacedBy amount
113
- * @targetRemovalDate 2025-04-01
114
- */
115
- rate?: string | null;
116
- /**
117
- * Should the default rate be used. Default value is false.
118
- * @deprecated Should the default rate be used. Default value is false.
119
- * @replacedBy active
120
- * @targetRemovalDate 2025-04-01
121
- */
122
- enabled?: boolean | null;
123
- /**
124
- * Default rate title that will concatenate to the delivery options the provider will offer.
125
- * @minLength 1
126
- * @maxLength 32
127
- */
128
- title?: string | null;
129
- /**
130
- * Default amount price for all delivery options that the provider will offer.
131
- * @decimalValue options { gte:0, maxScale:6 }
132
- */
133
- amount?: string | null;
134
- /** Should the default rate be used. Default value is false. */
135
- active?: boolean;
136
- }
137
- export interface AdditionalCharge {
138
- /**
139
- * Additional charge type.
140
- * @deprecated Additional charge type.
141
- * @targetRemovalDate 2025-04-01
142
- */
143
- type?: ChargeTypeWithLiterals;
144
- /**
145
- * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
146
- * @maxLength 250
147
- */
148
- description?: string | null;
149
- /**
150
- * Cost of additional charge. For example, `12.5`.
151
- * @maxLength 16
152
- * @deprecated Cost of additional charge. For example, `12.5`.
153
- * @replacedBy amount
154
- * @targetRemovalDate 2025-04-01
155
- */
156
- price?: string;
157
- /**
158
- * Cost of additional charge. For example, `12.5`.
159
- * @maxLength 16
160
- */
161
- amount?: string;
162
- }
163
- export declare enum ChargeType {
164
- HANDLING_FEE = "HANDLING_FEE"
165
- }
166
- /** @enumType */
167
- export type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE';
168
- /** Defines the area inside one country that is relevant for this rule. */
169
- export interface Destination {
170
- /**
171
- * 2-letters code represents the country of the delivery destinations
172
- * @format COUNTRY
173
- */
174
- countryCode?: string;
175
- /**
176
- * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
177
- * If empty, the rule applies to the entire country.
178
- * @maxSize 100
179
- * @minLength 1
180
- * @maxLength 256
181
- */
182
- subdivisions?: string[];
183
- }
184
- export interface CreatedBy extends CreatedByIdOneOf {
185
- /**
186
- * App ID - when the delivery profile was created by an external application or Wix service.
187
- * @format GUID
188
- */
189
- appId?: string | null;
190
- /**
191
- * User ID - when the delivery profile was created by a Wix user.
192
- * @format GUID
193
- */
194
- userId?: string | null;
195
- }
196
- /** @oneof */
197
- export interface CreatedByIdOneOf {
198
- /**
199
- * App ID - when the delivery profile was created by an external application or Wix service.
200
- * @format GUID
201
- */
202
- appId?: string | null;
203
- /**
204
- * User ID - when the delivery profile was created by a Wix user.
205
- * @format GUID
206
- */
207
- userId?: string | null;
208
- }
209
- export interface ExtendedFields {
210
- /**
211
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
212
- * The value of each key is structured according to the schema defined when the extended fields were configured.
213
- *
214
- * You can only access fields for which you have the appropriate permissions.
215
- *
216
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
217
- */
218
- namespaces?: Record<string, Record<string, any>>;
219
- }
220
- export interface DeliveryRegionAdded {
221
- /**
222
- * The DeliveryProfile owns this region.
223
- * @format GUID
224
- */
225
- deliveryProfileId?: string;
226
- /**
227
- * The delivery region id.
228
- * @format GUID
229
- * @readonly
230
- */
231
- deliveryRegionId?: string | null;
232
- /**
233
- * Optional name of the rule, for example: "Domestic".
234
- * @minLength 1
235
- * @maxLength 256
236
- */
237
- name?: string | null;
238
- /** Indicates that this rule is active, default value is true. */
239
- active?: boolean | null;
240
- /**
241
- * The spi implementers id of shipping-rates spi, assigned to this rule.
242
- * @maxSize 25
243
- * @readonly
244
- */
245
- deliveryCarriers?: DeliveryCarrier[];
246
- /**
247
- * The operation region of this rule, if empty than it is global.
248
- * @maxSize 200
249
- */
250
- destinations?: Destination[];
251
- /**
252
- * Represents the time this Profile was created
253
- * @readonly
254
- */
255
- _createdDate?: Date | null;
256
- }
257
- export interface DeliveryRegionRemoved {
258
- /**
259
- * The DeliveryProfile owns this region.
260
- * @format GUID
261
- */
262
- deliveryProfileId?: string;
263
- /** The removed DeliveryRegion id. */
264
- deliveryRegionId?: string;
265
- }
266
- export interface DeliveryRegionUpdated {
267
- /**
268
- * The DeliveryProfile owns this DeliveryRegion.
269
- * @format GUID
270
- */
271
- deliveryProfileId?: string;
272
- /**
273
- * The delivery region id.
274
- * @format GUID
275
- * @readonly
276
- */
277
- deliveryRegionId?: string | null;
278
- /**
279
- * Optional name of the rule, for example: "Domestic".
280
- * @minLength 1
281
- * @maxLength 256
282
- */
283
- name?: string | null;
284
- /** Indicates that this rule is active, default value is true. */
285
- active?: boolean | null;
286
- /**
287
- * The spi implementers id of shipping-rates spi, assigned to this rule.
288
- * @maxSize 25
289
- * @readonly
290
- */
291
- deliveryCarriers?: DeliveryCarrier[];
292
- /**
293
- * The operation region of this rule, if empty than it is global.
294
- * @maxSize 200
295
- */
296
- destinations?: Destination[];
297
- /**
298
- * Represents the time this Profile was created
299
- * @readonly
300
- */
301
- _createdDate?: Date | null;
302
- }
303
- export interface CreateDeliveryProfileRequest {
304
- /** DeliveryProfile to be created. */
305
- deliveryProfile: DeliveryProfile;
306
- }
307
- export interface CreateDeliveryProfileResponse {
308
- /** The created DeliveryProfile. */
309
- deliveryProfile?: DeliveryProfile;
310
- }
311
- export interface GetDeliveryProfileRequest {
312
- /**
313
- * ID of the DeliveryProfile to retrieve.
314
- * @format GUID
315
- */
316
- deliveryProfileId: string;
317
- }
318
- export interface GetDeliveryProfileResponse {
319
- /** The requested DeliveryProfile. */
320
- deliveryProfile?: DeliveryProfile;
321
- }
322
- export interface UpdateDeliveryProfileRequest {
323
- /** DeliveryProfile to be updated, may be partial. */
324
- deliveryProfile: DeliveryProfile;
325
- }
326
- export interface UpdateDeliveryProfileResponse {
327
- /** Updated DeliveryProfile. */
328
- deliveryProfile?: DeliveryProfile;
329
- }
330
- export interface DeleteDeliveryProfileRequest {
331
- /**
332
- * Id of the DeliveryProfile to delete.
333
- * @format GUID
334
- */
335
- deliveryProfileId: string;
336
- }
337
- export interface DeleteDeliveryProfileResponse {
338
- }
339
- export interface DeleteDefaultDeliveryProfileRequest {
340
- /**
341
- * Id of the DeliveryProfile to delete.
342
- * @format GUID
343
- */
344
- deliveryProfileId?: string;
345
- }
346
- export interface DeleteDefaultDeliveryProfileResponse {
347
- }
348
- export interface QueryDeliveryProfilesRequest {
349
- /** WQL expression. */
350
- query?: CursorQuery;
351
- }
352
- export interface CursorQuery extends CursorQueryPagingMethodOneOf {
353
- /** 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`. */
354
- cursorPaging?: CursorPaging;
355
- /**
356
- * Filter object in the following format:
357
- * `"filter" : {
358
- * "fieldName1": "value1",
359
- * "fieldName2":{"$operator":"value2"}
360
- * }`
361
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
362
- */
363
- filter?: Record<string, any> | null;
364
- /**
365
- * Sort object in the following format:
366
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
367
- * @maxSize 5
368
- */
369
- sort?: Sorting[];
370
- }
371
- /** @oneof */
372
- export interface CursorQueryPagingMethodOneOf {
373
- /** 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`. */
374
- cursorPaging?: CursorPaging;
375
- }
376
- export interface Sorting {
377
- /**
378
- * Name of the field to sort by.
379
- * @maxLength 512
380
- */
381
- fieldName?: string;
382
- /** Sort order. */
383
- order?: SortOrderWithLiterals;
384
- }
385
- export declare enum SortOrder {
386
- ASC = "ASC",
387
- DESC = "DESC"
388
- }
389
- /** @enumType */
390
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
391
- export interface CursorPaging {
392
- /**
393
- * Maximum number of items to return in the results.
394
- * @max 100
395
- */
396
- limit?: number | null;
397
- /**
398
- * Pointer to the next or previous page in the list of results.
399
- *
400
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
401
- * Not relevant for the first request.
402
- * @maxLength 16000
403
- */
404
- cursor?: string | null;
405
- }
406
- export interface QueryDeliveryProfilesResponse {
407
- /** List of DeliveryProfiles. */
408
- deliveryProfiles?: DeliveryProfile[];
409
- /** Paging metadata */
410
- pagingMetadata?: CursorPagingMetadata;
411
- }
412
- export interface CursorPagingMetadata {
413
- /** Number of items returned in the response. */
414
- count?: number | null;
415
- /** Cursor strings that point to the next page, previous page, or both. */
416
- cursors?: Cursors;
417
- /**
418
- * Whether there are more pages to retrieve following the current page.
419
- *
420
- * + `true`: Another page of results can be retrieved.
421
- * + `false`: This is the last page.
422
- */
423
- hasNext?: boolean | null;
424
- }
425
- export interface Cursors {
426
- /**
427
- * Cursor string pointing to the next page in the list of results.
428
- * @maxLength 16000
429
- */
430
- next?: string | null;
431
- /**
432
- * Cursor pointing to the previous page in the list of results.
433
- * @maxLength 16000
434
- */
435
- prev?: string | null;
436
- }
437
- export interface AddDeliveryRegionRequest {
438
- /**
439
- * delivery profile id to associated with the DeliveryRegion
440
- * @format GUID
441
- */
442
- deliveryProfileId: string;
443
- /** DeliveryRegion to be created */
444
- deliveryRegion: DeliveryRegion;
445
- /**
446
- * DeliveryProfile revision.
447
- * @readonly
448
- */
449
- revision?: string | null;
450
- }
451
- export interface AddDeliveryRegionResponse {
452
- /** The updated DeliveryProfile with the new DeliveryRegion */
453
- deliveryProfile?: DeliveryProfile;
454
- }
455
- export interface UpdateDeliveryRegionRequest {
456
- /**
457
- * DeliveryProfile id that owns the DeliveryRegion
458
- * @format GUID
459
- */
460
- deliveryProfileId: string;
461
- /** DeliveryRegion to be updated, may be partial */
462
- deliveryRegion: DeliveryRegion;
463
- /**
464
- * DeliveryProfile revision.
465
- * @readonly
466
- */
467
- revision?: string | null;
468
- }
469
- export interface UpdateDeliveryRegionResponse {
470
- /** The updated DeliveryProfile with the updated DeliveryRegion */
471
- deliveryProfile?: DeliveryProfile;
472
- }
473
- export interface RemoveDeliveryRegionRequest {
474
- /**
475
- * DeliveryProfile id that owns the DeliveryRegion
476
- * @format GUID
477
- */
478
- deliveryProfileId: string;
479
- /**
480
- * Id of the DeliveryRegion to delete
481
- * @format GUID
482
- */
483
- deliveryRegionId: string;
484
- /**
485
- * DeliveryProfile revision.
486
- * @readonly
487
- */
488
- revision?: string | null;
489
- }
490
- export interface RemoveDeliveryRegionResponse {
491
- /** The updated DeliveryProfile without DeliveryRegion */
492
- deliveryProfile?: DeliveryProfile;
493
- }
494
- export interface AddDeliveryCarrierRequest {
495
- /**
496
- * delivery_region id to associated with the delivery_carrier.
497
- * @format GUID
498
- */
499
- deliveryRegionId: string;
500
- /** delivery_carrier to be added. */
501
- deliveryCarrier: DeliveryCarrier;
502
- }
503
- export interface AddDeliveryCarrierResponse {
504
- /** The updated DeliveryProfile */
505
- deliveryProfile?: DeliveryProfile;
506
- }
507
- export interface RemoveDeliveryCarrierRequest {
508
- /**
509
- * Id of the DeliveryRegion
510
- * @format GUID
511
- */
512
- deliveryRegionId: string;
513
- /**
514
- * DeliveryCarrier app id to be removed.
515
- * @format GUID
516
- */
517
- appId: string;
518
- }
519
- export interface RemoveDeliveryCarrierResponse {
520
- /** The updated DeliveryProfile */
521
- deliveryProfile?: DeliveryProfile;
522
- }
523
- export interface UpdateDeliveryCarrierRequest {
524
- /**
525
- * DeliveryRegion id
526
- * @format GUID
527
- */
528
- deliveryRegionId: string;
529
- /** Updated delivery_carrier */
530
- deliveryCarrier?: DeliveryCarrier;
531
- }
532
- export interface UpdateDeliveryCarrierResponse {
533
- /** The updated DeliveryProfile with the updated DeliveryCarrier */
534
- deliveryProfile?: DeliveryProfile;
535
- }
536
- export interface ListDeliveryCarrierDetailsRequest {
537
- }
538
- export interface ListDeliveryCarrierDetailsResponse {
539
- /**
540
- * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
541
- * @maxSize 100
542
- */
543
- deliveryCarrierDetails?: DeliveryCarrierDetails[];
544
- }
545
- export interface DeliveryCarrierDetails {
546
- /**
547
- * The id of the provider.
548
- * @format GUID
549
- */
550
- _id?: string;
551
- /**
552
- * The name of the Provider.
553
- * @maxLength 256
554
- */
555
- displayName?: string;
556
- /**
557
- * Provider's description.
558
- * @maxLength 200
559
- */
560
- description?: string | null;
561
- /**
562
- * A link to learn more about the provider.
563
- * @maxLength 200
564
- */
565
- learnMoreUrl?: string | null;
566
- /**
567
- * Dashboard URL for the provider.
568
- * @minLength 1
569
- * @maxLength 2048
570
- * @format WEB_URL
571
- */
572
- dashboardUrl?: string | null;
573
- /** If the provider fallback definition is mandatory. */
574
- fallbackDefinitionMandatory?: boolean | null;
575
- /**
576
- * Thumbnail image for provider.
577
- * @format WEB_URL
578
- */
579
- thumbnailUrl?: string | null;
580
- /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
581
- toggleGetCarrierSettingsEnabled?: boolean;
582
- /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
583
- toggleUpdateCarrierActiveStatusEnabled?: boolean;
584
- }
585
- export interface ListInstalledDeliveryCarriersRequest {
586
- }
587
- export interface ListInstalledDeliveryCarriersResponse {
588
- /**
589
- * The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site)
590
- * @maxSize 100
591
- */
592
- installedDeliveryCarriers?: InstalledDeliveryCarrier[];
593
- }
594
- export interface InstalledDeliveryCarrier {
595
- /**
596
- * The id of the provider.
597
- * @format GUID
598
- */
599
- _id?: string;
600
- /**
601
- * The name of the Provider.
602
- * @maxLength 256
603
- */
604
- displayName?: string;
605
- /**
606
- * Provider's description.
607
- * @maxLength 200
608
- */
609
- description?: string | null;
610
- /**
611
- * A link to learn more about the provider.
612
- * @maxLength 200
613
- */
614
- learnMoreUrl?: string | null;
615
- /**
616
- * Dashboard URL for the provider.
617
- * @minLength 1
618
- * @maxLength 2048
619
- * @format WEB_URL
620
- */
621
- dashboardUrl?: string | null;
622
- /** If the provider fallback definition is mandatory. */
623
- fallbackDefinitionMandatory?: boolean | null;
624
- /**
625
- * Thumbnail image for provider.
626
- * @format WEB_URL
627
- */
628
- thumbnailUrl?: string | null;
629
- /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
630
- toggleGetCarrierSettingsEnabled?: boolean;
631
- }
632
- export interface ListDeliveryDestinationsRequest {
633
- }
634
- export interface ListDeliveryDestinationsResponse {
635
- /** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
636
- destinationScope?: DestinationScopeWithLiterals;
637
- /**
638
- * The list of destinations
639
- * @maxSize 200
640
- */
641
- destinations?: Destination[];
642
- }
643
- export declare enum DestinationScope {
644
- /** No additional destinations are requested */
645
- SPECIFIC_DESTINATIONS = "SPECIFIC_DESTINATIONS",
646
- /** All Destinations */
647
- WORLDWIDE = "WORLDWIDE"
648
- }
649
- /** @enumType */
650
- export type DestinationScopeWithLiterals = DestinationScope | 'SPECIFIC_DESTINATIONS' | 'WORLDWIDE';
651
- export interface RequiredZipcodeRequest {
652
- }
653
- export interface RequiredZipcodeResponse {
654
- /** If the site requires a zipcode for delivery */
655
- requiredZipcode?: boolean;
656
- }
657
- export interface ListDeliveryCarriersRequest {
658
- /**
659
- * Delivery profile id.
660
- * @format GUID
661
- */
662
- deliveryProfileId: string;
663
- /**
664
- * Delivery app ids to get settings for.
665
- * @format GUID
666
- * @minSize 1
667
- * @maxSize 25
668
- */
669
- appIds?: string[];
670
- }
671
- export interface ListDeliveryCarriersResponse {
672
- /**
673
- * The list of delivery settings for the given requests
674
- * @maxSize 100
675
- */
676
- results?: ListDeliveryCarriersResult[];
677
- /** Bulk action metadata. */
678
- bulkActionMetadata?: BulkActionMetadata;
679
- }
680
- export interface ListDeliveryCarriersResult {
681
- /** Information about successful action or error for failure. */
682
- deliveryCarrierMetadata?: ItemMetadata;
683
- /** The delivery carrier details */
684
- deliveryCarrierDetails?: DeliveryCarrierDetails;
685
- /**
686
- * The delivery settings for the delivery profile and delivery region.
687
- * @minSize 1
688
- * @maxSize 5
689
- */
690
- deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
691
- }
692
- export interface ItemMetadata {
693
- /**
694
- * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
695
- * @format GUID
696
- */
697
- _id?: string | null;
698
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
699
- success?: boolean;
700
- /** Details about the error in case of failure. */
701
- error?: ApplicationError;
702
- }
703
- export interface ApplicationError {
704
- /** Error code. */
705
- code?: string;
706
- /** Description of the error. */
707
- description?: string;
708
- /** Data related to the error. */
709
- data?: Record<string, any> | null;
710
- }
711
- export interface DeliveryCarrierRegionalSettings {
712
- /**
713
- * The delivery rule id.
714
- * @format GUID
715
- */
716
- deliveryRegionId?: string;
717
- /**
718
- * The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers.
719
- * @minSize 1
720
- * @maxSize 5
721
- */
722
- dashboardTables?: DashboardTable[];
723
- }
724
- export interface DashboardTable {
725
- /**
726
- * The title of the delivery settings that will be displayed in the UI.
727
- * @maxLength 256
728
- */
729
- title?: string;
730
- /**
731
- * The columns of the delivery settings that will be displayed in the UI.
732
- * @maxSize 200
733
- */
734
- columns?: Column[];
735
- /**
736
- * The content of the delivery settings. Each row is a map of column name to value.
737
- * @maxSize 25
738
- */
739
- rows?: Row[];
740
- }
741
- export interface Column {
742
- /**
743
- * The name of the column. This is used to get the data from the row.
744
- * @maxLength 256
745
- */
746
- key?: string;
747
- /**
748
- * The title of the column that will be displayed in the UI.
749
- * @maxLength 256
750
- */
751
- name?: string;
752
- }
753
- export interface Row {
754
- /**
755
- * The external key of the data presented in a row. This is used to identify the row in the UI for editing.
756
- * @maxLength 256
757
- */
758
- key?: string;
759
- /**
760
- * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
761
- * Data will be in JSON format.
762
- */
763
- data?: Record<string, any> | null;
764
- /** The configuration's status of the current row. */
765
- active?: boolean;
766
- }
767
- export interface BulkActionMetadata {
768
- /** Number of items that were successfully processed. */
769
- totalSuccesses?: number;
770
- /** Number of items that couldn't be processed. */
771
- totalFailures?: number;
772
- /** Number of failures without details because detailed failure threshold was exceeded. */
773
- undetailedFailures?: number;
774
- }
775
- export interface UpdateCarrierSettingsRequest {
776
- /**
777
- * Carrier id.
778
- * @format GUID
779
- */
780
- carrierId: string;
781
- /**
782
- * Row id triggered the change
783
- * @format GUID
784
- */
785
- rowId: string;
786
- /** New status */
787
- active: boolean | null;
788
- }
789
- export interface UpdateCarrierSettingsResponse {
790
- }
791
- export interface UpdateExtendedFieldsRequest {
792
- /** ID of the entity to update. */
793
- _id: string;
794
- /** Identifier for the app whose extended fields are being updated. */
795
- namespace: string;
796
- /** 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. */
797
- namespaceData: Record<string, any> | null;
798
- }
799
- export interface UpdateExtendedFieldsResponse {
800
- /** Updated DeliveryProfile. */
801
- deliveryProfile?: DeliveryProfile;
802
- }
803
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
804
- /** Emitted on a meta site creation. */
805
- siteCreated?: SiteCreated;
806
- /** Emitted on a meta site transfer completion. */
807
- siteTransferred?: SiteTransferred;
808
- /** Emitted on a meta site deletion. */
809
- siteDeleted?: SiteDeleted;
810
- /** Emitted on a meta site restoration. */
811
- siteUndeleted?: SiteUndeleted;
812
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
813
- sitePublished?: SitePublished;
814
- /** Emitted on a meta site unpublish. */
815
- siteUnpublished?: SiteUnpublished;
816
- /** Emitted when meta site is marked as template. */
817
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
818
- /** Emitted when meta site is marked as a WixSite. */
819
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
820
- /** Emitted when an application is provisioned (installed). */
821
- serviceProvisioned?: ServiceProvisioned;
822
- /** Emitted when an application is removed (uninstalled). */
823
- serviceRemoved?: ServiceRemoved;
824
- /** Emitted when meta site name (URL slug) is changed. */
825
- siteRenamedPayload?: SiteRenamed;
826
- /** Emitted when meta site was permanently deleted. */
827
- hardDeleted?: SiteHardDeleted;
828
- /** Emitted on a namespace change. */
829
- namespaceChanged?: NamespaceChanged;
830
- /** Emitted when Studio is attached. */
831
- studioAssigned?: StudioAssigned;
832
- /** Emitted when Studio is detached. */
833
- studioUnassigned?: StudioUnassigned;
834
- /**
835
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
836
- * the actual URL.
837
- *
838
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
839
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
840
- */
841
- urlChanged?: SiteUrlChanged;
842
- /** Site is marked as PurgedExternally */
843
- sitePurgedExternally?: SitePurgedExternally;
844
- /** Emitted when Odeditor is attached. */
845
- odeditorAssigned?: OdeditorAssigned;
846
- /** Emitted when Odeditor is detached. */
847
- odeditorUnassigned?: OdeditorUnassigned;
848
- /** Emitted when Picasso is attached. */
849
- picassoAssigned?: PicassoAssigned;
850
- /** Emitted when Picasso is detached. */
851
- picassoUnassigned?: PicassoUnassigned;
852
- /**
853
- * A meta site id.
854
- * @format GUID
855
- */
856
- metaSiteId?: string;
857
- /** A meta site version. Monotonically increasing. */
858
- version?: string;
859
- /** A timestamp of the event. */
860
- timestamp?: string;
861
- /**
862
- * TODO(meta-site): Change validation once validations are disabled for consumers
863
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
864
- * @maxSize 4000
865
- */
866
- assets?: Asset[];
867
- }
868
- /** @oneof */
869
- export interface MetaSiteSpecialEventPayloadOneOf {
870
- /** Emitted on a meta site creation. */
871
- siteCreated?: SiteCreated;
872
- /** Emitted on a meta site transfer completion. */
873
- siteTransferred?: SiteTransferred;
874
- /** Emitted on a meta site deletion. */
875
- siteDeleted?: SiteDeleted;
876
- /** Emitted on a meta site restoration. */
877
- siteUndeleted?: SiteUndeleted;
878
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
879
- sitePublished?: SitePublished;
880
- /** Emitted on a meta site unpublish. */
881
- siteUnpublished?: SiteUnpublished;
882
- /** Emitted when meta site is marked as template. */
883
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
884
- /** Emitted when meta site is marked as a WixSite. */
885
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
886
- /** Emitted when an application is provisioned (installed). */
887
- serviceProvisioned?: ServiceProvisioned;
888
- /** Emitted when an application is removed (uninstalled). */
889
- serviceRemoved?: ServiceRemoved;
890
- /** Emitted when meta site name (URL slug) is changed. */
891
- siteRenamedPayload?: SiteRenamed;
892
- /** Emitted when meta site was permanently deleted. */
893
- hardDeleted?: SiteHardDeleted;
894
- /** Emitted on a namespace change. */
895
- namespaceChanged?: NamespaceChanged;
896
- /** Emitted when Studio is attached. */
897
- studioAssigned?: StudioAssigned;
898
- /** Emitted when Studio is detached. */
899
- studioUnassigned?: StudioUnassigned;
900
- /**
901
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
902
- * the actual URL.
903
- *
904
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
905
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
906
- */
907
- urlChanged?: SiteUrlChanged;
908
- /** Site is marked as PurgedExternally */
909
- sitePurgedExternally?: SitePurgedExternally;
910
- /** Emitted when Odeditor is attached. */
911
- odeditorAssigned?: OdeditorAssigned;
912
- /** Emitted when Odeditor is detached. */
913
- odeditorUnassigned?: OdeditorUnassigned;
914
- /** Emitted when Picasso is attached. */
915
- picassoAssigned?: PicassoAssigned;
916
- /** Emitted when Picasso is detached. */
917
- picassoUnassigned?: PicassoUnassigned;
918
- }
919
- export interface Asset {
920
- /**
921
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
922
- * @maxLength 36
923
- */
924
- appDefId?: string;
925
- /**
926
- * An instance id. For legacy reasons may be UUID or a string.
927
- * @maxLength 200
928
- */
929
- instanceId?: string;
930
- /** An application state. */
931
- state?: StateWithLiterals;
932
- }
933
- export declare enum State {
934
- UNKNOWN = "UNKNOWN",
935
- ENABLED = "ENABLED",
936
- DISABLED = "DISABLED",
937
- PENDING = "PENDING",
938
- DEMO = "DEMO"
939
- }
940
- /** @enumType */
941
- export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
942
- export interface SiteCreated {
943
- /**
944
- * A template identifier (empty if not created from a template).
945
- * @maxLength 36
946
- */
947
- originTemplateId?: string;
948
- /**
949
- * An account id of the owner.
950
- * @format GUID
951
- */
952
- ownerId?: string;
953
- /** A context in which meta site was created. */
954
- context?: SiteCreatedContextWithLiterals;
955
- /**
956
- * A meta site id from which this site was created.
957
- *
958
- * In case of a creation from a template it's a template id.
959
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
960
- * @format GUID
961
- */
962
- originMetaSiteId?: string | null;
963
- /**
964
- * A meta site name (URL slug).
965
- * @maxLength 20
966
- */
967
- siteName?: string;
968
- /** A namespace. */
969
- namespace?: NamespaceWithLiterals;
970
- }
971
- export declare enum SiteCreatedContext {
972
- /** A valid option, we don't expose all reasons why site might be created. */
973
- OTHER = "OTHER",
974
- /** A meta site was created from template. */
975
- FROM_TEMPLATE = "FROM_TEMPLATE",
976
- /** A meta site was created by copying of the transfferred meta site. */
977
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
978
- /** A copy of existing meta site. */
979
- DUPLICATE = "DUPLICATE",
980
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
981
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
982
- /** deprecated A meta site was created for Flash editor. */
983
- FLASH = "FLASH"
984
- }
985
- /** @enumType */
986
- export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
987
- export declare enum Namespace {
988
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
989
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
990
- WIX = "WIX",
991
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
992
- SHOUT_OUT = "SHOUT_OUT",
993
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
994
- ALBUMS = "ALBUMS",
995
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
996
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
997
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
998
- HOTELS = "HOTELS",
999
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1000
- CLUBS = "CLUBS",
1001
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1002
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
1003
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1004
- DEV_SITE = "DEV_SITE",
1005
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1006
- LOGOS = "LOGOS",
1007
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
1008
- VIDEO_MAKER = "VIDEO_MAKER",
1009
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1010
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
1011
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
1012
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
1013
- /**
1014
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
1015
- *
1016
- * Meta site with this namespace will *not* be shown in a user's site list by default.
1017
- */
1018
- HTML_DRAFT = "HTML_DRAFT",
1019
- /**
1020
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
1021
- * Will be accessible from Site List and will not have a website app.
1022
- * Once the user attaches a site, the site will become a regular wixsite.
1023
- */
1024
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
1025
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
1026
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
1027
- /** It is to be used in the Business First efforts. */
1028
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
1029
- /** Bookings business flow with no site. */
1030
- ANYWHERE = "ANYWHERE",
1031
- /** Namespace for Headless Backoffice with no editor */
1032
- HEADLESS = "HEADLESS",
1033
- /**
1034
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
1035
- * The site will be used for account level CSM feature for enterprise
1036
- */
1037
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
1038
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
1039
- RISE = "RISE",
1040
- /**
1041
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
1042
- * There's a blank site behind the scene but it's blank).
1043
- * The Mobile company will be the owner of this namespace.
1044
- */
1045
- BRANDED_FIRST = "BRANDED_FIRST",
1046
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
1047
- NOWNIA = "NOWNIA",
1048
- /**
1049
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
1050
- * The Partners company owns this namespace.
1051
- */
1052
- UGC_TEMPLATE = "UGC_TEMPLATE",
1053
- /** Codux Headless Sites */
1054
- CODUX = "CODUX",
1055
- /** Bobb - AI Design Creator. */
1056
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
1057
- /**
1058
- * Shared Blog Site is a unique single site across Enterprise account,
1059
- * This site will hold all Blog posts related to the Marketing product.
1060
- */
1061
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
1062
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1063
- STANDALONE_FORMS = "STANDALONE_FORMS",
1064
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
1065
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
1066
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
1067
- MIMIR = "MIMIR"
1068
- }
1069
- /** @enumType */
1070
- export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
1071
- /** Site transferred to another user. */
1072
- export interface SiteTransferred {
1073
- /**
1074
- * A previous owner id (user that transfers meta site).
1075
- * @format GUID
1076
- */
1077
- oldOwnerId?: string;
1078
- /**
1079
- * A new owner id (user that accepts meta site).
1080
- * @format GUID
1081
- */
1082
- newOwnerId?: string;
1083
- }
1084
- /** Soft deletion of the meta site. Could be restored. */
1085
- export interface SiteDeleted {
1086
- /** A deletion context. */
1087
- deleteContext?: DeleteContext;
1088
- }
1089
- export interface DeleteContext {
1090
- /** When the meta site was deleted. */
1091
- dateDeleted?: Date | null;
1092
- /** A status. */
1093
- deleteStatus?: DeleteStatusWithLiterals;
1094
- /**
1095
- * A reason (flow).
1096
- * @maxLength 255
1097
- */
1098
- deleteOrigin?: string;
1099
- /**
1100
- * A service that deleted it.
1101
- * @maxLength 255
1102
- */
1103
- initiatorId?: string | null;
1104
- }
1105
- export declare enum DeleteStatus {
1106
- UNKNOWN = "UNKNOWN",
1107
- TRASH = "TRASH",
1108
- DELETED = "DELETED",
1109
- PENDING_PURGE = "PENDING_PURGE",
1110
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
1111
- }
1112
- /** @enumType */
1113
- export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
1114
- /** Restoration of the meta site. */
1115
- export interface SiteUndeleted {
1116
- }
1117
- /** First publish of a meta site. Or subsequent publish after unpublish. */
1118
- export interface SitePublished {
1119
- }
1120
- export interface SiteUnpublished {
1121
- /**
1122
- * A list of URLs previously associated with the meta site.
1123
- * @maxLength 4000
1124
- * @maxSize 10000
1125
- */
1126
- urls?: string[];
1127
- }
1128
- export interface SiteMarkedAsTemplate {
1129
- }
1130
- export interface SiteMarkedAsWixSite {
1131
- }
1132
- /**
1133
- * Represents a service provisioned a site.
1134
- *
1135
- * Note on `origin_instance_id`:
1136
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
1137
- * This is because of the following scenario:
1138
- *
1139
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
1140
- * such as a product catalog. When you create a site from this template, you inherit this
1141
- * default product catalog. However, if the template's product catalog is modified,
1142
- * your site will retain the catalog as it was at the time of site creation. This ensures that
1143
- * your site remains consistent with what you initially received and does not include any
1144
- * changes made to the original template afterward.
1145
- * To ensure this, the TPA on the template gets a new instance_id.
1146
- */
1147
- export interface ServiceProvisioned {
1148
- /**
1149
- * Either UUID or EmbeddedServiceType.
1150
- * @maxLength 36
1151
- */
1152
- appDefId?: string;
1153
- /**
1154
- * Not only UUID. Something here could be something weird.
1155
- * @maxLength 36
1156
- */
1157
- instanceId?: string;
1158
- /**
1159
- * An instance id from which this instance is originated.
1160
- * @maxLength 36
1161
- */
1162
- originInstanceId?: string;
1163
- /**
1164
- * A version.
1165
- * @maxLength 500
1166
- */
1167
- version?: string | null;
1168
- /**
1169
- * The origin meta site id
1170
- * @format GUID
1171
- */
1172
- originMetaSiteId?: string | null;
1173
- }
1174
- export interface ServiceRemoved {
1175
- /**
1176
- * Either UUID or EmbeddedServiceType.
1177
- * @maxLength 36
1178
- */
1179
- appDefId?: string;
1180
- /**
1181
- * Not only UUID. Something here could be something weird.
1182
- * @maxLength 36
1183
- */
1184
- instanceId?: string;
1185
- /**
1186
- * A version.
1187
- * @maxLength 500
1188
- */
1189
- version?: string | null;
1190
- }
1191
- /** Rename of the site. Meaning, free public url has been changed as well. */
1192
- export interface SiteRenamed {
1193
- /**
1194
- * A new meta site name (URL slug).
1195
- * @maxLength 20
1196
- */
1197
- newSiteName?: string;
1198
- /**
1199
- * A previous meta site name (URL slug).
1200
- * @maxLength 255
1201
- */
1202
- oldSiteName?: string;
1203
- }
1204
- /**
1205
- * Hard deletion of the meta site.
1206
- *
1207
- * Could not be restored. Therefore it's desirable to cleanup data.
1208
- */
1209
- export interface SiteHardDeleted {
1210
- /** A deletion context. */
1211
- deleteContext?: DeleteContext;
1212
- }
1213
- export interface NamespaceChanged {
1214
- /** A previous namespace. */
1215
- oldNamespace?: NamespaceWithLiterals;
1216
- /** A new namespace. */
1217
- newNamespace?: NamespaceWithLiterals;
1218
- }
1219
- /** Assigned Studio editor */
1220
- export interface StudioAssigned {
1221
- }
1222
- /** Unassigned Studio editor */
1223
- export interface StudioUnassigned {
1224
- }
1225
- /**
1226
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
1227
- *
1228
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
1229
- * with sites and its urls, you need to listen to another topic/event. Read about it:
1230
- *
1231
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
1232
- */
1233
- export interface SiteUrlChanged {
1234
- }
1235
- /**
1236
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
1237
- * Consumed by other teams to remove relevant data.
1238
- */
1239
- export interface SitePurgedExternally {
1240
- /**
1241
- * @maxLength 2048
1242
- * @maxSize 100
1243
- * @deprecated
1244
- * @targetRemovalDate 2025-04-15
1245
- */
1246
- appDefId?: string[];
1247
- }
1248
- /** Assigned Odeditor */
1249
- export interface OdeditorAssigned {
1250
- }
1251
- /** Unassigned Odeditor */
1252
- export interface OdeditorUnassigned {
1253
- }
1254
- /** Assigned Picasso editor */
1255
- export interface PicassoAssigned {
1256
- }
1257
- /** Unassigned Picasso */
1258
- export interface PicassoUnassigned {
1259
- }
1260
- export interface Empty {
1261
- }
1262
- export interface DomainEvent extends DomainEventBodyOneOf {
1263
- createdEvent?: EntityCreatedEvent;
1264
- updatedEvent?: EntityUpdatedEvent;
1265
- deletedEvent?: EntityDeletedEvent;
1266
- actionEvent?: ActionEvent;
1267
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1268
- _id?: string;
1269
- /**
1270
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1271
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1272
- */
1273
- entityFqdn?: string;
1274
- /**
1275
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1276
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1277
- */
1278
- slug?: string;
1279
- /** ID of the entity associated with the event. */
1280
- entityId?: string;
1281
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1282
- eventTime?: Date | null;
1283
- /**
1284
- * Whether the event was triggered as a result of a privacy regulation application
1285
- * (for example, GDPR).
1286
- */
1287
- triggeredByAnonymizeRequest?: boolean | null;
1288
- /** If present, indicates the action that triggered the event. */
1289
- originatedFrom?: string | null;
1290
- /**
1291
- * 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.
1292
- * 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.
1293
- */
1294
- entityEventSequence?: string | null;
1295
- }
1296
- /** @oneof */
1297
- export interface DomainEventBodyOneOf {
1298
- createdEvent?: EntityCreatedEvent;
1299
- updatedEvent?: EntityUpdatedEvent;
1300
- deletedEvent?: EntityDeletedEvent;
1301
- actionEvent?: ActionEvent;
1302
- }
1303
- export interface EntityCreatedEvent {
1304
- entity?: string;
1305
- }
1306
- export interface RestoreInfo {
1307
- deletedDate?: Date | null;
1308
- }
1309
- export interface EntityUpdatedEvent {
1310
- /**
1311
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1312
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1313
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1314
- */
1315
- currentEntity?: string;
1316
- }
1317
- export interface EntityDeletedEvent {
1318
- /** Entity that was deleted. */
1319
- deletedEntity?: string | null;
1320
- }
1321
- export interface ActionEvent {
1322
- body?: string;
1323
- }
1324
- export interface MessageEnvelope {
1325
- /**
1326
- * App instance ID.
1327
- * @format GUID
1328
- */
1329
- instanceId?: string | null;
1330
- /**
1331
- * Event type.
1332
- * @maxLength 150
1333
- */
1334
- eventType?: string;
1335
- /** The identification type and identity data. */
1336
- identity?: IdentificationData;
1337
- /** Stringify payload. */
1338
- data?: string;
1339
- }
1340
- export interface IdentificationData extends IdentificationDataIdOneOf {
1341
- /**
1342
- * ID of a site visitor that has not logged in to the site.
1343
- * @format GUID
1344
- */
1345
- anonymousVisitorId?: string;
1346
- /**
1347
- * ID of a site visitor that has logged in to the site.
1348
- * @format GUID
1349
- */
1350
- memberId?: string;
1351
- /**
1352
- * ID of a Wix user (site owner, contributor, etc.).
1353
- * @format GUID
1354
- */
1355
- wixUserId?: string;
1356
- /**
1357
- * ID of an app.
1358
- * @format GUID
1359
- */
1360
- appId?: string;
1361
- /** @readonly */
1362
- identityType?: WebhookIdentityTypeWithLiterals;
1363
- }
1364
- /** @oneof */
1365
- export interface IdentificationDataIdOneOf {
1366
- /**
1367
- * ID of a site visitor that has not logged in to the site.
1368
- * @format GUID
1369
- */
1370
- anonymousVisitorId?: string;
1371
- /**
1372
- * ID of a site visitor that has logged in to the site.
1373
- * @format GUID
1374
- */
1375
- memberId?: string;
1376
- /**
1377
- * ID of a Wix user (site owner, contributor, etc.).
1378
- * @format GUID
1379
- */
1380
- wixUserId?: string;
1381
- /**
1382
- * ID of an app.
1383
- * @format GUID
1384
- */
1385
- appId?: string;
1386
- }
1387
- export declare enum WebhookIdentityType {
1388
- UNKNOWN = "UNKNOWN",
1389
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1390
- MEMBER = "MEMBER",
1391
- WIX_USER = "WIX_USER",
1392
- APP = "APP"
1393
- }
1394
- /** @enumType */
1395
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1396
- type DeliveryProfileNonNullablePaths = `deliveryRegions`;
1397
- /**
1398
- * Creates a DeliveryProfile.
1399
- *
1400
- * The request body must include the DeliveryProfiles name. DeliveryRegions are optional.
1401
- * @param deliveryProfile - DeliveryProfile to be created.
1402
- * @public
1403
- * @documentationMaturity preview
1404
- * @requiredField deliveryProfile
1405
- * @requiredField deliveryProfile.deliveryRegions.destinations
1406
- * @requiredField deliveryProfile.deliveryRegions.destinations.countryCode
1407
- * @requiredField deliveryProfile.deliveryRegions.name
1408
- * @requiredField deliveryProfile.name
1409
- * @permissionId ECOM.DELIVERY_PROFILE_CREATE
1410
- * @permissionScope Manage Stores - all permissions
1411
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1412
- * @permissionScope Manage Stores
1413
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1414
- * @permissionScope Manage Restaurants - all permissions
1415
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1416
- * @permissionScope Manage eCommerce - all permissions
1417
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1418
- * @applicableIdentity APP
1419
- * @returns The created DeliveryProfile.
1420
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.CreateDeliveryProfile
1421
- */
1422
- export declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations` | `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths>>;
1423
- /**
1424
- * Retrieves a DeliveryProfile.
1425
- * @param deliveryProfileId - ID of the DeliveryProfile to retrieve.
1426
- * @public
1427
- * @documentationMaturity preview
1428
- * @requiredField deliveryProfileId
1429
- * @permissionId ECOM.DELIVERY_PROFILE_READ
1430
- * @permissionScope Manage Stores - all permissions
1431
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1432
- * @permissionScope Manage Stores
1433
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1434
- * @permissionScope Read eCommerce - all read permissions
1435
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1436
- * @permissionScope Manage Restaurants - all permissions
1437
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1438
- * @permissionScope Manage eCommerce - all permissions
1439
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1440
- * @applicableIdentity APP
1441
- * @applicableIdentity VISITOR
1442
- * @returns The requested DeliveryProfile.
1443
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfile
1444
- */
1445
- export declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths>>;
1446
- /**
1447
- * Updates a DeliveryProfile.
1448
- *
1449
- *
1450
- * Each time the DeliveryProfile is updated,
1451
- * `revision` increments by 1.
1452
- * The current `revision` must be passed when updating the DeliveryProfile.
1453
- * This ensures you're working with the latest DeliveryProfile
1454
- * and prevents unintended overwrites.
1455
- *
1456
- * This method does not allow updating the DeliveryRegions in this DeliveryProfile.
1457
- * Use AddDeliveryRegion, UpdateDeliveryRegion and RemoveDeliveryRegion for these functionalities.
1458
- * @param _id - DeliveryProfile ID.
1459
- * @public
1460
- * @documentationMaturity preview
1461
- * @requiredField _id
1462
- * @requiredField deliveryProfile
1463
- * @requiredField deliveryProfile.revision
1464
- * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1465
- * @permissionScope Manage Stores - all permissions
1466
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1467
- * @permissionScope Manage Stores
1468
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1469
- * @permissionScope Manage Restaurants - all permissions
1470
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1471
- * @permissionScope Manage eCommerce - all permissions
1472
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1473
- * @applicableIdentity APP
1474
- * @returns Updated DeliveryProfile.
1475
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryProfile
1476
- */
1477
- export declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths>>;
1478
- export interface UpdateDeliveryProfile {
1479
- /**
1480
- * DeliveryProfile ID.
1481
- * @format GUID
1482
- * @readonly
1483
- */
1484
- _id?: string | null;
1485
- /**
1486
- * DeliveryProfile name.
1487
- * @minLength 1
1488
- * @maxLength 256
1489
- */
1490
- name?: string | null;
1491
- /**
1492
- * Flags this DeliveryProfile as the default DeliveryProfile.
1493
- * @readonly
1494
- */
1495
- default?: boolean | null;
1496
- /**
1497
- * A list of DeliveryProfile regions.
1498
- * @maxSize 100
1499
- */
1500
- deliveryRegions?: DeliveryRegion[];
1501
- /** ID of the delivery profile's creator. */
1502
- createdBy?: CreatedBy;
1503
- /**
1504
- * DeliveryProfile revision.
1505
- * @readonly
1506
- */
1507
- revision?: string | null;
1508
- /**
1509
- * Date and time the DeliveryProfile was created.
1510
- * @readonly
1511
- */
1512
- _createdDate?: Date | null;
1513
- /**
1514
- * Date and time the DeliveryProfile was last updated.
1515
- * @readonly
1516
- */
1517
- _updatedDate?: Date | null;
1518
- /** [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. */
1519
- extendedFields?: ExtendedFields;
1520
- }
1521
- /**
1522
- * Deletes a DeliveryProfile.
1523
- *
1524
- * Deleting a DeliveryProfile permanently removes them from the DeliveryProfile List.
1525
- * @param deliveryProfileId - Id of the DeliveryProfile to delete.
1526
- * @public
1527
- * @documentationMaturity preview
1528
- * @requiredField deliveryProfileId
1529
- * @permissionId ECOM.DELIVERY_PROFILE_DELETE
1530
- * @permissionScope Manage Stores - all permissions
1531
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1532
- * @permissionScope Manage Stores
1533
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1534
- * @permissionScope Manage Restaurants - all permissions
1535
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1536
- * @permissionScope Manage eCommerce - all permissions
1537
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1538
- * @applicableIdentity APP
1539
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.DeleteDeliveryProfile
1540
- */
1541
- export declare function deleteDeliveryProfile(deliveryProfileId: string): Promise<void>;
1542
- /**
1543
- * Retrieves a list of DeliveryProfiles, given the provided [paging, filtering, and sorting][1].
1544
- *
1545
- * Up to 1,000 DeliveryProfiles can be returned per request.
1546
- *
1547
- * To learn how to query DeliveryProfiles, see [API Query Language][2].
1548
- *
1549
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
1550
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
1551
- * @public
1552
- * @documentationMaturity preview
1553
- * @permissionScope Manage Stores - all permissions
1554
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1555
- * @permissionScope Manage Stores
1556
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1557
- * @permissionScope Read eCommerce - all read permissions
1558
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1559
- * @permissionScope Manage Restaurants - all permissions
1560
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1561
- * @permissionScope Manage eCommerce - all permissions
1562
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1563
- * @permissionId ECOM.DELIVERY_PROFILE_READ
1564
- * @applicableIdentity APP
1565
- * @applicableIdentity VISITOR
1566
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.QueryDeliveryProfiles
1567
- */
1568
- export declare function queryDeliveryProfiles(): DeliveryProfilesQueryBuilder;
1569
- interface QueryCursorResult {
1570
- cursors: Cursors;
1571
- hasNext: () => boolean;
1572
- hasPrev: () => boolean;
1573
- length: number;
1574
- pageSize: number;
1575
- }
1576
- export interface DeliveryProfilesQueryResult extends QueryCursorResult {
1577
- items: DeliveryProfile[];
1578
- query: DeliveryProfilesQueryBuilder;
1579
- next: () => Promise<DeliveryProfilesQueryResult>;
1580
- prev: () => Promise<DeliveryProfilesQueryResult>;
1581
- }
1582
- export interface DeliveryProfilesQueryBuilder {
1583
- /** @param propertyName - Property whose value is compared with `value`.
1584
- * @param value - Value to compare against.
1585
- * @documentationMaturity preview
1586
- */
1587
- eq: (propertyName: '_id' | 'name' | 'default' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1588
- /** @param propertyName - Property whose value is compared with `value`.
1589
- * @param value - Value to compare against.
1590
- * @documentationMaturity preview
1591
- */
1592
- ne: (propertyName: '_id' | 'name' | 'default' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1593
- /** @param propertyName - Property whose value is compared with `value`.
1594
- * @param value - Value to compare against.
1595
- * @documentationMaturity preview
1596
- */
1597
- ge: (propertyName: '_id' | 'name' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1598
- /** @param propertyName - Property whose value is compared with `value`.
1599
- * @param value - Value to compare against.
1600
- * @documentationMaturity preview
1601
- */
1602
- gt: (propertyName: '_id' | 'name' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1603
- /** @param propertyName - Property whose value is compared with `value`.
1604
- * @param value - Value to compare against.
1605
- * @documentationMaturity preview
1606
- */
1607
- le: (propertyName: '_id' | 'name' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1608
- /** @param propertyName - Property whose value is compared with `value`.
1609
- * @param value - Value to compare against.
1610
- * @documentationMaturity preview
1611
- */
1612
- lt: (propertyName: '_id' | 'name' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1613
- /** @param propertyName - Property whose value is compared with `string`.
1614
- * @param string - String to compare against. Case-insensitive.
1615
- * @documentationMaturity preview
1616
- */
1617
- startsWith: (propertyName: '_id' | 'name', value: string) => DeliveryProfilesQueryBuilder;
1618
- /** @param propertyName - Property whose value is compared with `values`.
1619
- * @param values - List of values to compare against.
1620
- * @documentationMaturity preview
1621
- */
1622
- hasSome: (propertyName: '_id' | 'name' | 'default' | '_createdDate', value: any[]) => DeliveryProfilesQueryBuilder;
1623
- /** @documentationMaturity preview */
1624
- in: (propertyName: '_id' | 'name' | 'default' | '_createdDate', value: any) => DeliveryProfilesQueryBuilder;
1625
- /** @documentationMaturity preview */
1626
- exists: (propertyName: '_id' | 'name' | 'default' | '_createdDate', value: boolean) => DeliveryProfilesQueryBuilder;
1627
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1628
- * @documentationMaturity preview
1629
- */
1630
- ascending: (...propertyNames: Array<'_id' | 'name' | 'default' | '_createdDate'>) => DeliveryProfilesQueryBuilder;
1631
- /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
1632
- * @documentationMaturity preview
1633
- */
1634
- descending: (...propertyNames: Array<'_id' | 'name' | 'default' | '_createdDate'>) => DeliveryProfilesQueryBuilder;
1635
- /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
1636
- * @documentationMaturity preview
1637
- */
1638
- limit: (limit: number) => DeliveryProfilesQueryBuilder;
1639
- /** @param cursor - A pointer to specific record
1640
- * @documentationMaturity preview
1641
- */
1642
- skipTo: (cursor: string) => DeliveryProfilesQueryBuilder;
1643
- /** @documentationMaturity preview */
1644
- find: () => Promise<DeliveryProfilesQueryResult>;
1645
- }
1646
- /**
1647
- * Creates a new DeliveryRegion in an existing DeliveryProfile.
1648
- * @param deliveryProfileId - delivery profile id to associated with the DeliveryRegion
1649
- * @param deliveryRegion - DeliveryRegion to be created
1650
- * @public
1651
- * @documentationMaturity preview
1652
- * @requiredField deliveryProfileId
1653
- * @requiredField deliveryRegion
1654
- * @requiredField deliveryRegion.destinations.countryCode
1655
- * @requiredField deliveryRegion.name
1656
- * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1657
- * @permissionScope Manage Stores - all permissions
1658
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1659
- * @permissionScope Manage Stores
1660
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1661
- * @permissionScope Manage Restaurants - all permissions
1662
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1663
- * @permissionScope Manage eCommerce - all permissions
1664
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1665
- * @applicableIdentity APP
1666
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryRegion
1667
- */
1668
- export declare function addDeliveryRegion(deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
1669
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1670
- }[DeliveryProfileNonNullablePaths]>>;
1671
- export interface AddDeliveryRegionOptions {
1672
- /**
1673
- * DeliveryProfile revision.
1674
- * @readonly
1675
- */
1676
- revision?: string | null;
1677
- }
1678
- /**
1679
- * Update a DeliveryRegion, supports partial update
1680
- * Pass the latest `revision` for a successful update
1681
- *
1682
- * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
1683
- * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.
1684
- * @public
1685
- * @documentationMaturity preview
1686
- * @requiredField deliveryRegion
1687
- * @requiredField identifiers
1688
- * @requiredField identifiers.deliveryProfileId
1689
- * @requiredField identifiers.deliveryRegionId
1690
- * @permissionId ECOM.DELIVERY_REGION_UPDATE
1691
- * @permissionScope Manage Stores - all permissions
1692
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1693
- * @permissionScope Manage Stores
1694
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1695
- * @permissionScope Manage Restaurants - all permissions
1696
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1697
- * @permissionScope Manage eCommerce - all permissions
1698
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1699
- * @applicableIdentity APP
1700
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryRegion
1701
- */
1702
- export declare function updateDeliveryRegion(identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, {
1703
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1704
- }[DeliveryProfileNonNullablePaths]>>;
1705
- export interface UpdateDeliveryRegionIdentifiers {
1706
- /**
1707
- * DeliveryProfile id that owns the DeliveryRegion
1708
- * @format GUID
1709
- */
1710
- deliveryProfileId: string;
1711
- /**
1712
- * The delivery region id.
1713
- * @format GUID
1714
- * @readonly
1715
- */
1716
- deliveryRegionId?: string | null;
1717
- }
1718
- export interface UpdateDeliveryRegion {
1719
- /**
1720
- * The delivery region id.
1721
- * @format GUID
1722
- * @readonly
1723
- */
1724
- _id?: string | null;
1725
- /**
1726
- * Optional name of the region, for example: "Domestic".
1727
- * @minLength 1
1728
- * @maxLength 256
1729
- */
1730
- name?: string | null;
1731
- /** Indicates that this rule is active, default value is true. */
1732
- active?: boolean | null;
1733
- /**
1734
- * The spi implementers id of shipping-rates spi, assigned to this rule.
1735
- * @maxSize 25
1736
- * @readonly
1737
- */
1738
- deliveryCarriers?: DeliveryCarrier[];
1739
- /**
1740
- * The operation region of this rule, if empty than it is global.
1741
- * @maxSize 200
1742
- */
1743
- destinations?: Destination[];
1744
- /**
1745
- * Represents the time this Profile was created
1746
- * @readonly
1747
- */
1748
- _createdDate?: Date | null;
1749
- }
1750
- export interface UpdateDeliveryRegionOptions {
1751
- /**
1752
- * DeliveryProfile revision.
1753
- * @readonly
1754
- */
1755
- revision?: string | null;
1756
- }
1757
- /**
1758
- * Delete a DeliveryRegion
1759
- * @public
1760
- * @documentationMaturity preview
1761
- * @requiredField identifiers
1762
- * @requiredField identifiers.deliveryProfileId
1763
- * @requiredField identifiers.deliveryRegionId
1764
- * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1765
- * @permissionScope Manage Stores - all permissions
1766
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1767
- * @permissionScope Manage Stores
1768
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1769
- * @permissionScope Manage Restaurants - all permissions
1770
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1771
- * @permissionScope Manage eCommerce - all permissions
1772
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1773
- * @applicableIdentity APP
1774
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryRegion
1775
- */
1776
- export declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
1777
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1778
- }[DeliveryProfileNonNullablePaths]>>;
1779
- export interface RemoveDeliveryRegionIdentifiers {
1780
- /**
1781
- * DeliveryProfile id that owns the DeliveryRegion
1782
- * @format GUID
1783
- */
1784
- deliveryProfileId: string;
1785
- /**
1786
- * Id of the DeliveryRegion to delete
1787
- * @format GUID
1788
- */
1789
- deliveryRegionId: string;
1790
- }
1791
- export interface RemoveDeliveryRegionOptions {
1792
- /**
1793
- * DeliveryProfile revision.
1794
- * @readonly
1795
- */
1796
- revision?: string | null;
1797
- }
1798
- /**
1799
- * Add a delivery_carrier to a delivery region
1800
- * @param deliveryRegionId - delivery_region id to associated with the delivery_carrier.
1801
- * @public
1802
- * @documentationMaturity preview
1803
- * @requiredField deliveryRegionId
1804
- * @requiredField options
1805
- * @requiredField options.deliveryCarrier
1806
- * @permissionId ECOM.DELIVERY_CARRIER_ADD
1807
- * @permissionScope Manage Stores - all permissions
1808
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1809
- * @permissionScope Manage Stores
1810
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1811
- * @permissionScope Manage Restaurants - all permissions
1812
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1813
- * @permissionScope Manage eCommerce - all permissions
1814
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1815
- * @applicableIdentity APP
1816
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryCarrier
1817
- */
1818
- export declare function addDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier`>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, {
1819
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1820
- }[DeliveryProfileNonNullablePaths]>>;
1821
- export interface AddDeliveryCarrierOptions {
1822
- /** delivery_carrier to be added. */
1823
- deliveryCarrier: DeliveryCarrier;
1824
- }
1825
- /**
1826
- * Remove a delivery_carrier from a delivery region
1827
- * @param deliveryRegionId - Id of the DeliveryRegion
1828
- * @public
1829
- * @documentationMaturity preview
1830
- * @requiredField deliveryRegionId
1831
- * @requiredField options
1832
- * @requiredField options.appId
1833
- * @permissionId ECOM.DELIVERY_CARRIER_REMOVE
1834
- * @permissionScope Manage Stores - all permissions
1835
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1836
- * @permissionScope Manage Stores
1837
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1838
- * @permissionScope Manage Restaurants - all permissions
1839
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1840
- * @permissionScope Manage eCommerce - all permissions
1841
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1842
- * @applicableIdentity APP
1843
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryCarrier
1844
- */
1845
- export declare function removeDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, {
1846
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1847
- }[DeliveryProfileNonNullablePaths]>>;
1848
- export interface RemoveDeliveryCarrierOptions {
1849
- /**
1850
- * DeliveryCarrier app id to be removed.
1851
- * @format GUID
1852
- */
1853
- appId: string;
1854
- }
1855
- /**
1856
- * Update a delivery carrier in a delivery region
1857
- * @param deliveryRegionId - DeliveryRegion id
1858
- * @public
1859
- * @documentationMaturity preview
1860
- * @requiredField deliveryRegionId
1861
- * @requiredField options.deliveryCarrier.appId
1862
- * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
1863
- * @permissionScope Manage Stores - all permissions
1864
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1865
- * @permissionScope Manage Stores
1866
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1867
- * @permissionScope Manage Restaurants - all permissions
1868
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1869
- * @permissionScope Manage eCommerce - all permissions
1870
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1871
- * @applicableIdentity APP
1872
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryCarrier
1873
- */
1874
- export declare function updateDeliveryCarrier(deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, {
1875
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1876
- }[DeliveryProfileNonNullablePaths]>>;
1877
- export interface UpdateDeliveryCarrierOptions {
1878
- /** Updated delivery_carrier */
1879
- deliveryCarrier?: DeliveryCarrier;
1880
- }
1881
- /**
1882
- * List all installed delivery carriers in order to set their ids in delivery rules
1883
- * @public
1884
- * @documentationMaturity preview
1885
- * @permissionId ECOM.DELIVERY_CARRIER_DETAILS_READ
1886
- * @permissionScope Manage Stores - all permissions
1887
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1888
- * @permissionScope Manage Stores
1889
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1890
- * @permissionScope Read eCommerce - all read permissions
1891
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1892
- * @permissionScope Manage Restaurants - all permissions
1893
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1894
- * @permissionScope Manage eCommerce - all permissions
1895
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1896
- * @applicableIdentity APP
1897
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListDeliveryCarrierDetails
1898
- * @deprecated
1899
- * @replacedBy ListInstalledDeliveryCarriers
1900
- * @targetRemovalDate 2025-04-01
1901
- */
1902
- export declare function listDeliveryCarrierDetails(): Promise<NonNullablePaths<ListDeliveryCarrierDetailsResponse, `deliveryCarrierDetails` | `deliveryCarrierDetails.${number}._id` | `deliveryCarrierDetails.${number}.displayName` | `deliveryCarrierDetails.${number}.toggleGetCarrierSettingsEnabled` | `deliveryCarrierDetails.${number}.toggleUpdateCarrierActiveStatusEnabled`>>;
1903
- /** @public
1904
- * @documentationMaturity preview
1905
- * @permissionId ECOM.DELIVERY_CARRIER_READ
1906
- * @permissionScope Manage Stores - all permissions
1907
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1908
- * @permissionScope Manage Stores
1909
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1910
- * @permissionScope Read eCommerce - all read permissions
1911
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1912
- * @permissionScope Manage Restaurants - all permissions
1913
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1914
- * @permissionScope Manage eCommerce - all permissions
1915
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1916
- * @applicableIdentity APP
1917
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListInstalledDeliveryCarriers
1918
- */
1919
- export declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`>>;
1920
- /**
1921
- * Get delivery carrier settings for a delivery profile and delivery region.
1922
- * These are returned in a table format for the dashboard.
1923
- * @param deliveryProfileId - Delivery profile id.
1924
- * @public
1925
- * @documentationMaturity preview
1926
- * @requiredField deliveryProfileId
1927
- * @permissionId ECOM.DELIVERY_CARRIER_READ
1928
- * @permissionScope Manage Stores - all permissions
1929
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1930
- * @permissionScope Manage Stores
1931
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1932
- * @permissionScope Read eCommerce - all read permissions
1933
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1934
- * @permissionScope Manage Restaurants - all permissions
1935
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1936
- * @permissionScope Manage eCommerce - all permissions
1937
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1938
- * @applicableIdentity APP
1939
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListDeliveryCarriers
1940
- */
1941
- export declare function listDeliveryCarriers(deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise<NonNullablePaths<ListDeliveryCarriersResponse, `results` | `results.${number}.deliveryCarrierMetadata.success` | `results.${number}.deliveryCarrierMetadata.error.code` | `results.${number}.deliveryCarrierMetadata.error.description` | `results.${number}.deliveryCarrierDetails._id` | `results.${number}.deliveryCarrierDetails.displayName` | `results.${number}.deliveryCarrierDetails.toggleGetCarrierSettingsEnabled` | `results.${number}.deliveryCarrierDetails.toggleUpdateCarrierActiveStatusEnabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
1942
- export interface ListDeliveryCarriersOptions {
1943
- /**
1944
- * Delivery app ids to get settings for.
1945
- * @format GUID
1946
- * @minSize 1
1947
- * @maxSize 25
1948
- */
1949
- appIds?: string[];
1950
- }
1951
- /**
1952
- * Update carrier's external active settings
1953
- * @param carrierId - Carrier id.
1954
- * @public
1955
- * @documentationMaturity preview
1956
- * @requiredField carrierId
1957
- * @requiredField options
1958
- * @requiredField options.active
1959
- * @requiredField options.rowId
1960
- * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
1961
- * @permissionScope Manage Stores - all permissions
1962
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1963
- * @permissionScope Manage Stores
1964
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1965
- * @permissionScope Manage Restaurants - all permissions
1966
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1967
- * @permissionScope Manage eCommerce - all permissions
1968
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1969
- * @applicableIdentity APP
1970
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateCarrierSettings
1971
- */
1972
- export declare function updateCarrierSettings(carrierId: string, options: NonNullablePaths<UpdateCarrierSettingsOptions, `active` | `rowId`>): Promise<void>;
1973
- export interface UpdateCarrierSettingsOptions {
1974
- /**
1975
- * Row id triggered the change
1976
- * @format GUID
1977
- */
1978
- rowId: string;
1979
- /** New status */
1980
- active: boolean | null;
1981
- }
1982
- /**
1983
- * Updates extended fields of a DeliveryProfile without incrementing revision
1984
- * @param _id - ID of the entity to update.
1985
- * @param namespace - Identifier for the app whose extended fields are being updated.
1986
- * @public
1987
- * @documentationMaturity preview
1988
- * @requiredField _id
1989
- * @requiredField namespace
1990
- * @requiredField options
1991
- * @requiredField options.namespaceData
1992
- * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1993
- * @permissionScope Manage Stores - all permissions
1994
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1995
- * @permissionScope Manage Stores
1996
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1997
- * @permissionScope Manage Restaurants - all permissions
1998
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1999
- * @permissionScope Manage eCommerce - all permissions
2000
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2001
- * @applicableIdentity APP
2002
- * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateExtendedFields
2003
- */
2004
- export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
2005
- [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
2006
- }[DeliveryProfileNonNullablePaths]>>;
2007
- export interface UpdateExtendedFieldsOptions {
2008
- /** 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. */
2009
- namespaceData: Record<string, any> | null;
2010
- }
2011
- export {};