@wix/auto_sdk_ecom_orders 1.0.32 → 1.0.34

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-order-orders.types.d.ts → ecom-v1-order-orders.universal-UflOyGzD.d.mts} +1109 -637
  2. package/build/{es/src/ecom-v1-order-orders.types.d.ts → ecom-v1-order-orders.universal-UflOyGzD.d.ts} +1109 -637
  3. package/build/index.d.mts +212 -0
  4. package/build/index.d.ts +212 -0
  5. package/build/index.js +3504 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +3401 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{cjs/src/ecom-v1-order-orders.universal.d.ts → internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.mts} +957 -1005
  10. package/build/{es/src/ecom-v1-order-orders.universal.d.ts → internal/ecom-v1-order-orders.universal-DkzM7BQ-.d.ts} +957 -1005
  11. package/build/internal/index.d.mts +391 -0
  12. package/build/internal/index.d.ts +391 -0
  13. package/build/internal/index.js +3504 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +3401 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +3192 -0
  18. package/build/internal/meta.d.ts +3192 -0
  19. package/build/internal/meta.js +1941 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +1890 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +3192 -0
  24. package/build/meta.d.ts +3192 -0
  25. package/build/meta.js +1941 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +1890 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +13 -12
  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-order-orders.context.d.ts +0 -34
  40. package/build/cjs/src/ecom-v1-order-orders.context.js +0 -117
  41. package/build/cjs/src/ecom-v1-order-orders.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-order-orders.http.d.ts +0 -200
  43. package/build/cjs/src/ecom-v1-order-orders.http.js +0 -1610
  44. package/build/cjs/src/ecom-v1-order-orders.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +0 -78
  46. package/build/cjs/src/ecom-v1-order-orders.meta.js +0 -503
  47. package/build/cjs/src/ecom-v1-order-orders.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-order-orders.public.d.ts +0 -189
  49. package/build/cjs/src/ecom-v1-order-orders.public.js +0 -382
  50. package/build/cjs/src/ecom-v1-order-orders.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-order-orders.types.js +0 -652
  52. package/build/cjs/src/ecom-v1-order-orders.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-order-orders.universal.js +0 -2322
  54. package/build/cjs/src/ecom-v1-order-orders.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/ecom-v1-order-orders.context.d.ts +0 -34
  66. package/build/es/src/ecom-v1-order-orders.context.js +0 -62
  67. package/build/es/src/ecom-v1-order-orders.context.js.map +0 -1
  68. package/build/es/src/ecom-v1-order-orders.http.d.ts +0 -200
  69. package/build/es/src/ecom-v1-order-orders.http.js +0 -1582
  70. package/build/es/src/ecom-v1-order-orders.http.js.map +0 -1
  71. package/build/es/src/ecom-v1-order-orders.meta.d.ts +0 -78
  72. package/build/es/src/ecom-v1-order-orders.meta.js +0 -452
  73. package/build/es/src/ecom-v1-order-orders.meta.js.map +0 -1
  74. package/build/es/src/ecom-v1-order-orders.public.d.ts +0 -189
  75. package/build/es/src/ecom-v1-order-orders.public.js +0 -302
  76. package/build/es/src/ecom-v1-order-orders.public.js.map +0 -1
  77. package/build/es/src/ecom-v1-order-orders.types.js +0 -648
  78. package/build/es/src/ecom-v1-order-orders.types.js.map +0 -1
  79. package/build/es/src/ecom-v1-order-orders.universal.js +0 -2270
  80. package/build/es/src/ecom-v1-order-orders.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +0 -62
  91. package/build/internal/cjs/src/ecom-v1-order-orders.context.js +0 -117
  92. package/build/internal/cjs/src/ecom-v1-order-orders.context.js.map +0 -1
  93. package/build/internal/cjs/src/ecom-v1-order-orders.http.d.ts +0 -200
  94. package/build/internal/cjs/src/ecom-v1-order-orders.http.js +0 -1610
  95. package/build/internal/cjs/src/ecom-v1-order-orders.http.js.map +0 -1
  96. package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +0 -78
  97. package/build/internal/cjs/src/ecom-v1-order-orders.meta.js +0 -503
  98. package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +0 -1
  99. package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +0 -340
  100. package/build/internal/cjs/src/ecom-v1-order-orders.public.js +0 -382
  101. package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +0 -1
  102. package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +0 -6096
  103. package/build/internal/cjs/src/ecom-v1-order-orders.types.js +0 -652
  104. package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +0 -1
  105. package/build/internal/cjs/src/ecom-v1-order-orders.universal.d.ts +0 -7782
  106. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +0 -2322
  107. package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +0 -1
  108. package/build/internal/es/index.d.ts +0 -1
  109. package/build/internal/es/index.js +0 -2
  110. package/build/internal/es/index.js.map +0 -1
  111. package/build/internal/es/index.typings.d.ts +0 -1
  112. package/build/internal/es/index.typings.js +0 -2
  113. package/build/internal/es/index.typings.js.map +0 -1
  114. package/build/internal/es/meta.d.ts +0 -1
  115. package/build/internal/es/meta.js +0 -2
  116. package/build/internal/es/meta.js.map +0 -1
  117. package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +0 -62
  118. package/build/internal/es/src/ecom-v1-order-orders.context.js +0 -62
  119. package/build/internal/es/src/ecom-v1-order-orders.context.js.map +0 -1
  120. package/build/internal/es/src/ecom-v1-order-orders.http.d.ts +0 -200
  121. package/build/internal/es/src/ecom-v1-order-orders.http.js +0 -1582
  122. package/build/internal/es/src/ecom-v1-order-orders.http.js.map +0 -1
  123. package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +0 -78
  124. package/build/internal/es/src/ecom-v1-order-orders.meta.js +0 -452
  125. package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +0 -1
  126. package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +0 -340
  127. package/build/internal/es/src/ecom-v1-order-orders.public.js +0 -302
  128. package/build/internal/es/src/ecom-v1-order-orders.public.js.map +0 -1
  129. package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +0 -6096
  130. package/build/internal/es/src/ecom-v1-order-orders.types.js +0 -648
  131. package/build/internal/es/src/ecom-v1-order-orders.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-order-orders.universal.d.ts +0 -7782
  133. package/build/internal/es/src/ecom-v1-order-orders.universal.js +0 -2270
  134. package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +0 -1
@@ -1,2270 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
3
- import * as ambassadorWixEcomV1Order from './ecom-v1-order-orders.http.js';
4
- // @ts-ignore
5
- import { transformSDKAddressToRESTAddress } from '@wix/sdk-runtime/transformations/address';
6
- import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
7
- import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
8
- import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
9
- import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
10
- export var DescriptionLineType;
11
- (function (DescriptionLineType) {
12
- /** Unrecognized type. */
13
- DescriptionLineType["UNRECOGNISED"] = "UNRECOGNISED";
14
- /** Plain text type. */
15
- DescriptionLineType["PLAIN_TEXT"] = "PLAIN_TEXT";
16
- /** Color type. */
17
- DescriptionLineType["COLOR"] = "COLOR";
18
- })(DescriptionLineType || (DescriptionLineType = {}));
19
- export var ItemTypeItemType;
20
- (function (ItemTypeItemType) {
21
- ItemTypeItemType["UNRECOGNISED"] = "UNRECOGNISED";
22
- ItemTypeItemType["PHYSICAL"] = "PHYSICAL";
23
- ItemTypeItemType["DIGITAL"] = "DIGITAL";
24
- ItemTypeItemType["GIFT_CARD"] = "GIFT_CARD";
25
- ItemTypeItemType["SERVICE"] = "SERVICE";
26
- })(ItemTypeItemType || (ItemTypeItemType = {}));
27
- /** Type of selected payment option for catalog item */
28
- export var PaymentOptionType;
29
- (function (PaymentOptionType) {
30
- /** The entire payment for this item happens as part of the checkout. */
31
- PaymentOptionType["FULL_PAYMENT_ONLINE"] = "FULL_PAYMENT_ONLINE";
32
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
33
- PaymentOptionType["FULL_PAYMENT_OFFLINE"] = "FULL_PAYMENT_OFFLINE";
34
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
35
- PaymentOptionType["MEMBERSHIP"] = "MEMBERSHIP";
36
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
37
- PaymentOptionType["DEPOSIT_ONLINE"] = "DEPOSIT_ONLINE";
38
- /** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
39
- PaymentOptionType["MEMBERSHIP_OFFLINE"] = "MEMBERSHIP_OFFLINE";
40
- })(PaymentOptionType || (PaymentOptionType = {}));
41
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
42
- export var JurisdictionType;
43
- (function (JurisdictionType) {
44
- JurisdictionType["UNDEFINED"] = "UNDEFINED";
45
- JurisdictionType["COUNTRY"] = "COUNTRY";
46
- JurisdictionType["STATE"] = "STATE";
47
- JurisdictionType["COUNTY"] = "COUNTY";
48
- JurisdictionType["CITY"] = "CITY";
49
- JurisdictionType["SPECIAL"] = "SPECIAL";
50
- })(JurisdictionType || (JurisdictionType = {}));
51
- /** Frequency unit of recurring payment */
52
- export var SubscriptionFrequency;
53
- (function (SubscriptionFrequency) {
54
- SubscriptionFrequency["UNDEFINED"] = "UNDEFINED";
55
- SubscriptionFrequency["DAY"] = "DAY";
56
- SubscriptionFrequency["WEEK"] = "WEEK";
57
- SubscriptionFrequency["MONTH"] = "MONTH";
58
- SubscriptionFrequency["YEAR"] = "YEAR";
59
- })(SubscriptionFrequency || (SubscriptionFrequency = {}));
60
- export var AdjustmentType;
61
- (function (AdjustmentType) {
62
- AdjustmentType["UNKNOWN_ADJUSTMENT_TYPE"] = "UNKNOWN_ADJUSTMENT_TYPE";
63
- /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
64
- AdjustmentType["EXTRA_CHARGE"] = "EXTRA_CHARGE";
65
- /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
66
- AdjustmentType["CREDIT"] = "CREDIT";
67
- })(AdjustmentType || (AdjustmentType = {}));
68
- export var TaxableAddressType;
69
- (function (TaxableAddressType) {
70
- TaxableAddressType["UNKNOWN_TAXABLE_ADDRESS"] = "UNKNOWN_TAXABLE_ADDRESS";
71
- TaxableAddressType["BUSINESS"] = "BUSINESS";
72
- TaxableAddressType["BILLING"] = "BILLING";
73
- TaxableAddressType["SHIPPING"] = "SHIPPING";
74
- })(TaxableAddressType || (TaxableAddressType = {}));
75
- export var PaymentStatus;
76
- (function (PaymentStatus) {
77
- PaymentStatus["UNSPECIFIED"] = "UNSPECIFIED";
78
- /**
79
- * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
80
- * This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
81
- */
82
- PaymentStatus["NOT_PAID"] = "NOT_PAID";
83
- /** All required payments associated with this order are paid. */
84
- PaymentStatus["PAID"] = "PAID";
85
- /** Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. */
86
- PaymentStatus["PARTIALLY_REFUNDED"] = "PARTIALLY_REFUNDED";
87
- /** Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. */
88
- PaymentStatus["FULLY_REFUNDED"] = "FULLY_REFUNDED";
89
- /**
90
- * All payments pending.
91
- *
92
- * This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly.
93
- * Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
94
- */
95
- PaymentStatus["PENDING"] = "PENDING";
96
- /** At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. */
97
- PaymentStatus["PARTIALLY_PAID"] = "PARTIALLY_PAID";
98
- /**
99
- * Payment received, but not yet confirmed by the payment provider.
100
- *
101
- * In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
102
- * To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
103
- * @documentationMaturity preview
104
- */
105
- PaymentStatus["PENDING_MERCHANT"] = "PENDING_MERCHANT";
106
- /**
107
- * One or more payments canceled.
108
- * @documentationMaturity preview
109
- */
110
- PaymentStatus["CANCELED"] = "CANCELED";
111
- /**
112
- * One or more payments declined.
113
- * @documentationMaturity preview
114
- */
115
- PaymentStatus["DECLINED"] = "DECLINED";
116
- })(PaymentStatus || (PaymentStatus = {}));
117
- export var FulfillmentStatus;
118
- (function (FulfillmentStatus) {
119
- /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
120
- FulfillmentStatus["NOT_FULFILLED"] = "NOT_FULFILLED";
121
- /**
122
- * All of the order items are fulfilled or the order was manually marked as fulfilled.
123
- * Orders without shipping info are fulfilled automatically.
124
- */
125
- FulfillmentStatus["FULFILLED"] = "FULFILLED";
126
- /** Some, but not all, of the order items are fulfilled. */
127
- FulfillmentStatus["PARTIALLY_FULFILLED"] = "PARTIALLY_FULFILLED";
128
- })(FulfillmentStatus || (FulfillmentStatus = {}));
129
- export var WeightUnit;
130
- (function (WeightUnit) {
131
- /** Weight unit can't be classified due to an error. */
132
- WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
133
- /** Kilograms. */
134
- WeightUnit["KG"] = "KG";
135
- /** Pounds. */
136
- WeightUnit["LB"] = "LB";
137
- })(WeightUnit || (WeightUnit = {}));
138
- /** tax info types */
139
- export var VatType;
140
- (function (VatType) {
141
- VatType["UNSPECIFIED"] = "UNSPECIFIED";
142
- /** CPF - for individual tax payers. */
143
- VatType["CPF"] = "CPF";
144
- /** CNPJ - for corporations */
145
- VatType["CNPJ"] = "CNPJ";
146
- })(VatType || (VatType = {}));
147
- export var PickupMethod;
148
- (function (PickupMethod) {
149
- PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
150
- PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
151
- PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
152
- })(PickupMethod || (PickupMethod = {}));
153
- export var OrderStatus;
154
- (function (OrderStatus) {
155
- /** Order created, but not yet approved or canceled. */
156
- OrderStatus["INITIALIZED"] = "INITIALIZED";
157
- /**
158
- * Order approved.
159
- *
160
- * This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
161
- * Offline orders (cash payment) are automatically approved.
162
- */
163
- OrderStatus["APPROVED"] = "APPROVED";
164
- /** Order canceled by the user. */
165
- OrderStatus["CANCELED"] = "CANCELED";
166
- /**
167
- * Order pending.
168
- * @documentationMaturity preview
169
- */
170
- OrderStatus["PENDING"] = "PENDING";
171
- /**
172
- * Order rejected.
173
- *
174
- * This happens when pending payments fail.
175
- * @documentationMaturity preview
176
- */
177
- OrderStatus["REJECTED"] = "REJECTED";
178
- })(OrderStatus || (OrderStatus = {}));
179
- export var DiscountType;
180
- (function (DiscountType) {
181
- DiscountType["GLOBAL"] = "GLOBAL";
182
- DiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
183
- DiscountType["SHIPPING"] = "SHIPPING";
184
- })(DiscountType || (DiscountType = {}));
185
- export var DiscountReason;
186
- (function (DiscountReason) {
187
- DiscountReason["UNSPECIFIED"] = "UNSPECIFIED";
188
- DiscountReason["EXCHANGED_ITEMS"] = "EXCHANGED_ITEMS";
189
- DiscountReason["BILLING_ADJUSTMENT"] = "BILLING_ADJUSTMENT";
190
- })(DiscountReason || (DiscountReason = {}));
191
- export var LineItemQuantityChangeType;
192
- (function (LineItemQuantityChangeType) {
193
- /** Quantity increased. */
194
- LineItemQuantityChangeType["QUANTITY_INCREASED"] = "QUANTITY_INCREASED";
195
- /** Quantity decreased. */
196
- LineItemQuantityChangeType["QUANTITY_DECREASED"] = "QUANTITY_DECREASED";
197
- })(LineItemQuantityChangeType || (LineItemQuantityChangeType = {}));
198
- export var ActivityType;
199
- (function (ActivityType) {
200
- ActivityType["ORDER_REFUNDED"] = "ORDER_REFUNDED";
201
- ActivityType["ORDER_PLACED"] = "ORDER_PLACED";
202
- ActivityType["ORDER_PAID"] = "ORDER_PAID";
203
- ActivityType["ORDER_FULFILLED"] = "ORDER_FULFILLED";
204
- ActivityType["ORDER_NOT_FULFILLED"] = "ORDER_NOT_FULFILLED";
205
- ActivityType["ORDER_CANCELED"] = "ORDER_CANCELED";
206
- ActivityType["DOWNLOAD_LINK_SENT"] = "DOWNLOAD_LINK_SENT";
207
- ActivityType["TRACKING_NUMBER_ADDED"] = "TRACKING_NUMBER_ADDED";
208
- ActivityType["TRACKING_NUMBER_EDITED"] = "TRACKING_NUMBER_EDITED";
209
- ActivityType["TRACKING_LINK_ADDED"] = "TRACKING_LINK_ADDED";
210
- ActivityType["SHIPPING_CONFIRMATION_EMAIL_SENT"] = "SHIPPING_CONFIRMATION_EMAIL_SENT";
211
- ActivityType["INVOICE_ADDED"] = "INVOICE_ADDED";
212
- ActivityType["INVOICE_REMOVED"] = "INVOICE_REMOVED";
213
- ActivityType["INVOICE_SENT"] = "INVOICE_SENT";
214
- ActivityType["FULFILLER_EMAIL_SENT"] = "FULFILLER_EMAIL_SENT";
215
- ActivityType["SHIPPING_ADDRESS_EDITED"] = "SHIPPING_ADDRESS_EDITED";
216
- ActivityType["EMAIL_EDITED"] = "EMAIL_EDITED";
217
- ActivityType["PICKUP_READY_EMAIL_SENT"] = "PICKUP_READY_EMAIL_SENT";
218
- ActivityType["CUSTOM_ACTIVITY"] = "CUSTOM_ACTIVITY";
219
- ActivityType["MERCHANT_COMMENT"] = "MERCHANT_COMMENT";
220
- ActivityType["ORDER_CREATED_FROM_EXCHANGE"] = "ORDER_CREATED_FROM_EXCHANGE";
221
- ActivityType["NEW_EXCHANGE_ORDER_CREATED"] = "NEW_EXCHANGE_ORDER_CREATED";
222
- ActivityType["ORDER_PARTIALLY_PAID"] = "ORDER_PARTIALLY_PAID";
223
- ActivityType["DRAFT_ORDER_CHANGES_APPLIED"] = "DRAFT_ORDER_CHANGES_APPLIED";
224
- ActivityType["SAVED_PAYMENT_METHOD"] = "SAVED_PAYMENT_METHOD";
225
- /** @documentationMaturity preview */
226
- ActivityType["PAYMENT_PENDING"] = "PAYMENT_PENDING";
227
- /** @documentationMaturity preview */
228
- ActivityType["PAYMENT_CANCELED"] = "PAYMENT_CANCELED";
229
- /** @documentationMaturity preview */
230
- ActivityType["PAYMENT_DECLINED"] = "PAYMENT_DECLINED";
231
- /** @documentationMaturity preview */
232
- ActivityType["ORDER_PENDING"] = "ORDER_PENDING";
233
- /** @documentationMaturity preview */
234
- ActivityType["ORDER_REJECTED"] = "ORDER_REJECTED";
235
- })(ActivityType || (ActivityType = {}));
236
- export var AttributionSource;
237
- (function (AttributionSource) {
238
- AttributionSource["UNSPECIFIED"] = "UNSPECIFIED";
239
- AttributionSource["FACEBOOK_ADS"] = "FACEBOOK_ADS";
240
- })(AttributionSource || (AttributionSource = {}));
241
- export var ChannelType;
242
- (function (ChannelType) {
243
- /** Unspecified sales channel. This value is not supported. */
244
- ChannelType["UNSPECIFIED"] = "UNSPECIFIED";
245
- /** A web client. */
246
- ChannelType["WEB"] = "WEB";
247
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
248
- ChannelType["POS"] = "POS";
249
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
250
- ChannelType["EBAY"] = "EBAY";
251
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
252
- ChannelType["AMAZON"] = "AMAZON";
253
- /** Other sales platform. */
254
- ChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
255
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
256
- ChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
257
- /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
258
- ChannelType["WIX_INVOICES"] = "WIX_INVOICES";
259
- /** Wix merchant backoffice. */
260
- ChannelType["BACKOFFICE_MERCHANT"] = "BACKOFFICE_MERCHANT";
261
- /** Wish sales channel. */
262
- ChannelType["WISH"] = "WISH";
263
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
264
- ChannelType["CLASS_PASS"] = "CLASS_PASS";
265
- /** Global-E sales channel. */
266
- ChannelType["GLOBAL_E"] = "GLOBAL_E";
267
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
268
- ChannelType["FACEBOOK"] = "FACEBOOK";
269
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
270
- ChannelType["ETSY"] = "ETSY";
271
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
272
- ChannelType["TIKTOK"] = "TIKTOK";
273
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
274
- ChannelType["FAIRE_COM"] = "FAIRE_COM";
275
- })(ChannelType || (ChannelType = {}));
276
- export var ScheduledAction;
277
- (function (ScheduledAction) {
278
- ScheduledAction["UNSPECIFIED"] = "UNSPECIFIED";
279
- /** Whether payment will be auto-voided when duration passes */
280
- ScheduledAction["VOID"] = "VOID";
281
- /** Whether payment will be auto-captured when duration passes */
282
- ScheduledAction["CAPTURE"] = "CAPTURE";
283
- })(ScheduledAction || (ScheduledAction = {}));
284
- export var DurationUnit;
285
- (function (DurationUnit) {
286
- DurationUnit["UNKNOWN_DURATION_UNIT"] = "UNKNOWN_DURATION_UNIT";
287
- DurationUnit["MINUTES"] = "MINUTES";
288
- DurationUnit["HOURS"] = "HOURS";
289
- DurationUnit["DAYS"] = "DAYS";
290
- })(DurationUnit || (DurationUnit = {}));
291
- export var PaymentCollectabilityStatus;
292
- (function (PaymentCollectabilityStatus) {
293
- PaymentCollectabilityStatus["UNKNOWN"] = "UNKNOWN";
294
- PaymentCollectabilityStatus["COLLECTABLE"] = "COLLECTABLE";
295
- PaymentCollectabilityStatus["NONCOLLECTABLE_ORDER_IS_CANCELLED"] = "NONCOLLECTABLE_ORDER_IS_CANCELLED";
296
- PaymentCollectabilityStatus["NONCOLLECTABLE_ORDER_IS_PAID"] = "NONCOLLECTABLE_ORDER_IS_PAID";
297
- PaymentCollectabilityStatus["NONCOLLECTABLE_MISSING_PAYMENT_METHOD"] = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD";
298
- PaymentCollectabilityStatus["NONCOLLECTABLE_ORDER_IS_PENDING"] = "NONCOLLECTABLE_ORDER_IS_PENDING";
299
- PaymentCollectabilityStatus["NONCOLLECTABLE_ORDER_IS_REJECTED"] = "NONCOLLECTABLE_ORDER_IS_REJECTED";
300
- PaymentCollectabilityStatus["NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"] = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS";
301
- })(PaymentCollectabilityStatus || (PaymentCollectabilityStatus = {}));
302
- export var RefundableStatus;
303
- (function (RefundableStatus) {
304
- RefundableStatus["NOT_REFUNDABLE"] = "NOT_REFUNDABLE";
305
- RefundableStatus["MANUAL"] = "MANUAL";
306
- RefundableStatus["REFUNDABLE"] = "REFUNDABLE";
307
- })(RefundableStatus || (RefundableStatus = {}));
308
- export var NonRefundableReason;
309
- (function (NonRefundableReason) {
310
- NonRefundableReason["NONE"] = "NONE";
311
- NonRefundableReason["ALREADY_REFUNDED"] = "ALREADY_REFUNDED";
312
- NonRefundableReason["PROVIDER_IS_DOWN"] = "PROVIDER_IS_DOWN";
313
- NonRefundableReason["INTERNAL_ERROR"] = "INTERNAL_ERROR";
314
- NonRefundableReason["NOT_PAID"] = "NOT_PAID";
315
- NonRefundableReason["ACCESS_DENIED"] = "ACCESS_DENIED";
316
- NonRefundableReason["ZERO_PRICE"] = "ZERO_PRICE";
317
- NonRefundableReason["DISABLED_BY_PROVIDER"] = "DISABLED_BY_PROVIDER";
318
- NonRefundableReason["PENDING_REFUND"] = "PENDING_REFUND";
319
- NonRefundableReason["FORBIDDEN"] = "FORBIDDEN";
320
- NonRefundableReason["TRANSACTION_NOT_FOUND"] = "TRANSACTION_NOT_FOUND";
321
- NonRefundableReason["ORDER_IS_PENDING"] = "ORDER_IS_PENDING";
322
- NonRefundableReason["ORDER_IS_REJECTED"] = "ORDER_IS_REJECTED";
323
- })(NonRefundableReason || (NonRefundableReason = {}));
324
- export var ManuallyRefundableReason;
325
- (function (ManuallyRefundableReason) {
326
- ManuallyRefundableReason["EXPIRED"] = "EXPIRED";
327
- ManuallyRefundableReason["NOT_SUPPORTED"] = "NOT_SUPPORTED";
328
- ManuallyRefundableReason["OFFLINE"] = "OFFLINE";
329
- ManuallyRefundableReason["REQUIRES_CARD_READER"] = "REQUIRES_CARD_READER";
330
- })(ManuallyRefundableReason || (ManuallyRefundableReason = {}));
331
- export var RestockType;
332
- (function (RestockType) {
333
- RestockType["NO_ITEMS"] = "NO_ITEMS";
334
- RestockType["ALL_ITEMS"] = "ALL_ITEMS";
335
- RestockType["SOME_ITEMS"] = "SOME_ITEMS";
336
- })(RestockType || (RestockType = {}));
337
- export var TransactionStatus;
338
- (function (TransactionStatus) {
339
- TransactionStatus["UNDEFINED"] = "UNDEFINED";
340
- TransactionStatus["APPROVED"] = "APPROVED";
341
- TransactionStatus["PENDING"] = "PENDING";
342
- TransactionStatus["PENDING_MERCHANT"] = "PENDING_MERCHANT";
343
- TransactionStatus["CANCELED"] = "CANCELED";
344
- TransactionStatus["DECLINED"] = "DECLINED";
345
- TransactionStatus["REFUNDED"] = "REFUNDED";
346
- TransactionStatus["PARTIALLY_REFUNDED"] = "PARTIALLY_REFUNDED";
347
- TransactionStatus["AUTHORIZED"] = "AUTHORIZED";
348
- TransactionStatus["VOIDED"] = "VOIDED";
349
- })(TransactionStatus || (TransactionStatus = {}));
350
- export var AuthorizationCaptureStatus;
351
- (function (AuthorizationCaptureStatus) {
352
- AuthorizationCaptureStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
353
- /** Capture operation still in progress. */
354
- AuthorizationCaptureStatus["PENDING"] = "PENDING";
355
- /** Capture operation succeeded. */
356
- AuthorizationCaptureStatus["SUCCEEDED"] = "SUCCEEDED";
357
- /** Capture operation failed. */
358
- AuthorizationCaptureStatus["FAILED"] = "FAILED";
359
- })(AuthorizationCaptureStatus || (AuthorizationCaptureStatus = {}));
360
- export var AuthorizationVoidStatus;
361
- (function (AuthorizationVoidStatus) {
362
- AuthorizationVoidStatus["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
363
- /** Void operation still in progress. */
364
- AuthorizationVoidStatus["PENDING"] = "PENDING";
365
- /** Void operation succeeded. */
366
- AuthorizationVoidStatus["SUCCEEDED"] = "SUCCEEDED";
367
- /** Void operation failed. */
368
- AuthorizationVoidStatus["FAILED"] = "FAILED";
369
- })(AuthorizationVoidStatus || (AuthorizationVoidStatus = {}));
370
- /** Reason the authorization was voided. */
371
- export var Reason;
372
- (function (Reason) {
373
- Reason["UNKNOWN_REASON"] = "UNKNOWN_REASON";
374
- /** Authorization was voided by user. */
375
- Reason["MANUAL"] = "MANUAL";
376
- /** Authorization passed execution date. */
377
- Reason["SCHEDULED"] = "SCHEDULED";
378
- })(Reason || (Reason = {}));
379
- export var ActionType;
380
- (function (ActionType) {
381
- ActionType["UNKNOWN_ACTION_TYPE"] = "UNKNOWN_ACTION_TYPE";
382
- ActionType["VOID"] = "VOID";
383
- ActionType["CAPTURE"] = "CAPTURE";
384
- })(ActionType || (ActionType = {}));
385
- export var MembershipPaymentStatus;
386
- (function (MembershipPaymentStatus) {
387
- /** Payment was charged. */
388
- MembershipPaymentStatus["CHARGED"] = "CHARGED";
389
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
390
- MembershipPaymentStatus["CHARGE_FAILED"] = "CHARGE_FAILED";
391
- })(MembershipPaymentStatus || (MembershipPaymentStatus = {}));
392
- /** Refund transaction status. */
393
- export var RefundStatus;
394
- (function (RefundStatus) {
395
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
396
- RefundStatus["PENDING"] = "PENDING";
397
- /** Refund transaction succeeded. */
398
- RefundStatus["SUCCEEDED"] = "SUCCEEDED";
399
- /** Refund transaction failed. */
400
- RefundStatus["FAILED"] = "FAILED";
401
- /** Refund request acknowledged, and will be executed soon. */
402
- RefundStatus["SCHEDULED"] = "SCHEDULED";
403
- /** Refund was initiated on payment provider side. */
404
- RefundStatus["STARTED"] = "STARTED";
405
- })(RefundStatus || (RefundStatus = {}));
406
- export var WebhookIdentityType;
407
- (function (WebhookIdentityType) {
408
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
409
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
410
- WebhookIdentityType["MEMBER"] = "MEMBER";
411
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
412
- WebhookIdentityType["APP"] = "APP";
413
- })(WebhookIdentityType || (WebhookIdentityType = {}));
414
- export var TextDetection;
415
- (function (TextDetection) {
416
- /** No detection was made */
417
- TextDetection["UNKNOWN_TEXT_DETECTION"] = "UNKNOWN_TEXT_DETECTION";
418
- /** The image contains text */
419
- TextDetection["CONTAINS_TEXT"] = "CONTAINS_TEXT";
420
- /** The image does not contain text */
421
- TextDetection["NO_TEXT"] = "NO_TEXT";
422
- })(TextDetection || (TextDetection = {}));
423
- export var AnimationDetection;
424
- (function (AnimationDetection) {
425
- /** No detection was made */
426
- AnimationDetection["UNKNOWN_ANIMATION_DETECTION"] = "UNKNOWN_ANIMATION_DETECTION";
427
- /** The image contains animation */
428
- AnimationDetection["CONTAINS_ANIMATION"] = "CONTAINS_ANIMATION";
429
- /** The image does not contain animation */
430
- AnimationDetection["NO_ANIMATION"] = "NO_ANIMATION";
431
- })(AnimationDetection || (AnimationDetection = {}));
432
- export var PreviewEmailType;
433
- (function (PreviewEmailType) {
434
- PreviewEmailType["ORDER_PLACED"] = "ORDER_PLACED";
435
- PreviewEmailType["DOWNLOAD_LINKS"] = "DOWNLOAD_LINKS";
436
- PreviewEmailType["ORDER_SHIPPED"] = "ORDER_SHIPPED";
437
- PreviewEmailType["ORDER_READY_FOR_PICKUP"] = "ORDER_READY_FOR_PICKUP";
438
- })(PreviewEmailType || (PreviewEmailType = {}));
439
- /**
440
- * Represents the actual state of the application on site. Do not confuse with the State in the old MetaSiteDTO,
441
- * which has less values and doesn't have 1-to-1 correspondence with this one (this one is exact and correct!)
442
- */
443
- export var State;
444
- (function (State) {
445
- State["UNKNOWN"] = "UNKNOWN";
446
- /** App is installed on a site. */
447
- State["ENABLED"] = "ENABLED";
448
- /** App is removed from a site (but we preserve it just in case). */
449
- State["DISABLED"] = "DISABLED";
450
- /** App is in "demo" mode, meaning that it's in read-only mode (it's in a template OR not installed yet). */
451
- State["TEMPLATE"] = "TEMPLATE";
452
- /** App is not installed, there is a user intention for it only (user will see the pimpl in the editor). */
453
- State["PENDING"] = "PENDING";
454
- })(State || (State = {}));
455
- export var Namespace;
456
- (function (Namespace) {
457
- Namespace["UNKNOWN_NAMESPACE"] = "UNKNOWN_NAMESPACE";
458
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
459
- Namespace["WIX"] = "WIX";
460
- /** 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. */
461
- Namespace["SHOUT_OUT"] = "SHOUT_OUT";
462
- /** 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. */
463
- Namespace["ALBUMS"] = "ALBUMS";
464
- /** 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. */
465
- Namespace["WIX_STORES_TEST_DRIVE"] = "WIX_STORES_TEST_DRIVE";
466
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
467
- Namespace["HOTELS"] = "HOTELS";
468
- /** 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. */
469
- Namespace["CLUBS"] = "CLUBS";
470
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
471
- Namespace["ONBOARDING_DRAFT"] = "ONBOARDING_DRAFT";
472
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
473
- Namespace["DEV_SITE"] = "DEV_SITE";
474
- /** 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. */
475
- Namespace["LOGOS"] = "LOGOS";
476
- /** 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. */
477
- Namespace["VIDEO_MAKER"] = "VIDEO_MAKER";
478
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
479
- Namespace["PARTNER_DASHBOARD"] = "PARTNER_DASHBOARD";
480
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
481
- Namespace["DEV_CENTER_COMPANY"] = "DEV_CENTER_COMPANY";
482
- /**
483
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
484
- *
485
- * Meta site with this namespace will *not* be shown in a user's site list by default.
486
- */
487
- Namespace["HTML_DRAFT"] = "HTML_DRAFT";
488
- /**
489
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
490
- * Will be accessible from Site List and will not have a website app.
491
- * Once the user attaches a site, the site will become a regular wixsite.
492
- */
493
- Namespace["SITELESS_BUSINESS"] = "SITELESS_BUSINESS";
494
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
495
- Namespace["CREATOR_ECONOMY"] = "CREATOR_ECONOMY";
496
- /** It is to be used in the Business First efforts. */
497
- Namespace["DASHBOARD_FIRST"] = "DASHBOARD_FIRST";
498
- /** Bookings business flow with no site. */
499
- Namespace["ANYWHERE"] = "ANYWHERE";
500
- /** Namespace for Headless Backoffice with no editor */
501
- Namespace["HEADLESS"] = "HEADLESS";
502
- /**
503
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
504
- * The site will be used for account level CSM feature for enterprise
505
- */
506
- Namespace["ACCOUNT_MASTER_CMS"] = "ACCOUNT_MASTER_CMS";
507
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
508
- Namespace["RISE"] = "RISE";
509
- /**
510
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
511
- * There's a blank site behind the scene but it's blank).
512
- * The Mobile company will be the owner of this namespace.
513
- */
514
- Namespace["BRANDED_FIRST"] = "BRANDED_FIRST";
515
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
516
- Namespace["NOWNIA"] = "NOWNIA";
517
- /**
518
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
519
- * The Partners company owns this namespace.
520
- */
521
- Namespace["UGC_TEMPLATE"] = "UGC_TEMPLATE";
522
- /** Codux Headless Sites */
523
- Namespace["CODUX"] = "CODUX";
524
- /** Bobb - AI Design Creator. */
525
- Namespace["MEDIA_DESIGN_CREATOR"] = "MEDIA_DESIGN_CREATOR";
526
- /**
527
- * Shared Blog Site is a unique single site across Enterprise account,
528
- * This site will hold all Blog posts related to the Marketing product.
529
- */
530
- Namespace["SHARED_BLOG_ENTERPRISE"] = "SHARED_BLOG_ENTERPRISE";
531
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
532
- Namespace["STANDALONE_FORMS"] = "STANDALONE_FORMS";
533
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
534
- Namespace["STANDALONE_EVENTS"] = "STANDALONE_EVENTS";
535
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
536
- Namespace["MIMIR"] = "MIMIR";
537
- })(Namespace || (Namespace = {}));
538
- export var SortOrder;
539
- (function (SortOrder) {
540
- SortOrder["ASC"] = "ASC";
541
- SortOrder["DESC"] = "DESC";
542
- })(SortOrder || (SortOrder = {}));
543
- export var VersioningMode;
544
- (function (VersioningMode) {
545
- /** use default versioning mode agreed with search team */
546
- VersioningMode["DEFAULT"] = "DEFAULT";
547
- /** execute only if version is greater than existing */
548
- VersioningMode["GREATER_THAN"] = "GREATER_THAN";
549
- /** execute only if version is greater or equal to existing */
550
- VersioningMode["GREATER_OR_EQUAL"] = "GREATER_OR_EQUAL";
551
- })(VersioningMode || (VersioningMode = {}));
552
- export var OrderApprovalStrategy;
553
- (function (OrderApprovalStrategy) {
554
- /** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
555
- OrderApprovalStrategy["DEFAULT"] = "DEFAULT";
556
- /** Order is automatically approved **only** after receiving payment. */
557
- OrderApprovalStrategy["PAYMENT_RECEIVED"] = "PAYMENT_RECEIVED";
558
- /** Order is automatically approved when payment method is saved for it. */
559
- OrderApprovalStrategy["PAYMENT_METHOD_SAVED"] = "PAYMENT_METHOD_SAVED";
560
- })(OrderApprovalStrategy || (OrderApprovalStrategy = {}));
561
- /** Type of selected payment option for catalog item */
562
- export var DeltaPaymentOptionType;
563
- (function (DeltaPaymentOptionType) {
564
- /** Irrelevant */
565
- DeltaPaymentOptionType["UNKNOWN_PAYMENT_OPTION"] = "UNKNOWN_PAYMENT_OPTION";
566
- /** The entire payment for the given item will happen after checkout. */
567
- DeltaPaymentOptionType["FULL_PAYMENT_OFFLINE"] = "FULL_PAYMENT_OFFLINE";
568
- /**
569
- * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
570
- * Note: when this option is used, the price will be 0.
571
- */
572
- DeltaPaymentOptionType["MEMBERSHIP_OFFLINE"] = "MEMBERSHIP_OFFLINE";
573
- })(DeltaPaymentOptionType || (DeltaPaymentOptionType = {}));
574
- export var InventoryAction;
575
- (function (InventoryAction) {
576
- /** Restock inventory */
577
- InventoryAction["RESTOCK"] = "RESTOCK";
578
- /** Decrease inventory. Without failing on negative inventory. */
579
- InventoryAction["DECREASE"] = "DECREASE";
580
- })(InventoryAction || (InventoryAction = {}));
581
- export var Placement;
582
- (function (Placement) {
583
- Placement["Unknown"] = "Unknown";
584
- Placement["Replace"] = "Replace";
585
- Placement["Before"] = "Before";
586
- Placement["After"] = "After";
587
- })(Placement || (Placement = {}));
588
- export var SubdivisionType;
589
- (function (SubdivisionType) {
590
- SubdivisionType["UNKNOWN_SUBDIVISION_TYPE"] = "UNKNOWN_SUBDIVISION_TYPE";
591
- /** State */
592
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_1"] = "ADMINISTRATIVE_AREA_LEVEL_1";
593
- /** County */
594
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_2"] = "ADMINISTRATIVE_AREA_LEVEL_2";
595
- /** City/town */
596
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_3"] = "ADMINISTRATIVE_AREA_LEVEL_3";
597
- /** Neighborhood/quarter */
598
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_4"] = "ADMINISTRATIVE_AREA_LEVEL_4";
599
- /** Street/block */
600
- SubdivisionType["ADMINISTRATIVE_AREA_LEVEL_5"] = "ADMINISTRATIVE_AREA_LEVEL_5";
601
- /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
602
- SubdivisionType["COUNTRY"] = "COUNTRY";
603
- })(SubdivisionType || (SubdivisionType = {}));
604
- export var SourceType;
605
- (function (SourceType) {
606
- SourceType["UNKNOWN_SOURCE_TYPE"] = "UNKNOWN_SOURCE_TYPE";
607
- SourceType["WIX_APP"] = "WIX_APP";
608
- SourceType["EXTERNAL"] = "EXTERNAL";
609
- SourceType["ADMIN"] = "ADMIN";
610
- SourceType["OTHER"] = "OTHER";
611
- })(SourceType || (SourceType = {}));
612
- export var CustomFieldGroup;
613
- (function (CustomFieldGroup) {
614
- CustomFieldGroup["UNKNOWN_CUSTOM_FIELD_GROUP"] = "UNKNOWN_CUSTOM_FIELD_GROUP";
615
- CustomFieldGroup["BUSINESS_DETAILS"] = "BUSINESS_DETAILS";
616
- CustomFieldGroup["CUSTOMER_DETAILS"] = "CUSTOMER_DETAILS";
617
- CustomFieldGroup["DOCUMENT"] = "DOCUMENT";
618
- CustomFieldGroup["FOOTER"] = "FOOTER";
619
- CustomFieldGroup["OTHER"] = "OTHER";
620
- })(CustomFieldGroup || (CustomFieldGroup = {}));
621
- export var ValueType;
622
- (function (ValueType) {
623
- ValueType["UNKNOWN_VALUE_TYPE"] = "UNKNOWN_VALUE_TYPE";
624
- ValueType["STRING"] = "STRING";
625
- ValueType["DATE"] = "DATE";
626
- ValueType["BOOLEAN"] = "BOOLEAN";
627
- ValueType["NUMBER"] = "NUMBER";
628
- })(ValueType || (ValueType = {}));
629
- export var DepositType;
630
- (function (DepositType) {
631
- DepositType["UNKNOWN"] = "UNKNOWN";
632
- DepositType["FLAT"] = "FLAT";
633
- DepositType["PERCENTAGE"] = "PERCENTAGE";
634
- })(DepositType || (DepositType = {}));
635
- /**
636
- * InvoiceStatus allowed transitions based on current status:
637
- * Draft -> Deleted, Paid, Partially Paid, Sent
638
- * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
639
- * Processing -> PartiallyPaid, Paid, Sent
640
- * Paid -> Void
641
- * PartiallyPaid -> Void, (PartialAndOverdue)
642
- * Void -> Deleted
643
- * Deleted
644
- */
645
- export var InvoiceStatus;
646
- (function (InvoiceStatus) {
647
- InvoiceStatus["Draft"] = "Draft";
648
- InvoiceStatus["Sent"] = "Sent";
649
- InvoiceStatus["Processing"] = "Processing";
650
- InvoiceStatus["Paid"] = "Paid";
651
- InvoiceStatus["Overdue"] = "Overdue";
652
- InvoiceStatus["Void"] = "Void";
653
- InvoiceStatus["Deleted"] = "Deleted";
654
- InvoiceStatus["PartiallyPaid"] = "PartiallyPaid";
655
- InvoiceStatus["PartialAndOverdue"] = "PartialAndOverdue";
656
- })(InvoiceStatus || (InvoiceStatus = {}));
657
- /**
658
- * Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
659
- * Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
660
- * 2nd step is an actual charge of prepared payment gateway order. This could be done either
661
- * via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
662
- * or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
663
- * @param ecomOrderId - Ecom order ID.
664
- * @param amount - Amount to collect
665
- * @public
666
- * @documentationMaturity preview
667
- * @requiredField amount
668
- * @requiredField ecomOrderId
669
- * @permissionId ECOM.COLLECT_PAYMENTS
670
- * @permissionScope Manage Restaurants - all permissions
671
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
672
- * @permissionScope Picasso private app mega scope
673
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
674
- * @applicableIdentity APP
675
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.PreparePaymentCollection
676
- */
677
- export async function preparePaymentCollection(ecomOrderId, amount, options) {
678
- // @ts-ignore
679
- const { httpClient, sideEffects } = arguments[3];
680
- const payload = renameKeysFromSDKRequestToRESTRequest({
681
- ecomOrderId: ecomOrderId,
682
- amount: amount,
683
- paymentGatewayOrderId: options?.paymentGatewayOrderId,
684
- delayedCapture: options?.delayedCapture,
685
- delayedCaptureSettings: options?.delayedCaptureSettings,
686
- });
687
- const reqOpts = ambassadorWixEcomV1Order.preparePaymentCollection(payload);
688
- sideEffects?.onSiteCall?.();
689
- try {
690
- const result = await httpClient.request(reqOpts);
691
- sideEffects?.onSuccess?.(result);
692
- return renameKeysFromRESTResponseToSDKResponse(result.data);
693
- }
694
- catch (err) {
695
- const transformedError = sdkTransformError(err, {
696
- spreadPathsToArguments: {},
697
- explicitPathsToArguments: {
698
- ecomOrderId: '$[0]',
699
- amount: '$[1]',
700
- paymentGatewayOrderId: '$[2].paymentGatewayOrderId',
701
- delayedCapture: '$[2].delayedCapture',
702
- delayedCaptureSettings: '$[2].delayedCaptureSettings',
703
- },
704
- singleArgumentUnchanged: false,
705
- }, ['ecomOrderId', 'amount', 'options']);
706
- sideEffects?.onError?.(err);
707
- throw transformedError;
708
- }
709
- }
710
- /**
711
- * Provides payment collectability status for given order. If payment collection is possible
712
- * response will contain collectable amount for given ecom order. If not - response will contain
713
- * reason why payment collection is not possible.
714
- * @param ecomOrderId - Ecom order ID.
715
- * @public
716
- * @documentationMaturity preview
717
- * @requiredField ecomOrderId
718
- * @permissionId ECOM.COLLECT_PAYMENTS
719
- * @permissionScope Manage Restaurants - all permissions
720
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
721
- * @permissionScope Picasso private app mega scope
722
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
723
- * @applicableIdentity APP
724
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetPaymentCollectabilityStatus
725
- */
726
- export async function getPaymentCollectabilityStatus(ecomOrderId) {
727
- // @ts-ignore
728
- const { httpClient, sideEffects } = arguments[1];
729
- const payload = renameKeysFromSDKRequestToRESTRequest({
730
- ecomOrderId: ecomOrderId,
731
- });
732
- const reqOpts = ambassadorWixEcomV1Order.getPaymentCollectabilityStatus(payload);
733
- sideEffects?.onSiteCall?.();
734
- try {
735
- const result = await httpClient.request(reqOpts);
736
- sideEffects?.onSuccess?.(result);
737
- return renameKeysFromRESTResponseToSDKResponse(result.data);
738
- }
739
- catch (err) {
740
- const transformedError = sdkTransformError(err, {
741
- spreadPathsToArguments: {},
742
- explicitPathsToArguments: { ecomOrderId: '$[0]' },
743
- singleArgumentUnchanged: false,
744
- }, ['ecomOrderId']);
745
- sideEffects?.onError?.(err);
746
- throw transformedError;
747
- }
748
- }
749
- /**
750
- * Records and approves new manual payment with provided custom amount on given order.
751
- * Existing pending payments are ignored.
752
- * Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
753
- * @param orderId - Order ID.
754
- * @param amount - Amount to be recorded as approved manual payment for given order
755
- * @internal
756
- * @documentationMaturity preview
757
- * @requiredField amount
758
- * @requiredField orderId
759
- * @permissionId ECOM.COLLECT_PAYMENTS
760
- * @permissionScope Manage Restaurants - all permissions
761
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
762
- * @permissionScope Picasso private app mega scope
763
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
764
- * @applicableIdentity APP
765
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.RecordManuallyCollectedPayment
766
- */
767
- export async function recordManuallyCollectedPayment(orderId, amount) {
768
- // @ts-ignore
769
- const { httpClient, sideEffects } = arguments[2];
770
- const payload = renameKeysFromSDKRequestToRESTRequest({
771
- orderId: orderId,
772
- amount: amount,
773
- });
774
- const reqOpts = ambassadorWixEcomV1Order.recordManuallyCollectedPayment(payload);
775
- sideEffects?.onSiteCall?.();
776
- try {
777
- const result = await httpClient.request(reqOpts);
778
- sideEffects?.onSuccess?.(result);
779
- }
780
- catch (err) {
781
- const transformedError = sdkTransformError(err, {
782
- spreadPathsToArguments: {},
783
- explicitPathsToArguments: { orderId: '$[0]', amount: '$[1]' },
784
- singleArgumentUnchanged: false,
785
- }, ['orderId', 'amount']);
786
- sideEffects?.onError?.(err);
787
- throw transformedError;
788
- }
789
- }
790
- /**
791
- * Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
792
- * In case the order already has an offline payment transaction associated with it
793
- * (usually when manual payment method is chosen at checkout) - This transaction will become approved.
794
- * In case the order has no payment transactions associated with it
795
- * (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
796
- * will be created and approved.
797
- * @param ecomOrderId - Ecom order ID.
798
- * @internal
799
- * @documentationMaturity preview
800
- * @requiredField ecomOrderId
801
- * @permissionId ECOM.MODIFY_ORDERS
802
- * @permissionScope Manage Stores - all permissions
803
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
804
- * @permissionScope Manage Restaurants - all permissions
805
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
806
- * @permissionScope Manage eCommerce - all permissions
807
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
808
- * @permissionScope Picasso private app mega scope
809
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
810
- * @permissionScope Manage Orders
811
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
812
- * @applicableIdentity APP
813
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.MarkOrderAsPaid
814
- */
815
- export async function paymentCollectionMarkOrderAsPaid(ecomOrderId) {
816
- // @ts-ignore
817
- const { httpClient, sideEffects } = arguments[1];
818
- const payload = renameKeysFromSDKRequestToRESTRequest({
819
- ecomOrderId: ecomOrderId,
820
- });
821
- const reqOpts = ambassadorWixEcomV1Order.paymentCollectionMarkOrderAsPaid(payload);
822
- sideEffects?.onSiteCall?.();
823
- try {
824
- const result = await httpClient.request(reqOpts);
825
- sideEffects?.onSuccess?.(result);
826
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
827
- {
828
- transformFn: transformRESTImageToSDKImage,
829
- paths: [{ path: 'order.lineItems.image' }],
830
- },
831
- {
832
- transformFn: transformRESTAddressToSDKAddress,
833
- paths: [
834
- { path: 'order.billingInfo.address' },
835
- {
836
- path: 'order.shippingInfo.logistics.shippingDestination.address',
837
- },
838
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
839
- { path: 'order.recipientInfo.address' },
840
- ],
841
- },
842
- ]));
843
- }
844
- catch (err) {
845
- const transformedError = sdkTransformError(err, {
846
- spreadPathsToArguments: {},
847
- explicitPathsToArguments: { ecomOrderId: '$[0]' },
848
- singleArgumentUnchanged: false,
849
- }, ['ecomOrderId']);
850
- sideEffects?.onError?.(err);
851
- throw transformedError;
852
- }
853
- }
854
- /**
855
- * Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
856
- * @param ecomOrderIds - IDs of orders to mark as paid.
857
- * @internal
858
- * @documentationMaturity preview
859
- * @requiredField ecomOrderIds
860
- * @permissionId ECOM.MODIFY_ORDERS
861
- * @permissionScope Manage Stores - all permissions
862
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
863
- * @permissionScope Manage Restaurants - all permissions
864
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
865
- * @permissionScope Manage eCommerce - all permissions
866
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
867
- * @permissionScope Picasso private app mega scope
868
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
869
- * @permissionScope Manage Orders
870
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
871
- * @applicableIdentity APP
872
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.BulkMarkOrdersAsPaid
873
- */
874
- export async function paymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds) {
875
- // @ts-ignore
876
- const { httpClient, sideEffects } = arguments[1];
877
- const payload = renameKeysFromSDKRequestToRESTRequest({
878
- ecomOrderIds: ecomOrderIds,
879
- });
880
- const reqOpts = ambassadorWixEcomV1Order.paymentCollectionBulkMarkOrdersAsPaid(payload);
881
- sideEffects?.onSiteCall?.();
882
- try {
883
- const result = await httpClient.request(reqOpts);
884
- sideEffects?.onSuccess?.(result);
885
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
886
- {
887
- transformFn: transformRESTImageToSDKImage,
888
- paths: [{ path: 'results.item.lineItems.image' }],
889
- },
890
- {
891
- transformFn: transformRESTAddressToSDKAddress,
892
- paths: [
893
- { path: 'results.item.billingInfo.address' },
894
- {
895
- path: 'results.item.shippingInfo.logistics.shippingDestination.address',
896
- },
897
- {
898
- path: 'results.item.shippingInfo.logistics.pickupDetails.address',
899
- },
900
- { path: 'results.item.recipientInfo.address' },
901
- ],
902
- },
903
- ]));
904
- }
905
- catch (err) {
906
- const transformedError = sdkTransformError(err, {
907
- spreadPathsToArguments: {},
908
- explicitPathsToArguments: { ecomOrderIds: '$[0]' },
909
- singleArgumentUnchanged: false,
910
- }, ['ecomOrderIds']);
911
- sideEffects?.onError?.(err);
912
- throw transformedError;
913
- }
914
- }
915
- /**
916
- * Checks whether this order can be refunded.
917
- * @param ecomOrderId - Order ID.
918
- * @internal
919
- * @documentationMaturity preview
920
- * @requiredField ecomOrderId
921
- * @permissionId ECOM.READ_TRANSACTIONS
922
- * @permissionScope Manage Stores - all permissions
923
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
924
- * @permissionScope Read eCommerce - all read permissions
925
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
926
- * @permissionScope Read Orders
927
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
928
- * @permissionScope Read Stores - all read permissions
929
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
930
- * @permissionScope Manage Restaurants - all permissions
931
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
932
- * @permissionScope Manage eCommerce - all permissions
933
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
934
- * @permissionScope Picasso private app mega scope
935
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
936
- * @permissionScope Manage Orders
937
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
938
- * @applicableIdentity APP
939
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.GetRefundabilityStatus
940
- */
941
- export async function getRefundabilityStatus(ecomOrderId) {
942
- // @ts-ignore
943
- const { httpClient, sideEffects } = arguments[1];
944
- const payload = renameKeysFromSDKRequestToRESTRequest({
945
- ecomOrderId: ecomOrderId,
946
- });
947
- const reqOpts = ambassadorWixEcomV1Order.getRefundabilityStatus(payload);
948
- sideEffects?.onSiteCall?.();
949
- try {
950
- const result = await httpClient.request(reqOpts);
951
- sideEffects?.onSuccess?.(result);
952
- return renameKeysFromRESTResponseToSDKResponse(result.data);
953
- }
954
- catch (err) {
955
- const transformedError = sdkTransformError(err, {
956
- spreadPathsToArguments: {},
957
- explicitPathsToArguments: { ecomOrderId: '$[0]' },
958
- singleArgumentUnchanged: false,
959
- }, ['ecomOrderId']);
960
- sideEffects?.onError?.(err);
961
- throw transformedError;
962
- }
963
- }
964
- /**
965
- * Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
966
- * 1. An explicit amount provided in the request, or;
967
- * 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
968
- * As a result, an ID of the created payment gateway order would be returned.
969
- * You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
970
- * @param ecomOrderId - Ecom order ID.
971
- * @internal
972
- * @documentationMaturity preview
973
- * @requiredField ecomOrderId
974
- * @permissionId ECOM.MODIFY_ORDERS
975
- * @permissionScope Manage Stores - all permissions
976
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
977
- * @permissionScope Manage Restaurants - all permissions
978
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
979
- * @permissionScope Manage eCommerce - all permissions
980
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
981
- * @permissionScope Picasso private app mega scope
982
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
983
- * @permissionScope Manage Orders
984
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
985
- * @applicableIdentity APP
986
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CreatePaymentGatewayOrder
987
- */
988
- export async function paymentCollectionCreatePaymentGatewayOrder(ecomOrderId, options) {
989
- // @ts-ignore
990
- const { httpClient, sideEffects } = arguments[2];
991
- const payload = renameKeysFromSDKRequestToRESTRequest({
992
- ecomOrderId: ecomOrderId,
993
- chargedBy: options?.chargedBy,
994
- });
995
- const reqOpts = ambassadorWixEcomV1Order.paymentCollectionCreatePaymentGatewayOrder(payload);
996
- sideEffects?.onSiteCall?.();
997
- try {
998
- const result = await httpClient.request(reqOpts);
999
- sideEffects?.onSuccess?.(result);
1000
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1001
- }
1002
- catch (err) {
1003
- const transformedError = sdkTransformError(err, {
1004
- spreadPathsToArguments: {},
1005
- explicitPathsToArguments: {
1006
- ecomOrderId: '$[0]',
1007
- chargedBy: '$[1].chargedBy',
1008
- },
1009
- singleArgumentUnchanged: false,
1010
- }, ['ecomOrderId', 'options']);
1011
- sideEffects?.onError?.(err);
1012
- throw transformedError;
1013
- }
1014
- }
1015
- /** @param ecomOrderId - Order ID.
1016
- * @param memberId - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
1017
- * but a user which is using the membership on behalf of the a member
1018
- * @internal
1019
- * @documentationMaturity preview
1020
- * @requiredField ecomOrderId
1021
- * @requiredField memberId
1022
- * @requiredField options.membershipCharges.appId
1023
- * @requiredField options.membershipCharges.catalogReference
1024
- * @requiredField options.membershipCharges.catalogReference.appId
1025
- * @requiredField options.membershipCharges.catalogReference.catalogItemId
1026
- * @requiredField options.membershipCharges.membershipId
1027
- * @requiredField options.membershipCharges.membershipName
1028
- * @requiredField options.membershipCharges.membershipName.original
1029
- * @requiredField options.membershipCharges.rootCatalogItemId
1030
- * @permissionId ECOM.MODIFY_TRANSACTIONS
1031
- * @permissionScope Manage Stores - all permissions
1032
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1033
- * @permissionScope Manage Restaurants - all permissions
1034
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1035
- * @permissionScope Manage eCommerce - all permissions
1036
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1037
- * @permissionScope Picasso private app mega scope
1038
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1039
- * @permissionScope Manage Orders
1040
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1041
- * @applicableIdentity APP
1042
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.ChargeMemberships
1043
- */
1044
- export async function chargeMemberships(ecomOrderId, memberId, options) {
1045
- // @ts-ignore
1046
- const { httpClient, sideEffects } = arguments[3];
1047
- const payload = renameKeysFromSDKRequestToRESTRequest({
1048
- ecomOrderId: ecomOrderId,
1049
- memberId: memberId,
1050
- membershipCharges: options?.membershipCharges,
1051
- });
1052
- const reqOpts = ambassadorWixEcomV1Order.chargeMemberships(payload);
1053
- sideEffects?.onSiteCall?.();
1054
- try {
1055
- const result = await httpClient.request(reqOpts);
1056
- sideEffects?.onSuccess?.(result);
1057
- }
1058
- catch (err) {
1059
- const transformedError = sdkTransformError(err, {
1060
- spreadPathsToArguments: {},
1061
- explicitPathsToArguments: {
1062
- ecomOrderId: '$[0]',
1063
- memberId: '$[1]',
1064
- membershipCharges: '$[2].membershipCharges',
1065
- },
1066
- singleArgumentUnchanged: false,
1067
- }, ['ecomOrderId', 'memberId', 'options']);
1068
- sideEffects?.onError?.(err);
1069
- throw transformedError;
1070
- }
1071
- }
1072
- /**
1073
- * Calls corresponding payment providers and creates refund transactions for requested payments.
1074
- * Updates order transactions based on refund results.
1075
- * For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
1076
- * will only update order transactions.
1077
- * @param ecomOrderId - The order this refund related to
1078
- * @param payments - Refund operations information
1079
- * @internal
1080
- * @documentationMaturity preview
1081
- * @requiredField ecomOrderId
1082
- * @requiredField payments
1083
- * @requiredField payments.paymentId
1084
- * @permissionId ECOM.MODIFY_TRANSACTIONS
1085
- * @permissionScope Manage Stores - all permissions
1086
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1087
- * @permissionScope Manage Restaurants - all permissions
1088
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1089
- * @permissionScope Manage eCommerce - all permissions
1090
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1091
- * @permissionScope Picasso private app mega scope
1092
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1093
- * @permissionScope Manage Orders
1094
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1095
- * @applicableIdentity APP
1096
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.TriggerRefund
1097
- */
1098
- export async function triggerRefund(ecomOrderId, payments, options) {
1099
- // @ts-ignore
1100
- const { httpClient, sideEffects } = arguments[3];
1101
- const payload = renameKeysFromSDKRequestToRESTRequest({
1102
- ecomOrderId: ecomOrderId,
1103
- payments: payments,
1104
- details: options?.details,
1105
- sideEffects: options?.sideEffects,
1106
- });
1107
- const reqOpts = ambassadorWixEcomV1Order.triggerRefund(payload);
1108
- sideEffects?.onSiteCall?.();
1109
- try {
1110
- const result = await httpClient.request(reqOpts);
1111
- sideEffects?.onSuccess?.(result);
1112
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1113
- }
1114
- catch (err) {
1115
- const transformedError = sdkTransformError(err, {
1116
- spreadPathsToArguments: {},
1117
- explicitPathsToArguments: {
1118
- ecomOrderId: '$[0]',
1119
- payments: '$[1]',
1120
- details: '$[2].details',
1121
- sideEffects: '$[2].sideEffects',
1122
- },
1123
- singleArgumentUnchanged: false,
1124
- }, ['ecomOrderId', 'payments', 'options']);
1125
- sideEffects?.onError?.(err);
1126
- throw transformedError;
1127
- }
1128
- }
1129
- /**
1130
- * Void authorized payments
1131
- * Transaction statuses for related payments will be updated in async way
1132
- * @param ecomOrderId - Wix eCommerce order ID
1133
- * @param paymentIds - Payment IDs
1134
- * @public
1135
- * @documentationMaturity preview
1136
- * @requiredField ecomOrderId
1137
- * @requiredField paymentIds
1138
- * @permissionId ECOM.ORDER_VOID_AUTHORIZED_PAYMENT
1139
- * @permissionScope Manage Stores - all permissions
1140
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1141
- * @permissionScope Manage Restaurants - all permissions
1142
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1143
- * @permissionScope Manage eCommerce - all permissions
1144
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1145
- * @permissionScope Picasso private app mega scope
1146
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1147
- * @permissionScope Manage Orders
1148
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1149
- * @applicableIdentity APP
1150
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.VoidAuthorizedPayments
1151
- */
1152
- export async function voidAuthorizedPayments(ecomOrderId, paymentIds) {
1153
- // @ts-ignore
1154
- const { httpClient, sideEffects } = arguments[2];
1155
- const payload = renameKeysFromSDKRequestToRESTRequest({
1156
- ecomOrderId: ecomOrderId,
1157
- paymentIds: paymentIds,
1158
- });
1159
- const reqOpts = ambassadorWixEcomV1Order.voidAuthorizedPayments(payload);
1160
- sideEffects?.onSiteCall?.();
1161
- try {
1162
- const result = await httpClient.request(reqOpts);
1163
- sideEffects?.onSuccess?.(result);
1164
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1165
- }
1166
- catch (err) {
1167
- const transformedError = sdkTransformError(err, {
1168
- spreadPathsToArguments: {},
1169
- explicitPathsToArguments: { ecomOrderId: '$[0]', paymentIds: '$[1]' },
1170
- singleArgumentUnchanged: false,
1171
- }, ['ecomOrderId', 'paymentIds']);
1172
- sideEffects?.onError?.(err);
1173
- throw transformedError;
1174
- }
1175
- }
1176
- /**
1177
- * Capture authorized payments
1178
- * Transaction statuses for related payments will be updated in async way
1179
- * @param ecomOrderId - Wix eCommerce order ID
1180
- * @param payments - Capture payments information
1181
- * @public
1182
- * @documentationMaturity preview
1183
- * @requiredField ecomOrderId
1184
- * @requiredField payments
1185
- * @requiredField payments.paymentId
1186
- * @permissionId ECOM.ORDER_CAPTURE_AUTHORIZED_PAYMENT
1187
- * @permissionScope Manage Stores - all permissions
1188
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1189
- * @permissionScope Manage Restaurants - all permissions
1190
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1191
- * @permissionScope Manage eCommerce - all permissions
1192
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1193
- * @permissionScope Picasso private app mega scope
1194
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1195
- * @permissionScope Manage Orders
1196
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1197
- * @applicableIdentity APP
1198
- * @fqn com.wix.ecom.orders.payments_collector.v1.PaymentsCollector.CaptureAuthorizedPayments
1199
- */
1200
- export async function captureAuthorizedPayments(ecomOrderId, payments) {
1201
- // @ts-ignore
1202
- const { httpClient, sideEffects } = arguments[2];
1203
- const payload = renameKeysFromSDKRequestToRESTRequest({
1204
- ecomOrderId: ecomOrderId,
1205
- payments: payments,
1206
- });
1207
- const reqOpts = ambassadorWixEcomV1Order.captureAuthorizedPayments(payload);
1208
- sideEffects?.onSiteCall?.();
1209
- try {
1210
- const result = await httpClient.request(reqOpts);
1211
- sideEffects?.onSuccess?.(result);
1212
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1213
- }
1214
- catch (err) {
1215
- const transformedError = sdkTransformError(err, {
1216
- spreadPathsToArguments: {},
1217
- explicitPathsToArguments: { ecomOrderId: '$[0]', payments: '$[1]' },
1218
- singleArgumentUnchanged: false,
1219
- }, ['ecomOrderId', 'payments']);
1220
- sideEffects?.onError?.(err);
1221
- throw transformedError;
1222
- }
1223
- }
1224
- /**
1225
- * Retrieves an order.
1226
- *
1227
- *
1228
- * The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
1229
- *
1230
- * To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
1231
- * @param _id - ID of the order to retrieve.
1232
- * @public
1233
- * @requiredField _id
1234
- * @permissionId ECOM.READ_ORDERS
1235
- * @permissionId ECOM.ORDER_READ_ALL_EXTENDED_FIELDS
1236
- * @permissionScope Manage Stores - all permissions
1237
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1238
- * @permissionScope Read eCommerce - all read permissions
1239
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1240
- * @permissionScope Read Orders
1241
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
1242
- * @permissionScope Read Stores - all read permissions
1243
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
1244
- * @permissionScope Manage Restaurants - all permissions
1245
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1246
- * @permissionScope Manage eCommerce - all permissions
1247
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1248
- * @permissionScope Picasso private app mega scope
1249
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1250
- * @permissionScope Manage Orders
1251
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1252
- * @applicableIdentity APP
1253
- * @returns Fulfilled - The requested order.
1254
- * @fqn com.wix.ecom.orders.v1.Orders.GetOrder
1255
- */
1256
- export async function getOrder(_id) {
1257
- // @ts-ignore
1258
- const { httpClient, sideEffects } = arguments[1];
1259
- const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1260
- const reqOpts = ambassadorWixEcomV1Order.getOrder(payload);
1261
- sideEffects?.onSiteCall?.();
1262
- try {
1263
- const result = await httpClient.request(reqOpts);
1264
- sideEffects?.onSuccess?.(result);
1265
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1266
- {
1267
- transformFn: transformRESTImageToSDKImage,
1268
- paths: [{ path: 'order.lineItems.image' }],
1269
- },
1270
- {
1271
- transformFn: transformRESTAddressToSDKAddress,
1272
- paths: [
1273
- { path: 'order.billingInfo.address' },
1274
- {
1275
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1276
- },
1277
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1278
- { path: 'order.recipientInfo.address' },
1279
- ],
1280
- },
1281
- ]))?.order;
1282
- }
1283
- catch (err) {
1284
- const transformedError = sdkTransformError(err, {
1285
- spreadPathsToArguments: {},
1286
- explicitPathsToArguments: { id: '$[0]' },
1287
- singleArgumentUnchanged: false,
1288
- }, ['_id']);
1289
- sideEffects?.onError?.(err);
1290
- throw transformedError;
1291
- }
1292
- }
1293
- /**
1294
- * Retrieves a list of orders, given the provided paging, filtering, and sorting.
1295
- *
1296
- *
1297
- * Search Orders runs with these defaults, which you can override:
1298
- *
1299
- * - `createdDate` is sorted in `DESC` order
1300
- * - `cursorPaging.limit` is `100`
1301
- * - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
1302
- *
1303
- * For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
1304
- *
1305
- * To learn about working with _Search_ endpoints, see
1306
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
1307
- * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
1308
- * @public
1309
- * @permissionId ECOM.READ_ORDERS
1310
- * @permissionScope Manage Stores - all permissions
1311
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1312
- * @permissionScope Read eCommerce - all read permissions
1313
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
1314
- * @permissionScope Read Orders
1315
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
1316
- * @permissionScope Read Stores - all read permissions
1317
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
1318
- * @permissionScope Manage Restaurants - all permissions
1319
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1320
- * @permissionScope Manage eCommerce - all permissions
1321
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1322
- * @permissionScope Picasso private app mega scope
1323
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1324
- * @permissionScope Manage Orders
1325
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1326
- * @applicableIdentity APP
1327
- * @fqn com.wix.ecom.orders.v1.Orders.SearchOrders
1328
- */
1329
- export async function searchOrders(options) {
1330
- // @ts-ignore
1331
- const { httpClient, sideEffects } = arguments[1];
1332
- const payload = renameKeysFromSDKRequestToRESTRequest({
1333
- search: options?.search,
1334
- });
1335
- const reqOpts = ambassadorWixEcomV1Order.searchOrders(payload);
1336
- sideEffects?.onSiteCall?.();
1337
- try {
1338
- const result = await httpClient.request(reqOpts);
1339
- sideEffects?.onSuccess?.(result);
1340
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1341
- {
1342
- transformFn: transformRESTImageToSDKImage,
1343
- paths: [{ path: 'orders.lineItems.image' }],
1344
- },
1345
- {
1346
- transformFn: transformRESTAddressToSDKAddress,
1347
- paths: [
1348
- { path: 'orders.billingInfo.address' },
1349
- {
1350
- path: 'orders.shippingInfo.logistics.shippingDestination.address',
1351
- },
1352
- { path: 'orders.shippingInfo.logistics.pickupDetails.address' },
1353
- { path: 'orders.recipientInfo.address' },
1354
- ],
1355
- },
1356
- ]));
1357
- }
1358
- catch (err) {
1359
- const transformedError = sdkTransformError(err, {
1360
- spreadPathsToArguments: {},
1361
- explicitPathsToArguments: { search: '$[0].search' },
1362
- singleArgumentUnchanged: false,
1363
- }, ['options']);
1364
- sideEffects?.onError?.(err);
1365
- throw transformedError;
1366
- }
1367
- }
1368
- /**
1369
- * Creates an order.
1370
- *
1371
- *
1372
- * The `createOrder()` function returns a Promise that resolves when the order is created.
1373
- *
1374
- * > **Notes:**
1375
- * > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
1376
- * > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
1377
- * @param order - Order info.
1378
- * @public
1379
- * @requiredField order
1380
- * @requiredField order.billingInfo.contactDetails
1381
- * @requiredField order.channelInfo
1382
- * @requiredField order.currencyConversionDetails.conversionRate
1383
- * @requiredField order.currencyConversionDetails.originalCurrency
1384
- * @requiredField order.lineItems
1385
- * @requiredField order.lineItems.catalogReference.appId
1386
- * @requiredField order.lineItems.catalogReference.catalogItemId
1387
- * @requiredField order.lineItems.itemType
1388
- * @requiredField order.lineItems.price
1389
- * @requiredField order.lineItems.productName
1390
- * @requiredField order.lineItems.productName.original
1391
- * @requiredField order.lineItems.quantity
1392
- * @requiredField order.priceSummary
1393
- * @permissionId ECOM.CREATE_ORDERS
1394
- * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1395
- * @permissionScope Manage Stores - all permissions
1396
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1397
- * @permissionScope Manage Restaurants - all permissions
1398
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1399
- * @permissionScope Manage eCommerce - all permissions
1400
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1401
- * @permissionScope Picasso private app mega scope
1402
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1403
- * @permissionScope Manage Orders
1404
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1405
- * @applicableIdentity APP
1406
- * @returns Newly created order.
1407
- * @fqn com.wix.ecom.orders.v1.Orders.CreateOrder
1408
- */
1409
- export async function createOrder(order, options) {
1410
- // @ts-ignore
1411
- const { httpClient, sideEffects } = arguments[2];
1412
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1413
- order: order,
1414
- settings: options?.settings,
1415
- }), [
1416
- {
1417
- transformFn: transformSDKImageToRESTImage,
1418
- paths: [{ path: 'order.lineItems.image' }],
1419
- },
1420
- {
1421
- transformFn: transformSDKAddressToRESTAddress,
1422
- paths: [
1423
- { path: 'order.billingInfo.address' },
1424
- { path: 'order.shippingInfo.logistics.shippingDestination.address' },
1425
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1426
- { path: 'order.recipientInfo.address' },
1427
- ],
1428
- },
1429
- ]);
1430
- const reqOpts = ambassadorWixEcomV1Order.createOrder(payload);
1431
- sideEffects?.onSiteCall?.();
1432
- try {
1433
- const result = await httpClient.request(reqOpts);
1434
- sideEffects?.onSuccess?.(result);
1435
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1436
- {
1437
- transformFn: transformRESTImageToSDKImage,
1438
- paths: [{ path: 'order.lineItems.image' }],
1439
- },
1440
- {
1441
- transformFn: transformRESTAddressToSDKAddress,
1442
- paths: [
1443
- { path: 'order.billingInfo.address' },
1444
- {
1445
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1446
- },
1447
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1448
- { path: 'order.recipientInfo.address' },
1449
- ],
1450
- },
1451
- ]))?.order;
1452
- }
1453
- catch (err) {
1454
- const transformedError = sdkTransformError(err, {
1455
- spreadPathsToArguments: {},
1456
- explicitPathsToArguments: { order: '$[0]', settings: '$[1].settings' },
1457
- singleArgumentUnchanged: false,
1458
- }, ['order', 'options']);
1459
- sideEffects?.onError?.(err);
1460
- throw transformedError;
1461
- }
1462
- }
1463
- /**
1464
- * Updates an order.
1465
- *
1466
- *
1467
- * The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
1468
- *
1469
- * Currently, the following fields can be updated:
1470
- * + `order.buyerInfo.email`
1471
- * + `order.buyerLanguage`
1472
- * + `order.weightUnit`
1473
- * + `order.billingInfo.address`
1474
- * + `order.billingInfo.contactDetails`
1475
- * + `order.archived`
1476
- * + `order.attributionSource`
1477
- * + `order.seenByAHuman`
1478
- * + `order.recipientInfo.address`
1479
- * + `order.recipientInfo.contactDetails`
1480
- * + `order.shippingInfo.logistics.shippingDestination.address`
1481
- * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
1482
- *
1483
- * To update a field's value, include the new value in the `order` object in the method parameters.
1484
- * To remove a field's value, pass `null`.
1485
- *
1486
- * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
1487
- *
1488
- * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
1489
- * @param _id - Order ID.
1490
- * @public
1491
- * @requiredField _id
1492
- * @requiredField order
1493
- * @permissionId ECOM.MODIFY_ORDERS
1494
- * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1495
- * @permissionScope Manage Stores - all permissions
1496
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1497
- * @permissionScope Manage Restaurants - all permissions
1498
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1499
- * @permissionScope Manage eCommerce - all permissions
1500
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1501
- * @permissionScope Picasso private app mega scope
1502
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1503
- * @permissionScope Manage Orders
1504
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1505
- * @applicableIdentity APP
1506
- * @returns Newly created order.
1507
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrder
1508
- */
1509
- export async function updateOrder(_id, order) {
1510
- // @ts-ignore
1511
- const { httpClient, sideEffects } = arguments[2];
1512
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({ order: { ...order, id: _id } }), [
1513
- {
1514
- transformFn: transformSDKImageToRESTImage,
1515
- paths: [{ path: 'order.lineItems.image' }],
1516
- },
1517
- {
1518
- transformFn: transformSDKAddressToRESTAddress,
1519
- paths: [
1520
- { path: 'order.billingInfo.address' },
1521
- { path: 'order.shippingInfo.logistics.shippingDestination.address' },
1522
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1523
- { path: 'order.recipientInfo.address' },
1524
- ],
1525
- },
1526
- ]);
1527
- const reqOpts = ambassadorWixEcomV1Order.updateOrder(payload);
1528
- sideEffects?.onSiteCall?.();
1529
- try {
1530
- const result = await httpClient.request(reqOpts);
1531
- sideEffects?.onSuccess?.(result);
1532
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1533
- {
1534
- transformFn: transformRESTImageToSDKImage,
1535
- paths: [{ path: 'order.lineItems.image' }],
1536
- },
1537
- {
1538
- transformFn: transformRESTAddressToSDKAddress,
1539
- paths: [
1540
- { path: 'order.billingInfo.address' },
1541
- {
1542
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1543
- },
1544
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1545
- { path: 'order.recipientInfo.address' },
1546
- ],
1547
- },
1548
- ]))?.order;
1549
- }
1550
- catch (err) {
1551
- const transformedError = sdkTransformError(err, {
1552
- spreadPathsToArguments: { order: '$[1]' },
1553
- explicitPathsToArguments: { 'order.id': '$[0]' },
1554
- singleArgumentUnchanged: false,
1555
- }, ['_id', 'order']);
1556
- sideEffects?.onError?.(err);
1557
- throw transformedError;
1558
- }
1559
- }
1560
- /**
1561
- * Updates up to 100 orders.
1562
- *
1563
- *
1564
- * The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
1565
- *
1566
- * Currently, the following fields can be updated:
1567
- * + `order.buyerInfo.email`
1568
- * + `order.buyerLanguage`
1569
- * + `order.weightUnit`
1570
- * + `order.billingInfo.address`
1571
- * + `order.billingInfo.contactDetails`
1572
- * + `order.archived`
1573
- * + `order.attributionSource`
1574
- * + `order.seenByAHuman`
1575
- * + `order.recipientInfo.address`
1576
- * + `order.recipientInfo.contactDetails`
1577
- * + `order.shippingInfo.logistics.shippingDestination.address`
1578
- * + `order.shippingInfo.logistics.shippingDestination.contactDetails`
1579
- *
1580
- * To update a field's value, include the new value in the `orders.order` object in the method parameters.
1581
- * To remove a field's value, pass `null`.
1582
- *
1583
- * > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
1584
- *
1585
- * To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
1586
- * @param orders - Orders to update.
1587
- * @public
1588
- * @requiredField orders
1589
- * @requiredField orders.order
1590
- * @requiredField orders.order._id
1591
- * @permissionId ECOM.MODIFY_ORDERS
1592
- * @permissionScope Manage Stores - all permissions
1593
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1594
- * @permissionScope Manage Restaurants - all permissions
1595
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1596
- * @permissionScope Manage eCommerce - all permissions
1597
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1598
- * @permissionScope Picasso private app mega scope
1599
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1600
- * @permissionScope Manage Orders
1601
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1602
- * @applicableIdentity APP
1603
- * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrders
1604
- */
1605
- export async function bulkUpdateOrders(orders, options) {
1606
- // @ts-ignore
1607
- const { httpClient, sideEffects } = arguments[2];
1608
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1609
- orders: orders,
1610
- returnEntity: options?.returnEntity,
1611
- }), [
1612
- {
1613
- transformFn: transformSDKImageToRESTImage,
1614
- paths: [{ path: 'orders.order.lineItems.image' }],
1615
- },
1616
- {
1617
- transformFn: transformSDKAddressToRESTAddress,
1618
- paths: [
1619
- { path: 'orders.order.billingInfo.address' },
1620
- {
1621
- path: 'orders.order.shippingInfo.logistics.shippingDestination.address',
1622
- },
1623
- { path: 'orders.order.shippingInfo.logistics.pickupDetails.address' },
1624
- { path: 'orders.order.recipientInfo.address' },
1625
- ],
1626
- },
1627
- ]);
1628
- const reqOpts = ambassadorWixEcomV1Order.bulkUpdateOrders(payload);
1629
- sideEffects?.onSiteCall?.();
1630
- try {
1631
- const result = await httpClient.request(reqOpts);
1632
- sideEffects?.onSuccess?.(result);
1633
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1634
- {
1635
- transformFn: transformRESTImageToSDKImage,
1636
- paths: [{ path: 'results.item.lineItems.image' }],
1637
- },
1638
- {
1639
- transformFn: transformRESTAddressToSDKAddress,
1640
- paths: [
1641
- { path: 'results.item.billingInfo.address' },
1642
- {
1643
- path: 'results.item.shippingInfo.logistics.shippingDestination.address',
1644
- },
1645
- {
1646
- path: 'results.item.shippingInfo.logistics.pickupDetails.address',
1647
- },
1648
- { path: 'results.item.recipientInfo.address' },
1649
- ],
1650
- },
1651
- ]));
1652
- }
1653
- catch (err) {
1654
- const transformedError = sdkTransformError(err, {
1655
- spreadPathsToArguments: {},
1656
- explicitPathsToArguments: {
1657
- orders: '$[0]',
1658
- returnEntity: '$[1].returnEntity',
1659
- },
1660
- singleArgumentUnchanged: false,
1661
- }, ['orders', 'options']);
1662
- sideEffects?.onError?.(err);
1663
- throw transformedError;
1664
- }
1665
- }
1666
- /** @param _id - Order id to be updated
1667
- * @internal
1668
- * @documentationMaturity preview
1669
- * @requiredField _id
1670
- * @requiredField options.changes
1671
- * @requiredField options.changes.priceSummary.subtotal
1672
- * @requiredField options.changes.priceSummary.total
1673
- * @permissionId ECOM.ORDERS_DELTAS_COMMIT
1674
- * @permissionId ECOM.ORDER_WRITE_ALL_EXTENDED_FIELDS
1675
- * @fqn com.wix.ecom.orders.v1.Orders.CommitDeltas
1676
- */
1677
- export async function commitDeltas(_id, options) {
1678
- // @ts-ignore
1679
- const { httpClient, sideEffects } = arguments[2];
1680
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1681
- id: _id,
1682
- draftOrderId: options?.draftOrderId,
1683
- changes: options?.changes,
1684
- commitSettings: options?.commitSettings,
1685
- reason: options?.reason,
1686
- }), [
1687
- {
1688
- transformFn: transformSDKAddressToRESTAddress,
1689
- paths: [
1690
- {
1691
- path: 'changes.changedShippingInfo.logistics.shippingDestination.address',
1692
- },
1693
- {
1694
- path: 'changes.changedShippingInfo.logistics.pickupDetails.address',
1695
- },
1696
- { path: 'changes.changedBillingInfo.address' },
1697
- { path: 'changes.changedRecipientInfo.address' },
1698
- ],
1699
- },
1700
- {
1701
- transformFn: transformSDKImageToRESTImage,
1702
- paths: [{ path: 'changes.lineItems.lineItem.image' }],
1703
- },
1704
- ]);
1705
- const reqOpts = ambassadorWixEcomV1Order.commitDeltas(payload);
1706
- sideEffects?.onSiteCall?.();
1707
- try {
1708
- const result = await httpClient.request(reqOpts);
1709
- sideEffects?.onSuccess?.(result);
1710
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1711
- {
1712
- transformFn: transformRESTImageToSDKImage,
1713
- paths: [{ path: 'order.lineItems.image' }],
1714
- },
1715
- {
1716
- transformFn: transformRESTAddressToSDKAddress,
1717
- paths: [
1718
- { path: 'order.billingInfo.address' },
1719
- {
1720
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1721
- },
1722
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1723
- { path: 'order.recipientInfo.address' },
1724
- ],
1725
- },
1726
- ]));
1727
- }
1728
- catch (err) {
1729
- const transformedError = sdkTransformError(err, {
1730
- spreadPathsToArguments: {},
1731
- explicitPathsToArguments: {
1732
- id: '$[0]',
1733
- draftOrderId: '$[1].draftOrderId',
1734
- changes: '$[1].changes',
1735
- commitSettings: '$[1].commitSettings',
1736
- reason: '$[1].reason',
1737
- },
1738
- singleArgumentUnchanged: false,
1739
- }, ['_id', 'options']);
1740
- sideEffects?.onError?.(err);
1741
- throw transformedError;
1742
- }
1743
- }
1744
- /** @internal
1745
- * @documentationMaturity preview
1746
- * @requiredField identifiers
1747
- * @requiredField identifiers._id
1748
- * @requiredField identifiers.lineItemId
1749
- * @requiredField lineItem
1750
- * @permissionId ECOM.MODIFY_ORDERS
1751
- * @permissionScope Manage Stores - all permissions
1752
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1753
- * @permissionScope Manage Restaurants - all permissions
1754
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1755
- * @permissionScope Manage eCommerce - all permissions
1756
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1757
- * @permissionScope Picasso private app mega scope
1758
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1759
- * @permissionScope Manage Orders
1760
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1761
- * @applicableIdentity APP
1762
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderLineItem
1763
- * @deprecated
1764
- * @targetRemovalDate 2024-02-15
1765
- */
1766
- export async function updateOrderLineItem(identifiers, lineItem) {
1767
- // @ts-ignore
1768
- const { httpClient, sideEffects } = arguments[2];
1769
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1770
- id: identifiers?._id,
1771
- lineItem: { ...lineItem, id: identifiers?.lineItemId },
1772
- }), [
1773
- {
1774
- transformFn: transformSDKImageToRESTImage,
1775
- paths: [{ path: 'lineItem.image' }],
1776
- },
1777
- ]);
1778
- const reqOpts = ambassadorWixEcomV1Order.updateOrderLineItem(payload);
1779
- sideEffects?.onSiteCall?.();
1780
- try {
1781
- const result = await httpClient.request(reqOpts);
1782
- sideEffects?.onSuccess?.(result);
1783
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1784
- {
1785
- transformFn: transformRESTImageToSDKImage,
1786
- paths: [{ path: 'order.lineItems.image' }],
1787
- },
1788
- {
1789
- transformFn: transformRESTAddressToSDKAddress,
1790
- paths: [
1791
- { path: 'order.billingInfo.address' },
1792
- {
1793
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1794
- },
1795
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1796
- { path: 'order.recipientInfo.address' },
1797
- ],
1798
- },
1799
- ]));
1800
- }
1801
- catch (err) {
1802
- const transformedError = sdkTransformError(err, {
1803
- spreadPathsToArguments: { lineItem: '$[1]' },
1804
- explicitPathsToArguments: {
1805
- id: '$[0]._id',
1806
- 'lineItem.id': '$[0].lineItemId',
1807
- },
1808
- singleArgumentUnchanged: false,
1809
- }, ['identifiers', 'lineItem']);
1810
- sideEffects?.onError?.(err);
1811
- throw transformedError;
1812
- }
1813
- }
1814
- /**
1815
- * Adds a merchant comment to an order.
1816
- * > **Note:** Activities with type CustomActivity not supported
1817
- * @param _id - Order ID.
1818
- * @param activity - Activity info.
1819
- * @internal
1820
- * @documentationMaturity preview
1821
- * @requiredField _id
1822
- * @requiredField activity
1823
- * @permissionId ECOM.MODIFY_ORDERS
1824
- * @permissionScope Manage Stores - all permissions
1825
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1826
- * @permissionScope Manage Restaurants - all permissions
1827
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1828
- * @permissionScope Manage eCommerce - all permissions
1829
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1830
- * @permissionScope Picasso private app mega scope
1831
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1832
- * @permissionScope Manage Orders
1833
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1834
- * @applicableIdentity APP
1835
- * @fqn com.wix.ecom.orders.v1.Orders.AddActivity
1836
- * @deprecated
1837
- * @replacedBy com.wix.ecom.orders.v1.OrdersService.AddActivities
1838
- * @targetRemovalDate 2024-11-01
1839
- */
1840
- export async function addActivity(_id, activity) {
1841
- // @ts-ignore
1842
- const { httpClient, sideEffects } = arguments[2];
1843
- const payload = renameKeysFromSDKRequestToRESTRequest({
1844
- id: _id,
1845
- activity: activity,
1846
- });
1847
- const reqOpts = ambassadorWixEcomV1Order.addActivity(payload);
1848
- sideEffects?.onSiteCall?.();
1849
- try {
1850
- const result = await httpClient.request(reqOpts);
1851
- sideEffects?.onSuccess?.(result);
1852
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1853
- {
1854
- transformFn: transformRESTImageToSDKImage,
1855
- paths: [{ path: 'order.lineItems.image' }],
1856
- },
1857
- {
1858
- transformFn: transformRESTAddressToSDKAddress,
1859
- paths: [
1860
- { path: 'order.billingInfo.address' },
1861
- {
1862
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1863
- },
1864
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1865
- { path: 'order.recipientInfo.address' },
1866
- ],
1867
- },
1868
- ]));
1869
- }
1870
- catch (err) {
1871
- const transformedError = sdkTransformError(err, {
1872
- spreadPathsToArguments: {},
1873
- explicitPathsToArguments: { id: '$[0]', activity: '$[1]' },
1874
- singleArgumentUnchanged: false,
1875
- }, ['_id', 'activity']);
1876
- sideEffects?.onError?.(err);
1877
- throw transformedError;
1878
- }
1879
- }
1880
- /**
1881
- * Updates an order's activity.
1882
- * @param activity - Activity info.
1883
- * @internal
1884
- * @documentationMaturity preview
1885
- * @requiredField activity
1886
- * @requiredField identifiers
1887
- * @requiredField identifiers._id
1888
- * @requiredField identifiers.activityId
1889
- * @permissionId ECOM.MODIFY_ORDERS
1890
- * @permissionScope Manage Stores - all permissions
1891
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
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
- * @permissionScope Picasso private app mega scope
1897
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1898
- * @permissionScope Manage Orders
1899
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1900
- * @applicableIdentity APP
1901
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateActivity
1902
- */
1903
- export async function updateActivity(identifiers, activity) {
1904
- // @ts-ignore
1905
- const { httpClient, sideEffects } = arguments[2];
1906
- const payload = renameKeysFromSDKRequestToRESTRequest({
1907
- id: identifiers?._id,
1908
- activityId: identifiers?.activityId,
1909
- activity: activity,
1910
- });
1911
- const reqOpts = ambassadorWixEcomV1Order.updateActivity(payload);
1912
- sideEffects?.onSiteCall?.();
1913
- try {
1914
- const result = await httpClient.request(reqOpts);
1915
- sideEffects?.onSuccess?.(result);
1916
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1917
- {
1918
- transformFn: transformRESTImageToSDKImage,
1919
- paths: [{ path: 'order.lineItems.image' }],
1920
- },
1921
- {
1922
- transformFn: transformRESTAddressToSDKAddress,
1923
- paths: [
1924
- { path: 'order.billingInfo.address' },
1925
- {
1926
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1927
- },
1928
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1929
- { path: 'order.recipientInfo.address' },
1930
- ],
1931
- },
1932
- ]));
1933
- }
1934
- catch (err) {
1935
- const transformedError = sdkTransformError(err, {
1936
- spreadPathsToArguments: {},
1937
- explicitPathsToArguments: {
1938
- id: '$[0]._id',
1939
- activityId: '$[0].activityId',
1940
- activity: '$[1]',
1941
- },
1942
- singleArgumentUnchanged: false,
1943
- }, ['identifiers', 'activity']);
1944
- sideEffects?.onError?.(err);
1945
- throw transformedError;
1946
- }
1947
- }
1948
- /**
1949
- * Delete's an order's activity.
1950
- *
1951
- * Only custom activities and merchant comments can be deleted.
1952
- * @internal
1953
- * @documentationMaturity preview
1954
- * @requiredField identifiers
1955
- * @requiredField identifiers._id
1956
- * @requiredField identifiers.activityId
1957
- * @permissionId ECOM.MODIFY_ORDERS
1958
- * @permissionScope Manage Stores - all permissions
1959
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1960
- * @permissionScope Manage Restaurants - all permissions
1961
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1962
- * @permissionScope Manage eCommerce - all permissions
1963
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1964
- * @permissionScope Picasso private app mega scope
1965
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1966
- * @permissionScope Manage Orders
1967
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1968
- * @applicableIdentity APP
1969
- * @fqn com.wix.ecom.orders.v1.Orders.DeleteActivity
1970
- */
1971
- export async function deleteActivity(identifiers) {
1972
- // @ts-ignore
1973
- const { httpClient, sideEffects } = arguments[1];
1974
- const payload = renameKeysFromSDKRequestToRESTRequest({
1975
- id: identifiers?._id,
1976
- activityId: identifiers?.activityId,
1977
- });
1978
- const reqOpts = ambassadorWixEcomV1Order.deleteActivity(payload);
1979
- sideEffects?.onSiteCall?.();
1980
- try {
1981
- const result = await httpClient.request(reqOpts);
1982
- sideEffects?.onSuccess?.(result);
1983
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1984
- {
1985
- transformFn: transformRESTImageToSDKImage,
1986
- paths: [{ path: 'order.lineItems.image' }],
1987
- },
1988
- {
1989
- transformFn: transformRESTAddressToSDKAddress,
1990
- paths: [
1991
- { path: 'order.billingInfo.address' },
1992
- {
1993
- path: 'order.shippingInfo.logistics.shippingDestination.address',
1994
- },
1995
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
1996
- { path: 'order.recipientInfo.address' },
1997
- ],
1998
- },
1999
- ]));
2000
- }
2001
- catch (err) {
2002
- const transformedError = sdkTransformError(err, {
2003
- spreadPathsToArguments: {},
2004
- explicitPathsToArguments: {
2005
- id: '$[0]._id',
2006
- activityId: '$[0].activityId',
2007
- },
2008
- singleArgumentUnchanged: false,
2009
- }, ['identifiers']);
2010
- sideEffects?.onError?.(err);
2011
- throw transformedError;
2012
- }
2013
- }
2014
- /**
2015
- * Cancels an order.
2016
- *
2017
- *
2018
- * The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
2019
- * @param _id - Order ID.
2020
- * @public
2021
- * @requiredField _id
2022
- * @permissionId ECOM.MODIFY_ORDERS
2023
- * @permissionScope Manage Stores - all permissions
2024
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2025
- * @permissionScope Manage Restaurants - all permissions
2026
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2027
- * @permissionScope Manage eCommerce - all permissions
2028
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2029
- * @permissionScope Picasso private app mega scope
2030
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
2031
- * @permissionScope Manage Orders
2032
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2033
- * @applicableIdentity APP
2034
- * @fqn com.wix.ecom.orders.v1.Orders.CancelOrder
2035
- */
2036
- export async function cancelOrder(_id, options) {
2037
- // @ts-ignore
2038
- const { httpClient, sideEffects } = arguments[2];
2039
- const payload = renameKeysFromSDKRequestToRESTRequest({
2040
- id: _id,
2041
- sendOrderCanceledEmail: options?.sendOrderCanceledEmail,
2042
- customMessage: options?.customMessage,
2043
- restockAllItems: options?.restockAllItems,
2044
- });
2045
- const reqOpts = ambassadorWixEcomV1Order.cancelOrder(payload);
2046
- sideEffects?.onSiteCall?.();
2047
- try {
2048
- const result = await httpClient.request(reqOpts);
2049
- sideEffects?.onSuccess?.(result);
2050
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
2051
- {
2052
- transformFn: transformRESTImageToSDKImage,
2053
- paths: [{ path: 'order.lineItems.image' }],
2054
- },
2055
- {
2056
- transformFn: transformRESTAddressToSDKAddress,
2057
- paths: [
2058
- { path: 'order.billingInfo.address' },
2059
- {
2060
- path: 'order.shippingInfo.logistics.shippingDestination.address',
2061
- },
2062
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
2063
- { path: 'order.recipientInfo.address' },
2064
- ],
2065
- },
2066
- ]));
2067
- }
2068
- catch (err) {
2069
- const transformedError = sdkTransformError(err, {
2070
- spreadPathsToArguments: {},
2071
- explicitPathsToArguments: {
2072
- id: '$[0]',
2073
- sendOrderCanceledEmail: '$[1].sendOrderCanceledEmail',
2074
- customMessage: '$[1].customMessage',
2075
- restockAllItems: '$[1].restockAllItems',
2076
- },
2077
- singleArgumentUnchanged: false,
2078
- }, ['_id', 'options']);
2079
- sideEffects?.onError?.(err);
2080
- throw transformedError;
2081
- }
2082
- }
2083
- /**
2084
- * Updates order status.
2085
- *
2086
- * >CANCELED and REJECTED are final statuses. Update from either of those will fail.
2087
- * >Updates into INITIALIZED are not supported.
2088
- *
2089
- * Approving order:
2090
- * APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
2091
- *
2092
- * Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
2093
- * will cause an error.
2094
- *
2095
- * Setting PENDING status:
2096
- * Only orders in INITIALIZED status can be updated into PENDING.
2097
- * @param orderId - Order ID.
2098
- * @param status - New order status.
2099
- * @internal
2100
- * @documentationMaturity preview
2101
- * @requiredField orderId
2102
- * @requiredField status
2103
- * @permissionId ECOM.ORDER_UPDATE_STATUS
2104
- * @permissionScope Manage Stores - all permissions
2105
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2106
- * @permissionScope Manage Restaurants - all permissions
2107
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2108
- * @permissionScope Manage eCommerce - all permissions
2109
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2110
- * @permissionScope Picasso private app mega scope
2111
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
2112
- * @permissionScope Manage Orders
2113
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2114
- * @applicableIdentity APP
2115
- * @fqn com.wix.ecom.orders.v1.Orders.UpdateOrderStatus
2116
- */
2117
- export async function updateOrderStatus(orderId, status) {
2118
- // @ts-ignore
2119
- const { httpClient, sideEffects } = arguments[2];
2120
- const payload = renameKeysFromSDKRequestToRESTRequest({
2121
- orderId: orderId,
2122
- status: status,
2123
- });
2124
- const reqOpts = ambassadorWixEcomV1Order.updateOrderStatus(payload);
2125
- sideEffects?.onSiteCall?.();
2126
- try {
2127
- const result = await httpClient.request(reqOpts);
2128
- sideEffects?.onSuccess?.(result);
2129
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
2130
- {
2131
- transformFn: transformRESTImageToSDKImage,
2132
- paths: [{ path: 'order.lineItems.image' }],
2133
- },
2134
- {
2135
- transformFn: transformRESTAddressToSDKAddress,
2136
- paths: [
2137
- { path: 'order.billingInfo.address' },
2138
- {
2139
- path: 'order.shippingInfo.logistics.shippingDestination.address',
2140
- },
2141
- { path: 'order.shippingInfo.logistics.pickupDetails.address' },
2142
- { path: 'order.recipientInfo.address' },
2143
- ],
2144
- },
2145
- ]));
2146
- }
2147
- catch (err) {
2148
- const transformedError = sdkTransformError(err, {
2149
- spreadPathsToArguments: {},
2150
- explicitPathsToArguments: { orderId: '$[0]', status: '$[1]' },
2151
- singleArgumentUnchanged: false,
2152
- }, ['orderId', 'status']);
2153
- sideEffects?.onError?.(err);
2154
- throw transformedError;
2155
- }
2156
- }
2157
- /** @internal
2158
- * @documentationMaturity preview
2159
- * @requiredField options.aggregation
2160
- * @permissionId ECOM.READ_ORDERS
2161
- * @permissionScope Manage Stores - all permissions
2162
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2163
- * @permissionScope Read eCommerce - all read permissions
2164
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
2165
- * @permissionScope Read Orders
2166
- * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
2167
- * @permissionScope Read Stores - all read permissions
2168
- * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
2169
- * @permissionScope Manage Restaurants - all permissions
2170
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2171
- * @permissionScope Manage eCommerce - all permissions
2172
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2173
- * @permissionScope Picasso private app mega scope
2174
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
2175
- * @permissionScope Manage Orders
2176
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2177
- * @applicableIdentity APP
2178
- * @fqn com.wix.ecom.orders.v1.Orders.AggregateOrders
2179
- */
2180
- export async function aggregateOrders(options) {
2181
- // @ts-ignore
2182
- const { httpClient, sideEffects } = arguments[1];
2183
- const payload = renameKeysFromSDKRequestToRESTRequest({
2184
- filter: options?.filter,
2185
- aggregation: options?.aggregation,
2186
- hierarchySeparatorOverride: options?.hierarchySeparatorOverride,
2187
- });
2188
- const reqOpts = ambassadorWixEcomV1Order.aggregateOrders(payload);
2189
- sideEffects?.onSiteCall?.();
2190
- try {
2191
- const result = await httpClient.request(reqOpts);
2192
- sideEffects?.onSuccess?.(result);
2193
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2194
- }
2195
- catch (err) {
2196
- const transformedError = sdkTransformError(err, {
2197
- spreadPathsToArguments: {},
2198
- explicitPathsToArguments: {
2199
- filter: '$[0].filter',
2200
- aggregation: '$[0].aggregation',
2201
- hierarchySeparatorOverride: '$[0].hierarchySeparatorOverride',
2202
- },
2203
- singleArgumentUnchanged: false,
2204
- }, ['options']);
2205
- sideEffects?.onError?.(err);
2206
- throw transformedError;
2207
- }
2208
- }
2209
- /**
2210
- * Synchronously update tags on multiple orders, by list of order IDs.
2211
- *
2212
- * > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
2213
- * @param orderIds - IDs of orders to update tags for.
2214
- * @public
2215
- * @requiredField orderIds
2216
- * @permissionId ECOM.MODIFY_ORDERS
2217
- * @permissionId ECOM.ORDER_MODIFY_PRIVATE_TAGS
2218
- * @permissionScope Manage Stores - all permissions
2219
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2220
- * @permissionScope Manage Restaurants - all permissions
2221
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2222
- * @permissionScope Manage eCommerce - all permissions
2223
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2224
- * @permissionScope Picasso private app mega scope
2225
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
2226
- * @permissionScope Manage Orders
2227
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2228
- * @permissionScope Manage Stores - all permissions
2229
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
2230
- * @permissionScope Manage Restaurants - all permissions
2231
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
2232
- * @permissionScope Manage eCommerce - all permissions
2233
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
2234
- * @permissionScope Picasso private app mega scope
2235
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
2236
- * @permissionScope Manage Orders
2237
- * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
2238
- * @applicableIdentity APP
2239
- * @fqn com.wix.ecom.orders.v1.Orders.BulkUpdateOrderTags
2240
- */
2241
- export async function bulkUpdateOrderTags(orderIds, options) {
2242
- // @ts-ignore
2243
- const { httpClient, sideEffects } = arguments[2];
2244
- const payload = renameKeysFromSDKRequestToRESTRequest({
2245
- orderIds: orderIds,
2246
- assignTags: options?.assignTags,
2247
- unassignTags: options?.unassignTags,
2248
- });
2249
- const reqOpts = ambassadorWixEcomV1Order.bulkUpdateOrderTags(payload);
2250
- sideEffects?.onSiteCall?.();
2251
- try {
2252
- const result = await httpClient.request(reqOpts);
2253
- sideEffects?.onSuccess?.(result);
2254
- return renameKeysFromRESTResponseToSDKResponse(result.data);
2255
- }
2256
- catch (err) {
2257
- const transformedError = sdkTransformError(err, {
2258
- spreadPathsToArguments: {},
2259
- explicitPathsToArguments: {
2260
- orderIds: '$[0]',
2261
- assignTags: '$[1].assignTags',
2262
- unassignTags: '$[1].unassignTags',
2263
- },
2264
- singleArgumentUnchanged: false,
2265
- }, ['orderIds', 'options']);
2266
- sideEffects?.onError?.(err);
2267
- throw transformedError;
2268
- }
2269
- }
2270
- //# sourceMappingURL=ecom-v1-order-orders.universal.js.map