@wix/auto_sdk_ecom_draft-orders 1.0.17 → 1.0.19

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/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.mts} +423 -831
  2. package/build/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-Ch0BEnrn.d.ts} +423 -831
  3. package/build/index.d.mts +232 -0
  4. package/build/index.d.ts +232 -0
  5. package/build/index.js +4593 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +4520 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{cjs/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.mts} +885 -1096
  10. package/build/internal/{es/src/ecom-v1-draft-order-draft-orders.types.d.ts → ecom-v1-draft-order-draft-orders.universal-B5CD1SEk.d.ts} +885 -1096
  11. package/build/internal/index.d.mts +232 -0
  12. package/build/internal/index.d.ts +232 -0
  13. package/build/internal/index.js +4593 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +4520 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +2751 -0
  18. package/build/internal/meta.d.ts +2751 -0
  19. package/build/internal/meta.js +3323 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +3275 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +2751 -0
  24. package/build/meta.d.ts +2751 -0
  25. package/build/meta.js +3323 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +3275 -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-draft-order-draft-orders.context.d.ts +0 -26
  40. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
  41. package/build/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  42. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
  43. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
  44. package/build/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  45. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
  46. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
  47. package/build/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  48. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
  49. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
  50. package/build/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  51. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
  52. package/build/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  53. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
  54. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
  55. package/build/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
  67. package/build/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
  68. package/build/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  69. package/build/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
  70. package/build/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
  71. package/build/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  72. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
  73. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
  74. package/build/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  75. package/build/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
  76. package/build/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
  77. package/build/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  78. package/build/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
  79. package/build/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  80. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -4562
  81. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
  82. package/build/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
  93. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js +0 -57
  94. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  95. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
  96. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js +0 -2951
  97. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  98. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
  99. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js +0 -446
  100. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  101. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
  102. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js +0 -168
  103. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  104. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js +0 -360
  105. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  106. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
  107. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1943
  108. package/build/internal/cjs/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.d.ts +0 -26
  119. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js +0 -26
  120. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.context.js.map +0 -1
  121. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.d.ts +0 -97
  122. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js +0 -2926
  123. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.http.js.map +0 -1
  124. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.d.ts +0 -60
  125. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js +0 -398
  126. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.meta.js.map +0 -1
  127. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.d.ts +0 -209
  128. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js +0 -114
  129. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.public.js.map +0 -1
  130. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js +0 -357
  131. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.types.js.map +0 -1
  132. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.d.ts +0 -5285
  133. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js +0 -1895
  134. package/build/internal/es/src/ecom-v1-draft-order-draft-orders.universal.js.map +0 -1
@@ -1,1895 +0,0 @@
1
- import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
2
- import { queryBuilder } from '@wix/sdk-runtime/query-builder';
3
- import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
4
- import * as ambassadorWixEcomV1DraftOrder from './ecom-v1-draft-order-draft-orders.http.js';
5
- // @ts-ignore
6
- import { transformSDKAddressToRESTAddress } from '@wix/sdk-runtime/transformations/address';
7
- import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
8
- import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
9
- import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
10
- import { transformSDKPageURLV2ToRESTPageURLV2 } from '@wix/sdk-runtime/transformations/page-url-v2';
11
- import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
12
- export var DescriptionLineType;
13
- (function (DescriptionLineType) {
14
- /** Unrecognized type. */
15
- DescriptionLineType["UNRECOGNISED"] = "UNRECOGNISED";
16
- /** Plain text type. */
17
- DescriptionLineType["PLAIN_TEXT"] = "PLAIN_TEXT";
18
- /** Color type. */
19
- DescriptionLineType["COLOR"] = "COLOR";
20
- })(DescriptionLineType || (DescriptionLineType = {}));
21
- export var ItemTypeItemType;
22
- (function (ItemTypeItemType) {
23
- ItemTypeItemType["UNRECOGNISED"] = "UNRECOGNISED";
24
- ItemTypeItemType["PHYSICAL"] = "PHYSICAL";
25
- ItemTypeItemType["DIGITAL"] = "DIGITAL";
26
- ItemTypeItemType["GIFT_CARD"] = "GIFT_CARD";
27
- ItemTypeItemType["SERVICE"] = "SERVICE";
28
- })(ItemTypeItemType || (ItemTypeItemType = {}));
29
- /** Type of selected payment option for catalog item */
30
- export var PaymentOptionType;
31
- (function (PaymentOptionType) {
32
- /** The entire payment for this item happens as part of the checkout. */
33
- PaymentOptionType["FULL_PAYMENT_ONLINE"] = "FULL_PAYMENT_ONLINE";
34
- /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
35
- PaymentOptionType["FULL_PAYMENT_OFFLINE"] = "FULL_PAYMENT_OFFLINE";
36
- /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
37
- PaymentOptionType["MEMBERSHIP"] = "MEMBERSHIP";
38
- /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
39
- PaymentOptionType["DEPOSIT_ONLINE"] = "DEPOSIT_ONLINE";
40
- /** 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`. */
41
- PaymentOptionType["MEMBERSHIP_OFFLINE"] = "MEMBERSHIP_OFFLINE";
42
- })(PaymentOptionType || (PaymentOptionType = {}));
43
- /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
44
- export var JurisdictionType;
45
- (function (JurisdictionType) {
46
- JurisdictionType["UNDEFINED"] = "UNDEFINED";
47
- JurisdictionType["COUNTRY"] = "COUNTRY";
48
- JurisdictionType["STATE"] = "STATE";
49
- JurisdictionType["COUNTY"] = "COUNTY";
50
- JurisdictionType["CITY"] = "CITY";
51
- JurisdictionType["SPECIAL"] = "SPECIAL";
52
- })(JurisdictionType || (JurisdictionType = {}));
53
- /** Frequency unit of recurring payment */
54
- export var SubscriptionFrequency;
55
- (function (SubscriptionFrequency) {
56
- SubscriptionFrequency["UNDEFINED"] = "UNDEFINED";
57
- SubscriptionFrequency["DAY"] = "DAY";
58
- SubscriptionFrequency["WEEK"] = "WEEK";
59
- SubscriptionFrequency["MONTH"] = "MONTH";
60
- SubscriptionFrequency["YEAR"] = "YEAR";
61
- })(SubscriptionFrequency || (SubscriptionFrequency = {}));
62
- export var AdjustmentType;
63
- (function (AdjustmentType) {
64
- AdjustmentType["UNKNOWN_ADJUSTMENT_TYPE"] = "UNKNOWN_ADJUSTMENT_TYPE";
65
- /** Adjustment increases the total amount due to changes like covering extra billing days. Typically results in an additional fee. */
66
- AdjustmentType["EXTRA_CHARGE"] = "EXTRA_CHARGE";
67
- /** Adjustment reduces the total amount due to changes like covering fewer billing days. Typically results in a credit or discount. */
68
- AdjustmentType["CREDIT"] = "CREDIT";
69
- })(AdjustmentType || (AdjustmentType = {}));
70
- export var TaxableAddressType;
71
- (function (TaxableAddressType) {
72
- TaxableAddressType["UNKNOWN_TAXABLE_ADDRESS"] = "UNKNOWN_TAXABLE_ADDRESS";
73
- TaxableAddressType["BUSINESS"] = "BUSINESS";
74
- TaxableAddressType["BILLING"] = "BILLING";
75
- TaxableAddressType["SHIPPING"] = "SHIPPING";
76
- })(TaxableAddressType || (TaxableAddressType = {}));
77
- /** tax info types */
78
- export var VatType;
79
- (function (VatType) {
80
- VatType["UNSPECIFIED"] = "UNSPECIFIED";
81
- /** CPF - for individual tax payers. */
82
- VatType["CPF"] = "CPF";
83
- /** CNPJ - for corporations */
84
- VatType["CNPJ"] = "CNPJ";
85
- })(VatType || (VatType = {}));
86
- export var PickupDetailsPickupMethod;
87
- (function (PickupDetailsPickupMethod) {
88
- PickupDetailsPickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
89
- PickupDetailsPickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
90
- PickupDetailsPickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
91
- })(PickupDetailsPickupMethod || (PickupDetailsPickupMethod = {}));
92
- export var SourceType;
93
- (function (SourceType) {
94
- /** Part of the original order */
95
- SourceType["ORIGINAL_ORDER"] = "ORIGINAL_ORDER";
96
- /** Added by estimate * */
97
- SourceType["AUTOMATIC"] = "AUTOMATIC";
98
- /** Added manually to current draft order */
99
- SourceType["CUSTOM"] = "CUSTOM";
100
- })(SourceType || (SourceType = {}));
101
- export var AppliedDiscountDiscountType;
102
- (function (AppliedDiscountDiscountType) {
103
- AppliedDiscountDiscountType["GLOBAL"] = "GLOBAL";
104
- AppliedDiscountDiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
105
- AppliedDiscountDiscountType["SHIPPING"] = "SHIPPING";
106
- })(AppliedDiscountDiscountType || (AppliedDiscountDiscountType = {}));
107
- export var DiscountReason;
108
- (function (DiscountReason) {
109
- DiscountReason["UNSPECIFIED"] = "UNSPECIFIED";
110
- DiscountReason["EXCHANGED_ITEMS"] = "EXCHANGED_ITEMS";
111
- DiscountReason["BILLING_ADJUSTMENT"] = "BILLING_ADJUSTMENT";
112
- })(DiscountReason || (DiscountReason = {}));
113
- export var EditingStatus;
114
- (function (EditingStatus) {
115
- /** DraftOrder is in draft state. */
116
- EditingStatus["DRAFT"] = "DRAFT";
117
- /** DraftOrder is in committed state. */
118
- EditingStatus["COMMITTED"] = "COMMITTED";
119
- })(EditingStatus || (EditingStatus = {}));
120
- export var WeightUnit;
121
- (function (WeightUnit) {
122
- /** Weight unit can't be classified due to an error. */
123
- WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
124
- /** Kilograms. */
125
- WeightUnit["KG"] = "KG";
126
- /** Pounds. */
127
- WeightUnit["LB"] = "LB";
128
- })(WeightUnit || (WeightUnit = {}));
129
- export var PickupMethod;
130
- (function (PickupMethod) {
131
- PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
132
- PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
133
- PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
134
- })(PickupMethod || (PickupMethod = {}));
135
- export var RuleType;
136
- (function (RuleType) {
137
- RuleType["VALIDATION"] = "VALIDATION";
138
- RuleType["OTHER"] = "OTHER";
139
- RuleType["MAX"] = "MAX";
140
- RuleType["MIN"] = "MIN";
141
- RuleType["MAX_LENGTH"] = "MAX_LENGTH";
142
- RuleType["MIN_LENGTH"] = "MIN_LENGTH";
143
- RuleType["MAX_SIZE"] = "MAX_SIZE";
144
- RuleType["MIN_SIZE"] = "MIN_SIZE";
145
- RuleType["FORMAT"] = "FORMAT";
146
- RuleType["DECIMAL_LTE"] = "DECIMAL_LTE";
147
- RuleType["DECIMAL_GTE"] = "DECIMAL_GTE";
148
- RuleType["DECIMAL_LT"] = "DECIMAL_LT";
149
- RuleType["DECIMAL_GT"] = "DECIMAL_GT";
150
- RuleType["DECIMAL_MAX_SCALE"] = "DECIMAL_MAX_SCALE";
151
- RuleType["INVALID_ENUM_VALUE"] = "INVALID_ENUM_VALUE";
152
- RuleType["REQUIRED_FIELD"] = "REQUIRED_FIELD";
153
- RuleType["FIELD_NOT_ALLOWED"] = "FIELD_NOT_ALLOWED";
154
- RuleType["ONE_OF_ALIGNMENT"] = "ONE_OF_ALIGNMENT";
155
- RuleType["EXACT_LENGTH"] = "EXACT_LENGTH";
156
- RuleType["EXACT_SIZE"] = "EXACT_SIZE";
157
- RuleType["REQUIRED_ONE_OF_FIELD"] = "REQUIRED_ONE_OF_FIELD";
158
- })(RuleType || (RuleType = {}));
159
- export var FileType;
160
- (function (FileType) {
161
- FileType["UNSPECIFIED"] = "UNSPECIFIED";
162
- FileType["SECURE_PICTURE"] = "SECURE_PICTURE";
163
- FileType["SECURE_VIDEO"] = "SECURE_VIDEO";
164
- FileType["SECURE_DOCUMENT"] = "SECURE_DOCUMENT";
165
- FileType["SECURE_MUSIC"] = "SECURE_MUSIC";
166
- FileType["SECURE_ARCHIVE"] = "SECURE_ARCHIVE";
167
- })(FileType || (FileType = {}));
168
- export var DiscountType;
169
- (function (DiscountType) {
170
- DiscountType["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
171
- DiscountType["GLOBAL"] = "GLOBAL";
172
- DiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
173
- DiscountType["SHIPPING"] = "SHIPPING";
174
- })(DiscountType || (DiscountType = {}));
175
- export var NonDraftableReason;
176
- (function (NonDraftableReason) {
177
- NonDraftableReason["UNSPECIFIED"] = "UNSPECIFIED";
178
- NonDraftableReason["PARTIALLY_OR_FULLY_REFUNDED"] = "PARTIALLY_OR_FULLY_REFUNDED";
179
- NonDraftableReason["UNSUPPORTED_CHANNEL_TYPE"] = "UNSUPPORTED_CHANNEL_TYPE";
180
- NonDraftableReason["ORDER_STATUS_IS_NOT_SUPPORTED"] = "ORDER_STATUS_IS_NOT_SUPPORTED";
181
- NonDraftableReason["ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT"] = "ORDER_AND_SITE_CURRENCIES_ARE_INCONSISTENT";
182
- NonDraftableReason["ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT"] = "ORDER_AND_SITE_WEIGHT_UNITS_ARE_INCONSISTENT";
183
- NonDraftableReason["AMOUNTS_DO_NOT_ADD_UP"] = "AMOUNTS_DO_NOT_ADD_UP";
184
- /** remove - this is not a reason, it's an error */
185
- NonDraftableReason["ORDER_NOT_FOUND"] = "ORDER_NOT_FOUND";
186
- NonDraftableReason["SUBSCRIPTION_LINE_ITEM_EXISTS"] = "SUBSCRIPTION_LINE_ITEM_EXISTS";
187
- NonDraftableReason["UNSUPPORTED_CATALOG_ITEM"] = "UNSUPPORTED_CATALOG_ITEM";
188
- NonDraftableReason["TAXABLE_EXISTING_ADDITIONAL_FEE"] = "TAXABLE_EXISTING_ADDITIONAL_FEE";
189
- })(NonDraftableReason || (NonDraftableReason = {}));
190
- export var PaymentStatus;
191
- (function (PaymentStatus) {
192
- PaymentStatus["UNSPECIFIED"] = "UNSPECIFIED";
193
- /**
194
- * `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
195
- * This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
196
- */
197
- PaymentStatus["NOT_PAID"] = "NOT_PAID";
198
- /** All required payments associated with this order are paid. */
199
- PaymentStatus["PAID"] = "PAID";
200
- /** Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. */
201
- PaymentStatus["PARTIALLY_REFUNDED"] = "PARTIALLY_REFUNDED";
202
- /** Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. */
203
- PaymentStatus["FULLY_REFUNDED"] = "FULLY_REFUNDED";
204
- /**
205
- * All payments pending.
206
- *
207
- * 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.
208
- * Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
209
- */
210
- PaymentStatus["PENDING"] = "PENDING";
211
- /** At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. */
212
- PaymentStatus["PARTIALLY_PAID"] = "PARTIALLY_PAID";
213
- /**
214
- * Payment received, but not yet confirmed by the payment provider.
215
- *
216
- * In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
217
- * 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.
218
- * @documentationMaturity preview
219
- */
220
- PaymentStatus["PENDING_MERCHANT"] = "PENDING_MERCHANT";
221
- /**
222
- * One or more payments canceled.
223
- * @documentationMaturity preview
224
- */
225
- PaymentStatus["CANCELED"] = "CANCELED";
226
- /**
227
- * One or more payments declined.
228
- * @documentationMaturity preview
229
- */
230
- PaymentStatus["DECLINED"] = "DECLINED";
231
- })(PaymentStatus || (PaymentStatus = {}));
232
- export var FulfillmentStatus;
233
- (function (FulfillmentStatus) {
234
- /** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
235
- FulfillmentStatus["NOT_FULFILLED"] = "NOT_FULFILLED";
236
- /**
237
- * All of the order items are fulfilled or the order was manually marked as fulfilled.
238
- * Orders without shipping info are fulfilled automatically.
239
- */
240
- FulfillmentStatus["FULFILLED"] = "FULFILLED";
241
- /** Some, but not all, of the order items are fulfilled. */
242
- FulfillmentStatus["PARTIALLY_FULFILLED"] = "PARTIALLY_FULFILLED";
243
- })(FulfillmentStatus || (FulfillmentStatus = {}));
244
- export var OrderStatus;
245
- (function (OrderStatus) {
246
- /** Order created, but not yet approved or canceled. */
247
- OrderStatus["INITIALIZED"] = "INITIALIZED";
248
- /**
249
- * Order approved.
250
- *
251
- * This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
252
- * Offline orders (cash payment) are automatically approved.
253
- */
254
- OrderStatus["APPROVED"] = "APPROVED";
255
- /** Order canceled by the user. */
256
- OrderStatus["CANCELED"] = "CANCELED";
257
- /**
258
- * Order pending.
259
- * @documentationMaturity preview
260
- */
261
- OrderStatus["PENDING"] = "PENDING";
262
- /**
263
- * Order rejected.
264
- *
265
- * This happens when pending payments fail.
266
- * @documentationMaturity preview
267
- */
268
- OrderStatus["REJECTED"] = "REJECTED";
269
- })(OrderStatus || (OrderStatus = {}));
270
- export var LineItemQuantityChangeType;
271
- (function (LineItemQuantityChangeType) {
272
- /** Quantity increased. */
273
- LineItemQuantityChangeType["QUANTITY_INCREASED"] = "QUANTITY_INCREASED";
274
- /** Quantity decreased. */
275
- LineItemQuantityChangeType["QUANTITY_DECREASED"] = "QUANTITY_DECREASED";
276
- })(LineItemQuantityChangeType || (LineItemQuantityChangeType = {}));
277
- export var ActivityType;
278
- (function (ActivityType) {
279
- ActivityType["ORDER_REFUNDED"] = "ORDER_REFUNDED";
280
- ActivityType["ORDER_PLACED"] = "ORDER_PLACED";
281
- ActivityType["ORDER_PAID"] = "ORDER_PAID";
282
- ActivityType["ORDER_FULFILLED"] = "ORDER_FULFILLED";
283
- ActivityType["ORDER_NOT_FULFILLED"] = "ORDER_NOT_FULFILLED";
284
- ActivityType["ORDER_CANCELED"] = "ORDER_CANCELED";
285
- ActivityType["DOWNLOAD_LINK_SENT"] = "DOWNLOAD_LINK_SENT";
286
- ActivityType["TRACKING_NUMBER_ADDED"] = "TRACKING_NUMBER_ADDED";
287
- ActivityType["TRACKING_NUMBER_EDITED"] = "TRACKING_NUMBER_EDITED";
288
- ActivityType["TRACKING_LINK_ADDED"] = "TRACKING_LINK_ADDED";
289
- ActivityType["SHIPPING_CONFIRMATION_EMAIL_SENT"] = "SHIPPING_CONFIRMATION_EMAIL_SENT";
290
- ActivityType["INVOICE_ADDED"] = "INVOICE_ADDED";
291
- ActivityType["INVOICE_REMOVED"] = "INVOICE_REMOVED";
292
- ActivityType["INVOICE_SENT"] = "INVOICE_SENT";
293
- ActivityType["FULFILLER_EMAIL_SENT"] = "FULFILLER_EMAIL_SENT";
294
- ActivityType["SHIPPING_ADDRESS_EDITED"] = "SHIPPING_ADDRESS_EDITED";
295
- ActivityType["EMAIL_EDITED"] = "EMAIL_EDITED";
296
- ActivityType["PICKUP_READY_EMAIL_SENT"] = "PICKUP_READY_EMAIL_SENT";
297
- ActivityType["CUSTOM_ACTIVITY"] = "CUSTOM_ACTIVITY";
298
- ActivityType["MERCHANT_COMMENT"] = "MERCHANT_COMMENT";
299
- ActivityType["ORDER_CREATED_FROM_EXCHANGE"] = "ORDER_CREATED_FROM_EXCHANGE";
300
- ActivityType["NEW_EXCHANGE_ORDER_CREATED"] = "NEW_EXCHANGE_ORDER_CREATED";
301
- ActivityType["ORDER_PARTIALLY_PAID"] = "ORDER_PARTIALLY_PAID";
302
- ActivityType["DRAFT_ORDER_CHANGES_APPLIED"] = "DRAFT_ORDER_CHANGES_APPLIED";
303
- ActivityType["SAVED_PAYMENT_METHOD"] = "SAVED_PAYMENT_METHOD";
304
- /** @documentationMaturity preview */
305
- ActivityType["PAYMENT_PENDING"] = "PAYMENT_PENDING";
306
- /** @documentationMaturity preview */
307
- ActivityType["PAYMENT_CANCELED"] = "PAYMENT_CANCELED";
308
- /** @documentationMaturity preview */
309
- ActivityType["PAYMENT_DECLINED"] = "PAYMENT_DECLINED";
310
- /** @documentationMaturity preview */
311
- ActivityType["ORDER_PENDING"] = "ORDER_PENDING";
312
- /** @documentationMaturity preview */
313
- ActivityType["ORDER_REJECTED"] = "ORDER_REJECTED";
314
- })(ActivityType || (ActivityType = {}));
315
- export var AttributionSource;
316
- (function (AttributionSource) {
317
- AttributionSource["UNSPECIFIED"] = "UNSPECIFIED";
318
- AttributionSource["FACEBOOK_ADS"] = "FACEBOOK_ADS";
319
- })(AttributionSource || (AttributionSource = {}));
320
- export var ChannelType;
321
- (function (ChannelType) {
322
- /** Unspecified sales channel. This value is not supported. */
323
- ChannelType["UNSPECIFIED"] = "UNSPECIFIED";
324
- /** A web client. */
325
- ChannelType["WEB"] = "WEB";
326
- /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
327
- ChannelType["POS"] = "POS";
328
- /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
329
- ChannelType["EBAY"] = "EBAY";
330
- /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
331
- ChannelType["AMAZON"] = "AMAZON";
332
- /** Other sales platform. */
333
- ChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
334
- /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
335
- ChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
336
- /** 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) */
337
- ChannelType["WIX_INVOICES"] = "WIX_INVOICES";
338
- /** Wix merchant backoffice. */
339
- ChannelType["BACKOFFICE_MERCHANT"] = "BACKOFFICE_MERCHANT";
340
- /** Wish sales channel. */
341
- ChannelType["WISH"] = "WISH";
342
- /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
343
- ChannelType["CLASS_PASS"] = "CLASS_PASS";
344
- /** Global-E sales channel. */
345
- ChannelType["GLOBAL_E"] = "GLOBAL_E";
346
- /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
347
- ChannelType["FACEBOOK"] = "FACEBOOK";
348
- /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
349
- ChannelType["ETSY"] = "ETSY";
350
- /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
351
- ChannelType["TIKTOK"] = "TIKTOK";
352
- /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
353
- ChannelType["FAIRE_COM"] = "FAIRE_COM";
354
- })(ChannelType || (ChannelType = {}));
355
- export var SortOrder;
356
- (function (SortOrder) {
357
- SortOrder["ASC"] = "ASC";
358
- SortOrder["DESC"] = "DESC";
359
- })(SortOrder || (SortOrder = {}));
360
- export var WebhookIdentityType;
361
- (function (WebhookIdentityType) {
362
- WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
363
- WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
364
- WebhookIdentityType["MEMBER"] = "MEMBER";
365
- WebhookIdentityType["WIX_USER"] = "WIX_USER";
366
- WebhookIdentityType["APP"] = "APP";
367
- })(WebhookIdentityType || (WebhookIdentityType = {}));
368
- /**
369
- * Creates or gets a draft order.
370
- *
371
- * When passing the ID of an order that is already in draft, the existing draft order will be returned.
372
- * To complete a draft and update the order, call [Commit Draft Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/commit-draft-order).
373
- * @param orderId - To create a draft from existing order, provide its id. Otherwise, an empty draft will be created.
374
- * @public
375
- * @documentationMaturity preview
376
- * @requiredField orderId
377
- * @permissionId ECOM.DRAFT_ORDERS_CREATE
378
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
379
- * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
380
- * @permissionScope Manage Stores - all permissions
381
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
382
- * @permissionScope Manage Restaurants - all permissions
383
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
384
- * @permissionScope Manage eCommerce - all permissions
385
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
386
- * @permissionScope Picasso private app mega scope
387
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
388
- * @applicableIdentity APP
389
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateDraftOrder
390
- */
391
- export async function createDraftOrder(orderId) {
392
- // @ts-ignore
393
- const { httpClient, sideEffects } = arguments[1];
394
- const payload = renameKeysFromSDKRequestToRESTRequest({ orderId: orderId });
395
- const reqOpts = ambassadorWixEcomV1DraftOrder.createDraftOrder(payload);
396
- sideEffects?.onSiteCall?.();
397
- try {
398
- const result = await httpClient.request(reqOpts);
399
- sideEffects?.onSuccess?.(result);
400
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
401
- {
402
- transformFn: transformRESTImageToSDKImage,
403
- paths: [
404
- {
405
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
406
- },
407
- ],
408
- },
409
- {
410
- transformFn: transformRESTAddressToSDKAddress,
411
- paths: [
412
- {
413
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
414
- },
415
- {
416
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
417
- },
418
- {
419
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
420
- },
421
- {
422
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
423
- },
424
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
425
- {
426
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
427
- },
428
- {
429
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
430
- },
431
- {
432
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
433
- },
434
- {
435
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
436
- },
437
- {
438
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
439
- },
440
- ],
441
- },
442
- ]));
443
- }
444
- catch (err) {
445
- const transformedError = sdkTransformError(err, {
446
- spreadPathsToArguments: {},
447
- explicitPathsToArguments: { orderId: '$[0]' },
448
- singleArgumentUnchanged: false,
449
- }, ['orderId']);
450
- sideEffects?.onError?.(err);
451
- throw transformedError;
452
- }
453
- }
454
- /**
455
- * Creates an empty draft order.
456
- * @public
457
- * @documentationMaturity preview
458
- * @permissionId ECOM.DRAFT_ORDERS_CREATE
459
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
460
- * @permissionId DRAFT_ORDER_WRITE_ALL_EXTENDED_FIELDS
461
- * @permissionScope Manage Stores - all permissions
462
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
463
- * @permissionScope Manage Restaurants - all permissions
464
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
465
- * @permissionScope Manage eCommerce - all permissions
466
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
467
- * @permissionScope Picasso private app mega scope
468
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
469
- * @applicableIdentity APP
470
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateEmptyDraftOrder
471
- */
472
- export async function createEmptyDraftOrder() {
473
- // @ts-ignore
474
- const { httpClient, sideEffects } = arguments[0];
475
- const payload = renameKeysFromSDKRequestToRESTRequest({});
476
- const reqOpts = ambassadorWixEcomV1DraftOrder.createEmptyDraftOrder(payload);
477
- sideEffects?.onSiteCall?.();
478
- try {
479
- const result = await httpClient.request(reqOpts);
480
- sideEffects?.onSuccess?.(result);
481
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
482
- {
483
- transformFn: transformRESTImageToSDKImage,
484
- paths: [
485
- {
486
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
487
- },
488
- ],
489
- },
490
- {
491
- transformFn: transformRESTAddressToSDKAddress,
492
- paths: [
493
- {
494
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
495
- },
496
- {
497
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
498
- },
499
- {
500
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
501
- },
502
- {
503
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
504
- },
505
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
506
- {
507
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
508
- },
509
- {
510
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
511
- },
512
- {
513
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
514
- },
515
- {
516
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
517
- },
518
- {
519
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
520
- },
521
- ],
522
- },
523
- ]));
524
- }
525
- catch (err) {
526
- const transformedError = sdkTransformError(err, {
527
- spreadPathsToArguments: {},
528
- explicitPathsToArguments: {},
529
- singleArgumentUnchanged: false,
530
- }, []);
531
- sideEffects?.onError?.(err);
532
- throw transformedError;
533
- }
534
- }
535
- /**
536
- * Adds line items to a draft order.
537
- * @param draftOrderId - The draft order id
538
- * @public
539
- * @documentationMaturity preview
540
- * @requiredField draftOrderId
541
- * @requiredField options.catalogLineItems.catalogReference
542
- * @permissionId ECOM.DRAFT_ORDERS_ADD_LINE_ITEMS
543
- * @permissionScope Manage Stores - all permissions
544
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
545
- * @permissionScope Manage Restaurants - all permissions
546
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
547
- * @permissionScope Manage eCommerce - all permissions
548
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
549
- * @permissionScope Picasso private app mega scope
550
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
551
- * @applicableIdentity APP
552
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.AddLineItemsToDraftOrder
553
- */
554
- export async function addLineItemsToDraftOrder(draftOrderId, options) {
555
- // @ts-ignore
556
- const { httpClient, sideEffects } = arguments[2];
557
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
558
- draftOrderId: draftOrderId,
559
- catalogLineItems: options?.catalogLineItems,
560
- customLineItems: options?.customLineItems,
561
- }), [
562
- {
563
- transformFn: transformSDKPageURLV2ToRESTPageURLV2,
564
- paths: [{ path: 'customLineItems.url' }],
565
- },
566
- {
567
- transformFn: transformSDKImageToRESTImage,
568
- paths: [{ path: 'customLineItems.media' }],
569
- },
570
- ]);
571
- const reqOpts = ambassadorWixEcomV1DraftOrder.addLineItemsToDraftOrder(payload);
572
- sideEffects?.onSiteCall?.();
573
- try {
574
- const result = await httpClient.request(reqOpts);
575
- sideEffects?.onSuccess?.(result);
576
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
577
- {
578
- transformFn: transformRESTImageToSDKImage,
579
- paths: [
580
- {
581
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
582
- },
583
- ],
584
- },
585
- {
586
- transformFn: transformRESTAddressToSDKAddress,
587
- paths: [
588
- {
589
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
590
- },
591
- {
592
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
593
- },
594
- {
595
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
596
- },
597
- {
598
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
599
- },
600
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
601
- {
602
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
603
- },
604
- {
605
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
606
- },
607
- {
608
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
609
- },
610
- {
611
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
612
- },
613
- {
614
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
615
- },
616
- ],
617
- },
618
- ]));
619
- }
620
- catch (err) {
621
- const transformedError = sdkTransformError(err, {
622
- spreadPathsToArguments: {},
623
- explicitPathsToArguments: {
624
- draftOrderId: '$[0]',
625
- catalogLineItems: '$[1].catalogLineItems',
626
- customLineItems: '$[1].customLineItems',
627
- },
628
- singleArgumentUnchanged: false,
629
- }, ['draftOrderId', 'options']);
630
- sideEffects?.onError?.(err);
631
- throw transformedError;
632
- }
633
- }
634
- /**
635
- * Updates a draft order's line items.
636
- *
637
- * Using this API, you can update a line item's quantity, price, and description.
638
- * > **Notes:**
639
- * > + Passing a quantity of `0` will remove the line item.
640
- * > + Price cannot be updated for line items with `paymentOption: MEMBERSHIP`.
641
- * > + Quantity cannot be decreased fulfilled line items. To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
642
- * @param draftOrderId - The draft order id
643
- * @public
644
- * @documentationMaturity preview
645
- * @requiredField draftOrderId
646
- * @permissionId ECOM.DRAFT_ORDERS_MODIFY_ITEMS
647
- * @permissionScope Manage Stores - all permissions
648
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
649
- * @permissionScope Manage Restaurants - all permissions
650
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
651
- * @permissionScope Manage eCommerce - all permissions
652
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
653
- * @permissionScope Picasso private app mega scope
654
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
655
- * @applicableIdentity APP
656
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.UpdateLineItems
657
- */
658
- export async function updateLineItems(draftOrderId, options) {
659
- // @ts-ignore
660
- const { httpClient, sideEffects } = arguments[2];
661
- const payload = renameKeysFromSDKRequestToRESTRequest({
662
- draftOrderId: draftOrderId,
663
- lineItemChanges: options?.lineItemChanges,
664
- });
665
- const reqOpts = ambassadorWixEcomV1DraftOrder.updateLineItems(payload);
666
- sideEffects?.onSiteCall?.();
667
- try {
668
- const result = await httpClient.request(reqOpts);
669
- sideEffects?.onSuccess?.(result);
670
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
671
- {
672
- transformFn: transformRESTImageToSDKImage,
673
- paths: [
674
- {
675
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
676
- },
677
- ],
678
- },
679
- {
680
- transformFn: transformRESTAddressToSDKAddress,
681
- paths: [
682
- {
683
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
684
- },
685
- {
686
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
687
- },
688
- {
689
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
690
- },
691
- {
692
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
693
- },
694
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
695
- {
696
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
697
- },
698
- {
699
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
700
- },
701
- {
702
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
703
- },
704
- {
705
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
706
- },
707
- {
708
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
709
- },
710
- ],
711
- },
712
- ]));
713
- }
714
- catch (err) {
715
- const transformedError = sdkTransformError(err, {
716
- spreadPathsToArguments: {},
717
- explicitPathsToArguments: {
718
- draftOrderId: '$[0]',
719
- lineItemChanges: '$[1].lineItemChanges',
720
- },
721
- singleArgumentUnchanged: false,
722
- }, ['draftOrderId', 'options']);
723
- sideEffects?.onError?.(err);
724
- throw transformedError;
725
- }
726
- }
727
- /**
728
- * Sets and enables or disables discounts on a draft order.
729
- *
730
- * Any discounts not passed will not change.
731
- * @param draftOrderId - The draft order id
732
- * @param discounts - The discount ids to opt-in. all existing discounts not listed are to be opted-out.
733
- * @public
734
- * @documentationMaturity preview
735
- * @requiredField discounts
736
- * @requiredField draftOrderId
737
- * @permissionId ECOM.DRAFT_ORDERS_SET_DISCOUNTS
738
- * @permissionScope Manage Stores - all permissions
739
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
740
- * @permissionScope Manage Restaurants - all permissions
741
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
742
- * @permissionScope Manage eCommerce - all permissions
743
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
744
- * @permissionScope Picasso private app mega scope
745
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
746
- * @applicableIdentity APP
747
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetDiscounts
748
- */
749
- export async function setDiscounts(draftOrderId, discounts) {
750
- // @ts-ignore
751
- const { httpClient, sideEffects } = arguments[2];
752
- const payload = renameKeysFromSDKRequestToRESTRequest({
753
- draftOrderId: draftOrderId,
754
- discounts: discounts,
755
- });
756
- const reqOpts = ambassadorWixEcomV1DraftOrder.setDiscounts(payload);
757
- sideEffects?.onSiteCall?.();
758
- try {
759
- const result = await httpClient.request(reqOpts);
760
- sideEffects?.onSuccess?.(result);
761
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
762
- {
763
- transformFn: transformRESTImageToSDKImage,
764
- paths: [
765
- {
766
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
767
- },
768
- ],
769
- },
770
- {
771
- transformFn: transformRESTAddressToSDKAddress,
772
- paths: [
773
- {
774
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
775
- },
776
- {
777
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
778
- },
779
- {
780
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
781
- },
782
- {
783
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
784
- },
785
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
786
- {
787
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
788
- },
789
- {
790
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
791
- },
792
- {
793
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
794
- },
795
- {
796
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
797
- },
798
- {
799
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
800
- },
801
- ],
802
- },
803
- ]));
804
- }
805
- catch (err) {
806
- const transformedError = sdkTransformError(err, {
807
- spreadPathsToArguments: {},
808
- explicitPathsToArguments: { draftOrderId: '$[0]', discounts: '$[1]' },
809
- singleArgumentUnchanged: false,
810
- }, ['draftOrderId', 'discounts']);
811
- sideEffects?.onError?.(err);
812
- throw transformedError;
813
- }
814
- }
815
- /**
816
- * Adds merchant discounts to the order.
817
- * @param draftOrderId - The draft order id
818
- * @public
819
- * @documentationMaturity preview
820
- * @requiredField draftOrderId
821
- * @requiredField options.discounts.amount
822
- * @requiredField options.discounts.amount.amount
823
- * @requiredField options.discounts.discountType
824
- * @permissionId ECOM.DRAFT_ORDERS_ADD_DISCOUNTS
825
- * @permissionScope Manage Stores - all permissions
826
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
827
- * @permissionScope Manage Restaurants - all permissions
828
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
829
- * @permissionScope Manage eCommerce - all permissions
830
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
831
- * @permissionScope Picasso private app mega scope
832
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
833
- * @applicableIdentity APP
834
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomDiscounts
835
- */
836
- export async function createCustomDiscounts(draftOrderId, options) {
837
- // @ts-ignore
838
- const { httpClient, sideEffects } = arguments[2];
839
- const payload = renameKeysFromSDKRequestToRESTRequest({
840
- draftOrderId: draftOrderId,
841
- discounts: options?.discounts,
842
- });
843
- const reqOpts = ambassadorWixEcomV1DraftOrder.createCustomDiscounts(payload);
844
- sideEffects?.onSiteCall?.();
845
- try {
846
- const result = await httpClient.request(reqOpts);
847
- sideEffects?.onSuccess?.(result);
848
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
849
- {
850
- transformFn: transformRESTImageToSDKImage,
851
- paths: [
852
- {
853
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
854
- },
855
- ],
856
- },
857
- {
858
- transformFn: transformRESTAddressToSDKAddress,
859
- paths: [
860
- {
861
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
862
- },
863
- {
864
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
865
- },
866
- {
867
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
868
- },
869
- {
870
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
871
- },
872
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
873
- {
874
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
875
- },
876
- {
877
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
878
- },
879
- {
880
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
881
- },
882
- {
883
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
884
- },
885
- {
886
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
887
- },
888
- ],
889
- },
890
- ]));
891
- }
892
- catch (err) {
893
- const transformedError = sdkTransformError(err, {
894
- spreadPathsToArguments: {},
895
- explicitPathsToArguments: {
896
- draftOrderId: '$[0]',
897
- discounts: '$[1].discounts',
898
- },
899
- singleArgumentUnchanged: false,
900
- }, ['draftOrderId', 'options']);
901
- sideEffects?.onError?.(err);
902
- throw transformedError;
903
- }
904
- }
905
- /**
906
- * Remove custom discounts from the order.
907
- * @param draftOrderId - The draft order id
908
- * @param discountIds - The discounts to remove
909
- * @public
910
- * @documentationMaturity preview
911
- * @requiredField discountIds
912
- * @requiredField draftOrderId
913
- * @permissionId ECOM.DRAFT_ORDERS_DELETE_DISCOUNTS
914
- * @permissionScope Manage Stores - all permissions
915
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
916
- * @permissionScope Manage Restaurants - all permissions
917
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
918
- * @permissionScope Manage eCommerce - all permissions
919
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
920
- * @permissionScope Picasso private app mega scope
921
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
922
- * @applicableIdentity APP
923
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomDiscounts
924
- */
925
- export async function deleteCustomDiscounts(draftOrderId, discountIds) {
926
- // @ts-ignore
927
- const { httpClient, sideEffects } = arguments[2];
928
- const payload = renameKeysFromSDKRequestToRESTRequest({
929
- draftOrderId: draftOrderId,
930
- discountIds: discountIds,
931
- });
932
- const reqOpts = ambassadorWixEcomV1DraftOrder.deleteCustomDiscounts(payload);
933
- sideEffects?.onSiteCall?.();
934
- try {
935
- const result = await httpClient.request(reqOpts);
936
- sideEffects?.onSuccess?.(result);
937
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
938
- {
939
- transformFn: transformRESTImageToSDKImage,
940
- paths: [
941
- {
942
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
943
- },
944
- ],
945
- },
946
- {
947
- transformFn: transformRESTAddressToSDKAddress,
948
- paths: [
949
- {
950
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
951
- },
952
- {
953
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
954
- },
955
- {
956
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
957
- },
958
- {
959
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
960
- },
961
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
962
- {
963
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
964
- },
965
- {
966
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
967
- },
968
- {
969
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
970
- },
971
- {
972
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
973
- },
974
- {
975
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
976
- },
977
- ],
978
- },
979
- ]));
980
- }
981
- catch (err) {
982
- const transformedError = sdkTransformError(err, {
983
- spreadPathsToArguments: {},
984
- explicitPathsToArguments: { draftOrderId: '$[0]', discountIds: '$[1]' },
985
- singleArgumentUnchanged: false,
986
- }, ['draftOrderId', 'discountIds']);
987
- sideEffects?.onError?.(err);
988
- throw transformedError;
989
- }
990
- }
991
- /**
992
- * Set which additional fees existing on the draft order are to be opt-in.
993
- * All existing additional fees not provided on the call are opted-out.
994
- * @param draftOrderId - The draft order id
995
- * @param additionalFees - The additional fees ids to opt-in. all existing additional fees not listed are to be opted-out
996
- * @public
997
- * @documentationMaturity preview
998
- * @requiredField additionalFees
999
- * @requiredField draftOrderId
1000
- * @permissionId ECOM.DRAFT_ORDERS_SET_ADDITIONAL_FEES
1001
- * @permissionScope Manage Stores - all permissions
1002
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1003
- * @permissionScope Manage Restaurants - all permissions
1004
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1005
- * @permissionScope Manage eCommerce - all permissions
1006
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1007
- * @permissionScope Picasso private app mega scope
1008
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1009
- * @applicableIdentity APP
1010
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetAdditionalFees
1011
- */
1012
- export async function setAdditionalFees(draftOrderId, additionalFees) {
1013
- // @ts-ignore
1014
- const { httpClient, sideEffects } = arguments[2];
1015
- const payload = renameKeysFromSDKRequestToRESTRequest({
1016
- draftOrderId: draftOrderId,
1017
- additionalFees: additionalFees,
1018
- });
1019
- const reqOpts = ambassadorWixEcomV1DraftOrder.setAdditionalFees(payload);
1020
- sideEffects?.onSiteCall?.();
1021
- try {
1022
- const result = await httpClient.request(reqOpts);
1023
- sideEffects?.onSuccess?.(result);
1024
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1025
- {
1026
- transformFn: transformRESTImageToSDKImage,
1027
- paths: [
1028
- {
1029
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
1030
- },
1031
- ],
1032
- },
1033
- {
1034
- transformFn: transformRESTAddressToSDKAddress,
1035
- paths: [
1036
- {
1037
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1038
- },
1039
- {
1040
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1041
- },
1042
- {
1043
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1044
- },
1045
- {
1046
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1047
- },
1048
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
1049
- {
1050
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1051
- },
1052
- {
1053
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
1054
- },
1055
- {
1056
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
1057
- },
1058
- {
1059
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
1060
- },
1061
- {
1062
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
1063
- },
1064
- ],
1065
- },
1066
- ]));
1067
- }
1068
- catch (err) {
1069
- const transformedError = sdkTransformError(err, {
1070
- spreadPathsToArguments: {},
1071
- explicitPathsToArguments: {
1072
- draftOrderId: '$[0]',
1073
- additionalFees: '$[1]',
1074
- },
1075
- singleArgumentUnchanged: false,
1076
- }, ['draftOrderId', 'additionalFees']);
1077
- sideEffects?.onError?.(err);
1078
- throw transformedError;
1079
- }
1080
- }
1081
- /**
1082
- * Create custom additional fees to the order.
1083
- * added additional fees are by default opted-out.
1084
- * To opt-in them, please call SetAdditionalFees with the added additional fee ids.
1085
- * @param draftOrderId - The draft order id
1086
- * @public
1087
- * @documentationMaturity preview
1088
- * @requiredField draftOrderId
1089
- * @requiredField options.customAdditionalFees.name
1090
- * @requiredField options.customAdditionalFees.price
1091
- * @requiredField options.customAdditionalFees.price.amount
1092
- * @permissionId ECOM.DRAFT_ORDERS_CREATE_ADDITIONAL_FEES
1093
- * @permissionScope Manage Stores - all permissions
1094
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1095
- * @permissionScope Manage Restaurants - all permissions
1096
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1097
- * @permissionScope Manage eCommerce - all permissions
1098
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1099
- * @permissionScope Picasso private app mega scope
1100
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1101
- * @applicableIdentity APP
1102
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateCustomAdditionalFees
1103
- */
1104
- export async function createCustomAdditionalFees(draftOrderId, options) {
1105
- // @ts-ignore
1106
- const { httpClient, sideEffects } = arguments[2];
1107
- const payload = renameKeysFromSDKRequestToRESTRequest({
1108
- draftOrderId: draftOrderId,
1109
- customAdditionalFees: options?.customAdditionalFees,
1110
- });
1111
- const reqOpts = ambassadorWixEcomV1DraftOrder.createCustomAdditionalFees(payload);
1112
- sideEffects?.onSiteCall?.();
1113
- try {
1114
- const result = await httpClient.request(reqOpts);
1115
- sideEffects?.onSuccess?.(result);
1116
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1117
- {
1118
- transformFn: transformRESTImageToSDKImage,
1119
- paths: [
1120
- {
1121
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
1122
- },
1123
- ],
1124
- },
1125
- {
1126
- transformFn: transformRESTAddressToSDKAddress,
1127
- paths: [
1128
- {
1129
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1130
- },
1131
- {
1132
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1133
- },
1134
- {
1135
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1136
- },
1137
- {
1138
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1139
- },
1140
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
1141
- {
1142
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1143
- },
1144
- {
1145
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
1146
- },
1147
- {
1148
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
1149
- },
1150
- {
1151
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
1152
- },
1153
- {
1154
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
1155
- },
1156
- ],
1157
- },
1158
- ]));
1159
- }
1160
- catch (err) {
1161
- const transformedError = sdkTransformError(err, {
1162
- spreadPathsToArguments: {},
1163
- explicitPathsToArguments: {
1164
- draftOrderId: '$[0]',
1165
- customAdditionalFees: '$[1].customAdditionalFees',
1166
- },
1167
- singleArgumentUnchanged: false,
1168
- }, ['draftOrderId', 'options']);
1169
- sideEffects?.onError?.(err);
1170
- throw transformedError;
1171
- }
1172
- }
1173
- /**
1174
- * Remove custom additional fees from the order.
1175
- * @param draftOrderId - The draft order id
1176
- * @param customAdditionalFees - The additional fees to remove
1177
- * @public
1178
- * @documentationMaturity preview
1179
- * @requiredField customAdditionalFees
1180
- * @requiredField draftOrderId
1181
- * @permissionId ECOM.DRAFT_ORDERS_DELETE_ADDITIONAL_FEES
1182
- * @permissionScope Manage Stores - all permissions
1183
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1184
- * @permissionScope Manage Restaurants - all permissions
1185
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1186
- * @permissionScope Manage eCommerce - all permissions
1187
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1188
- * @permissionScope Picasso private app mega scope
1189
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1190
- * @applicableIdentity APP
1191
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteCustomAdditionalFees
1192
- */
1193
- export async function deleteCustomAdditionalFees(draftOrderId, customAdditionalFees) {
1194
- // @ts-ignore
1195
- const { httpClient, sideEffects } = arguments[2];
1196
- const payload = renameKeysFromSDKRequestToRESTRequest({
1197
- draftOrderId: draftOrderId,
1198
- customAdditionalFees: customAdditionalFees,
1199
- });
1200
- const reqOpts = ambassadorWixEcomV1DraftOrder.deleteCustomAdditionalFees(payload);
1201
- sideEffects?.onSiteCall?.();
1202
- try {
1203
- const result = await httpClient.request(reqOpts);
1204
- sideEffects?.onSuccess?.(result);
1205
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1206
- {
1207
- transformFn: transformRESTImageToSDKImage,
1208
- paths: [
1209
- {
1210
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
1211
- },
1212
- ],
1213
- },
1214
- {
1215
- transformFn: transformRESTAddressToSDKAddress,
1216
- paths: [
1217
- {
1218
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1219
- },
1220
- {
1221
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1222
- },
1223
- {
1224
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1225
- },
1226
- {
1227
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1228
- },
1229
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
1230
- {
1231
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1232
- },
1233
- {
1234
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
1235
- },
1236
- {
1237
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
1238
- },
1239
- {
1240
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
1241
- },
1242
- {
1243
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
1244
- },
1245
- ],
1246
- },
1247
- ]));
1248
- }
1249
- catch (err) {
1250
- const transformedError = sdkTransformError(err, {
1251
- spreadPathsToArguments: {},
1252
- explicitPathsToArguments: {
1253
- draftOrderId: '$[0]',
1254
- customAdditionalFees: '$[1]',
1255
- },
1256
- singleArgumentUnchanged: false,
1257
- }, ['draftOrderId', 'customAdditionalFees']);
1258
- sideEffects?.onError?.(err);
1259
- throw transformedError;
1260
- }
1261
- }
1262
- /**
1263
- * Sets shipping info to a draft order.
1264
- * @public
1265
- * @documentationMaturity preview
1266
- * @permissionId ECOM.DRAFT_ORDERS_SET_SHIPPING_INFO
1267
- * @permissionScope Manage Stores - all permissions
1268
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1269
- * @permissionScope Manage Restaurants - all permissions
1270
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1271
- * @permissionScope Manage eCommerce - all permissions
1272
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1273
- * @permissionScope Picasso private app mega scope
1274
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1275
- * @applicableIdentity APP
1276
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetShippingInfo
1277
- */
1278
- export async function setShippingInfo() {
1279
- // @ts-ignore
1280
- const { httpClient, sideEffects } = arguments[0];
1281
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({}), [
1282
- {
1283
- transformFn: transformSDKAddressToRESTAddress,
1284
- paths: [
1285
- { path: 'shippingInfo.logistics.shippingDestination.address' },
1286
- { path: 'shippingInfo.logistics.pickupDetails.address' },
1287
- ],
1288
- },
1289
- ]);
1290
- const reqOpts = ambassadorWixEcomV1DraftOrder.setShippingInfo(payload);
1291
- sideEffects?.onSiteCall?.();
1292
- try {
1293
- const result = await httpClient.request(reqOpts);
1294
- sideEffects?.onSuccess?.(result);
1295
- }
1296
- catch (err) {
1297
- const transformedError = sdkTransformError(err, {
1298
- spreadPathsToArguments: {},
1299
- explicitPathsToArguments: {},
1300
- singleArgumentUnchanged: false,
1301
- }, []);
1302
- sideEffects?.onError?.(err);
1303
- throw transformedError;
1304
- }
1305
- }
1306
- /**
1307
- * Sets buyer info to a draft order.
1308
- * @public
1309
- * @documentationMaturity preview
1310
- * @permissionId ECOM.DRAFT_ORDER_SET_BUYER_INFO
1311
- * @permissionScope Manage Stores - all permissions
1312
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1313
- * @permissionScope Manage Restaurants - all permissions
1314
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1315
- * @permissionScope Manage eCommerce - all permissions
1316
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1317
- * @permissionScope Picasso private app mega scope
1318
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1319
- * @applicableIdentity APP
1320
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBuyerInfo
1321
- */
1322
- export async function setBuyerInfo() {
1323
- // @ts-ignore
1324
- const { httpClient, sideEffects } = arguments[0];
1325
- const payload = renameKeysFromSDKRequestToRESTRequest({});
1326
- const reqOpts = ambassadorWixEcomV1DraftOrder.setBuyerInfo(payload);
1327
- sideEffects?.onSiteCall?.();
1328
- try {
1329
- const result = await httpClient.request(reqOpts);
1330
- sideEffects?.onSuccess?.(result);
1331
- }
1332
- catch (err) {
1333
- const transformedError = sdkTransformError(err, {
1334
- spreadPathsToArguments: {},
1335
- explicitPathsToArguments: {},
1336
- singleArgumentUnchanged: false,
1337
- }, []);
1338
- sideEffects?.onError?.(err);
1339
- throw transformedError;
1340
- }
1341
- }
1342
- /**
1343
- * Sets recipient info to a draft order.
1344
- * @public
1345
- * @documentationMaturity preview
1346
- * @permissionId ECOM.DRAFT_ORDER_SET_RECIPIENT_INFO
1347
- * @permissionScope Manage Stores - all permissions
1348
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1349
- * @permissionScope Manage Restaurants - all permissions
1350
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1351
- * @permissionScope Manage eCommerce - all permissions
1352
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1353
- * @permissionScope Picasso private app mega scope
1354
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1355
- * @applicableIdentity APP
1356
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetRecipientInfo
1357
- */
1358
- export async function setRecipientInfo() {
1359
- // @ts-ignore
1360
- const { httpClient, sideEffects } = arguments[0];
1361
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({}), [
1362
- {
1363
- transformFn: transformSDKAddressToRESTAddress,
1364
- paths: [{ path: 'recipientInfo.address' }],
1365
- },
1366
- ]);
1367
- const reqOpts = ambassadorWixEcomV1DraftOrder.setRecipientInfo(payload);
1368
- sideEffects?.onSiteCall?.();
1369
- try {
1370
- const result = await httpClient.request(reqOpts);
1371
- sideEffects?.onSuccess?.(result);
1372
- }
1373
- catch (err) {
1374
- const transformedError = sdkTransformError(err, {
1375
- spreadPathsToArguments: {},
1376
- explicitPathsToArguments: {},
1377
- singleArgumentUnchanged: false,
1378
- }, []);
1379
- sideEffects?.onError?.(err);
1380
- throw transformedError;
1381
- }
1382
- }
1383
- /**
1384
- * Sets billing info to a draft order.
1385
- * @public
1386
- * @documentationMaturity preview
1387
- * @permissionId ECOM.DRAFT_ORDER_SET_BILLING_INFO
1388
- * @permissionScope Manage Stores - all permissions
1389
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1390
- * @permissionScope Manage Restaurants - all permissions
1391
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1392
- * @permissionScope Manage eCommerce - all permissions
1393
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1394
- * @permissionScope Picasso private app mega scope
1395
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1396
- * @applicableIdentity APP
1397
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBillingInfo
1398
- */
1399
- export async function setBillingInfo() {
1400
- // @ts-ignore
1401
- const { httpClient, sideEffects } = arguments[0];
1402
- const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({}), [
1403
- {
1404
- transformFn: transformSDKAddressToRESTAddress,
1405
- paths: [{ path: 'billingInfo.address' }],
1406
- },
1407
- ]);
1408
- const reqOpts = ambassadorWixEcomV1DraftOrder.setBillingInfo(payload);
1409
- sideEffects?.onSiteCall?.();
1410
- try {
1411
- const result = await httpClient.request(reqOpts);
1412
- sideEffects?.onSuccess?.(result);
1413
- }
1414
- catch (err) {
1415
- const transformedError = sdkTransformError(err, {
1416
- spreadPathsToArguments: {},
1417
- explicitPathsToArguments: {},
1418
- singleArgumentUnchanged: false,
1419
- }, []);
1420
- sideEffects?.onError?.(err);
1421
- throw transformedError;
1422
- }
1423
- }
1424
- /**
1425
- * Get an order.
1426
- * When order is in draft status, it's re-estimated and return with latest tax and totals
1427
- * Automatic discounts and automatic additional fees will reflect the latest prices and eligibility.
1428
- * Calculation will be based on current draft order content - items, shipping info and eligible discounts and additional fees.
1429
- * When order is in committed status, it's returned with it's calculation at the moment it was committed.
1430
- * @param draftOrderId - The draft order id
1431
- * @public
1432
- * @documentationMaturity preview
1433
- * @requiredField draftOrderId
1434
- * @permissionId ECOM.DRAFT_ORDERS_READ
1435
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
1436
- * @permissionScope Manage Stores - all permissions
1437
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1438
- * @permissionScope Manage Restaurants - all permissions
1439
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1440
- * @permissionScope Manage eCommerce - all permissions
1441
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1442
- * @permissionScope Picasso private app mega scope
1443
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1444
- * @applicableIdentity APP
1445
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetDraftOrder
1446
- */
1447
- export async function getDraftOrder(draftOrderId) {
1448
- // @ts-ignore
1449
- const { httpClient, sideEffects } = arguments[1];
1450
- const payload = renameKeysFromSDKRequestToRESTRequest({
1451
- draftOrderId: draftOrderId,
1452
- });
1453
- const reqOpts = ambassadorWixEcomV1DraftOrder.getDraftOrder(payload);
1454
- sideEffects?.onSiteCall?.();
1455
- try {
1456
- const result = await httpClient.request(reqOpts);
1457
- sideEffects?.onSuccess?.(result);
1458
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1459
- {
1460
- transformFn: transformRESTImageToSDKImage,
1461
- paths: [
1462
- {
1463
- path: 'calculatedDraftOrder.draftOrder.lineItems.lineItem.image',
1464
- },
1465
- ],
1466
- },
1467
- {
1468
- transformFn: transformRESTAddressToSDKAddress,
1469
- paths: [
1470
- {
1471
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1472
- },
1473
- {
1474
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1475
- },
1476
- {
1477
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1478
- },
1479
- {
1480
- path: 'calculatedDraftOrder.draftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1481
- },
1482
- { path: 'calculatedDraftOrder.draftOrder.billingInfo.address' },
1483
- {
1484
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1485
- },
1486
- {
1487
- path: 'calculatedDraftOrder.draftOrder.recipientInfo.recipientInfo.address',
1488
- },
1489
- {
1490
- path: 'calculatedDraftOrder.draftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
1491
- },
1492
- {
1493
- path: 'calculatedDraftOrder.draftOrder.billingDetails.billingInfo.address',
1494
- },
1495
- {
1496
- path: 'calculatedDraftOrder.shippingOptions.logistics.pickupDetails.address',
1497
- },
1498
- ],
1499
- },
1500
- ]));
1501
- }
1502
- catch (err) {
1503
- const transformedError = sdkTransformError(err, {
1504
- spreadPathsToArguments: {},
1505
- explicitPathsToArguments: { draftOrderId: '$[0]' },
1506
- singleArgumentUnchanged: false,
1507
- }, ['draftOrderId']);
1508
- sideEffects?.onError?.(err);
1509
- throw transformedError;
1510
- }
1511
- }
1512
- /**
1513
- * Checks whether a draft can be created for this order
1514
- * @param orderId - Order ID.
1515
- * @public
1516
- * @documentationMaturity preview
1517
- * @requiredField orderId
1518
- * @permissionId ECOM.DRAFT_ORDERS_READ
1519
- * @permissionScope Manage Stores - all permissions
1520
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1521
- * @permissionScope Manage Restaurants - all permissions
1522
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1523
- * @permissionScope Manage eCommerce - all permissions
1524
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1525
- * @permissionScope Picasso private app mega scope
1526
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1527
- * @applicableIdentity APP
1528
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.GetOrderDraftabilityStatus
1529
- */
1530
- export async function getOrderDraftabilityStatus(orderId) {
1531
- // @ts-ignore
1532
- const { httpClient, sideEffects } = arguments[1];
1533
- const payload = renameKeysFromSDKRequestToRESTRequest({ orderId: orderId });
1534
- const reqOpts = ambassadorWixEcomV1DraftOrder.getOrderDraftabilityStatus(payload);
1535
- sideEffects?.onSiteCall?.();
1536
- try {
1537
- const result = await httpClient.request(reqOpts);
1538
- sideEffects?.onSuccess?.(result);
1539
- return renameKeysFromRESTResponseToSDKResponse(result.data);
1540
- }
1541
- catch (err) {
1542
- const transformedError = sdkTransformError(err, {
1543
- spreadPathsToArguments: {},
1544
- explicitPathsToArguments: { orderId: '$[0]' },
1545
- singleArgumentUnchanged: false,
1546
- }, ['orderId']);
1547
- sideEffects?.onError?.(err);
1548
- throw transformedError;
1549
- }
1550
- }
1551
- /**
1552
- * Commit latest changes to the baseline order and control what side-effects will be applied.
1553
- * Commit cannot be undone or reverted.
1554
- * Order-edit become closed for editing, however it's kept for reference and can be retrieved.
1555
- * @param draftOrderId - The draft order id
1556
- * @public
1557
- * @documentationMaturity preview
1558
- * @requiredField draftOrderId
1559
- * @permissionId ECOM.DRAFT_ORDERS_COMMIT
1560
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
1561
- * @permissionScope Manage Stores - all permissions
1562
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1563
- * @permissionScope Manage Restaurants - all permissions
1564
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1565
- * @permissionScope Manage eCommerce - all permissions
1566
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1567
- * @permissionScope Picasso private app mega scope
1568
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1569
- * @applicableIdentity APP
1570
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CommitDraftOrder
1571
- */
1572
- export async function commitDraftOrder(draftOrderId, options) {
1573
- // @ts-ignore
1574
- const { httpClient, sideEffects } = arguments[2];
1575
- const payload = renameKeysFromSDKRequestToRESTRequest({
1576
- draftOrderId: draftOrderId,
1577
- commitSettings: options?.commitSettings,
1578
- reason: options?.reason,
1579
- });
1580
- const reqOpts = ambassadorWixEcomV1DraftOrder.commitDraftOrder(payload);
1581
- sideEffects?.onSiteCall?.();
1582
- try {
1583
- const result = await httpClient.request(reqOpts);
1584
- sideEffects?.onSuccess?.(result);
1585
- return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1586
- {
1587
- transformFn: transformRESTImageToSDKImage,
1588
- paths: [
1589
- { path: 'committedDraftOrder.lineItems.lineItem.image' },
1590
- { path: 'orderAfterCommit.lineItems.image' },
1591
- ],
1592
- },
1593
- {
1594
- transformFn: transformRESTAddressToSDKAddress,
1595
- paths: [
1596
- {
1597
- path: 'committedDraftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1598
- },
1599
- {
1600
- path: 'committedDraftOrder.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1601
- },
1602
- {
1603
- path: 'committedDraftOrder.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1604
- },
1605
- {
1606
- path: 'committedDraftOrder.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1607
- },
1608
- { path: 'committedDraftOrder.billingInfo.address' },
1609
- {
1610
- path: 'committedDraftOrder.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1611
- },
1612
- { path: 'committedDraftOrder.recipientInfo.recipientInfo.address' },
1613
- {
1614
- path: 'committedDraftOrder.billingDetails.changedDetails.billingInfoBeforeChange.address',
1615
- },
1616
- { path: 'committedDraftOrder.billingDetails.billingInfo.address' },
1617
- { path: 'orderAfterCommit.billingInfo.address' },
1618
- {
1619
- path: 'orderAfterCommit.shippingInfo.logistics.shippingDestination.address',
1620
- },
1621
- {
1622
- path: 'orderAfterCommit.shippingInfo.logistics.pickupDetails.address',
1623
- },
1624
- { path: 'orderAfterCommit.recipientInfo.address' },
1625
- ],
1626
- },
1627
- ]));
1628
- }
1629
- catch (err) {
1630
- const transformedError = sdkTransformError(err, {
1631
- spreadPathsToArguments: {},
1632
- explicitPathsToArguments: {
1633
- draftOrderId: '$[0]',
1634
- commitSettings: '$[1].commitSettings',
1635
- reason: '$[1].reason',
1636
- },
1637
- singleArgumentUnchanged: false,
1638
- }, ['draftOrderId', 'options']);
1639
- sideEffects?.onError?.(err);
1640
- throw transformedError;
1641
- }
1642
- }
1643
- /**
1644
- * Create new order and control what side-effects will be applied
1645
- * Commit cannot be undone or reverted.
1646
- * Order-edit become closed for editing, however it's kept for reference and can be retrieved.
1647
- * @public
1648
- * @documentationMaturity preview
1649
- * @permissionId ECOM.DRAFT_ORDER_CREATE_ORDER_FROM_DRAFT
1650
- * @permissionId ECOM.DRAFT_ORDER_READ_ALL_EXTENDED_FIELDS
1651
- * @permissionScope Manage Stores - all permissions
1652
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1653
- * @permissionScope Manage Restaurants - all permissions
1654
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1655
- * @permissionScope Manage eCommerce - all permissions
1656
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1657
- * @permissionScope Picasso private app mega scope
1658
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1659
- * @applicableIdentity APP
1660
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.CreateOrderFromDraft
1661
- */
1662
- export async function createOrderFromDraft() {
1663
- // @ts-ignore
1664
- const { httpClient, sideEffects } = arguments[0];
1665
- const payload = renameKeysFromSDKRequestToRESTRequest({});
1666
- const reqOpts = ambassadorWixEcomV1DraftOrder.createOrderFromDraft(payload);
1667
- sideEffects?.onSiteCall?.();
1668
- try {
1669
- const result = await httpClient.request(reqOpts);
1670
- sideEffects?.onSuccess?.(result);
1671
- }
1672
- catch (err) {
1673
- const transformedError = sdkTransformError(err, {
1674
- spreadPathsToArguments: {},
1675
- explicitPathsToArguments: {},
1676
- singleArgumentUnchanged: false,
1677
- }, []);
1678
- sideEffects?.onError?.(err);
1679
- throw transformedError;
1680
- }
1681
- }
1682
- /**
1683
- * Delete order-edit entity with all pending changes.
1684
- * Order-edit in status 'COMMITTED' cannot be deleted.
1685
- * @param draftOrderId - The draft order id
1686
- * @public
1687
- * @documentationMaturity preview
1688
- * @requiredField draftOrderId
1689
- * @permissionId ECOM.DRAFT_ORDERS_DELETE
1690
- * @permissionId ECOM.DRAFT_ORDERS_ADMIN_DELETE
1691
- * @permissionScope Manage Stores - all permissions
1692
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1693
- * @permissionScope Manage Restaurants - all permissions
1694
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1695
- * @permissionScope Manage eCommerce - all permissions
1696
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1697
- * @permissionScope Picasso private app mega scope
1698
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1699
- * @applicableIdentity APP
1700
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.DeleteDraftOrder
1701
- */
1702
- export async function deleteDraftOrder(draftOrderId) {
1703
- // @ts-ignore
1704
- const { httpClient, sideEffects } = arguments[1];
1705
- const payload = renameKeysFromSDKRequestToRESTRequest({
1706
- draftOrderId: draftOrderId,
1707
- });
1708
- const reqOpts = ambassadorWixEcomV1DraftOrder.deleteDraftOrder(payload);
1709
- sideEffects?.onSiteCall?.();
1710
- try {
1711
- const result = await httpClient.request(reqOpts);
1712
- sideEffects?.onSuccess?.(result);
1713
- }
1714
- catch (err) {
1715
- const transformedError = sdkTransformError(err, {
1716
- spreadPathsToArguments: {},
1717
- explicitPathsToArguments: { draftOrderId: '$[0]' },
1718
- singleArgumentUnchanged: false,
1719
- }, ['draftOrderId']);
1720
- sideEffects?.onError?.(err);
1721
- throw transformedError;
1722
- }
1723
- }
1724
- /**
1725
- * Retrieves a list of draft orders given the provided paging, filtering, and sorting. Up to 100 draft orders can be returned per request.
1726
- *
1727
- * Refer to the table below for supported fields, filters, and sorting:
1728
- * | **Property** | **Supported Filters & Sorting** | **Sortable** |
1729
- * |----------------|---------------------------------------------------------------------------------|--------------|
1730
- * | `_createdDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
1731
- * | `_updatedDate` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `lt()`, `le()`, `gt()`, `ge()` | Sortable |
1732
- * | `status` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()` | Sortable |
1733
- * | `orderId` | `eq()`, `ne()`, `exists()`, `in()`, `hasSome()`, `startsWith()` | |
1734
- * To learn how to query draft orders, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
1735
- * @public
1736
- * @documentationMaturity preview
1737
- * @permissionScope Manage Stores - all permissions
1738
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1739
- * @permissionScope Manage Restaurants - all permissions
1740
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1741
- * @permissionScope Manage eCommerce - all permissions
1742
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1743
- * @permissionScope Picasso private app mega scope
1744
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1745
- * @permissionId ECOM.DRAFT_ORDERS_READ
1746
- * @applicableIdentity APP
1747
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.QueryDraftOrders
1748
- */
1749
- export function queryDraftOrders() {
1750
- // @ts-ignore
1751
- const { httpClient, sideEffects } = arguments[0];
1752
- return queryBuilder({
1753
- func: async (payload) => {
1754
- const reqOpts = ambassadorWixEcomV1DraftOrder.queryDraftOrders(payload);
1755
- sideEffects?.onSiteCall?.();
1756
- try {
1757
- const result = await httpClient.request(reqOpts);
1758
- sideEffects?.onSuccess?.(result);
1759
- return result;
1760
- }
1761
- catch (err) {
1762
- sideEffects?.onError?.(err);
1763
- throw err;
1764
- }
1765
- },
1766
- requestTransformer: (query) => {
1767
- const args = [query, {}];
1768
- return renameKeysFromSDKRequestToRESTRequest({
1769
- ...args?.[1],
1770
- query: args?.[0],
1771
- });
1772
- },
1773
- responseTransformer: ({ data }) => {
1774
- const transformedData = renameKeysFromRESTResponseToSDKResponse(transformPaths(data, [
1775
- {
1776
- transformFn: transformRESTImageToSDKImage,
1777
- paths: [{ path: 'draftOrders.lineItems.lineItem.image' }],
1778
- },
1779
- {
1780
- transformFn: transformRESTAddressToSDKAddress,
1781
- paths: [
1782
- {
1783
- path: 'draftOrders.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.shippingDestination.address',
1784
- },
1785
- {
1786
- path: 'draftOrders.shippingInfo.changedDetails.shippingInfoBeforeChange.logistics.pickupDetails.address',
1787
- },
1788
- {
1789
- path: 'draftOrders.shippingInfo.shippingInfo.logistics.shippingDestination.address',
1790
- },
1791
- {
1792
- path: 'draftOrders.shippingInfo.shippingInfo.logistics.pickupDetails.address',
1793
- },
1794
- { path: 'draftOrders.billingInfo.address' },
1795
- {
1796
- path: 'draftOrders.recipientInfo.changedDetails.recipientInfoBeforeChange.address',
1797
- },
1798
- { path: 'draftOrders.recipientInfo.recipientInfo.address' },
1799
- {
1800
- path: 'draftOrders.billingDetails.changedDetails.billingInfoBeforeChange.address',
1801
- },
1802
- { path: 'draftOrders.billingDetails.billingInfo.address' },
1803
- ],
1804
- },
1805
- ]));
1806
- return {
1807
- items: transformedData?.draftOrders,
1808
- pagingMetadata: transformedData?.pagingMetadata,
1809
- };
1810
- },
1811
- errorTransformer: (err) => {
1812
- const transformedError = sdkTransformError(err, {
1813
- spreadPathsToArguments: {},
1814
- explicitPathsToArguments: { query: '$[0]' },
1815
- singleArgumentUnchanged: false,
1816
- });
1817
- throw transformedError;
1818
- },
1819
- pagingMethod: 'CURSOR',
1820
- transformationPaths: {},
1821
- });
1822
- }
1823
- /**
1824
- * Sets tax exemption to a draft order.
1825
- * @public
1826
- * @documentationMaturity preview
1827
- * @permissionId ECOM.DRAFT_ORDER_SET_TAX_EXEMPTION
1828
- * @permissionScope Manage Stores - all permissions
1829
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1830
- * @permissionScope Manage Restaurants - all permissions
1831
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1832
- * @permissionScope Manage eCommerce - all permissions
1833
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1834
- * @permissionScope Picasso private app mega scope
1835
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1836
- * @applicableIdentity APP
1837
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetTaxExemption
1838
- */
1839
- export async function setTaxExemption() {
1840
- // @ts-ignore
1841
- const { httpClient, sideEffects } = arguments[0];
1842
- const payload = renameKeysFromSDKRequestToRESTRequest({});
1843
- const reqOpts = ambassadorWixEcomV1DraftOrder.setTaxExemption(payload);
1844
- sideEffects?.onSiteCall?.();
1845
- try {
1846
- const result = await httpClient.request(reqOpts);
1847
- sideEffects?.onSuccess?.(result);
1848
- }
1849
- catch (err) {
1850
- const transformedError = sdkTransformError(err, {
1851
- spreadPathsToArguments: {},
1852
- explicitPathsToArguments: {},
1853
- singleArgumentUnchanged: false,
1854
- }, []);
1855
- sideEffects?.onError?.(err);
1856
- throw transformedError;
1857
- }
1858
- }
1859
- /**
1860
- * Sets business location to a draft order.
1861
- * @public
1862
- * @documentationMaturity preview
1863
- * @permissionId ECOM.DRAFT_ORDER_SET_BUSINESS_LOCATION
1864
- * @permissionScope Manage Stores - all permissions
1865
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1866
- * @permissionScope Manage Restaurants - all permissions
1867
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1868
- * @permissionScope Manage eCommerce - all permissions
1869
- * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1870
- * @permissionScope Picasso private app mega scope
1871
- * @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
1872
- * @applicableIdentity APP
1873
- * @fqn com.wix.ecom.orders.draft.v1.DraftOrders.SetBusinessLocation
1874
- */
1875
- export async function setBusinessLocation() {
1876
- // @ts-ignore
1877
- const { httpClient, sideEffects } = arguments[0];
1878
- const payload = renameKeysFromSDKRequestToRESTRequest({});
1879
- const reqOpts = ambassadorWixEcomV1DraftOrder.setBusinessLocation(payload);
1880
- sideEffects?.onSiteCall?.();
1881
- try {
1882
- const result = await httpClient.request(reqOpts);
1883
- sideEffects?.onSuccess?.(result);
1884
- }
1885
- catch (err) {
1886
- const transformedError = sdkTransformError(err, {
1887
- spreadPathsToArguments: {},
1888
- explicitPathsToArguments: {},
1889
- singleArgumentUnchanged: false,
1890
- }, []);
1891
- sideEffects?.onError?.(err);
1892
- throw transformedError;
1893
- }
1894
- }
1895
- //# sourceMappingURL=ecom-v1-draft-order-draft-orders.universal.js.map