@wix/auto_sdk_ecom_checkout 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  11. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +71 -0
  12. package/build/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  13. package/build/cjs/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  14. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1299 -0
  15. package/build/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  16. package/build/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  17. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +332 -0
  18. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  19. package/build/cjs/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
  20. package/build/cjs/src/ecom-v1-checkout-checkout.public.js +346 -0
  21. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  22. package/build/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3046 -0
  23. package/build/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
  24. package/build/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  25. package/build/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +3740 -0
  26. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1513 -0
  27. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  39. package/build/es/src/ecom-v1-checkout-checkout.context.js +37 -0
  40. package/build/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  41. package/build/es/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  42. package/build/es/src/ecom-v1-checkout-checkout.http.js +1280 -0
  43. package/build/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  44. package/build/es/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  45. package/build/es/src/ecom-v1-checkout-checkout.meta.js +290 -0
  46. package/build/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  47. package/build/es/src/ecom-v1-checkout-checkout.public.d.ts +186 -0
  48. package/build/es/src/ecom-v1-checkout-checkout.public.js +295 -0
  49. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  50. package/build/es/src/ecom-v1-checkout-checkout.types.d.ts +3046 -0
  51. package/build/es/src/ecom-v1-checkout-checkout.types.js +298 -0
  52. package/build/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  53. package/build/es/src/ecom-v1-checkout-checkout.universal.d.ts +3740 -0
  54. package/build/es/src/ecom-v1-checkout-checkout.universal.js +1471 -0
  55. package/build/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  66. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +71 -0
  67. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  68. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  69. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1299 -0
  70. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  71. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  72. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +332 -0
  73. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  74. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.d.ts +210 -0
  75. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +346 -0
  76. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  77. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.d.ts +3085 -0
  78. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js +301 -0
  79. package/build/internal/cjs/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  80. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.d.ts +4005 -0
  81. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1513 -0
  82. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/ecom-v1-checkout-checkout.context.d.ts +37 -0
  93. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +37 -0
  94. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js.map +1 -0
  95. package/build/internal/es/src/ecom-v1-checkout-checkout.http.d.ts +120 -0
  96. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1280 -0
  97. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js.map +1 -0
  98. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.d.ts +58 -0
  99. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +290 -0
  100. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js.map +1 -0
  101. package/build/internal/es/src/ecom-v1-checkout-checkout.public.d.ts +210 -0
  102. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +295 -0
  103. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  104. package/build/internal/es/src/ecom-v1-checkout-checkout.types.d.ts +3085 -0
  105. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js +298 -0
  106. package/build/internal/es/src/ecom-v1-checkout-checkout.types.js.map +1 -0
  107. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.d.ts +4005 -0
  108. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1471 -0
  109. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1471 @@
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 ambassadorWixEcomV1Checkout from './ecom-v1-checkout-checkout.http.js';
4
+ import { transformSDKAddressToRESTAddress } from '@wix/sdk-runtime/transformations/address';
5
+ import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
6
+ import { transformSDKImageToRESTImage } from '@wix/sdk-runtime/transformations/image';
7
+ import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
8
+ import { transformSDKPageURLV2ToRESTPageURLV2 } from '@wix/sdk-runtime/transformations/page-url-v2';
9
+ import { transformRESTPageURLV2ToSDKPageURLV2 } from '@wix/sdk-runtime/transformations/page-url-v2';
10
+ import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
11
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
12
+ export var JurisdictionType;
13
+ (function (JurisdictionType) {
14
+ JurisdictionType["UNDEFINED"] = "UNDEFINED";
15
+ JurisdictionType["COUNTRY"] = "COUNTRY";
16
+ JurisdictionType["STATE"] = "STATE";
17
+ JurisdictionType["COUNTY"] = "COUNTY";
18
+ JurisdictionType["CITY"] = "CITY";
19
+ JurisdictionType["SPECIAL"] = "SPECIAL";
20
+ })(JurisdictionType || (JurisdictionType = {}));
21
+ export var DescriptionLineType;
22
+ (function (DescriptionLineType) {
23
+ /** Unrecognized type. */
24
+ DescriptionLineType["UNRECOGNISED"] = "UNRECOGNISED";
25
+ /** Plain text type. */
26
+ DescriptionLineType["PLAIN_TEXT"] = "PLAIN_TEXT";
27
+ /** Color type. */
28
+ DescriptionLineType["COLOR"] = "COLOR";
29
+ })(DescriptionLineType || (DescriptionLineType = {}));
30
+ export var ItemAvailabilityStatus;
31
+ (function (ItemAvailabilityStatus) {
32
+ ItemAvailabilityStatus["AVAILABLE"] = "AVAILABLE";
33
+ /** Item does not exist */
34
+ ItemAvailabilityStatus["NOT_FOUND"] = "NOT_FOUND";
35
+ /** Item not in stock */
36
+ ItemAvailabilityStatus["NOT_AVAILABLE"] = "NOT_AVAILABLE";
37
+ /** Available quantity is less than requested */
38
+ ItemAvailabilityStatus["PARTIALLY_AVAILABLE"] = "PARTIALLY_AVAILABLE";
39
+ })(ItemAvailabilityStatus || (ItemAvailabilityStatus = {}));
40
+ export var ItemTypeItemType;
41
+ (function (ItemTypeItemType) {
42
+ ItemTypeItemType["UNRECOGNISED"] = "UNRECOGNISED";
43
+ ItemTypeItemType["PHYSICAL"] = "PHYSICAL";
44
+ ItemTypeItemType["DIGITAL"] = "DIGITAL";
45
+ ItemTypeItemType["GIFT_CARD"] = "GIFT_CARD";
46
+ ItemTypeItemType["SERVICE"] = "SERVICE";
47
+ })(ItemTypeItemType || (ItemTypeItemType = {}));
48
+ /** Frequency unit of recurring payment */
49
+ export var SubscriptionFrequency;
50
+ (function (SubscriptionFrequency) {
51
+ SubscriptionFrequency["UNDEFINED"] = "UNDEFINED";
52
+ SubscriptionFrequency["DAY"] = "DAY";
53
+ SubscriptionFrequency["WEEK"] = "WEEK";
54
+ SubscriptionFrequency["MONTH"] = "MONTH";
55
+ SubscriptionFrequency["YEAR"] = "YEAR";
56
+ })(SubscriptionFrequency || (SubscriptionFrequency = {}));
57
+ export var FileType;
58
+ (function (FileType) {
59
+ FileType["UNSPECIFIED"] = "UNSPECIFIED";
60
+ FileType["SECURE_PICTURE"] = "SECURE_PICTURE";
61
+ FileType["SECURE_VIDEO"] = "SECURE_VIDEO";
62
+ FileType["SECURE_DOCUMENT"] = "SECURE_DOCUMENT";
63
+ FileType["SECURE_MUSIC"] = "SECURE_MUSIC";
64
+ FileType["SECURE_ARCHIVE"] = "SECURE_ARCHIVE";
65
+ })(FileType || (FileType = {}));
66
+ /** Type of selected payment option for catalog item */
67
+ export var PaymentOptionType;
68
+ (function (PaymentOptionType) {
69
+ /** The entire payment for this item happens as part of the checkout. */
70
+ PaymentOptionType["FULL_PAYMENT_ONLINE"] = "FULL_PAYMENT_ONLINE";
71
+ /** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
72
+ PaymentOptionType["FULL_PAYMENT_OFFLINE"] = "FULL_PAYMENT_OFFLINE";
73
+ /** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
74
+ PaymentOptionType["MEMBERSHIP"] = "MEMBERSHIP";
75
+ /** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
76
+ PaymentOptionType["DEPOSIT_ONLINE"] = "DEPOSIT_ONLINE";
77
+ /** 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`. */
78
+ PaymentOptionType["MEMBERSHIP_OFFLINE"] = "MEMBERSHIP_OFFLINE";
79
+ })(PaymentOptionType || (PaymentOptionType = {}));
80
+ export var TaxableAddressType;
81
+ (function (TaxableAddressType) {
82
+ TaxableAddressType["UNKNOWN_TAXABLE_ADDRESS"] = "UNKNOWN_TAXABLE_ADDRESS";
83
+ TaxableAddressType["BUSINESS"] = "BUSINESS";
84
+ TaxableAddressType["BILLING"] = "BILLING";
85
+ TaxableAddressType["SHIPPING"] = "SHIPPING";
86
+ })(TaxableAddressType || (TaxableAddressType = {}));
87
+ /** tax info types */
88
+ export var CommonVatType;
89
+ (function (CommonVatType) {
90
+ CommonVatType["UNSPECIFIED"] = "UNSPECIFIED";
91
+ /** CPF - for individual tax payers. */
92
+ CommonVatType["CPF"] = "CPF";
93
+ /** CNPJ - for corporations */
94
+ CommonVatType["CNPJ"] = "CNPJ";
95
+ })(CommonVatType || (CommonVatType = {}));
96
+ export var PickupMethod;
97
+ (function (PickupMethod) {
98
+ PickupMethod["UNKNOWN_METHOD"] = "UNKNOWN_METHOD";
99
+ PickupMethod["STORE_PICKUP"] = "STORE_PICKUP";
100
+ PickupMethod["PICKUP_POINT"] = "PICKUP_POINT";
101
+ })(PickupMethod || (PickupMethod = {}));
102
+ export var ChargeType;
103
+ (function (ChargeType) {
104
+ ChargeType["HANDLING_FEE"] = "HANDLING_FEE";
105
+ ChargeType["INSURANCE"] = "INSURANCE";
106
+ })(ChargeType || (ChargeType = {}));
107
+ export var RuleType;
108
+ (function (RuleType) {
109
+ RuleType["VALIDATION"] = "VALIDATION";
110
+ RuleType["OTHER"] = "OTHER";
111
+ RuleType["MAX"] = "MAX";
112
+ RuleType["MIN"] = "MIN";
113
+ RuleType["MAX_LENGTH"] = "MAX_LENGTH";
114
+ RuleType["MIN_LENGTH"] = "MIN_LENGTH";
115
+ RuleType["MAX_SIZE"] = "MAX_SIZE";
116
+ RuleType["MIN_SIZE"] = "MIN_SIZE";
117
+ RuleType["FORMAT"] = "FORMAT";
118
+ RuleType["DECIMAL_LTE"] = "DECIMAL_LTE";
119
+ RuleType["DECIMAL_GTE"] = "DECIMAL_GTE";
120
+ RuleType["DECIMAL_LT"] = "DECIMAL_LT";
121
+ RuleType["DECIMAL_GT"] = "DECIMAL_GT";
122
+ RuleType["DECIMAL_MAX_SCALE"] = "DECIMAL_MAX_SCALE";
123
+ RuleType["INVALID_ENUM_VALUE"] = "INVALID_ENUM_VALUE";
124
+ RuleType["REQUIRED_FIELD"] = "REQUIRED_FIELD";
125
+ RuleType["FIELD_NOT_ALLOWED"] = "FIELD_NOT_ALLOWED";
126
+ RuleType["ONE_OF_ALIGNMENT"] = "ONE_OF_ALIGNMENT";
127
+ RuleType["EXACT_LENGTH"] = "EXACT_LENGTH";
128
+ RuleType["EXACT_SIZE"] = "EXACT_SIZE";
129
+ RuleType["REQUIRED_ONE_OF_FIELD"] = "REQUIRED_ONE_OF_FIELD";
130
+ })(RuleType || (RuleType = {}));
131
+ export var DiscountType;
132
+ (function (DiscountType) {
133
+ DiscountType["GLOBAL"] = "GLOBAL";
134
+ DiscountType["SPECIFIC_ITEMS"] = "SPECIFIC_ITEMS";
135
+ DiscountType["SHIPPING"] = "SHIPPING";
136
+ })(DiscountType || (DiscountType = {}));
137
+ export var WeightUnit;
138
+ (function (WeightUnit) {
139
+ /** Weight unit can't be classified, due to an error */
140
+ WeightUnit["UNSPECIFIED_WEIGHT_UNIT"] = "UNSPECIFIED_WEIGHT_UNIT";
141
+ /** Kilograms */
142
+ WeightUnit["KG"] = "KG";
143
+ /** Pounds */
144
+ WeightUnit["LB"] = "LB";
145
+ })(WeightUnit || (WeightUnit = {}));
146
+ export var RateType;
147
+ (function (RateType) {
148
+ /** no tax being collected for this request due to location of purchase */
149
+ RateType["NO_TAX_COLLECTED"] = "NO_TAX_COLLECTED";
150
+ /** manual rate used for calculation */
151
+ RateType["MANUAL_RATE"] = "MANUAL_RATE";
152
+ /** autotax rate used for calculation */
153
+ RateType["AUTO_RATE"] = "AUTO_RATE";
154
+ /** fallback rate used for calculation */
155
+ RateType["FALLBACK_RATE"] = "FALLBACK_RATE";
156
+ })(RateType || (RateType = {}));
157
+ export var ManualCalculationReason;
158
+ (function (ManualCalculationReason) {
159
+ /** user set calculator in Business Manager to be Manual */
160
+ ManualCalculationReason["GLOBAL_SETTING_TO_MANUAL"] = "GLOBAL_SETTING_TO_MANUAL";
161
+ /** specific region is on manual even though Global setting is Auto-tax */
162
+ ManualCalculationReason["REGION_SETTING_TO_MANUAL"] = "REGION_SETTING_TO_MANUAL";
163
+ })(ManualCalculationReason || (ManualCalculationReason = {}));
164
+ export var FallbackReason;
165
+ (function (FallbackReason) {
166
+ /** auto-tax failed to be calculated */
167
+ FallbackReason["AUTO_TAX_FAILED"] = "AUTO_TAX_FAILED";
168
+ /** auto-tax was temporarily deactivated on a system-level */
169
+ FallbackReason["AUTO_TAX_DEACTIVATED"] = "AUTO_TAX_DEACTIVATED";
170
+ })(FallbackReason || (FallbackReason = {}));
171
+ export var ChannelType;
172
+ (function (ChannelType) {
173
+ /** Unspecified sales channel. This value is not supported. */
174
+ ChannelType["UNSPECIFIED"] = "UNSPECIFIED";
175
+ /** A web client. */
176
+ ChannelType["WEB"] = "WEB";
177
+ /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
178
+ ChannelType["POS"] = "POS";
179
+ /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
180
+ ChannelType["EBAY"] = "EBAY";
181
+ /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
182
+ ChannelType["AMAZON"] = "AMAZON";
183
+ /** Other sales platform. */
184
+ ChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
185
+ /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
186
+ ChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
187
+ /** 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) */
188
+ ChannelType["WIX_INVOICES"] = "WIX_INVOICES";
189
+ /** Wix merchant backoffice. */
190
+ ChannelType["BACKOFFICE_MERCHANT"] = "BACKOFFICE_MERCHANT";
191
+ /** Wish sales channel. */
192
+ ChannelType["WISH"] = "WISH";
193
+ /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
194
+ ChannelType["CLASS_PASS"] = "CLASS_PASS";
195
+ /** Global-E sales channel. */
196
+ ChannelType["GLOBAL_E"] = "GLOBAL_E";
197
+ /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
198
+ ChannelType["FACEBOOK"] = "FACEBOOK";
199
+ /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
200
+ ChannelType["ETSY"] = "ETSY";
201
+ /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
202
+ ChannelType["TIKTOK"] = "TIKTOK";
203
+ /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
204
+ ChannelType["FAIRE_COM"] = "FAIRE_COM";
205
+ })(ChannelType || (ChannelType = {}));
206
+ export var AdditionalFeeSource;
207
+ (function (AdditionalFeeSource) {
208
+ AdditionalFeeSource["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
209
+ /** The additional fee was added by an additional fee service plugin */
210
+ AdditionalFeeSource["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
211
+ /** The additional fee was added on the item either via the catalog or on custom line item */
212
+ AdditionalFeeSource["ITEM"] = "ITEM";
213
+ /** The additional fee was added manually on the request */
214
+ AdditionalFeeSource["MANUAL"] = "MANUAL";
215
+ })(AdditionalFeeSource || (AdditionalFeeSource = {}));
216
+ export var Severity;
217
+ (function (Severity) {
218
+ /** The user is allowed to move forward in the flow. */
219
+ Severity["WARNING"] = "WARNING";
220
+ /**
221
+ * The user is blocked from moving forward in the flow.
222
+ * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
223
+ */
224
+ Severity["ERROR"] = "ERROR";
225
+ })(Severity || (Severity = {}));
226
+ /** Available locations on the webpage */
227
+ export var NameInOther;
228
+ (function (NameInOther) {
229
+ /** Default location, in case no specific location is specified. */
230
+ NameInOther["OTHER_DEFAULT"] = "OTHER_DEFAULT";
231
+ })(NameInOther || (NameInOther = {}));
232
+ /** Available locations on the line item */
233
+ export var NameInLineItem;
234
+ (function (NameInLineItem) {
235
+ /** Default location, in case no specific location is specified. */
236
+ NameInLineItem["LINE_ITEM_DEFAULT"] = "LINE_ITEM_DEFAULT";
237
+ })(NameInLineItem || (NameInLineItem = {}));
238
+ export var SuggestedFix;
239
+ (function (SuggestedFix) {
240
+ /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
241
+ SuggestedFix["UNKNOWN_SUGGESTED_FIX"] = "UNKNOWN_SUGGESTED_FIX";
242
+ /** The line item should be removed from the cart or checkout to resolve the violation. */
243
+ SuggestedFix["REMOVE_LINE_ITEM"] = "REMOVE_LINE_ITEM";
244
+ })(SuggestedFix || (SuggestedFix = {}));
245
+ export var GetCheckoutPaymentSettingsResponsePaymentOption;
246
+ (function (GetCheckoutPaymentSettingsResponsePaymentOption) {
247
+ GetCheckoutPaymentSettingsResponsePaymentOption["UNKNOWN_PAYMENT_OPTION"] = "UNKNOWN_PAYMENT_OPTION";
248
+ GetCheckoutPaymentSettingsResponsePaymentOption["MANUAL"] = "MANUAL";
249
+ })(GetCheckoutPaymentSettingsResponsePaymentOption || (GetCheckoutPaymentSettingsResponsePaymentOption = {}));
250
+ export var IdentityType;
251
+ (function (IdentityType) {
252
+ IdentityType["UNSPECIFIED_IDENTITY_TYPE"] = "UNSPECIFIED_IDENTITY_TYPE";
253
+ /** Site member */
254
+ IdentityType["MEMBER"] = "MEMBER";
255
+ /** Contact */
256
+ IdentityType["CONTACT"] = "CONTACT";
257
+ })(IdentityType || (IdentityType = {}));
258
+ export var LineItemType;
259
+ (function (LineItemType) {
260
+ /** Line item type can't be classified, due to an error */
261
+ LineItemType["UNSPECIFIED_LINE_ITEM_TYPE"] = "UNSPECIFIED_LINE_ITEM_TYPE";
262
+ /** Physical item type */
263
+ LineItemType["PHYSICAL"] = "PHYSICAL";
264
+ /** Digital item type */
265
+ LineItemType["DIGITAL"] = "DIGITAL";
266
+ /** Custom item price */
267
+ LineItemType["CUSTOM_AMOUNT_ITEM"] = "CUSTOM_AMOUNT_ITEM";
268
+ })(LineItemType || (LineItemType = {}));
269
+ export var MediaItemType;
270
+ (function (MediaItemType) {
271
+ /** Media item type can't be classified, due to an error */
272
+ MediaItemType["UNSPECIFIED_MEDIA_TYPE_ITEM"] = "UNSPECIFIED_MEDIA_TYPE_ITEM";
273
+ /** Image item type */
274
+ MediaItemType["IMAGE"] = "IMAGE";
275
+ })(MediaItemType || (MediaItemType = {}));
276
+ /** Brazilian tax info types */
277
+ export var VatType;
278
+ (function (VatType) {
279
+ /** When the tax info type can't be classified, due to an error */
280
+ VatType["UNSPECIFIED_TAX_TYPE"] = "UNSPECIFIED_TAX_TYPE";
281
+ /** CPF - for individual tax payers */
282
+ VatType["CPF"] = "CPF";
283
+ /** CNPJ - for corporations */
284
+ VatType["CNPJ"] = "CNPJ";
285
+ })(VatType || (VatType = {}));
286
+ export var DiscountDiscountType;
287
+ (function (DiscountDiscountType) {
288
+ DiscountDiscountType["UNDEFINED"] = "UNDEFINED";
289
+ /** No discount */
290
+ DiscountDiscountType["AMOUNT"] = "AMOUNT";
291
+ DiscountDiscountType["PERCENT"] = "PERCENT";
292
+ })(DiscountDiscountType || (DiscountDiscountType = {}));
293
+ export var ChannelInfoChannelType;
294
+ (function (ChannelInfoChannelType) {
295
+ ChannelInfoChannelType["UNSPECIFIED"] = "UNSPECIFIED";
296
+ ChannelInfoChannelType["WEB"] = "WEB";
297
+ ChannelInfoChannelType["OTHER_PLATFORM"] = "OTHER_PLATFORM";
298
+ ChannelInfoChannelType["WIX_APP_STORE"] = "WIX_APP_STORE";
299
+ })(ChannelInfoChannelType || (ChannelInfoChannelType = {}));
300
+ export var WebhookIdentityType;
301
+ (function (WebhookIdentityType) {
302
+ WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
303
+ WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
304
+ WebhookIdentityType["MEMBER"] = "MEMBER";
305
+ WebhookIdentityType["WIX_USER"] = "WIX_USER";
306
+ WebhookIdentityType["APP"] = "APP";
307
+ })(WebhookIdentityType || (WebhookIdentityType = {}));
308
+ /**
309
+ * Creates a checkout.
310
+ *
311
+ *
312
+ * The `createCheckout()` function returns a Promise that resolves to the new checkout when it's created.
313
+ *
314
+ * > **Notes:**
315
+ * > + Checkout must include at least 1 item in the `options.lineItems` array.
316
+ * > + `options.channelType` is required.
317
+ * > + If `_id` for `options.lineItems` is added, make sure that each `_id` is unique.
318
+ * > + If `options.checkoutInfo.customFields` are added, then `options.checkoutInfo.customFields.value` is required.
319
+ * @public
320
+ * @requiredField options.channelType
321
+ * @requiredField options.checkoutInfo.customFields.value
322
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships._id
323
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.appId
324
+ * @requiredField options.checkoutInfo.membershipOptions.selectedMemberships.memberships.lineItemIds
325
+ * @requiredField options.customLineItems.descriptionLines
326
+ * @requiredField options.customLineItems.descriptionLines.name
327
+ * @requiredField options.customLineItems.itemType
328
+ * @requiredField options.customLineItems.price
329
+ * @requiredField options.customLineItems.productName
330
+ * @requiredField options.customLineItems.quantity
331
+ * @requiredField options.lineItems.catalogReference
332
+ * @requiredField options.lineItems.catalogReference.appId
333
+ * @requiredField options.lineItems.catalogReference.catalogItemId
334
+ * @requiredField options.lineItems.quantity
335
+ * @param options - Checkout creation options.
336
+ * @permissionId ECOM.MODIFY_CHECKOUTS
337
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
338
+ * @permissionScope Manage Stores - all permissions
339
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
340
+ * @permissionScope Manage Restaurants - all permissions
341
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
342
+ * @permissionScope Manage eCommerce - all permissions
343
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
344
+ * @permissionScope Manage Orders
345
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
346
+ * @permissionScope Manage Stores - all permissions
347
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
348
+ * @permissionScope Manage eCommerce - Admin Permissions
349
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
350
+ * @permissionScope Manage eCommerce - all permissions
351
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
352
+ * @applicableIdentity APP
353
+ * @applicableIdentity VISITOR
354
+ * @returns Fulfilled - the newly created checkout.
355
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
356
+ */
357
+ export async function createCheckout(options) {
358
+ // @ts-ignore
359
+ const { httpClient, sideEffects } = arguments[1];
360
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
361
+ checkoutInfo: options?.checkoutInfo,
362
+ couponCode: options?.couponCode,
363
+ lineItems: options?.lineItems,
364
+ customLineItems: options?.customLineItems,
365
+ channelType: options?.channelType,
366
+ giftCardCode: options?.giftCardCode,
367
+ overrideCheckoutUrl: options?.overrideCheckoutUrl,
368
+ }), [
369
+ {
370
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
371
+ paths: [
372
+ { path: 'checkoutInfo.lineItems.url' },
373
+ { path: 'lineItems.url' },
374
+ { path: 'customLineItems.url' },
375
+ ],
376
+ },
377
+ {
378
+ transformFn: transformSDKImageToRESTImage,
379
+ paths: [
380
+ { path: 'checkoutInfo.lineItems.media' },
381
+ { path: 'checkoutInfo.lineItems.catalogOverrideFields.image' },
382
+ { path: 'lineItems.media' },
383
+ { path: 'lineItems.catalogOverrideFields.image' },
384
+ { path: 'customLineItems.media' },
385
+ ],
386
+ },
387
+ {
388
+ transformFn: transformSDKAddressToRESTAddress,
389
+ paths: [
390
+ { path: 'checkoutInfo.billingInfo.address' },
391
+ { path: 'checkoutInfo.shippingInfo.shippingDestination.address' },
392
+ {
393
+ path: 'checkoutInfo.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
394
+ },
395
+ {
396
+ path: 'checkoutInfo.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
397
+ },
398
+ ],
399
+ },
400
+ ]);
401
+ const reqOpts = ambassadorWixEcomV1Checkout.createCheckout(payload);
402
+ sideEffects?.onSiteCall?.();
403
+ try {
404
+ const result = await httpClient.request(reqOpts);
405
+ sideEffects?.onSuccess?.(result);
406
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
407
+ {
408
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
409
+ paths: [{ path: 'checkout.lineItems.url' }],
410
+ },
411
+ {
412
+ transformFn: transformRESTImageToSDKImage,
413
+ paths: [
414
+ { path: 'checkout.lineItems.media' },
415
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
416
+ ],
417
+ },
418
+ {
419
+ transformFn: transformRESTAddressToSDKAddress,
420
+ paths: [
421
+ { path: 'checkout.billingInfo.address' },
422
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
423
+ {
424
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
425
+ },
426
+ {
427
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
428
+ },
429
+ ],
430
+ },
431
+ ]))?.checkout;
432
+ }
433
+ catch (err) {
434
+ const transformedError = sdkTransformError(err, {
435
+ spreadPathsToArguments: {},
436
+ explicitPathsToArguments: {
437
+ checkoutInfo: '$[0].checkoutInfo',
438
+ couponCode: '$[0].couponCode',
439
+ lineItems: '$[0].lineItems',
440
+ customLineItems: '$[0].customLineItems',
441
+ channelType: '$[0].channelType',
442
+ giftCardCode: '$[0].giftCardCode',
443
+ overrideCheckoutUrl: '$[0].overrideCheckoutUrl',
444
+ },
445
+ singleArgumentUnchanged: false,
446
+ }, ['options']);
447
+ sideEffects?.onError?.(err);
448
+ throw transformedError;
449
+ }
450
+ }
451
+ /**
452
+ * Retrieves a checkout.
453
+ *
454
+ *
455
+ * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
456
+ * @param _id - Checkout ID.
457
+ * @public
458
+ * @requiredField _id
459
+ * @permissionId ECOM.READ_CHECKOUTS
460
+ * @permissionScope Manage Stores - all permissions
461
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
462
+ * @permissionScope Read eCommerce - all read permissions
463
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
464
+ * @permissionScope Read Orders
465
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
466
+ * @permissionScope Read Stores - all read permissions
467
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
468
+ * @permissionScope Manage Restaurants - all permissions
469
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
470
+ * @permissionScope Manage eCommerce - all permissions
471
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
472
+ * @permissionScope Manage Orders
473
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
474
+ * @applicableIdentity APP
475
+ * @applicableIdentity VISITOR
476
+ * @returns Fulfilled - the requested checkout.
477
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
478
+ */
479
+ export async function getCheckout(_id) {
480
+ // @ts-ignore
481
+ const { httpClient, sideEffects } = arguments[1];
482
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
483
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckout(payload);
484
+ sideEffects?.onSiteCall?.();
485
+ try {
486
+ const result = await httpClient.request(reqOpts);
487
+ sideEffects?.onSuccess?.(result);
488
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
489
+ {
490
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
491
+ paths: [{ path: 'checkout.lineItems.url' }],
492
+ },
493
+ {
494
+ transformFn: transformRESTImageToSDKImage,
495
+ paths: [
496
+ { path: 'checkout.lineItems.media' },
497
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
498
+ ],
499
+ },
500
+ {
501
+ transformFn: transformRESTAddressToSDKAddress,
502
+ paths: [
503
+ { path: 'checkout.billingInfo.address' },
504
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
505
+ {
506
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
507
+ },
508
+ {
509
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
510
+ },
511
+ ],
512
+ },
513
+ ]))?.checkout;
514
+ }
515
+ catch (err) {
516
+ const transformedError = sdkTransformError(err, {
517
+ spreadPathsToArguments: {},
518
+ explicitPathsToArguments: { id: '$[0]' },
519
+ singleArgumentUnchanged: false,
520
+ }, ['_id']);
521
+ sideEffects?.onError?.(err);
522
+ throw transformedError;
523
+ }
524
+ }
525
+ /**
526
+ * Retrieves the checkout associated with a specified cart.
527
+ * @param _id - Cart ID.
528
+ * @public
529
+ * @documentationMaturity preview
530
+ * @requiredField _id
531
+ * @permissionId ECOM.READ_CHECKOUTS
532
+ * @permissionScope Manage Stores - all permissions
533
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
534
+ * @permissionScope Read eCommerce - all read permissions
535
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
536
+ * @permissionScope Read Orders
537
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
538
+ * @permissionScope Read Stores - all read permissions
539
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
540
+ * @permissionScope Manage Restaurants - all permissions
541
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
542
+ * @permissionScope Manage eCommerce - all permissions
543
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
544
+ * @permissionScope Manage Orders
545
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
546
+ * @applicableIdentity APP
547
+ * @applicableIdentity VISITOR
548
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
549
+ */
550
+ export async function getCheckoutByCartId(_id) {
551
+ // @ts-ignore
552
+ const { httpClient, sideEffects } = arguments[1];
553
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
554
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutByCartId(payload);
555
+ sideEffects?.onSiteCall?.();
556
+ try {
557
+ const result = await httpClient.request(reqOpts);
558
+ sideEffects?.onSuccess?.(result);
559
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
560
+ {
561
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
562
+ paths: [{ path: 'checkout.lineItems.url' }],
563
+ },
564
+ {
565
+ transformFn: transformRESTImageToSDKImage,
566
+ paths: [
567
+ { path: 'checkout.lineItems.media' },
568
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
569
+ ],
570
+ },
571
+ {
572
+ transformFn: transformRESTAddressToSDKAddress,
573
+ paths: [
574
+ { path: 'checkout.billingInfo.address' },
575
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
576
+ {
577
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
578
+ },
579
+ {
580
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
581
+ },
582
+ ],
583
+ },
584
+ ]));
585
+ }
586
+ catch (err) {
587
+ const transformedError = sdkTransformError(err, {
588
+ spreadPathsToArguments: {},
589
+ explicitPathsToArguments: { id: '$[0]' },
590
+ singleArgumentUnchanged: false,
591
+ }, ['_id']);
592
+ sideEffects?.onError?.(err);
593
+ throw transformedError;
594
+ }
595
+ }
596
+ /**
597
+ * Deprecated and will be removed soon, use GetCheckoutURL
598
+ * @param _id - Checkout ID.
599
+ * @internal
600
+ * @documentationMaturity preview
601
+ * @requiredField _id
602
+ * @permissionId ECOM.READ_CHECKOUTS
603
+ * @permissionScope Manage Stores - all permissions
604
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
605
+ * @permissionScope Read eCommerce - all read permissions
606
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
607
+ * @permissionScope Read Orders
608
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
609
+ * @permissionScope Read Stores - all read permissions
610
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
611
+ * @permissionScope Manage Restaurants - all permissions
612
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
613
+ * @permissionScope Manage eCommerce - all permissions
614
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
615
+ * @permissionScope Manage Orders
616
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
617
+ * @applicableIdentity APP
618
+ * @applicableIdentity VISITOR
619
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetWixCheckoutURL
620
+ */
621
+ export async function getWixCheckoutUrl(_id) {
622
+ // @ts-ignore
623
+ const { httpClient, sideEffects } = arguments[1];
624
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
625
+ const reqOpts = ambassadorWixEcomV1Checkout.getWixCheckoutUrl(payload);
626
+ sideEffects?.onSiteCall?.();
627
+ try {
628
+ const result = await httpClient.request(reqOpts);
629
+ sideEffects?.onSuccess?.(result);
630
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
631
+ }
632
+ catch (err) {
633
+ const transformedError = sdkTransformError(err, {
634
+ spreadPathsToArguments: {},
635
+ explicitPathsToArguments: { id: '$[0]' },
636
+ singleArgumentUnchanged: false,
637
+ }, ['_id']);
638
+ sideEffects?.onError?.(err);
639
+ throw transformedError;
640
+ }
641
+ }
642
+ /**
643
+ * Retrieves the checkout page URL of a specified checkout.
644
+ *
645
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
646
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
647
+ * @param _id - Checkout ID.
648
+ * @public
649
+ * @requiredField _id
650
+ * @permissionId ECOM.READ_CHECKOUTS
651
+ * @permissionScope Manage Stores - all permissions
652
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
653
+ * @permissionScope Read eCommerce - all read permissions
654
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
655
+ * @permissionScope Read Orders
656
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
657
+ * @permissionScope Read Stores - all read permissions
658
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
659
+ * @permissionScope Manage Restaurants - all permissions
660
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
661
+ * @permissionScope Manage eCommerce - all permissions
662
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
663
+ * @permissionScope Manage Orders
664
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
665
+ * @applicableIdentity APP
666
+ * @applicableIdentity VISITOR
667
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
668
+ */
669
+ export async function getCheckoutUrl(_id) {
670
+ // @ts-ignore
671
+ const { httpClient, sideEffects } = arguments[1];
672
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
673
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutUrl(payload);
674
+ sideEffects?.onSiteCall?.();
675
+ try {
676
+ const result = await httpClient.request(reqOpts);
677
+ sideEffects?.onSuccess?.(result);
678
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
679
+ }
680
+ catch (err) {
681
+ const transformedError = sdkTransformError(err, {
682
+ spreadPathsToArguments: {},
683
+ explicitPathsToArguments: { id: '$[0]' },
684
+ singleArgumentUnchanged: false,
685
+ }, ['_id']);
686
+ sideEffects?.onError?.(err);
687
+ throw transformedError;
688
+ }
689
+ }
690
+ /**
691
+ * Updates a checkout.
692
+ *
693
+ *
694
+ * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
695
+ *
696
+ * >**Notes:**
697
+ * > + If nothing is passed in the request, the call will fail.
698
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
699
+ * @param _id - Checkout ID.
700
+ * @public
701
+ * @requiredField _id
702
+ * @requiredField checkout
703
+ * @requiredField checkout.customFields.value
704
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
705
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
706
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
707
+ * @requiredField options.customLineItems.descriptionLines
708
+ * @requiredField options.customLineItems.descriptionLines.name
709
+ * @requiredField options.customLineItems.itemType
710
+ * @requiredField options.customLineItems.productName
711
+ * @requiredField options.customLineItems.quantity
712
+ * @requiredField options.lineItems.catalogReference
713
+ * @requiredField options.lineItems.catalogReference.appId
714
+ * @requiredField options.lineItems.catalogReference.catalogItemId
715
+ * @requiredField options.lineItems.quantity
716
+ * @param options - Checkout update options.
717
+ * @permissionId ECOM.MODIFY_CHECKOUTS
718
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
719
+ * @permissionScope Manage Stores - all permissions
720
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
721
+ * @permissionScope Manage Restaurants - all permissions
722
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
723
+ * @permissionScope Manage eCommerce - all permissions
724
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
725
+ * @permissionScope Manage Orders
726
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
727
+ * @permissionScope Manage Stores - all permissions
728
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
729
+ * @permissionScope Manage eCommerce - Admin Permissions
730
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
731
+ * @permissionScope Manage eCommerce - all permissions
732
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
733
+ * @applicableIdentity APP
734
+ * @applicableIdentity VISITOR
735
+ * @returns Updated checkout.
736
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
737
+ */
738
+ export async function updateCheckout(_id, checkout, options) {
739
+ // @ts-ignore
740
+ const { httpClient, sideEffects } = arguments[3];
741
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
742
+ checkout: { ...checkout, id: _id },
743
+ couponCode: options?.couponCode,
744
+ giftCardCode: options?.giftCardCode,
745
+ overrideCheckoutUrl: options?.overrideCheckoutUrl,
746
+ lineItems: options?.lineItems,
747
+ customLineItems: options?.customLineItems,
748
+ }), [
749
+ {
750
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
751
+ paths: [
752
+ { path: 'checkout.lineItems.url' },
753
+ { path: 'lineItems.url' },
754
+ { path: 'customLineItems.url' },
755
+ ],
756
+ },
757
+ {
758
+ transformFn: transformSDKImageToRESTImage,
759
+ paths: [
760
+ { path: 'checkout.lineItems.media' },
761
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
762
+ { path: 'lineItems.media' },
763
+ { path: 'lineItems.catalogOverrideFields.image' },
764
+ { path: 'customLineItems.media' },
765
+ ],
766
+ },
767
+ {
768
+ transformFn: transformSDKAddressToRESTAddress,
769
+ paths: [
770
+ { path: 'checkout.billingInfo.address' },
771
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
772
+ {
773
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
774
+ },
775
+ {
776
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
777
+ },
778
+ ],
779
+ },
780
+ ]);
781
+ const reqOpts = ambassadorWixEcomV1Checkout.updateCheckout(payload);
782
+ sideEffects?.onSiteCall?.();
783
+ try {
784
+ const result = await httpClient.request(reqOpts);
785
+ sideEffects?.onSuccess?.(result);
786
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
787
+ {
788
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
789
+ paths: [{ path: 'checkout.lineItems.url' }],
790
+ },
791
+ {
792
+ transformFn: transformRESTImageToSDKImage,
793
+ paths: [
794
+ { path: 'checkout.lineItems.media' },
795
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
796
+ ],
797
+ },
798
+ {
799
+ transformFn: transformRESTAddressToSDKAddress,
800
+ paths: [
801
+ { path: 'checkout.billingInfo.address' },
802
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
803
+ {
804
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
805
+ },
806
+ {
807
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
808
+ },
809
+ ],
810
+ },
811
+ ]))?.checkout;
812
+ }
813
+ catch (err) {
814
+ const transformedError = sdkTransformError(err, {
815
+ spreadPathsToArguments: { checkout: '$[1]' },
816
+ explicitPathsToArguments: {
817
+ 'checkout.id': '$[0]',
818
+ couponCode: '$[2].couponCode',
819
+ giftCardCode: '$[2].giftCardCode',
820
+ overrideCheckoutUrl: '$[2].overrideCheckoutUrl',
821
+ lineItems: '$[2].lineItems',
822
+ customLineItems: '$[2].customLineItems',
823
+ },
824
+ singleArgumentUnchanged: false,
825
+ }, ['_id', 'checkout', 'options']);
826
+ sideEffects?.onError?.(err);
827
+ throw transformedError;
828
+ }
829
+ }
830
+ /**
831
+ * Removes the coupon from a specified checkout.
832
+ *
833
+ *
834
+ * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
835
+ *
836
+ * >**Note:** A checkout can only hold 1 coupon.
837
+ * @param _id - ID of the checkout to remove the coupon from.
838
+ * @public
839
+ * @requiredField _id
840
+ * @permissionId ECOM.MODIFY_CHECKOUTS
841
+ * @permissionScope Manage Stores - all permissions
842
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
843
+ * @permissionScope Manage Restaurants - all permissions
844
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
845
+ * @permissionScope Manage eCommerce - all permissions
846
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
847
+ * @permissionScope Manage Orders
848
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
849
+ * @applicableIdentity APP
850
+ * @applicableIdentity VISITOR
851
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
852
+ */
853
+ export async function removeCoupon(_id) {
854
+ // @ts-ignore
855
+ const { httpClient, sideEffects } = arguments[1];
856
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
857
+ const reqOpts = ambassadorWixEcomV1Checkout.removeCoupon(payload);
858
+ sideEffects?.onSiteCall?.();
859
+ try {
860
+ const result = await httpClient.request(reqOpts);
861
+ sideEffects?.onSuccess?.(result);
862
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
863
+ {
864
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
865
+ paths: [{ path: 'checkout.lineItems.url' }],
866
+ },
867
+ {
868
+ transformFn: transformRESTImageToSDKImage,
869
+ paths: [
870
+ { path: 'checkout.lineItems.media' },
871
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
872
+ ],
873
+ },
874
+ {
875
+ transformFn: transformRESTAddressToSDKAddress,
876
+ paths: [
877
+ { path: 'checkout.billingInfo.address' },
878
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
879
+ {
880
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
881
+ },
882
+ {
883
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
884
+ },
885
+ ],
886
+ },
887
+ ]));
888
+ }
889
+ catch (err) {
890
+ const transformedError = sdkTransformError(err, {
891
+ spreadPathsToArguments: {},
892
+ explicitPathsToArguments: { id: '$[0]' },
893
+ singleArgumentUnchanged: false,
894
+ }, ['_id']);
895
+ sideEffects?.onError?.(err);
896
+ throw transformedError;
897
+ }
898
+ }
899
+ /**
900
+ * Removes the gift card from a specified checkout.
901
+ *
902
+ *
903
+ * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
904
+ *
905
+ * >**Note:** A checkout can only hold 1 gift card.
906
+ * @param _id - ID of the checkout to remove the gift card from.
907
+ * @public
908
+ * @requiredField _id
909
+ * @permissionId ECOM.MODIFY_CHECKOUTS
910
+ * @permissionScope Manage Stores - all permissions
911
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
912
+ * @permissionScope Manage Restaurants - all permissions
913
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
914
+ * @permissionScope Manage eCommerce - all permissions
915
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
916
+ * @permissionScope Manage Orders
917
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
918
+ * @applicableIdentity APP
919
+ * @applicableIdentity VISITOR
920
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
921
+ */
922
+ export async function removeGiftCard(_id) {
923
+ // @ts-ignore
924
+ const { httpClient, sideEffects } = arguments[1];
925
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
926
+ const reqOpts = ambassadorWixEcomV1Checkout.removeGiftCard(payload);
927
+ sideEffects?.onSiteCall?.();
928
+ try {
929
+ const result = await httpClient.request(reqOpts);
930
+ sideEffects?.onSuccess?.(result);
931
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
932
+ {
933
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
934
+ paths: [{ path: 'checkout.lineItems.url' }],
935
+ },
936
+ {
937
+ transformFn: transformRESTImageToSDKImage,
938
+ paths: [
939
+ { path: 'checkout.lineItems.media' },
940
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
941
+ ],
942
+ },
943
+ {
944
+ transformFn: transformRESTAddressToSDKAddress,
945
+ paths: [
946
+ { path: 'checkout.billingInfo.address' },
947
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
948
+ {
949
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
950
+ },
951
+ {
952
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
953
+ },
954
+ ],
955
+ },
956
+ ]));
957
+ }
958
+ catch (err) {
959
+ const transformedError = sdkTransformError(err, {
960
+ spreadPathsToArguments: {},
961
+ explicitPathsToArguments: { id: '$[0]' },
962
+ singleArgumentUnchanged: false,
963
+ }, ['_id']);
964
+ sideEffects?.onError?.(err);
965
+ throw transformedError;
966
+ }
967
+ }
968
+ /**
969
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
970
+ *
971
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
972
+ * Wix checkout page URL.
973
+ * @param _id - ID of the checkout to remove the override checkout url from.
974
+ * @public
975
+ * @requiredField _id
976
+ * @permissionId ECOM.MODIFY_CHECKOUTS
977
+ * @permissionScope Manage Stores - all permissions
978
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
979
+ * @permissionScope Manage Restaurants - all permissions
980
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
981
+ * @permissionScope Manage eCommerce - all permissions
982
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
983
+ * @permissionScope Manage Orders
984
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
985
+ * @applicableIdentity APP
986
+ * @applicableIdentity VISITOR
987
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
988
+ */
989
+ export async function removeOverrideCheckoutUrl(_id) {
990
+ // @ts-ignore
991
+ const { httpClient, sideEffects } = arguments[1];
992
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
993
+ const reqOpts = ambassadorWixEcomV1Checkout.removeOverrideCheckoutUrl(payload);
994
+ sideEffects?.onSiteCall?.();
995
+ try {
996
+ const result = await httpClient.request(reqOpts);
997
+ sideEffects?.onSuccess?.(result);
998
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
999
+ {
1000
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1001
+ paths: [{ path: 'checkout.lineItems.url' }],
1002
+ },
1003
+ {
1004
+ transformFn: transformRESTImageToSDKImage,
1005
+ paths: [
1006
+ { path: 'checkout.lineItems.media' },
1007
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1008
+ ],
1009
+ },
1010
+ {
1011
+ transformFn: transformRESTAddressToSDKAddress,
1012
+ paths: [
1013
+ { path: 'checkout.billingInfo.address' },
1014
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1015
+ {
1016
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1017
+ },
1018
+ {
1019
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1020
+ },
1021
+ ],
1022
+ },
1023
+ ]));
1024
+ }
1025
+ catch (err) {
1026
+ const transformedError = sdkTransformError(err, {
1027
+ spreadPathsToArguments: {},
1028
+ explicitPathsToArguments: { id: '$[0]' },
1029
+ singleArgumentUnchanged: false,
1030
+ }, ['_id']);
1031
+ sideEffects?.onError?.(err);
1032
+ throw transformedError;
1033
+ }
1034
+ }
1035
+ /**
1036
+ * Adds catalog line items and/or custom line items to a checkout.
1037
+ *
1038
+ *
1039
+ * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
1040
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
1041
+ * @param _id - Checkout ID.
1042
+ * @public
1043
+ * @requiredField _id
1044
+ * @requiredField options.customLineItems.descriptionLines
1045
+ * @requiredField options.customLineItems.descriptionLines.name
1046
+ * @requiredField options.customLineItems.itemType
1047
+ * @requiredField options.customLineItems.productName
1048
+ * @requiredField options.customLineItems.quantity
1049
+ * @requiredField options.lineItems.catalogReference
1050
+ * @requiredField options.lineItems.catalogReference.appId
1051
+ * @requiredField options.lineItems.catalogReference.catalogItemId
1052
+ * @requiredField options.lineItems.quantity
1053
+ * @param options - Items to be added to checkout.
1054
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1055
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
1056
+ * @permissionScope Manage Stores - all permissions
1057
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1058
+ * @permissionScope Manage Restaurants - all permissions
1059
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1060
+ * @permissionScope Manage eCommerce - all permissions
1061
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1062
+ * @permissionScope Manage Orders
1063
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1064
+ * @permissionScope Manage Stores - all permissions
1065
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1066
+ * @permissionScope Manage eCommerce - Admin Permissions
1067
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
1068
+ * @permissionScope Manage eCommerce - all permissions
1069
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1070
+ * @applicableIdentity APP
1071
+ * @applicableIdentity VISITOR
1072
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
1073
+ */
1074
+ export async function addToCheckout(_id, options) {
1075
+ // @ts-ignore
1076
+ const { httpClient, sideEffects } = arguments[2];
1077
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1078
+ id: _id,
1079
+ lineItems: options?.lineItems,
1080
+ customLineItems: options?.customLineItems,
1081
+ }), [
1082
+ {
1083
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
1084
+ paths: [{ path: 'lineItems.url' }, { path: 'customLineItems.url' }],
1085
+ },
1086
+ {
1087
+ transformFn: transformSDKImageToRESTImage,
1088
+ paths: [
1089
+ { path: 'lineItems.media' },
1090
+ { path: 'lineItems.catalogOverrideFields.image' },
1091
+ { path: 'customLineItems.media' },
1092
+ ],
1093
+ },
1094
+ ]);
1095
+ const reqOpts = ambassadorWixEcomV1Checkout.addToCheckout(payload);
1096
+ sideEffects?.onSiteCall?.();
1097
+ try {
1098
+ const result = await httpClient.request(reqOpts);
1099
+ sideEffects?.onSuccess?.(result);
1100
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1101
+ {
1102
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1103
+ paths: [{ path: 'checkout.lineItems.url' }],
1104
+ },
1105
+ {
1106
+ transformFn: transformRESTImageToSDKImage,
1107
+ paths: [
1108
+ { path: 'checkout.lineItems.media' },
1109
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1110
+ ],
1111
+ },
1112
+ {
1113
+ transformFn: transformRESTAddressToSDKAddress,
1114
+ paths: [
1115
+ { path: 'checkout.billingInfo.address' },
1116
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1117
+ {
1118
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1119
+ },
1120
+ {
1121
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1122
+ },
1123
+ ],
1124
+ },
1125
+ ]));
1126
+ }
1127
+ catch (err) {
1128
+ const transformedError = sdkTransformError(err, {
1129
+ spreadPathsToArguments: {},
1130
+ explicitPathsToArguments: {
1131
+ id: '$[0]',
1132
+ lineItems: '$[1].lineItems',
1133
+ customLineItems: '$[1].customLineItems',
1134
+ },
1135
+ singleArgumentUnchanged: false,
1136
+ }, ['_id', 'options']);
1137
+ sideEffects?.onError?.(err);
1138
+ throw transformedError;
1139
+ }
1140
+ }
1141
+ /**
1142
+ * Removes line items from the specified checkout.
1143
+ *
1144
+ *
1145
+ * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
1146
+ * @param _id - ID of the checkout to remove line items from.
1147
+ * @public
1148
+ * @requiredField _id
1149
+ * @requiredField lineItemIds
1150
+ * @param lineItemIds - IDs of the line items to be removed.
1151
+ * To find the IDs of the checkout line items you'd like to remove, pass the `checkout._id` to [getCheckout()](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and look for the IDs under `lineItems` and/or `customLineItems`.
1152
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1153
+ * @permissionScope Manage Stores - all permissions
1154
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1155
+ * @permissionScope Manage Restaurants - all permissions
1156
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1157
+ * @permissionScope Manage eCommerce - all permissions
1158
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1159
+ * @permissionScope Manage Orders
1160
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1161
+ * @applicableIdentity APP
1162
+ * @applicableIdentity VISITOR
1163
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
1164
+ */
1165
+ export async function removeLineItems(_id, lineItemIds) {
1166
+ // @ts-ignore
1167
+ const { httpClient, sideEffects } = arguments[2];
1168
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1169
+ id: _id,
1170
+ lineItemIds: lineItemIds,
1171
+ });
1172
+ const reqOpts = ambassadorWixEcomV1Checkout.removeLineItems(payload);
1173
+ sideEffects?.onSiteCall?.();
1174
+ try {
1175
+ const result = await httpClient.request(reqOpts);
1176
+ sideEffects?.onSuccess?.(result);
1177
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1178
+ {
1179
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1180
+ paths: [{ path: 'checkout.lineItems.url' }],
1181
+ },
1182
+ {
1183
+ transformFn: transformRESTImageToSDKImage,
1184
+ paths: [
1185
+ { path: 'checkout.lineItems.media' },
1186
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1187
+ ],
1188
+ },
1189
+ {
1190
+ transformFn: transformRESTAddressToSDKAddress,
1191
+ paths: [
1192
+ { path: 'checkout.billingInfo.address' },
1193
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1194
+ {
1195
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1196
+ },
1197
+ {
1198
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1199
+ },
1200
+ ],
1201
+ },
1202
+ ]));
1203
+ }
1204
+ catch (err) {
1205
+ const transformedError = sdkTransformError(err, {
1206
+ spreadPathsToArguments: {},
1207
+ explicitPathsToArguments: { id: '$[0]', lineItemIds: '$[1]' },
1208
+ singleArgumentUnchanged: false,
1209
+ }, ['_id', 'lineItemIds']);
1210
+ sideEffects?.onError?.(err);
1211
+ throw transformedError;
1212
+ }
1213
+ }
1214
+ /**
1215
+ * Creates an order from a specified checkout.
1216
+ *
1217
+ * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
1218
+ * Pass the `paymentGatewayOrderId` as the `paymentId` param to the [`startPayment()`](https://www.wix.com/velo/reference/wix-pay-frontend/startpayment) function to allow a customer to pay for their order.
1219
+ *
1220
+ * > **Note:** The following requirements must be met for an order to be created from a checkout.
1221
+ * > + A checkout cannot have calculation errors. Pass the `checkout._id` to [Get Checkout](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/getcheckout) and take a look at the `calculationErrors` field.
1222
+ * > + A checkout must have at least 1 line item.
1223
+ * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
1224
+ * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
1225
+ * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
1226
+ * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
1227
+ * @param _id - Checkout ID.
1228
+ * @public
1229
+ * @requiredField _id
1230
+ * @param options - Further order creation options.
1231
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1232
+ * @permissionScope Manage Stores - all permissions
1233
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1234
+ * @permissionScope Manage Restaurants - all permissions
1235
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1236
+ * @permissionScope Manage eCommerce - all permissions
1237
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1238
+ * @permissionScope Manage Orders
1239
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1240
+ * @applicableIdentity APP
1241
+ * @applicableIdentity VISITOR
1242
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
1243
+ */
1244
+ export async function createOrder(_id, options) {
1245
+ // @ts-ignore
1246
+ const { httpClient, sideEffects } = arguments[2];
1247
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1248
+ id: _id,
1249
+ savePaymentMethod: options?.savePaymentMethod,
1250
+ delayCapture: options?.delayCapture,
1251
+ });
1252
+ const reqOpts = ambassadorWixEcomV1Checkout.createOrder(payload);
1253
+ sideEffects?.onSiteCall?.();
1254
+ try {
1255
+ const result = await httpClient.request(reqOpts);
1256
+ sideEffects?.onSuccess?.(result);
1257
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1258
+ }
1259
+ catch (err) {
1260
+ const transformedError = sdkTransformError(err, {
1261
+ spreadPathsToArguments: {},
1262
+ explicitPathsToArguments: {
1263
+ id: '$[0]',
1264
+ savePaymentMethod: '$[1].savePaymentMethod',
1265
+ delayCapture: '$[1].delayCapture',
1266
+ },
1267
+ singleArgumentUnchanged: false,
1268
+ }, ['_id', 'options']);
1269
+ sideEffects?.onError?.(err);
1270
+ throw transformedError;
1271
+ }
1272
+ }
1273
+ /**
1274
+ * Deprecated (use createOrder instead)
1275
+ * @param _id - Checkout ID.
1276
+ * @internal
1277
+ * @documentationMaturity preview
1278
+ * @requiredField _id
1279
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1280
+ * @permissionScope Manage Stores - all permissions
1281
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1282
+ * @permissionScope Manage Restaurants - all permissions
1283
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1284
+ * @permissionScope Manage eCommerce - all permissions
1285
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1286
+ * @permissionScope Manage Orders
1287
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1288
+ * @applicableIdentity APP
1289
+ * @applicableIdentity VISITOR
1290
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrderAndCharge
1291
+ */
1292
+ export async function createOrderAndCharge(_id, options) {
1293
+ // @ts-ignore
1294
+ const { httpClient, sideEffects } = arguments[2];
1295
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1296
+ id: _id,
1297
+ paymentToken: options?.paymentToken,
1298
+ savePaymentMethod: options?.savePaymentMethod,
1299
+ delayCapture: options?.delayCapture,
1300
+ });
1301
+ const reqOpts = ambassadorWixEcomV1Checkout.createOrderAndCharge(payload);
1302
+ sideEffects?.onSiteCall?.();
1303
+ try {
1304
+ const result = await httpClient.request(reqOpts);
1305
+ sideEffects?.onSuccess?.(result);
1306
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1307
+ }
1308
+ catch (err) {
1309
+ const transformedError = sdkTransformError(err, {
1310
+ spreadPathsToArguments: {},
1311
+ explicitPathsToArguments: {
1312
+ id: '$[0]',
1313
+ paymentToken: '$[1].paymentToken',
1314
+ savePaymentMethod: '$[1].savePaymentMethod',
1315
+ delayCapture: '$[1].delayCapture',
1316
+ },
1317
+ singleArgumentUnchanged: false,
1318
+ }, ['_id', 'options']);
1319
+ sideEffects?.onError?.(err);
1320
+ throw transformedError;
1321
+ }
1322
+ }
1323
+ /**
1324
+ * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
1325
+ *
1326
+ *
1327
+ * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
1328
+ * @param _id - Checkout ID.
1329
+ * @public
1330
+ * @requiredField _id
1331
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1332
+ * @permissionScope Manage Stores - all permissions
1333
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1334
+ * @permissionScope Manage Restaurants - all permissions
1335
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1336
+ * @permissionScope Manage eCommerce - all permissions
1337
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1338
+ * @permissionScope Manage Orders
1339
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1340
+ * @applicableIdentity APP
1341
+ * @applicableIdentity VISITOR
1342
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
1343
+ */
1344
+ export async function markCheckoutAsCompleted(_id) {
1345
+ // @ts-ignore
1346
+ const { httpClient, sideEffects } = arguments[1];
1347
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1348
+ const reqOpts = ambassadorWixEcomV1Checkout.markCheckoutAsCompleted(payload);
1349
+ sideEffects?.onSiteCall?.();
1350
+ try {
1351
+ const result = await httpClient.request(reqOpts);
1352
+ sideEffects?.onSuccess?.(result);
1353
+ }
1354
+ catch (err) {
1355
+ const transformedError = sdkTransformError(err, {
1356
+ spreadPathsToArguments: {},
1357
+ explicitPathsToArguments: { id: '$[0]' },
1358
+ singleArgumentUnchanged: false,
1359
+ }, ['_id']);
1360
+ sideEffects?.onError?.(err);
1361
+ throw transformedError;
1362
+ }
1363
+ }
1364
+ /**
1365
+ * Updates the quantity of one or more line items in a checkout.
1366
+ *
1367
+ * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
1368
+ * the checkout, use [`removeLineItems()`](#removelineitems).
1369
+ * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
1370
+ *
1371
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
1372
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
1373
+ * of remaining stock.
1374
+ * @param _id - Checkout ID.
1375
+ * @param lineItems - Line item info to update.
1376
+ * @public
1377
+ * @requiredField _id
1378
+ * @requiredField lineItems
1379
+ * @requiredField lineItems._id
1380
+ * @requiredField lineItems.quantity
1381
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1382
+ * @permissionScope Manage Stores - all permissions
1383
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1384
+ * @permissionScope Manage Restaurants - all permissions
1385
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1386
+ * @permissionScope Manage eCommerce - all permissions
1387
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1388
+ * @permissionScope Manage Orders
1389
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1390
+ * @applicableIdentity APP
1391
+ * @applicableIdentity VISITOR
1392
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
1393
+ */
1394
+ export async function updateLineItemsQuantity(_id, lineItems) {
1395
+ // @ts-ignore
1396
+ const { httpClient, sideEffects } = arguments[2];
1397
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1398
+ id: _id,
1399
+ lineItems: lineItems,
1400
+ });
1401
+ const reqOpts = ambassadorWixEcomV1Checkout.updateLineItemsQuantity(payload);
1402
+ sideEffects?.onSiteCall?.();
1403
+ try {
1404
+ const result = await httpClient.request(reqOpts);
1405
+ sideEffects?.onSuccess?.(result);
1406
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1407
+ {
1408
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1409
+ paths: [{ path: 'checkout.lineItems.url' }],
1410
+ },
1411
+ {
1412
+ transformFn: transformRESTImageToSDKImage,
1413
+ paths: [
1414
+ { path: 'checkout.lineItems.media' },
1415
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1416
+ ],
1417
+ },
1418
+ {
1419
+ transformFn: transformRESTAddressToSDKAddress,
1420
+ paths: [
1421
+ { path: 'checkout.billingInfo.address' },
1422
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1423
+ {
1424
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1425
+ },
1426
+ {
1427
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1428
+ },
1429
+ ],
1430
+ },
1431
+ ]));
1432
+ }
1433
+ catch (err) {
1434
+ const transformedError = sdkTransformError(err, {
1435
+ spreadPathsToArguments: {},
1436
+ explicitPathsToArguments: { id: '$[0]', lineItems: '$[1]' },
1437
+ singleArgumentUnchanged: false,
1438
+ }, ['_id', 'lineItems']);
1439
+ sideEffects?.onError?.(err);
1440
+ throw transformedError;
1441
+ }
1442
+ }
1443
+ /** @param _id - Checkout ID.
1444
+ * @internal
1445
+ * @documentationMaturity preview
1446
+ * @requiredField _id
1447
+ * @permissionId ECOM.READ_PAYMENT_SETTINGS
1448
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutPaymentSettings
1449
+ */
1450
+ export async function getCheckoutPaymentSettings(_id) {
1451
+ // @ts-ignore
1452
+ const { httpClient, sideEffects } = arguments[1];
1453
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1454
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutPaymentSettings(payload);
1455
+ sideEffects?.onSiteCall?.();
1456
+ try {
1457
+ const result = await httpClient.request(reqOpts);
1458
+ sideEffects?.onSuccess?.(result);
1459
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1460
+ }
1461
+ catch (err) {
1462
+ const transformedError = sdkTransformError(err, {
1463
+ spreadPathsToArguments: {},
1464
+ explicitPathsToArguments: { id: '$[0]' },
1465
+ singleArgumentUnchanged: false,
1466
+ }, ['_id']);
1467
+ sideEffects?.onError?.(err);
1468
+ throw transformedError;
1469
+ }
1470
+ }
1471
+ //# sourceMappingURL=ecom-v1-checkout-checkout.universal.js.map