@wix/auto_sdk_ecom_checkout 1.0.16 → 1.0.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/cjs/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 +34 -0
  11. package/build/cjs/src/ecom-v1-checkout-checkout.context.js +77 -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 +122 -0
  14. package/build/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -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 +59 -0
  17. package/build/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -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 +358 -0
  21. package/build/cjs/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  22. package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.mts → cjs/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
  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/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.mts → cjs/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
  26. package/build/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -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 +34 -0
  39. package/build/es/src/ecom-v1-checkout-checkout.context.js +42 -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 +122 -0
  42. package/build/es/src/ecom-v1-checkout-checkout.http.js +1318 -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 +59 -0
  45. package/build/es/src/ecom-v1-checkout-checkout.meta.js +308 -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 +306 -0
  49. package/build/es/src/ecom-v1-checkout-checkout.public.js.map +1 -0
  50. package/build/{ecom-v1-checkout-checkout.universal-C4Y04uL3.d.ts → es/src/ecom-v1-checkout-checkout.types.d.ts} +382 -658
  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/{internal/ecom-v1-checkout-checkout.universal-ClmAJ_ss.d.ts → es/src/ecom-v1-checkout-checkout.universal.d.ts} +743 -449
  54. package/build/es/src/ecom-v1-checkout-checkout.universal.js +1516 -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 +42 -0
  66. package/build/internal/cjs/src/ecom-v1-checkout-checkout.context.js +77 -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 +122 -0
  69. package/build/internal/cjs/src/ecom-v1-checkout-checkout.http.js +1338 -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 +59 -0
  72. package/build/internal/cjs/src/ecom-v1-checkout-checkout.meta.js +351 -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 +219 -0
  75. package/build/internal/cjs/src/ecom-v1-checkout-checkout.public.js +358 -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 +3406 -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 +4468 -0
  81. package/build/internal/cjs/src/ecom-v1-checkout-checkout.universal.js +1559 -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 +42 -0
  93. package/build/internal/es/src/ecom-v1-checkout-checkout.context.js +42 -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 +122 -0
  96. package/build/internal/es/src/ecom-v1-checkout-checkout.http.js +1318 -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 +59 -0
  99. package/build/internal/es/src/ecom-v1-checkout-checkout.meta.js +308 -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 +219 -0
  102. package/build/internal/es/src/ecom-v1-checkout-checkout.public.js +306 -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 +3406 -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 +4468 -0
  108. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js +1516 -0
  109. package/build/internal/es/src/ecom-v1-checkout-checkout.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -211
  112. package/build/index.d.ts +0 -211
  113. package/build/index.js +0 -2781
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -2707
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -252
  118. package/build/internal/index.d.ts +0 -252
  119. package/build/internal/index.js +0 -2781
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -2707
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -2322
  124. package/build/internal/meta.d.ts +0 -2322
  125. package/build/internal/meta.js +0 -1587
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -1544
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -2322
  130. package/build/meta.d.ts +0 -2322
  131. package/build/meta.js +0 -1587
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -1544
  134. package/build/meta.mjs.map +0 -1
@@ -0,0 +1,1516 @@
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 is 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.name
326
+ * @requiredField options.customLineItems.descriptionLines.value
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 Restaurants - all permissions
351
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
352
+ * @permissionScope Manage eCommerce - all permissions
353
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
354
+ * @applicableIdentity APP
355
+ * @applicableIdentity VISITOR
356
+ * @returns Fulfilled - the newly created checkout.
357
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateCheckout
358
+ */
359
+ export async function createCheckout(options) {
360
+ // @ts-ignore
361
+ const { httpClient, sideEffects } = arguments[1];
362
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
363
+ checkoutInfo: options?.checkoutInfo,
364
+ couponCode: options?.couponCode,
365
+ lineItems: options?.lineItems,
366
+ customLineItems: options?.customLineItems,
367
+ channelType: options?.channelType,
368
+ giftCardCode: options?.giftCardCode,
369
+ overrideCheckoutUrl: options?.overrideCheckoutUrl,
370
+ }), [
371
+ {
372
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
373
+ paths: [
374
+ { path: 'checkoutInfo.lineItems.url' },
375
+ { path: 'lineItems.url' },
376
+ { path: 'customLineItems.url' },
377
+ ],
378
+ },
379
+ {
380
+ transformFn: transformSDKImageToRESTImage,
381
+ paths: [
382
+ { path: 'checkoutInfo.lineItems.media' },
383
+ { path: 'checkoutInfo.lineItems.catalogOverrideFields.image' },
384
+ { path: 'lineItems.media' },
385
+ { path: 'lineItems.catalogOverrideFields.image' },
386
+ { path: 'customLineItems.media' },
387
+ ],
388
+ },
389
+ {
390
+ transformFn: transformSDKAddressToRESTAddress,
391
+ paths: [
392
+ { path: 'checkoutInfo.billingInfo.address' },
393
+ { path: 'checkoutInfo.shippingInfo.shippingDestination.address' },
394
+ {
395
+ path: 'checkoutInfo.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
396
+ },
397
+ {
398
+ path: 'checkoutInfo.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
399
+ },
400
+ ],
401
+ },
402
+ ]);
403
+ const reqOpts = ambassadorWixEcomV1Checkout.createCheckout(payload);
404
+ sideEffects?.onSiteCall?.();
405
+ try {
406
+ const result = await httpClient.request(reqOpts);
407
+ sideEffects?.onSuccess?.(result);
408
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
409
+ {
410
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
411
+ paths: [{ path: 'checkout.lineItems.url' }],
412
+ },
413
+ {
414
+ transformFn: transformRESTImageToSDKImage,
415
+ paths: [
416
+ { path: 'checkout.lineItems.media' },
417
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
418
+ ],
419
+ },
420
+ {
421
+ transformFn: transformRESTAddressToSDKAddress,
422
+ paths: [
423
+ { path: 'checkout.billingInfo.address' },
424
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
425
+ {
426
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
427
+ },
428
+ {
429
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
430
+ },
431
+ ],
432
+ },
433
+ ]))?.checkout;
434
+ }
435
+ catch (err) {
436
+ const transformedError = sdkTransformError(err, {
437
+ spreadPathsToArguments: {},
438
+ explicitPathsToArguments: {
439
+ checkoutInfo: '$[0].checkoutInfo',
440
+ couponCode: '$[0].couponCode',
441
+ lineItems: '$[0].lineItems',
442
+ customLineItems: '$[0].customLineItems',
443
+ channelType: '$[0].channelType',
444
+ giftCardCode: '$[0].giftCardCode',
445
+ overrideCheckoutUrl: '$[0].overrideCheckoutUrl',
446
+ },
447
+ singleArgumentUnchanged: false,
448
+ }, ['options']);
449
+ sideEffects?.onError?.(err);
450
+ throw transformedError;
451
+ }
452
+ }
453
+ /**
454
+ * Retrieves a checkout.
455
+ *
456
+ *
457
+ * The `getCheckout()` function returns a Promise that resolves when the specified checkout is retrieved.
458
+ * @param _id - Checkout ID.
459
+ * @public
460
+ * @requiredField _id
461
+ * @permissionId ECOM.READ_CHECKOUTS
462
+ * @permissionScope Manage Stores - all permissions
463
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
464
+ * @permissionScope Read eCommerce - all read permissions
465
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
466
+ * @permissionScope Read Orders
467
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
468
+ * @permissionScope Read Stores - all read permissions
469
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
470
+ * @permissionScope Manage Restaurants - all permissions
471
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
472
+ * @permissionScope Manage eCommerce - all permissions
473
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
474
+ * @permissionScope Manage Orders
475
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
476
+ * @applicableIdentity APP
477
+ * @applicableIdentity VISITOR
478
+ * @returns Fulfilled - the requested checkout.
479
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckout
480
+ */
481
+ export async function getCheckout(_id) {
482
+ // @ts-ignore
483
+ const { httpClient, sideEffects } = arguments[1];
484
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
485
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckout(payload);
486
+ sideEffects?.onSiteCall?.();
487
+ try {
488
+ const result = await httpClient.request(reqOpts);
489
+ sideEffects?.onSuccess?.(result);
490
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
491
+ {
492
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
493
+ paths: [{ path: 'checkout.lineItems.url' }],
494
+ },
495
+ {
496
+ transformFn: transformRESTImageToSDKImage,
497
+ paths: [
498
+ { path: 'checkout.lineItems.media' },
499
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
500
+ ],
501
+ },
502
+ {
503
+ transformFn: transformRESTAddressToSDKAddress,
504
+ paths: [
505
+ { path: 'checkout.billingInfo.address' },
506
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
507
+ {
508
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
509
+ },
510
+ {
511
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
512
+ },
513
+ ],
514
+ },
515
+ ]))?.checkout;
516
+ }
517
+ catch (err) {
518
+ const transformedError = sdkTransformError(err, {
519
+ spreadPathsToArguments: {},
520
+ explicitPathsToArguments: { id: '$[0]' },
521
+ singleArgumentUnchanged: false,
522
+ }, ['_id']);
523
+ sideEffects?.onError?.(err);
524
+ throw transformedError;
525
+ }
526
+ }
527
+ /**
528
+ * Retrieves the checkout associated with a specified cart.
529
+ * @param _id - Cart ID.
530
+ * @public
531
+ * @requiredField _id
532
+ * @permissionId ECOM.READ_CHECKOUTS
533
+ * @permissionScope Manage Stores - all permissions
534
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
535
+ * @permissionScope Read eCommerce - all read permissions
536
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
537
+ * @permissionScope Read Orders
538
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
539
+ * @permissionScope Read Stores - all read permissions
540
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
541
+ * @permissionScope Manage Restaurants - all permissions
542
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
543
+ * @permissionScope Manage eCommerce - all permissions
544
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
545
+ * @permissionScope Manage Orders
546
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
547
+ * @applicableIdentity APP
548
+ * @applicableIdentity VISITOR
549
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutByCartId
550
+ */
551
+ export async function getCheckoutByCartId(_id) {
552
+ // @ts-ignore
553
+ const { httpClient, sideEffects } = arguments[1];
554
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
555
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutByCartId(payload);
556
+ sideEffects?.onSiteCall?.();
557
+ try {
558
+ const result = await httpClient.request(reqOpts);
559
+ sideEffects?.onSuccess?.(result);
560
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
561
+ {
562
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
563
+ paths: [{ path: 'checkout.lineItems.url' }],
564
+ },
565
+ {
566
+ transformFn: transformRESTImageToSDKImage,
567
+ paths: [
568
+ { path: 'checkout.lineItems.media' },
569
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
570
+ ],
571
+ },
572
+ {
573
+ transformFn: transformRESTAddressToSDKAddress,
574
+ paths: [
575
+ { path: 'checkout.billingInfo.address' },
576
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
577
+ {
578
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
579
+ },
580
+ {
581
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
582
+ },
583
+ ],
584
+ },
585
+ ]));
586
+ }
587
+ catch (err) {
588
+ const transformedError = sdkTransformError(err, {
589
+ spreadPathsToArguments: {},
590
+ explicitPathsToArguments: { id: '$[0]' },
591
+ singleArgumentUnchanged: false,
592
+ }, ['_id']);
593
+ sideEffects?.onError?.(err);
594
+ throw transformedError;
595
+ }
596
+ }
597
+ /**
598
+ * Deprecated and will be removed soon, use GetCheckoutURL
599
+ * @param _id - Checkout ID.
600
+ * @internal
601
+ * @documentationMaturity preview
602
+ * @requiredField _id
603
+ * @permissionId ECOM.READ_CHECKOUTS
604
+ * @permissionScope Manage Stores - all permissions
605
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
606
+ * @permissionScope Read eCommerce - all read permissions
607
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
608
+ * @permissionScope Read Orders
609
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
610
+ * @permissionScope Read Stores - all read permissions
611
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
612
+ * @permissionScope Manage Restaurants - all permissions
613
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
614
+ * @permissionScope Manage eCommerce - all permissions
615
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
616
+ * @permissionScope Manage Orders
617
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
618
+ * @applicableIdentity APP
619
+ * @applicableIdentity VISITOR
620
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetWixCheckoutURL
621
+ */
622
+ export async function getWixCheckoutUrl(_id) {
623
+ // @ts-ignore
624
+ const { httpClient, sideEffects } = arguments[1];
625
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
626
+ const reqOpts = ambassadorWixEcomV1Checkout.getWixCheckoutUrl(payload);
627
+ sideEffects?.onSiteCall?.();
628
+ try {
629
+ const result = await httpClient.request(reqOpts);
630
+ sideEffects?.onSuccess?.(result);
631
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
632
+ }
633
+ catch (err) {
634
+ const transformedError = sdkTransformError(err, {
635
+ spreadPathsToArguments: {},
636
+ explicitPathsToArguments: { id: '$[0]' },
637
+ singleArgumentUnchanged: false,
638
+ }, ['_id']);
639
+ sideEffects?.onError?.(err);
640
+ throw transformedError;
641
+ }
642
+ }
643
+ /**
644
+ * Retrieves the checkout page URL of a specified checkout.
645
+ *
646
+ * By default, a `checkoutUrl` generates for a checkout and directs to a standard Wix checkout page.
647
+ * However, if `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`.
648
+ * @param _id - Checkout ID.
649
+ * @public
650
+ * @requiredField _id
651
+ * @permissionId ECOM.READ_CHECKOUTS
652
+ * @permissionScope Manage Stores - all permissions
653
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
654
+ * @permissionScope Read eCommerce - all read permissions
655
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
656
+ * @permissionScope Read Orders
657
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
658
+ * @permissionScope Read Stores - all read permissions
659
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
660
+ * @permissionScope Manage Restaurants - all permissions
661
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
662
+ * @permissionScope Manage eCommerce - all permissions
663
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
664
+ * @permissionScope Manage Orders
665
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
666
+ * @applicableIdentity APP
667
+ * @applicableIdentity VISITOR
668
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutURL
669
+ */
670
+ export async function getCheckoutUrl(_id) {
671
+ // @ts-ignore
672
+ const { httpClient, sideEffects } = arguments[1];
673
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
674
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutUrl(payload);
675
+ sideEffects?.onSiteCall?.();
676
+ try {
677
+ const result = await httpClient.request(reqOpts);
678
+ sideEffects?.onSuccess?.(result);
679
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
680
+ }
681
+ catch (err) {
682
+ const transformedError = sdkTransformError(err, {
683
+ spreadPathsToArguments: {},
684
+ explicitPathsToArguments: { id: '$[0]' },
685
+ singleArgumentUnchanged: false,
686
+ }, ['_id']);
687
+ sideEffects?.onError?.(err);
688
+ throw transformedError;
689
+ }
690
+ }
691
+ /**
692
+ * Updates a checkout.
693
+ *
694
+ *
695
+ * The `updateCheckout()` function returns a Promise that resolves to the updated checkout when the specified properties are updated.
696
+ *
697
+ * >**Notes:**
698
+ * > + If nothing is passed in the request, the call will fail.
699
+ * > + The `checkout.buyerInfo.email` may not be removed once it is set.
700
+ * @param _id - Checkout ID.
701
+ * @public
702
+ * @requiredField _id
703
+ * @requiredField checkout
704
+ * @requiredField checkout.customFields.value
705
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships._id
706
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.appId
707
+ * @requiredField checkout.membershipOptions.selectedMemberships.memberships.lineItemIds
708
+ * @requiredField options.customLineItems.descriptionLines.name
709
+ * @requiredField options.customLineItems.descriptionLines.value
710
+ * @requiredField options.customLineItems.itemType
711
+ * @requiredField options.customLineItems.productName
712
+ * @requiredField options.customLineItems.quantity
713
+ * @requiredField options.lineItems.catalogReference
714
+ * @requiredField options.lineItems.catalogReference.appId
715
+ * @requiredField options.lineItems.catalogReference.catalogItemId
716
+ * @requiredField options.lineItems.quantity
717
+ * @param options - Checkout update options.
718
+ * @permissionId ECOM.MODIFY_CHECKOUTS
719
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
720
+ * @permissionScope Manage Stores - all permissions
721
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
722
+ * @permissionScope Manage Restaurants - all permissions
723
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
724
+ * @permissionScope Manage eCommerce - all permissions
725
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
726
+ * @permissionScope Manage Orders
727
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
728
+ * @permissionScope Manage Stores - all permissions
729
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
730
+ * @permissionScope Manage eCommerce - Admin Permissions
731
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
732
+ * @permissionScope Manage Restaurants - all permissions
733
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
734
+ * @permissionScope Manage eCommerce - all permissions
735
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
736
+ * @applicableIdentity APP
737
+ * @applicableIdentity VISITOR
738
+ * @returns Updated checkout.
739
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateCheckout
740
+ */
741
+ export async function updateCheckout(_id, checkout, options) {
742
+ // @ts-ignore
743
+ const { httpClient, sideEffects } = arguments[3];
744
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
745
+ checkout: { ...checkout, id: _id },
746
+ couponCode: options?.couponCode,
747
+ giftCardCode: options?.giftCardCode,
748
+ overrideCheckoutUrl: options?.overrideCheckoutUrl,
749
+ lineItems: options?.lineItems,
750
+ customLineItems: options?.customLineItems,
751
+ }), [
752
+ {
753
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
754
+ paths: [
755
+ { path: 'checkout.lineItems.url' },
756
+ { path: 'lineItems.url' },
757
+ { path: 'customLineItems.url' },
758
+ ],
759
+ },
760
+ {
761
+ transformFn: transformSDKImageToRESTImage,
762
+ paths: [
763
+ { path: 'checkout.lineItems.media' },
764
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
765
+ { path: 'lineItems.media' },
766
+ { path: 'lineItems.catalogOverrideFields.image' },
767
+ { path: 'customLineItems.media' },
768
+ ],
769
+ },
770
+ {
771
+ transformFn: transformSDKAddressToRESTAddress,
772
+ paths: [
773
+ { path: 'checkout.billingInfo.address' },
774
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
775
+ {
776
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
777
+ },
778
+ {
779
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
780
+ },
781
+ ],
782
+ },
783
+ ]);
784
+ const reqOpts = ambassadorWixEcomV1Checkout.updateCheckout(payload);
785
+ sideEffects?.onSiteCall?.();
786
+ try {
787
+ const result = await httpClient.request(reqOpts);
788
+ sideEffects?.onSuccess?.(result);
789
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
790
+ {
791
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
792
+ paths: [{ path: 'checkout.lineItems.url' }],
793
+ },
794
+ {
795
+ transformFn: transformRESTImageToSDKImage,
796
+ paths: [
797
+ { path: 'checkout.lineItems.media' },
798
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
799
+ ],
800
+ },
801
+ {
802
+ transformFn: transformRESTAddressToSDKAddress,
803
+ paths: [
804
+ { path: 'checkout.billingInfo.address' },
805
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
806
+ {
807
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
808
+ },
809
+ {
810
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
811
+ },
812
+ ],
813
+ },
814
+ ]))?.checkout;
815
+ }
816
+ catch (err) {
817
+ const transformedError = sdkTransformError(err, {
818
+ spreadPathsToArguments: { checkout: '$[1]' },
819
+ explicitPathsToArguments: {
820
+ 'checkout.id': '$[0]',
821
+ couponCode: '$[2].couponCode',
822
+ giftCardCode: '$[2].giftCardCode',
823
+ overrideCheckoutUrl: '$[2].overrideCheckoutUrl',
824
+ lineItems: '$[2].lineItems',
825
+ customLineItems: '$[2].customLineItems',
826
+ },
827
+ singleArgumentUnchanged: false,
828
+ }, ['_id', 'checkout', 'options']);
829
+ sideEffects?.onError?.(err);
830
+ throw transformedError;
831
+ }
832
+ }
833
+ /**
834
+ * Removes the coupon from a specified checkout.
835
+ *
836
+ *
837
+ * The `removeCoupon()` function returns a Promise that resolves to the updated checkout when the coupon is removed from the specified checkout.
838
+ *
839
+ * >**Note:** A checkout can only hold 1 coupon.
840
+ * @param _id - ID of the checkout to remove the coupon from.
841
+ * @public
842
+ * @requiredField _id
843
+ * @permissionId ECOM.MODIFY_CHECKOUTS
844
+ * @permissionScope Manage Stores - all permissions
845
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
846
+ * @permissionScope Manage Restaurants - all permissions
847
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
848
+ * @permissionScope Manage eCommerce - all permissions
849
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
850
+ * @permissionScope Manage Orders
851
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
852
+ * @applicableIdentity APP
853
+ * @applicableIdentity VISITOR
854
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveCoupon
855
+ */
856
+ export async function removeCoupon(_id) {
857
+ // @ts-ignore
858
+ const { httpClient, sideEffects } = arguments[1];
859
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
860
+ const reqOpts = ambassadorWixEcomV1Checkout.removeCoupon(payload);
861
+ sideEffects?.onSiteCall?.();
862
+ try {
863
+ const result = await httpClient.request(reqOpts);
864
+ sideEffects?.onSuccess?.(result);
865
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
866
+ {
867
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
868
+ paths: [{ path: 'checkout.lineItems.url' }],
869
+ },
870
+ {
871
+ transformFn: transformRESTImageToSDKImage,
872
+ paths: [
873
+ { path: 'checkout.lineItems.media' },
874
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
875
+ ],
876
+ },
877
+ {
878
+ transformFn: transformRESTAddressToSDKAddress,
879
+ paths: [
880
+ { path: 'checkout.billingInfo.address' },
881
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
882
+ {
883
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
884
+ },
885
+ {
886
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
887
+ },
888
+ ],
889
+ },
890
+ ]));
891
+ }
892
+ catch (err) {
893
+ const transformedError = sdkTransformError(err, {
894
+ spreadPathsToArguments: {},
895
+ explicitPathsToArguments: { id: '$[0]' },
896
+ singleArgumentUnchanged: false,
897
+ }, ['_id']);
898
+ sideEffects?.onError?.(err);
899
+ throw transformedError;
900
+ }
901
+ }
902
+ /**
903
+ * Removes the gift card from a specified checkout.
904
+ *
905
+ *
906
+ * The `removeGiftCard()` function returns a Promise that resolves to the updated checkout when the gift card is removed from the specified checkout.
907
+ *
908
+ * >**Note:** A checkout can only hold 1 gift card.
909
+ * @param _id - ID of the checkout to remove the gift card from.
910
+ * @public
911
+ * @requiredField _id
912
+ * @permissionId ECOM.MODIFY_CHECKOUTS
913
+ * @permissionScope Manage Stores - all permissions
914
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
915
+ * @permissionScope Manage Restaurants - all permissions
916
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
917
+ * @permissionScope Manage eCommerce - all permissions
918
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
919
+ * @permissionScope Manage Orders
920
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
921
+ * @applicableIdentity APP
922
+ * @applicableIdentity VISITOR
923
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveGiftCard
924
+ */
925
+ export async function removeGiftCard(_id) {
926
+ // @ts-ignore
927
+ const { httpClient, sideEffects } = arguments[1];
928
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
929
+ const reqOpts = ambassadorWixEcomV1Checkout.removeGiftCard(payload);
930
+ sideEffects?.onSiteCall?.();
931
+ try {
932
+ const result = await httpClient.request(reqOpts);
933
+ sideEffects?.onSuccess?.(result);
934
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
935
+ {
936
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
937
+ paths: [{ path: 'checkout.lineItems.url' }],
938
+ },
939
+ {
940
+ transformFn: transformRESTImageToSDKImage,
941
+ paths: [
942
+ { path: 'checkout.lineItems.media' },
943
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
944
+ ],
945
+ },
946
+ {
947
+ transformFn: transformRESTAddressToSDKAddress,
948
+ paths: [
949
+ { path: 'checkout.billingInfo.address' },
950
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
951
+ {
952
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
953
+ },
954
+ {
955
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
956
+ },
957
+ ],
958
+ },
959
+ ]));
960
+ }
961
+ catch (err) {
962
+ const transformedError = sdkTransformError(err, {
963
+ spreadPathsToArguments: {},
964
+ explicitPathsToArguments: { id: '$[0]' },
965
+ singleArgumentUnchanged: false,
966
+ }, ['_id']);
967
+ sideEffects?.onError?.(err);
968
+ throw transformedError;
969
+ }
970
+ }
971
+ /**
972
+ * Removes the `overrideCheckoutUrl` from a specified checkout.
973
+ *
974
+ * When `overrideCheckoutUrl` is removed, the `checkoutUrl` will be set to the default, standard
975
+ * Wix checkout page URL.
976
+ * @param _id - ID of the checkout to remove the override checkout url from.
977
+ * @public
978
+ * @requiredField _id
979
+ * @permissionId ECOM.MODIFY_CHECKOUTS
980
+ * @permissionScope Manage Stores - all permissions
981
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
982
+ * @permissionScope Manage Restaurants - all permissions
983
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
984
+ * @permissionScope Manage eCommerce - all permissions
985
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
986
+ * @permissionScope Manage Orders
987
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
988
+ * @applicableIdentity APP
989
+ * @applicableIdentity VISITOR
990
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveOverrideCheckoutUrl
991
+ */
992
+ export async function removeOverrideCheckoutUrl(_id) {
993
+ // @ts-ignore
994
+ const { httpClient, sideEffects } = arguments[1];
995
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
996
+ const reqOpts = ambassadorWixEcomV1Checkout.removeOverrideCheckoutUrl(payload);
997
+ sideEffects?.onSiteCall?.();
998
+ try {
999
+ const result = await httpClient.request(reqOpts);
1000
+ sideEffects?.onSuccess?.(result);
1001
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1002
+ {
1003
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1004
+ paths: [{ path: 'checkout.lineItems.url' }],
1005
+ },
1006
+ {
1007
+ transformFn: transformRESTImageToSDKImage,
1008
+ paths: [
1009
+ { path: 'checkout.lineItems.media' },
1010
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1011
+ ],
1012
+ },
1013
+ {
1014
+ transformFn: transformRESTAddressToSDKAddress,
1015
+ paths: [
1016
+ { path: 'checkout.billingInfo.address' },
1017
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1018
+ {
1019
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1020
+ },
1021
+ {
1022
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1023
+ },
1024
+ ],
1025
+ },
1026
+ ]));
1027
+ }
1028
+ catch (err) {
1029
+ const transformedError = sdkTransformError(err, {
1030
+ spreadPathsToArguments: {},
1031
+ explicitPathsToArguments: { id: '$[0]' },
1032
+ singleArgumentUnchanged: false,
1033
+ }, ['_id']);
1034
+ sideEffects?.onError?.(err);
1035
+ throw transformedError;
1036
+ }
1037
+ }
1038
+ /**
1039
+ * Adds catalog line items and/or custom line items to a checkout.
1040
+ *
1041
+ *
1042
+ * The `addToCheckout()` function returns a Promise that resolves to the updated checkout when the specified items have been added.
1043
+ * > **Note:** When adding catalog items, `options.lineItems.catalogReference` is required.
1044
+ * @param _id - Checkout ID.
1045
+ * @public
1046
+ * @requiredField _id
1047
+ * @requiredField options.customLineItems.descriptionLines.name
1048
+ * @requiredField options.customLineItems.descriptionLines.value
1049
+ * @requiredField options.customLineItems.itemType
1050
+ * @requiredField options.customLineItems.productName
1051
+ * @requiredField options.customLineItems.quantity
1052
+ * @requiredField options.lineItems.catalogReference
1053
+ * @requiredField options.lineItems.catalogReference.appId
1054
+ * @requiredField options.lineItems.catalogReference.catalogItemId
1055
+ * @requiredField options.lineItems.quantity
1056
+ * @param options - Items to be added to checkout.
1057
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1058
+ * @permissionId ECOM.ADMIN_MODIFY_CHECKOUTS
1059
+ * @permissionScope Manage Stores - all permissions
1060
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1061
+ * @permissionScope Manage Restaurants - all permissions
1062
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1063
+ * @permissionScope Manage eCommerce - all permissions
1064
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1065
+ * @permissionScope Manage Orders
1066
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1067
+ * @permissionScope Manage Stores - all permissions
1068
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1069
+ * @permissionScope Manage eCommerce - Admin Permissions
1070
+ * @permissionScopeId SCOPE.ECOM.MANAGE-ADMIN
1071
+ * @permissionScope Manage Restaurants - all permissions
1072
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1073
+ * @permissionScope Manage eCommerce - all permissions
1074
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1075
+ * @applicableIdentity APP
1076
+ * @applicableIdentity VISITOR
1077
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.AddToCheckout
1078
+ */
1079
+ export async function addToCheckout(_id, options) {
1080
+ // @ts-ignore
1081
+ const { httpClient, sideEffects } = arguments[2];
1082
+ const payload = transformPaths(renameKeysFromSDKRequestToRESTRequest({
1083
+ id: _id,
1084
+ lineItems: options?.lineItems,
1085
+ customLineItems: options?.customLineItems,
1086
+ }), [
1087
+ {
1088
+ transformFn: transformSDKPageURLV2ToRESTPageURLV2,
1089
+ paths: [{ path: 'lineItems.url' }, { path: 'customLineItems.url' }],
1090
+ },
1091
+ {
1092
+ transformFn: transformSDKImageToRESTImage,
1093
+ paths: [
1094
+ { path: 'lineItems.media' },
1095
+ { path: 'lineItems.catalogOverrideFields.image' },
1096
+ { path: 'customLineItems.media' },
1097
+ ],
1098
+ },
1099
+ ]);
1100
+ const reqOpts = ambassadorWixEcomV1Checkout.addToCheckout(payload);
1101
+ sideEffects?.onSiteCall?.();
1102
+ try {
1103
+ const result = await httpClient.request(reqOpts);
1104
+ sideEffects?.onSuccess?.(result);
1105
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1106
+ {
1107
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1108
+ paths: [{ path: 'checkout.lineItems.url' }],
1109
+ },
1110
+ {
1111
+ transformFn: transformRESTImageToSDKImage,
1112
+ paths: [
1113
+ { path: 'checkout.lineItems.media' },
1114
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1115
+ ],
1116
+ },
1117
+ {
1118
+ transformFn: transformRESTAddressToSDKAddress,
1119
+ paths: [
1120
+ { path: 'checkout.billingInfo.address' },
1121
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1122
+ {
1123
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1124
+ },
1125
+ {
1126
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1127
+ },
1128
+ ],
1129
+ },
1130
+ ]));
1131
+ }
1132
+ catch (err) {
1133
+ const transformedError = sdkTransformError(err, {
1134
+ spreadPathsToArguments: {},
1135
+ explicitPathsToArguments: {
1136
+ id: '$[0]',
1137
+ lineItems: '$[1].lineItems',
1138
+ customLineItems: '$[1].customLineItems',
1139
+ },
1140
+ singleArgumentUnchanged: false,
1141
+ }, ['_id', 'options']);
1142
+ sideEffects?.onError?.(err);
1143
+ throw transformedError;
1144
+ }
1145
+ }
1146
+ /**
1147
+ * Removes line items from the specified checkout.
1148
+ *
1149
+ *
1150
+ * The `removeLineItems()` function returns a Promise that resolves to the updated checkout when the line items are removed from the specified checkout.
1151
+ * @param _id - ID of the checkout to remove line items from.
1152
+ * @public
1153
+ * @requiredField _id
1154
+ * @requiredField lineItemIds
1155
+ * @param lineItemIds - IDs of the line items to be removed.
1156
+ * 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`.
1157
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1158
+ * @permissionScope Manage Stores - all permissions
1159
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1160
+ * @permissionScope Manage Restaurants - all permissions
1161
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1162
+ * @permissionScope Manage eCommerce - all permissions
1163
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1164
+ * @permissionScope Manage Orders
1165
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1166
+ * @applicableIdentity APP
1167
+ * @applicableIdentity VISITOR
1168
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.RemoveLineItems
1169
+ */
1170
+ export async function removeLineItems(_id, lineItemIds) {
1171
+ // @ts-ignore
1172
+ const { httpClient, sideEffects } = arguments[2];
1173
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1174
+ id: _id,
1175
+ lineItemIds: lineItemIds,
1176
+ });
1177
+ const reqOpts = ambassadorWixEcomV1Checkout.removeLineItems(payload);
1178
+ sideEffects?.onSiteCall?.();
1179
+ try {
1180
+ const result = await httpClient.request(reqOpts);
1181
+ sideEffects?.onSuccess?.(result);
1182
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1183
+ {
1184
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1185
+ paths: [{ path: 'checkout.lineItems.url' }],
1186
+ },
1187
+ {
1188
+ transformFn: transformRESTImageToSDKImage,
1189
+ paths: [
1190
+ { path: 'checkout.lineItems.media' },
1191
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1192
+ ],
1193
+ },
1194
+ {
1195
+ transformFn: transformRESTAddressToSDKAddress,
1196
+ paths: [
1197
+ { path: 'checkout.billingInfo.address' },
1198
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1199
+ {
1200
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1201
+ },
1202
+ {
1203
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1204
+ },
1205
+ ],
1206
+ },
1207
+ ]));
1208
+ }
1209
+ catch (err) {
1210
+ const transformedError = sdkTransformError(err, {
1211
+ spreadPathsToArguments: {},
1212
+ explicitPathsToArguments: { id: '$[0]', lineItemIds: '$[1]' },
1213
+ singleArgumentUnchanged: false,
1214
+ }, ['_id', 'lineItemIds']);
1215
+ sideEffects?.onError?.(err);
1216
+ throw transformedError;
1217
+ }
1218
+ }
1219
+ /**
1220
+ * Creates an order from a specified checkout.
1221
+ *
1222
+ * The `createOrder()` function returns a Promise that resolves to the new order's ID and `paymentGatewayOrderID` when the order is created.
1223
+ * 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.
1224
+ *
1225
+ * > **Note:** The following requirements must be met for an order to be created from a checkout.
1226
+ * > + 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.
1227
+ * > + A checkout must have at least 1 line item.
1228
+ * > + All of the line Items have an `availability.status` of `"AVAILABLE"` or `"PARTIALLY_AVAILABLE"`.
1229
+ * > + If there is a payment to be made, meaning that `priceSummary.total` is greater than 0, the `billingInfo.address` field must be provided.
1230
+ * > + When a checkout has line items to be shipped, the `shippingInfo.shippingDestination.address` and `shippingInfo.selectedCarrierServiceOption` fields must be provided.
1231
+ * > + When a checkout has line items for pickup, the `shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails` field must be provided.
1232
+ * @param _id - Checkout ID.
1233
+ * @public
1234
+ * @requiredField _id
1235
+ * @param options - Further order creation options.
1236
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1237
+ * @permissionScope Manage Stores - all permissions
1238
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1239
+ * @permissionScope Manage Restaurants - all permissions
1240
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1241
+ * @permissionScope Manage eCommerce - all permissions
1242
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1243
+ * @permissionScope Manage Orders
1244
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1245
+ * @applicableIdentity APP
1246
+ * @applicableIdentity VISITOR
1247
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrder
1248
+ */
1249
+ export async function createOrder(_id, options) {
1250
+ // @ts-ignore
1251
+ const { httpClient, sideEffects } = arguments[2];
1252
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1253
+ id: _id,
1254
+ savePaymentMethod: options?.savePaymentMethod,
1255
+ delayCapture: options?.delayCapture,
1256
+ });
1257
+ const reqOpts = ambassadorWixEcomV1Checkout.createOrder(payload);
1258
+ sideEffects?.onSiteCall?.();
1259
+ try {
1260
+ const result = await httpClient.request(reqOpts);
1261
+ sideEffects?.onSuccess?.(result);
1262
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1263
+ }
1264
+ catch (err) {
1265
+ const transformedError = sdkTransformError(err, {
1266
+ spreadPathsToArguments: {},
1267
+ explicitPathsToArguments: {
1268
+ id: '$[0]',
1269
+ savePaymentMethod: '$[1].savePaymentMethod',
1270
+ delayCapture: '$[1].delayCapture',
1271
+ },
1272
+ singleArgumentUnchanged: false,
1273
+ }, ['_id', 'options']);
1274
+ sideEffects?.onError?.(err);
1275
+ throw transformedError;
1276
+ }
1277
+ }
1278
+ /**
1279
+ * Deprecated (use createOrder instead)
1280
+ * @param _id - Checkout ID.
1281
+ * @internal
1282
+ * @documentationMaturity preview
1283
+ * @requiredField _id
1284
+ * @permissionId ECOM.CREATE_ORDER_FROM_CHECKOUT
1285
+ * @permissionScope Manage Stores - all permissions
1286
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1287
+ * @permissionScope Manage Restaurants - all permissions
1288
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1289
+ * @permissionScope Manage eCommerce - all permissions
1290
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1291
+ * @permissionScope Manage Orders
1292
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1293
+ * @applicableIdentity APP
1294
+ * @applicableIdentity VISITOR
1295
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.CreateOrderAndCharge
1296
+ */
1297
+ export async function createOrderAndCharge(_id, options) {
1298
+ // @ts-ignore
1299
+ const { httpClient, sideEffects } = arguments[2];
1300
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1301
+ id: _id,
1302
+ paymentToken: options?.paymentToken,
1303
+ savePaymentMethod: options?.savePaymentMethod,
1304
+ delayCapture: options?.delayCapture,
1305
+ });
1306
+ const reqOpts = ambassadorWixEcomV1Checkout.createOrderAndCharge(payload);
1307
+ sideEffects?.onSiteCall?.();
1308
+ try {
1309
+ const result = await httpClient.request(reqOpts);
1310
+ sideEffects?.onSuccess?.(result);
1311
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1312
+ }
1313
+ catch (err) {
1314
+ const transformedError = sdkTransformError(err, {
1315
+ spreadPathsToArguments: {},
1316
+ explicitPathsToArguments: {
1317
+ id: '$[0]',
1318
+ paymentToken: '$[1].paymentToken',
1319
+ savePaymentMethod: '$[1].savePaymentMethod',
1320
+ delayCapture: '$[1].delayCapture',
1321
+ },
1322
+ singleArgumentUnchanged: false,
1323
+ }, ['_id', 'options']);
1324
+ sideEffects?.onError?.(err);
1325
+ throw transformedError;
1326
+ }
1327
+ }
1328
+ /**
1329
+ * Marks a checkout as completed and redirects to a specified URL.
1330
+ * @param token - Server-signed JWT token with required information to complete checkout
1331
+ * @internal
1332
+ * @documentationMaturity preview
1333
+ * @requiredField token
1334
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1335
+ * @permissionScope Manage Stores - all permissions
1336
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1337
+ * @permissionScope Manage Restaurants - all permissions
1338
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1339
+ * @permissionScope Manage eCommerce - all permissions
1340
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1341
+ * @permissionScope Manage Orders
1342
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1343
+ * @applicableIdentity APP
1344
+ * @applicableIdentity VISITOR
1345
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompletedAndRedirectToUrl
1346
+ */
1347
+ export async function markCheckoutAsCompletedAndRedirectToUrl(token) {
1348
+ // @ts-ignore
1349
+ const { httpClient, sideEffects } = arguments[1];
1350
+ const payload = renameKeysFromSDKRequestToRESTRequest({ token: token });
1351
+ const reqOpts = ambassadorWixEcomV1Checkout.markCheckoutAsCompletedAndRedirectToUrl(payload);
1352
+ sideEffects?.onSiteCall?.();
1353
+ try {
1354
+ const result = await httpClient.request(reqOpts);
1355
+ sideEffects?.onSuccess?.(result);
1356
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1357
+ }
1358
+ catch (err) {
1359
+ const transformedError = sdkTransformError(err, {
1360
+ spreadPathsToArguments: {},
1361
+ explicitPathsToArguments: { token: '$[0]' },
1362
+ singleArgumentUnchanged: false,
1363
+ }, ['token']);
1364
+ sideEffects?.onError?.(err);
1365
+ throw transformedError;
1366
+ }
1367
+ }
1368
+ /**
1369
+ * Marks a checkout as completed - `checkout.complete` boolean is set to `true`.
1370
+ *
1371
+ *
1372
+ * The `markCheckoutAsCompleted()` function returns a Promise that resolves when the specified checkout is marked as completed.
1373
+ * @param _id - Checkout ID.
1374
+ * @public
1375
+ * @requiredField _id
1376
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1377
+ * @permissionScope Manage Stores - all permissions
1378
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1379
+ * @permissionScope Manage Restaurants - all permissions
1380
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1381
+ * @permissionScope Manage eCommerce - all permissions
1382
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1383
+ * @permissionScope Manage Orders
1384
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1385
+ * @applicableIdentity APP
1386
+ * @applicableIdentity VISITOR
1387
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.MarkCheckoutAsCompleted
1388
+ */
1389
+ export async function markCheckoutAsCompleted(_id) {
1390
+ // @ts-ignore
1391
+ const { httpClient, sideEffects } = arguments[1];
1392
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1393
+ const reqOpts = ambassadorWixEcomV1Checkout.markCheckoutAsCompleted(payload);
1394
+ sideEffects?.onSiteCall?.();
1395
+ try {
1396
+ const result = await httpClient.request(reqOpts);
1397
+ sideEffects?.onSuccess?.(result);
1398
+ }
1399
+ catch (err) {
1400
+ const transformedError = sdkTransformError(err, {
1401
+ spreadPathsToArguments: {},
1402
+ explicitPathsToArguments: { id: '$[0]' },
1403
+ singleArgumentUnchanged: false,
1404
+ }, ['_id']);
1405
+ sideEffects?.onError?.(err);
1406
+ throw transformedError;
1407
+ }
1408
+ }
1409
+ /**
1410
+ * Updates the quantity of one or more line items in a checkout.
1411
+ *
1412
+ * This endpoint is only for updating the quantity of line items. To entirely remove a line item from
1413
+ * the checkout, use [`removeLineItems()`](#removelineitems).
1414
+ * To add a new line item to the checkout, use [`addToCheckout()`](#addtocheckout).
1415
+ *
1416
+ * This endpoint checks the amount of stock remaining for this line item. If the specified `quantity`
1417
+ * is greater than the remaining stock, then the `quantity` returned in the response is the total amount
1418
+ * of remaining stock.
1419
+ * @param _id - Checkout ID.
1420
+ * @param lineItems - Line item info to update.
1421
+ * @public
1422
+ * @requiredField _id
1423
+ * @requiredField lineItems
1424
+ * @requiredField lineItems._id
1425
+ * @requiredField lineItems.quantity
1426
+ * @permissionId ECOM.MODIFY_CHECKOUTS
1427
+ * @permissionScope Manage Stores - all permissions
1428
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1429
+ * @permissionScope Manage Restaurants - all permissions
1430
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1431
+ * @permissionScope Manage eCommerce - all permissions
1432
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
1433
+ * @permissionScope Manage Orders
1434
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
1435
+ * @applicableIdentity APP
1436
+ * @applicableIdentity VISITOR
1437
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.UpdateLineItemsQuantity
1438
+ */
1439
+ export async function updateLineItemsQuantity(_id, lineItems) {
1440
+ // @ts-ignore
1441
+ const { httpClient, sideEffects } = arguments[2];
1442
+ const payload = renameKeysFromSDKRequestToRESTRequest({
1443
+ id: _id,
1444
+ lineItems: lineItems,
1445
+ });
1446
+ const reqOpts = ambassadorWixEcomV1Checkout.updateLineItemsQuantity(payload);
1447
+ sideEffects?.onSiteCall?.();
1448
+ try {
1449
+ const result = await httpClient.request(reqOpts);
1450
+ sideEffects?.onSuccess?.(result);
1451
+ return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
1452
+ {
1453
+ transformFn: transformRESTPageURLV2ToSDKPageURLV2,
1454
+ paths: [{ path: 'checkout.lineItems.url' }],
1455
+ },
1456
+ {
1457
+ transformFn: transformRESTImageToSDKImage,
1458
+ paths: [
1459
+ { path: 'checkout.lineItems.media' },
1460
+ { path: 'checkout.lineItems.catalogOverrideFields.image' },
1461
+ ],
1462
+ },
1463
+ {
1464
+ transformFn: transformRESTAddressToSDKAddress,
1465
+ paths: [
1466
+ { path: 'checkout.billingInfo.address' },
1467
+ { path: 'checkout.shippingInfo.shippingDestination.address' },
1468
+ {
1469
+ path: 'checkout.shippingInfo.selectedCarrierServiceOption.logistics.pickupDetails.address',
1470
+ },
1471
+ {
1472
+ path: 'checkout.shippingInfo.carrierServiceOptions.shippingOptions.logistics.pickupDetails.address',
1473
+ },
1474
+ ],
1475
+ },
1476
+ ]));
1477
+ }
1478
+ catch (err) {
1479
+ const transformedError = sdkTransformError(err, {
1480
+ spreadPathsToArguments: {},
1481
+ explicitPathsToArguments: { id: '$[0]', lineItems: '$[1]' },
1482
+ singleArgumentUnchanged: false,
1483
+ }, ['_id', 'lineItems']);
1484
+ sideEffects?.onError?.(err);
1485
+ throw transformedError;
1486
+ }
1487
+ }
1488
+ /** @param _id - Checkout ID.
1489
+ * @internal
1490
+ * @documentationMaturity preview
1491
+ * @requiredField _id
1492
+ * @permissionId ECOM.READ_PAYMENT_SETTINGS
1493
+ * @fqn com.wix.ecom.checkout.api.v1.CheckoutService.GetCheckoutPaymentSettings
1494
+ */
1495
+ export async function getCheckoutPaymentSettings(_id) {
1496
+ // @ts-ignore
1497
+ const { httpClient, sideEffects } = arguments[1];
1498
+ const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
1499
+ const reqOpts = ambassadorWixEcomV1Checkout.getCheckoutPaymentSettings(payload);
1500
+ sideEffects?.onSiteCall?.();
1501
+ try {
1502
+ const result = await httpClient.request(reqOpts);
1503
+ sideEffects?.onSuccess?.(result);
1504
+ return renameKeysFromRESTResponseToSDKResponse(result.data);
1505
+ }
1506
+ catch (err) {
1507
+ const transformedError = sdkTransformError(err, {
1508
+ spreadPathsToArguments: {},
1509
+ explicitPathsToArguments: { id: '$[0]' },
1510
+ singleArgumentUnchanged: false,
1511
+ }, ['_id']);
1512
+ sideEffects?.onError?.(err);
1513
+ throw transformedError;
1514
+ }
1515
+ }
1516
+ //# sourceMappingURL=ecom-v1-checkout-checkout.universal.js.map