@wix/auto_sdk_ecom_checkout-templates 1.0.150 → 1.0.151
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.
- package/build/cjs/schemas.js +1011 -996
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/schemas.mjs +1011 -996
- package/build/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
- package/build/internal/cjs/index.js +0 -1512
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -1173
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -918
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/schemas.js +0 -2579
- package/build/internal/cjs/schemas.js.map +0 -1
- package/build/internal/es/index.mjs +0 -1446
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -1110
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -854
- package/build/internal/es/meta.mjs.map +0 -1
- package/build/internal/es/schemas.mjs +0 -2529
- package/build/internal/es/schemas.mjs.map +0 -1
package/build/cjs/schemas.js
CHANGED
|
@@ -50,115 +50,115 @@ module.exports = __toCommonJS(schemas_exports);
|
|
|
50
50
|
// src/ecom-v1-checkout-template-checkout-templates.schemas.ts
|
|
51
51
|
var z = __toESM(require("zod"));
|
|
52
52
|
var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
53
|
-
checkoutTemplate: z.object({
|
|
54
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
53
|
+
checkoutTemplate: /* @__PURE__ */ z.object({
|
|
54
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
55
55
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
56
56
|
"Must be a valid GUID"
|
|
57
57
|
).optional().nullable(),
|
|
58
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).optional(),
|
|
59
|
-
customization: z.object({
|
|
60
|
-
webClient: z.object({
|
|
61
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
58
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).optional(),
|
|
59
|
+
customization: /* @__PURE__ */ z.object({
|
|
60
|
+
webClient: /* @__PURE__ */ z.object({
|
|
61
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
62
62
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
63
63
|
).optional(),
|
|
64
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
64
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
65
65
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
66
66
|
).optional()
|
|
67
67
|
}).describe(
|
|
68
68
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
69
69
|
).optional(),
|
|
70
|
-
lockedGiftCard: z.boolean().describe(
|
|
70
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
71
71
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
72
72
|
).optional(),
|
|
73
|
-
lockedCoupon: z.boolean().describe(
|
|
73
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
74
74
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
75
75
|
).optional(),
|
|
76
|
-
disabledManualPayment: z.boolean().describe(
|
|
76
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
77
77
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
78
78
|
).optional()
|
|
79
79
|
}).describe(
|
|
80
80
|
"Custom settings to apply to the checkout page created from this template."
|
|
81
81
|
).optional(),
|
|
82
|
-
lineItems: z.array(
|
|
83
|
-
z.object({
|
|
84
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5),
|
|
85
|
-
catalogReference: z.object({
|
|
86
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36),
|
|
87
|
-
appId: z.string().describe(
|
|
82
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
83
|
+
/* @__PURE__ */ z.object({
|
|
84
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5),
|
|
85
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
86
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36),
|
|
87
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
88
88
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
89
89
|
).min(1),
|
|
90
|
-
options: z.record(z.string(), z.any()).describe(
|
|
90
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
91
91
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
92
92
|
).optional().nullable()
|
|
93
93
|
}).describe(
|
|
94
94
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
95
95
|
),
|
|
96
|
-
catalogOverrideFields: z.object({
|
|
97
|
-
productName: z.object({
|
|
98
|
-
original: z.string().describe(
|
|
96
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
97
|
+
productName: /* @__PURE__ */ z.object({
|
|
98
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
99
99
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
100
100
|
).min(1).max(200).optional(),
|
|
101
|
-
translated: z.string().describe(
|
|
101
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
102
102
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
103
103
|
).min(1).max(400).optional().nullable()
|
|
104
104
|
}).describe("Item name.").optional(),
|
|
105
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
106
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
107
|
-
descriptionLines: z.array(
|
|
108
|
-
z.intersection(
|
|
109
|
-
z.object({
|
|
110
|
-
name: z.object({
|
|
111
|
-
original: z.string().describe(
|
|
105
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
106
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
107
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
108
|
+
/* @__PURE__ */ z.intersection(
|
|
109
|
+
/* @__PURE__ */ z.object({
|
|
110
|
+
name: /* @__PURE__ */ z.object({
|
|
111
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
112
112
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
113
113
|
).max(100).optional(),
|
|
114
|
-
translated: z.string().describe(
|
|
114
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
115
115
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
116
116
|
).max(200).optional().nullable()
|
|
117
117
|
}).describe("Description line name.").optional()
|
|
118
118
|
}),
|
|
119
|
-
z.xor([
|
|
120
|
-
z.object({
|
|
121
|
-
plainText: z.never().optional(),
|
|
122
|
-
colorInfo: z.never().optional()
|
|
119
|
+
/* @__PURE__ */ z.xor([
|
|
120
|
+
/* @__PURE__ */ z.object({
|
|
121
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
122
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
123
123
|
}),
|
|
124
|
-
z.object({
|
|
125
|
-
colorInfo: z.never().optional(),
|
|
126
|
-
plainText: z.object({
|
|
127
|
-
original: z.string().describe(
|
|
124
|
+
/* @__PURE__ */ z.object({
|
|
125
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
126
|
+
plainText: /* @__PURE__ */ z.object({
|
|
127
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
128
128
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
129
129
|
).max(600).optional(),
|
|
130
|
-
translated: z.string().describe(
|
|
130
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
131
131
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
132
132
|
).max(600).optional().nullable()
|
|
133
133
|
}).describe("Description line plain text value.")
|
|
134
134
|
}),
|
|
135
|
-
z.object({
|
|
136
|
-
plainText: z.never().optional(),
|
|
137
|
-
colorInfo: z.object({
|
|
138
|
-
original: z.string().describe(
|
|
135
|
+
/* @__PURE__ */ z.object({
|
|
136
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
137
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
138
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
139
139
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
140
140
|
).max(500).optional(),
|
|
141
|
-
translated: z.string().describe(
|
|
141
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
142
142
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
143
143
|
).max(500).optional().nullable(),
|
|
144
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
144
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
145
145
|
}).describe("Description line color value.")
|
|
146
146
|
})
|
|
147
147
|
])
|
|
148
148
|
)
|
|
149
149
|
).min(0).max(20).optional(),
|
|
150
|
-
physicalProperties: z.object({
|
|
151
|
-
weight: z.number().describe(
|
|
150
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
151
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
152
152
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
153
153
|
).optional().nullable(),
|
|
154
|
-
sku: z.string().describe(
|
|
154
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
155
155
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
156
156
|
).max(40).optional().nullable(),
|
|
157
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
157
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
158
158
|
}).describe("Physical properties of the item.").optional(),
|
|
159
|
-
image: z.string().describe("Item image.").optional(),
|
|
160
|
-
paymentOption: z.object({
|
|
161
|
-
value: z.enum([
|
|
159
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
160
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
161
|
+
value: /* @__PURE__ */ z.enum([
|
|
162
162
|
"FULL_PAYMENT_ONLINE",
|
|
163
163
|
"FULL_PAYMENT_OFFLINE",
|
|
164
164
|
"MEMBERSHIP",
|
|
@@ -167,110 +167,110 @@ var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
167
167
|
"MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER"
|
|
168
168
|
]).optional()
|
|
169
169
|
}).describe("Payment method selected for the item.").optional(),
|
|
170
|
-
depositAmount: z.string().describe(
|
|
170
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
171
171
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
172
172
|
).optional().nullable(),
|
|
173
|
-
savePaymentMethod: z.boolean().describe(
|
|
173
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
174
174
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
175
175
|
).optional().nullable(),
|
|
176
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
176
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
177
177
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
178
178
|
"Must be a valid GUID"
|
|
179
179
|
).optional().nullable()
|
|
180
180
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
181
181
|
})
|
|
182
182
|
).max(300).optional(),
|
|
183
|
-
customLineItems: z.array(
|
|
184
|
-
z.object({
|
|
185
|
-
quantity: z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5),
|
|
186
|
-
price: z.string().describe(
|
|
183
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
184
|
+
/* @__PURE__ */ z.object({
|
|
185
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5),
|
|
186
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
187
187
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
188
188
|
).optional(),
|
|
189
|
-
priceDescription: z.object({
|
|
190
|
-
original: z.string().describe(
|
|
189
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
190
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
191
191
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
192
192
|
).min(1).max(100).optional(),
|
|
193
|
-
translated: z.string().describe(
|
|
193
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
194
194
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
195
195
|
).min(1).max(100).optional().nullable()
|
|
196
196
|
}).describe(
|
|
197
197
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
198
198
|
).optional(),
|
|
199
|
-
descriptionLines: z.array(
|
|
200
|
-
z.intersection(
|
|
201
|
-
z.object({
|
|
202
|
-
name: z.object({
|
|
203
|
-
original: z.string().describe(
|
|
199
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
200
|
+
/* @__PURE__ */ z.intersection(
|
|
201
|
+
/* @__PURE__ */ z.object({
|
|
202
|
+
name: /* @__PURE__ */ z.object({
|
|
203
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
204
204
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
205
205
|
).max(100).optional(),
|
|
206
|
-
translated: z.string().describe(
|
|
206
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
207
207
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
208
208
|
).max(200).optional().nullable()
|
|
209
209
|
}).describe("Description line name.").optional()
|
|
210
210
|
}),
|
|
211
|
-
z.xor([
|
|
212
|
-
z.object({
|
|
213
|
-
plainText: z.never().optional(),
|
|
214
|
-
colorInfo: z.never().optional()
|
|
211
|
+
/* @__PURE__ */ z.xor([
|
|
212
|
+
/* @__PURE__ */ z.object({
|
|
213
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
214
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
215
215
|
}),
|
|
216
|
-
z.object({
|
|
217
|
-
colorInfo: z.never().optional(),
|
|
218
|
-
plainText: z.object({
|
|
219
|
-
original: z.string().describe(
|
|
216
|
+
/* @__PURE__ */ z.object({
|
|
217
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
218
|
+
plainText: /* @__PURE__ */ z.object({
|
|
219
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
220
220
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
221
221
|
).max(600).optional(),
|
|
222
|
-
translated: z.string().describe(
|
|
222
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
223
223
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
224
224
|
).max(600).optional().nullable()
|
|
225
225
|
}).describe("Description line plain text value.")
|
|
226
226
|
}),
|
|
227
|
-
z.object({
|
|
228
|
-
plainText: z.never().optional(),
|
|
229
|
-
colorInfo: z.object({
|
|
230
|
-
original: z.string().describe(
|
|
227
|
+
/* @__PURE__ */ z.object({
|
|
228
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
229
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
230
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
231
231
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
232
232
|
).max(500).optional(),
|
|
233
|
-
translated: z.string().describe(
|
|
233
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
234
234
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
235
235
|
).max(500).optional().nullable(),
|
|
236
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
236
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
237
237
|
}).describe("Description line color value.")
|
|
238
238
|
})
|
|
239
239
|
])
|
|
240
240
|
)
|
|
241
241
|
).max(10).optional(),
|
|
242
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
243
|
-
_id: z.string().describe(
|
|
242
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
243
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
244
244
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
245
245
|
).regex(
|
|
246
246
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
247
247
|
"Must be a valid GUID"
|
|
248
248
|
).optional().nullable(),
|
|
249
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
249
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
250
250
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
251
251
|
"Must be a valid GUID"
|
|
252
252
|
).optional().nullable(),
|
|
253
|
-
productName: z.object({
|
|
254
|
-
original: z.string().describe(
|
|
253
|
+
productName: /* @__PURE__ */ z.object({
|
|
254
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
255
255
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
256
256
|
).min(1).max(200).optional(),
|
|
257
|
-
translated: z.string().describe(
|
|
257
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
258
258
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
259
259
|
).min(1).max(400).optional().nullable()
|
|
260
260
|
}).describe("Name of the item or product."),
|
|
261
|
-
url: z.string().describe(
|
|
261
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
262
262
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
263
263
|
).optional(),
|
|
264
|
-
itemType: z.intersection(
|
|
265
|
-
z.object({}),
|
|
266
|
-
z.xor([
|
|
267
|
-
z.object({
|
|
268
|
-
preset: z.never().optional(),
|
|
269
|
-
custom: z.never().optional()
|
|
264
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
265
|
+
/* @__PURE__ */ z.object({}),
|
|
266
|
+
/* @__PURE__ */ z.xor([
|
|
267
|
+
/* @__PURE__ */ z.object({
|
|
268
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
269
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
270
270
|
}),
|
|
271
|
-
z.object({
|
|
272
|
-
custom: z.never().optional(),
|
|
273
|
-
preset: z.enum([
|
|
271
|
+
/* @__PURE__ */ z.object({
|
|
272
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
273
|
+
preset: /* @__PURE__ */ z.enum([
|
|
274
274
|
"UNRECOGNISED",
|
|
275
275
|
"PHYSICAL",
|
|
276
276
|
"DIGITAL",
|
|
@@ -278,30 +278,30 @@ var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
278
278
|
"SERVICE"
|
|
279
279
|
]).describe("Preset item type.")
|
|
280
280
|
}),
|
|
281
|
-
z.object({
|
|
282
|
-
preset: z.never().optional(),
|
|
283
|
-
custom: z.string().describe(
|
|
281
|
+
/* @__PURE__ */ z.object({
|
|
282
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
283
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
284
284
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
285
285
|
)
|
|
286
286
|
})
|
|
287
287
|
])
|
|
288
288
|
).describe("Item type. Either a preset type or custom."),
|
|
289
|
-
fullPrice: z.string().describe(
|
|
289
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
290
290
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
291
291
|
).optional().nullable(),
|
|
292
|
-
quantityAvailable: z.number().int().describe(
|
|
292
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
293
293
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
294
294
|
).min(0).max(1e5).optional().nullable(),
|
|
295
|
-
physicalProperties: z.object({
|
|
296
|
-
weight: z.number().describe(
|
|
295
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
296
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
297
297
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
298
298
|
).optional().nullable(),
|
|
299
|
-
sku: z.string().describe(
|
|
299
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
300
300
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
301
301
|
).max(40).optional().nullable(),
|
|
302
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
302
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
303
303
|
}).describe("Physical properties of the item.").optional(),
|
|
304
|
-
paymentOption: z.enum([
|
|
304
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
305
305
|
"FULL_PAYMENT_ONLINE",
|
|
306
306
|
"FULL_PAYMENT_OFFLINE",
|
|
307
307
|
"MEMBERSHIP",
|
|
@@ -309,118 +309,120 @@ var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
309
309
|
"MEMBERSHIP_OFFLINE",
|
|
310
310
|
"MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER"
|
|
311
311
|
]).optional(),
|
|
312
|
-
serviceProperties: z.object({
|
|
313
|
-
scheduledDate: z.date().describe(
|
|
312
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
313
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
314
314
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
315
315
|
).optional().nullable(),
|
|
316
|
-
numberOfParticipants: z.number().int().describe(
|
|
316
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
317
317
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
318
318
|
).min(1).max(1e4).optional().nullable()
|
|
319
319
|
}).describe(
|
|
320
320
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
321
321
|
).optional(),
|
|
322
|
-
rootCatalogItemId: z.string().describe(
|
|
322
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
323
323
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
324
324
|
).min(1).max(36).optional().nullable(),
|
|
325
|
-
depositAmount: z.string().describe(
|
|
325
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
326
326
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
327
327
|
).optional().nullable(),
|
|
328
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
328
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
329
329
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
330
330
|
"Must be a valid GUID"
|
|
331
331
|
).optional().nullable(),
|
|
332
|
-
catalogReference: z.object({
|
|
333
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36),
|
|
334
|
-
appId: z.string().describe(
|
|
332
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
333
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36),
|
|
334
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
335
335
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
336
336
|
).min(1),
|
|
337
|
-
options: z.record(z.string(), z.any()).describe(
|
|
337
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
338
338
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
339
339
|
).optional().nullable()
|
|
340
340
|
}).describe(
|
|
341
341
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
342
342
|
).optional(),
|
|
343
|
-
priceUndetermined: z.boolean().describe(
|
|
343
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
344
344
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
345
345
|
).optional(),
|
|
346
|
-
fixedQuantity: z.boolean().describe(
|
|
346
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
347
347
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
348
348
|
).optional(),
|
|
349
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
349
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
350
350
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
351
351
|
).min(1).max(1e3).optional().nullable(),
|
|
352
|
-
savePaymentMethod: z.boolean().describe(
|
|
352
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
353
353
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
354
354
|
).optional(),
|
|
355
|
-
policies: z.array(
|
|
356
|
-
z.object({
|
|
357
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
358
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
355
|
+
policies: /* @__PURE__ */ z.array(
|
|
356
|
+
/* @__PURE__ */ z.object({
|
|
357
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
358
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
359
359
|
})
|
|
360
360
|
).max(5).optional(),
|
|
361
|
-
membersOnly: z.boolean().describe(
|
|
361
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
362
362
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
363
363
|
).optional(),
|
|
364
|
-
taxableAddress: z.intersection(
|
|
365
|
-
z.object({}),
|
|
366
|
-
z.xor([
|
|
367
|
-
z.object({
|
|
368
|
-
|
|
369
|
-
|
|
364
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
365
|
+
/* @__PURE__ */ z.object({}),
|
|
366
|
+
/* @__PURE__ */ z.xor([
|
|
367
|
+
/* @__PURE__ */ z.object({
|
|
368
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
369
|
+
}),
|
|
370
|
+
/* @__PURE__ */ z.object({
|
|
371
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
370
372
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
371
373
|
)
|
|
372
374
|
})
|
|
373
375
|
])
|
|
374
376
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
375
|
-
modifierGroups: z.array(
|
|
376
|
-
z.object({
|
|
377
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
378
|
-
name: z.object({
|
|
379
|
-
original: z.string().describe(
|
|
377
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
378
|
+
/* @__PURE__ */ z.object({
|
|
379
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
380
|
+
name: /* @__PURE__ */ z.object({
|
|
381
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
380
382
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
381
383
|
).min(1).max(200).optional(),
|
|
382
|
-
translated: z.string().describe(
|
|
384
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
383
385
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
384
386
|
).min(1).max(400).optional().nullable()
|
|
385
387
|
}).describe("Modifier group name.").optional(),
|
|
386
|
-
modifiers: z.array(
|
|
387
|
-
z.object({
|
|
388
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
389
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
390
|
-
label: z.object({
|
|
391
|
-
original: z.string().describe(
|
|
388
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
389
|
+
/* @__PURE__ */ z.object({
|
|
390
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
391
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
392
|
+
label: /* @__PURE__ */ z.object({
|
|
393
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
392
394
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
393
395
|
).min(1).max(200).optional(),
|
|
394
|
-
translated: z.string().describe(
|
|
396
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
395
397
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
396
398
|
).min(1).max(400).optional().nullable()
|
|
397
399
|
}).describe("Primary display label for the modifier.").optional(),
|
|
398
|
-
details: z.object({
|
|
399
|
-
original: z.string().describe(
|
|
400
|
+
details: /* @__PURE__ */ z.object({
|
|
401
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
400
402
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
401
403
|
).min(1).max(200).optional(),
|
|
402
|
-
translated: z.string().describe(
|
|
404
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
403
405
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
404
406
|
).min(1).max(400).optional().nullable()
|
|
405
407
|
}).describe("Additional details.").optional(),
|
|
406
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
408
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
407
409
|
})
|
|
408
410
|
).min(1).max(25).optional()
|
|
409
411
|
})
|
|
410
412
|
).max(25).optional()
|
|
411
413
|
})
|
|
412
414
|
).max(300).optional(),
|
|
413
|
-
couponCode: z.string().describe(
|
|
415
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
414
416
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
415
417
|
).optional().nullable(),
|
|
416
|
-
customContentReference: z.object({
|
|
417
|
-
appId: z.string().describe(
|
|
418
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
419
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
418
420
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
419
421
|
).regex(
|
|
420
422
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
421
423
|
"Must be a valid GUID"
|
|
422
424
|
).optional(),
|
|
423
|
-
componentId: z.string().describe(
|
|
425
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
424
426
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
425
427
|
).regex(
|
|
426
428
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -429,14 +431,14 @@ var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
429
431
|
}).describe(
|
|
430
432
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
431
433
|
).optional(),
|
|
432
|
-
externalReference: z.object({
|
|
433
|
-
appId: z.string().describe(
|
|
434
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
435
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
434
436
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
435
437
|
).regex(
|
|
436
438
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
437
439
|
"Must be a valid GUID"
|
|
438
440
|
).optional(),
|
|
439
|
-
resourceId: z.string().describe(
|
|
441
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
440
442
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
441
443
|
).min(1).max(100).optional().nullable()
|
|
442
444
|
}).describe(
|
|
@@ -445,116 +447,116 @@ var CreateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
445
447
|
}).describe("Checkout template to create.")
|
|
446
448
|
});
|
|
447
449
|
var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
448
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
450
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
449
451
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
450
452
|
"Must be a valid GUID"
|
|
451
453
|
).optional().nullable(),
|
|
452
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
454
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
453
455
|
"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`"
|
|
454
456
|
).optional(),
|
|
455
|
-
customization: z.object({
|
|
456
|
-
webClient: z.object({
|
|
457
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
457
|
+
customization: /* @__PURE__ */ z.object({
|
|
458
|
+
webClient: /* @__PURE__ */ z.object({
|
|
459
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
458
460
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
459
461
|
).optional(),
|
|
460
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
462
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
461
463
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
462
464
|
).optional()
|
|
463
465
|
}).describe(
|
|
464
466
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
465
467
|
).optional(),
|
|
466
|
-
lockedGiftCard: z.boolean().describe(
|
|
468
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
467
469
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
468
470
|
).optional(),
|
|
469
|
-
lockedCoupon: z.boolean().describe(
|
|
471
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
470
472
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
471
473
|
).optional(),
|
|
472
|
-
disabledManualPayment: z.boolean().describe(
|
|
474
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
473
475
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
474
476
|
).optional()
|
|
475
477
|
}).describe(
|
|
476
478
|
"Custom settings to apply to the checkout page created from this template."
|
|
477
479
|
).optional(),
|
|
478
|
-
lineItems: z.array(
|
|
479
|
-
z.object({
|
|
480
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
481
|
-
catalogReference: z.object({
|
|
482
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
483
|
-
appId: z.string().describe(
|
|
480
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
481
|
+
/* @__PURE__ */ z.object({
|
|
482
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
483
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
484
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
485
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
484
486
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
485
487
|
).min(1).optional(),
|
|
486
|
-
options: z.record(z.string(), z.any()).describe(
|
|
488
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
487
489
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
488
490
|
).optional().nullable()
|
|
489
491
|
}).describe(
|
|
490
492
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
491
493
|
).optional(),
|
|
492
|
-
catalogOverrideFields: z.object({
|
|
493
|
-
productName: z.object({
|
|
494
|
-
original: z.string().describe(
|
|
494
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
495
|
+
productName: /* @__PURE__ */ z.object({
|
|
496
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
495
497
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
496
498
|
).min(1).max(200).optional(),
|
|
497
|
-
translated: z.string().describe(
|
|
499
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
498
500
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
499
501
|
).min(1).max(400).optional().nullable()
|
|
500
502
|
}).describe("Item name.").optional(),
|
|
501
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
502
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
503
|
-
descriptionLines: z.array(
|
|
504
|
-
z.intersection(
|
|
505
|
-
z.object({
|
|
506
|
-
name: z.object({
|
|
507
|
-
original: z.string().describe(
|
|
503
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
504
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
505
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
506
|
+
/* @__PURE__ */ z.intersection(
|
|
507
|
+
/* @__PURE__ */ z.object({
|
|
508
|
+
name: /* @__PURE__ */ z.object({
|
|
509
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
508
510
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
509
511
|
).max(100).optional(),
|
|
510
|
-
translated: z.string().describe(
|
|
512
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
511
513
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
512
514
|
).max(200).optional().nullable()
|
|
513
515
|
}).describe("Description line name.").optional()
|
|
514
516
|
}),
|
|
515
|
-
z.xor([
|
|
516
|
-
z.object({
|
|
517
|
-
plainText: z.never().optional(),
|
|
518
|
-
colorInfo: z.never().optional()
|
|
517
|
+
/* @__PURE__ */ z.xor([
|
|
518
|
+
/* @__PURE__ */ z.object({
|
|
519
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
520
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
519
521
|
}),
|
|
520
|
-
z.object({
|
|
521
|
-
colorInfo: z.never().optional(),
|
|
522
|
-
plainText: z.object({
|
|
523
|
-
original: z.string().describe(
|
|
522
|
+
/* @__PURE__ */ z.object({
|
|
523
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
524
|
+
plainText: /* @__PURE__ */ z.object({
|
|
525
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
524
526
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
525
527
|
).max(600).optional(),
|
|
526
|
-
translated: z.string().describe(
|
|
528
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
527
529
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
528
530
|
).max(600).optional().nullable()
|
|
529
531
|
}).describe("Description line plain text value.")
|
|
530
532
|
}),
|
|
531
|
-
z.object({
|
|
532
|
-
plainText: z.never().optional(),
|
|
533
|
-
colorInfo: z.object({
|
|
534
|
-
original: z.string().describe(
|
|
533
|
+
/* @__PURE__ */ z.object({
|
|
534
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
535
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
536
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
535
537
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
536
538
|
).max(500).optional(),
|
|
537
|
-
translated: z.string().describe(
|
|
539
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
538
540
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
539
541
|
).max(500).optional().nullable(),
|
|
540
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
542
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
541
543
|
}).describe("Description line color value.")
|
|
542
544
|
})
|
|
543
545
|
])
|
|
544
546
|
)
|
|
545
547
|
).min(0).max(20).optional(),
|
|
546
|
-
physicalProperties: z.object({
|
|
547
|
-
weight: z.number().describe(
|
|
548
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
549
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
548
550
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
549
551
|
).optional().nullable(),
|
|
550
|
-
sku: z.string().describe(
|
|
552
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
551
553
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
552
554
|
).max(40).optional().nullable(),
|
|
553
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
555
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
554
556
|
}).describe("Physical properties of the item.").optional(),
|
|
555
|
-
image: z.string().describe("Item image.").optional(),
|
|
556
|
-
paymentOption: z.object({
|
|
557
|
-
value: z.enum([
|
|
557
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
558
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
559
|
+
value: /* @__PURE__ */ z.enum([
|
|
558
560
|
"FULL_PAYMENT_ONLINE",
|
|
559
561
|
"FULL_PAYMENT_OFFLINE",
|
|
560
562
|
"MEMBERSHIP",
|
|
@@ -565,110 +567,110 @@ var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
565
567
|
"Type of selected payment option for current item.\n\nDefault: `FULL_PAYMENT_ONLINE`"
|
|
566
568
|
).optional()
|
|
567
569
|
}).describe("Payment method selected for the item.").optional(),
|
|
568
|
-
depositAmount: z.string().describe(
|
|
570
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
569
571
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
570
572
|
).optional().nullable(),
|
|
571
|
-
savePaymentMethod: z.boolean().describe(
|
|
573
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
572
574
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
573
575
|
).optional().nullable(),
|
|
574
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
576
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
575
577
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
576
578
|
"Must be a valid GUID"
|
|
577
579
|
).optional().nullable()
|
|
578
580
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
579
581
|
})
|
|
580
582
|
).max(300).optional(),
|
|
581
|
-
customLineItems: z.array(
|
|
582
|
-
z.object({
|
|
583
|
-
quantity: z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
584
|
-
price: z.string().describe(
|
|
583
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
584
|
+
/* @__PURE__ */ z.object({
|
|
585
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
586
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
585
587
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
586
588
|
).optional(),
|
|
587
|
-
priceDescription: z.object({
|
|
588
|
-
original: z.string().describe(
|
|
589
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
590
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
589
591
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
590
592
|
).min(1).max(100).optional(),
|
|
591
|
-
translated: z.string().describe(
|
|
593
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
592
594
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
593
595
|
).min(1).max(100).optional().nullable()
|
|
594
596
|
}).describe(
|
|
595
597
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
596
598
|
).optional(),
|
|
597
|
-
descriptionLines: z.array(
|
|
598
|
-
z.intersection(
|
|
599
|
-
z.object({
|
|
600
|
-
name: z.object({
|
|
601
|
-
original: z.string().describe(
|
|
599
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
600
|
+
/* @__PURE__ */ z.intersection(
|
|
601
|
+
/* @__PURE__ */ z.object({
|
|
602
|
+
name: /* @__PURE__ */ z.object({
|
|
603
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
602
604
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
603
605
|
).max(100).optional(),
|
|
604
|
-
translated: z.string().describe(
|
|
606
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
605
607
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
606
608
|
).max(200).optional().nullable()
|
|
607
609
|
}).describe("Description line name.").optional()
|
|
608
610
|
}),
|
|
609
|
-
z.xor([
|
|
610
|
-
z.object({
|
|
611
|
-
plainText: z.never().optional(),
|
|
612
|
-
colorInfo: z.never().optional()
|
|
611
|
+
/* @__PURE__ */ z.xor([
|
|
612
|
+
/* @__PURE__ */ z.object({
|
|
613
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
614
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
613
615
|
}),
|
|
614
|
-
z.object({
|
|
615
|
-
colorInfo: z.never().optional(),
|
|
616
|
-
plainText: z.object({
|
|
617
|
-
original: z.string().describe(
|
|
616
|
+
/* @__PURE__ */ z.object({
|
|
617
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
618
|
+
plainText: /* @__PURE__ */ z.object({
|
|
619
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
618
620
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
619
621
|
).max(600).optional(),
|
|
620
|
-
translated: z.string().describe(
|
|
622
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
621
623
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
622
624
|
).max(600).optional().nullable()
|
|
623
625
|
}).describe("Description line plain text value.")
|
|
624
626
|
}),
|
|
625
|
-
z.object({
|
|
626
|
-
plainText: z.never().optional(),
|
|
627
|
-
colorInfo: z.object({
|
|
628
|
-
original: z.string().describe(
|
|
627
|
+
/* @__PURE__ */ z.object({
|
|
628
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
629
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
630
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
629
631
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
630
632
|
).max(500).optional(),
|
|
631
|
-
translated: z.string().describe(
|
|
633
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
632
634
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
633
635
|
).max(500).optional().nullable(),
|
|
634
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
636
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
635
637
|
}).describe("Description line color value.")
|
|
636
638
|
})
|
|
637
639
|
])
|
|
638
640
|
)
|
|
639
641
|
).max(10).optional(),
|
|
640
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
641
|
-
_id: z.string().describe(
|
|
642
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
643
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
642
644
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
643
645
|
).regex(
|
|
644
646
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
645
647
|
"Must be a valid GUID"
|
|
646
648
|
).optional().nullable(),
|
|
647
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
649
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
648
650
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
649
651
|
"Must be a valid GUID"
|
|
650
652
|
).optional().nullable(),
|
|
651
|
-
productName: z.object({
|
|
652
|
-
original: z.string().describe(
|
|
653
|
+
productName: /* @__PURE__ */ z.object({
|
|
654
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
653
655
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
654
656
|
).min(1).max(200).optional(),
|
|
655
|
-
translated: z.string().describe(
|
|
657
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
656
658
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
657
659
|
).min(1).max(400).optional().nullable()
|
|
658
660
|
}).describe("Name of the item or product.").optional(),
|
|
659
|
-
url: z.string().describe(
|
|
661
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
660
662
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
661
663
|
).optional(),
|
|
662
|
-
itemType: z.intersection(
|
|
663
|
-
z.object({}),
|
|
664
|
-
z.xor([
|
|
665
|
-
z.object({
|
|
666
|
-
preset: z.never().optional(),
|
|
667
|
-
custom: z.never().optional()
|
|
664
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
665
|
+
/* @__PURE__ */ z.object({}),
|
|
666
|
+
/* @__PURE__ */ z.xor([
|
|
667
|
+
/* @__PURE__ */ z.object({
|
|
668
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
669
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
668
670
|
}),
|
|
669
|
-
z.object({
|
|
670
|
-
custom: z.never().optional(),
|
|
671
|
-
preset: z.enum([
|
|
671
|
+
/* @__PURE__ */ z.object({
|
|
672
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
673
|
+
preset: /* @__PURE__ */ z.enum([
|
|
672
674
|
"UNRECOGNISED",
|
|
673
675
|
"PHYSICAL",
|
|
674
676
|
"DIGITAL",
|
|
@@ -676,30 +678,30 @@ var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
676
678
|
"SERVICE"
|
|
677
679
|
]).describe("Preset item type.")
|
|
678
680
|
}),
|
|
679
|
-
z.object({
|
|
680
|
-
preset: z.never().optional(),
|
|
681
|
-
custom: z.string().describe(
|
|
681
|
+
/* @__PURE__ */ z.object({
|
|
682
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
683
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
682
684
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
683
685
|
)
|
|
684
686
|
})
|
|
685
687
|
])
|
|
686
688
|
).describe("Item type. Either a preset type or custom.").optional(),
|
|
687
|
-
fullPrice: z.string().describe(
|
|
689
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
688
690
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
689
691
|
).optional().nullable(),
|
|
690
|
-
quantityAvailable: z.number().int().describe(
|
|
692
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
691
693
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
692
694
|
).min(0).max(1e5).optional().nullable(),
|
|
693
|
-
physicalProperties: z.object({
|
|
694
|
-
weight: z.number().describe(
|
|
695
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
696
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
695
697
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
696
698
|
).optional().nullable(),
|
|
697
|
-
sku: z.string().describe(
|
|
699
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
698
700
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
699
701
|
).max(40).optional().nullable(),
|
|
700
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
702
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
701
703
|
}).describe("Physical properties of the item.").optional(),
|
|
702
|
-
paymentOption: z.enum([
|
|
704
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
703
705
|
"FULL_PAYMENT_ONLINE",
|
|
704
706
|
"FULL_PAYMENT_OFFLINE",
|
|
705
707
|
"MEMBERSHIP",
|
|
@@ -709,118 +711,120 @@ var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
709
711
|
]).describe(
|
|
710
712
|
"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field."
|
|
711
713
|
).optional(),
|
|
712
|
-
serviceProperties: z.object({
|
|
713
|
-
scheduledDate: z.date().describe(
|
|
714
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
715
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
714
716
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
715
717
|
).optional().nullable(),
|
|
716
|
-
numberOfParticipants: z.number().int().describe(
|
|
718
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
717
719
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
718
720
|
).min(1).max(1e4).optional().nullable()
|
|
719
721
|
}).describe(
|
|
720
722
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
721
723
|
).optional(),
|
|
722
|
-
rootCatalogItemId: z.string().describe(
|
|
724
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
723
725
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
724
726
|
).min(1).max(36).optional().nullable(),
|
|
725
|
-
depositAmount: z.string().describe(
|
|
727
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
726
728
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
727
729
|
).optional().nullable(),
|
|
728
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
730
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
729
731
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
730
732
|
"Must be a valid GUID"
|
|
731
733
|
).optional().nullable(),
|
|
732
|
-
catalogReference: z.object({
|
|
733
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
734
|
-
appId: z.string().describe(
|
|
734
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
735
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
736
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
735
737
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
736
738
|
).min(1).optional(),
|
|
737
|
-
options: z.record(z.string(), z.any()).describe(
|
|
739
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
738
740
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
739
741
|
).optional().nullable()
|
|
740
742
|
}).describe(
|
|
741
743
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
742
744
|
).optional(),
|
|
743
|
-
priceUndetermined: z.boolean().describe(
|
|
745
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
744
746
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
745
747
|
).optional(),
|
|
746
|
-
fixedQuantity: z.boolean().describe(
|
|
748
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
747
749
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
748
750
|
).optional(),
|
|
749
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
751
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
750
752
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
751
753
|
).min(1).max(1e3).optional().nullable(),
|
|
752
|
-
savePaymentMethod: z.boolean().describe(
|
|
754
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
753
755
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
754
756
|
).optional(),
|
|
755
|
-
policies: z.array(
|
|
756
|
-
z.object({
|
|
757
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
758
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
757
|
+
policies: /* @__PURE__ */ z.array(
|
|
758
|
+
/* @__PURE__ */ z.object({
|
|
759
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
760
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
759
761
|
})
|
|
760
762
|
).max(5).optional(),
|
|
761
|
-
membersOnly: z.boolean().describe(
|
|
763
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
762
764
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
763
765
|
).optional(),
|
|
764
|
-
taxableAddress: z.intersection(
|
|
765
|
-
z.object({}),
|
|
766
|
-
z.xor([
|
|
767
|
-
z.object({
|
|
768
|
-
|
|
769
|
-
|
|
766
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
767
|
+
/* @__PURE__ */ z.object({}),
|
|
768
|
+
/* @__PURE__ */ z.xor([
|
|
769
|
+
/* @__PURE__ */ z.object({
|
|
770
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
771
|
+
}),
|
|
772
|
+
/* @__PURE__ */ z.object({
|
|
773
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
770
774
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
771
775
|
)
|
|
772
776
|
})
|
|
773
777
|
])
|
|
774
778
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
775
|
-
modifierGroups: z.array(
|
|
776
|
-
z.object({
|
|
777
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
778
|
-
name: z.object({
|
|
779
|
-
original: z.string().describe(
|
|
779
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
780
|
+
/* @__PURE__ */ z.object({
|
|
781
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
782
|
+
name: /* @__PURE__ */ z.object({
|
|
783
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
780
784
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
781
785
|
).min(1).max(200).optional(),
|
|
782
|
-
translated: z.string().describe(
|
|
786
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
783
787
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
784
788
|
).min(1).max(400).optional().nullable()
|
|
785
789
|
}).describe("Modifier group name.").optional(),
|
|
786
|
-
modifiers: z.array(
|
|
787
|
-
z.object({
|
|
788
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
789
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
790
|
-
label: z.object({
|
|
791
|
-
original: z.string().describe(
|
|
790
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
791
|
+
/* @__PURE__ */ z.object({
|
|
792
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
793
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
794
|
+
label: /* @__PURE__ */ z.object({
|
|
795
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
792
796
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
793
797
|
).min(1).max(200).optional(),
|
|
794
|
-
translated: z.string().describe(
|
|
798
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
795
799
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
796
800
|
).min(1).max(400).optional().nullable()
|
|
797
801
|
}).describe("Primary display label for the modifier.").optional(),
|
|
798
|
-
details: z.object({
|
|
799
|
-
original: z.string().describe(
|
|
802
|
+
details: /* @__PURE__ */ z.object({
|
|
803
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
800
804
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
801
805
|
).min(1).max(200).optional(),
|
|
802
|
-
translated: z.string().describe(
|
|
806
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
803
807
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
804
808
|
).min(1).max(400).optional().nullable()
|
|
805
809
|
}).describe("Additional details.").optional(),
|
|
806
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
810
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
807
811
|
})
|
|
808
812
|
).min(1).max(25).optional()
|
|
809
813
|
})
|
|
810
814
|
).max(25).optional()
|
|
811
815
|
})
|
|
812
816
|
).max(300).optional(),
|
|
813
|
-
couponCode: z.string().describe(
|
|
817
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
814
818
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
815
819
|
).optional().nullable(),
|
|
816
|
-
customContentReference: z.object({
|
|
817
|
-
appId: z.string().describe(
|
|
820
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
821
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
818
822
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
819
823
|
).regex(
|
|
820
824
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
821
825
|
"Must be a valid GUID"
|
|
822
826
|
).optional(),
|
|
823
|
-
componentId: z.string().describe(
|
|
827
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
824
828
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
825
829
|
).regex(
|
|
826
830
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -829,14 +833,14 @@ var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
829
833
|
}).describe(
|
|
830
834
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
831
835
|
).optional(),
|
|
832
|
-
externalReference: z.object({
|
|
833
|
-
appId: z.string().describe(
|
|
836
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
837
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
834
838
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
835
839
|
).regex(
|
|
836
840
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
837
841
|
"Must be a valid GUID"
|
|
838
842
|
).optional(),
|
|
839
|
-
resourceId: z.string().describe(
|
|
843
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
840
844
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
841
845
|
).min(1).max(100).optional().nullable()
|
|
842
846
|
}).describe(
|
|
@@ -844,122 +848,122 @@ var CreateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
844
848
|
).optional()
|
|
845
849
|
});
|
|
846
850
|
var GetCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
847
|
-
checkoutTemplateId: z.string().describe("ID of the checkout template to retrieve.").regex(
|
|
851
|
+
checkoutTemplateId: /* @__PURE__ */ z.string().describe("ID of the checkout template to retrieve.").regex(
|
|
848
852
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
849
853
|
"Must be a valid GUID"
|
|
850
854
|
)
|
|
851
855
|
});
|
|
852
856
|
var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
853
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
857
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
854
858
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
855
859
|
"Must be a valid GUID"
|
|
856
860
|
).optional().nullable(),
|
|
857
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
861
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
858
862
|
"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`"
|
|
859
863
|
).optional(),
|
|
860
|
-
customization: z.object({
|
|
861
|
-
webClient: z.object({
|
|
862
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
864
|
+
customization: /* @__PURE__ */ z.object({
|
|
865
|
+
webClient: /* @__PURE__ */ z.object({
|
|
866
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
863
867
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
864
868
|
).optional(),
|
|
865
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
869
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
866
870
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
867
871
|
).optional()
|
|
868
872
|
}).describe(
|
|
869
873
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
870
874
|
).optional(),
|
|
871
|
-
lockedGiftCard: z.boolean().describe(
|
|
875
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
872
876
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
873
877
|
).optional(),
|
|
874
|
-
lockedCoupon: z.boolean().describe(
|
|
878
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
875
879
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
876
880
|
).optional(),
|
|
877
|
-
disabledManualPayment: z.boolean().describe(
|
|
881
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
878
882
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
879
883
|
).optional()
|
|
880
884
|
}).describe(
|
|
881
885
|
"Custom settings to apply to the checkout page created from this template."
|
|
882
886
|
).optional(),
|
|
883
|
-
lineItems: z.array(
|
|
884
|
-
z.object({
|
|
885
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
886
|
-
catalogReference: z.object({
|
|
887
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
888
|
-
appId: z.string().describe(
|
|
887
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
888
|
+
/* @__PURE__ */ z.object({
|
|
889
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
890
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
891
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
892
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
889
893
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
890
894
|
).min(1).optional(),
|
|
891
|
-
options: z.record(z.string(), z.any()).describe(
|
|
895
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
892
896
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
893
897
|
).optional().nullable()
|
|
894
898
|
}).describe(
|
|
895
899
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
896
900
|
).optional(),
|
|
897
|
-
catalogOverrideFields: z.object({
|
|
898
|
-
productName: z.object({
|
|
899
|
-
original: z.string().describe(
|
|
901
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
902
|
+
productName: /* @__PURE__ */ z.object({
|
|
903
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
900
904
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
901
905
|
).min(1).max(200).optional(),
|
|
902
|
-
translated: z.string().describe(
|
|
906
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
903
907
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
904
908
|
).min(1).max(400).optional().nullable()
|
|
905
909
|
}).describe("Item name.").optional(),
|
|
906
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
907
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
908
|
-
descriptionLines: z.array(
|
|
909
|
-
z.intersection(
|
|
910
|
-
z.object({
|
|
911
|
-
name: z.object({
|
|
912
|
-
original: z.string().describe(
|
|
910
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
911
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
912
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
913
|
+
/* @__PURE__ */ z.intersection(
|
|
914
|
+
/* @__PURE__ */ z.object({
|
|
915
|
+
name: /* @__PURE__ */ z.object({
|
|
916
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
913
917
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
914
918
|
).max(100).optional(),
|
|
915
|
-
translated: z.string().describe(
|
|
919
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
916
920
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
917
921
|
).max(200).optional().nullable()
|
|
918
922
|
}).describe("Description line name.").optional()
|
|
919
923
|
}),
|
|
920
|
-
z.xor([
|
|
921
|
-
z.object({
|
|
922
|
-
plainText: z.never().optional(),
|
|
923
|
-
colorInfo: z.never().optional()
|
|
924
|
+
/* @__PURE__ */ z.xor([
|
|
925
|
+
/* @__PURE__ */ z.object({
|
|
926
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
927
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
924
928
|
}),
|
|
925
|
-
z.object({
|
|
926
|
-
colorInfo: z.never().optional(),
|
|
927
|
-
plainText: z.object({
|
|
928
|
-
original: z.string().describe(
|
|
929
|
+
/* @__PURE__ */ z.object({
|
|
930
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
931
|
+
plainText: /* @__PURE__ */ z.object({
|
|
932
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
929
933
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
930
934
|
).max(600).optional(),
|
|
931
|
-
translated: z.string().describe(
|
|
935
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
932
936
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
933
937
|
).max(600).optional().nullable()
|
|
934
938
|
}).describe("Description line plain text value.")
|
|
935
939
|
}),
|
|
936
|
-
z.object({
|
|
937
|
-
plainText: z.never().optional(),
|
|
938
|
-
colorInfo: z.object({
|
|
939
|
-
original: z.string().describe(
|
|
940
|
+
/* @__PURE__ */ z.object({
|
|
941
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
942
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
943
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
940
944
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
941
945
|
).max(500).optional(),
|
|
942
|
-
translated: z.string().describe(
|
|
946
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
943
947
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
944
948
|
).max(500).optional().nullable(),
|
|
945
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
949
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
946
950
|
}).describe("Description line color value.")
|
|
947
951
|
})
|
|
948
952
|
])
|
|
949
953
|
)
|
|
950
954
|
).min(0).max(20).optional(),
|
|
951
|
-
physicalProperties: z.object({
|
|
952
|
-
weight: z.number().describe(
|
|
955
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
956
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
953
957
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
954
958
|
).optional().nullable(),
|
|
955
|
-
sku: z.string().describe(
|
|
959
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
956
960
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
957
961
|
).max(40).optional().nullable(),
|
|
958
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
962
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
959
963
|
}).describe("Physical properties of the item.").optional(),
|
|
960
|
-
image: z.string().describe("Item image.").optional(),
|
|
961
|
-
paymentOption: z.object({
|
|
962
|
-
value: z.enum([
|
|
964
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
965
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
966
|
+
value: /* @__PURE__ */ z.enum([
|
|
963
967
|
"FULL_PAYMENT_ONLINE",
|
|
964
968
|
"FULL_PAYMENT_OFFLINE",
|
|
965
969
|
"MEMBERSHIP",
|
|
@@ -970,110 +974,110 @@ var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
970
974
|
"Type of selected payment option for current item.\n\nDefault: `FULL_PAYMENT_ONLINE`"
|
|
971
975
|
).optional()
|
|
972
976
|
}).describe("Payment method selected for the item.").optional(),
|
|
973
|
-
depositAmount: z.string().describe(
|
|
977
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
974
978
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
975
979
|
).optional().nullable(),
|
|
976
|
-
savePaymentMethod: z.boolean().describe(
|
|
980
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
977
981
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
978
982
|
).optional().nullable(),
|
|
979
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
983
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
980
984
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
981
985
|
"Must be a valid GUID"
|
|
982
986
|
).optional().nullable()
|
|
983
987
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
984
988
|
})
|
|
985
989
|
).max(300).optional(),
|
|
986
|
-
customLineItems: z.array(
|
|
987
|
-
z.object({
|
|
988
|
-
quantity: z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
989
|
-
price: z.string().describe(
|
|
990
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
991
|
+
/* @__PURE__ */ z.object({
|
|
992
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
993
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
990
994
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
991
995
|
).optional(),
|
|
992
|
-
priceDescription: z.object({
|
|
993
|
-
original: z.string().describe(
|
|
996
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
997
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
994
998
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
995
999
|
).min(1).max(100).optional(),
|
|
996
|
-
translated: z.string().describe(
|
|
1000
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
997
1001
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
998
1002
|
).min(1).max(100).optional().nullable()
|
|
999
1003
|
}).describe(
|
|
1000
1004
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
1001
1005
|
).optional(),
|
|
1002
|
-
descriptionLines: z.array(
|
|
1003
|
-
z.intersection(
|
|
1004
|
-
z.object({
|
|
1005
|
-
name: z.object({
|
|
1006
|
-
original: z.string().describe(
|
|
1006
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
1007
|
+
/* @__PURE__ */ z.intersection(
|
|
1008
|
+
/* @__PURE__ */ z.object({
|
|
1009
|
+
name: /* @__PURE__ */ z.object({
|
|
1010
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1007
1011
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1008
1012
|
).max(100).optional(),
|
|
1009
|
-
translated: z.string().describe(
|
|
1013
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1010
1014
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1011
1015
|
).max(200).optional().nullable()
|
|
1012
1016
|
}).describe("Description line name.").optional()
|
|
1013
1017
|
}),
|
|
1014
|
-
z.xor([
|
|
1015
|
-
z.object({
|
|
1016
|
-
plainText: z.never().optional(),
|
|
1017
|
-
colorInfo: z.never().optional()
|
|
1018
|
+
/* @__PURE__ */ z.xor([
|
|
1019
|
+
/* @__PURE__ */ z.object({
|
|
1020
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1021
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
1018
1022
|
}),
|
|
1019
|
-
z.object({
|
|
1020
|
-
colorInfo: z.never().optional(),
|
|
1021
|
-
plainText: z.object({
|
|
1022
|
-
original: z.string().describe(
|
|
1023
|
+
/* @__PURE__ */ z.object({
|
|
1024
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
1025
|
+
plainText: /* @__PURE__ */ z.object({
|
|
1026
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1023
1027
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1024
1028
|
).max(600).optional(),
|
|
1025
|
-
translated: z.string().describe(
|
|
1029
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1026
1030
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1027
1031
|
).max(600).optional().nullable()
|
|
1028
1032
|
}).describe("Description line plain text value.")
|
|
1029
1033
|
}),
|
|
1030
|
-
z.object({
|
|
1031
|
-
plainText: z.never().optional(),
|
|
1032
|
-
colorInfo: z.object({
|
|
1033
|
-
original: z.string().describe(
|
|
1034
|
+
/* @__PURE__ */ z.object({
|
|
1035
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1036
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
1037
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1034
1038
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1035
1039
|
).max(500).optional(),
|
|
1036
|
-
translated: z.string().describe(
|
|
1040
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1037
1041
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1038
1042
|
).max(500).optional().nullable(),
|
|
1039
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1043
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1040
1044
|
}).describe("Description line color value.")
|
|
1041
1045
|
})
|
|
1042
1046
|
])
|
|
1043
1047
|
)
|
|
1044
1048
|
).max(10).optional(),
|
|
1045
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
1046
|
-
_id: z.string().describe(
|
|
1049
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
1050
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
1047
1051
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
1048
1052
|
).regex(
|
|
1049
1053
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1050
1054
|
"Must be a valid GUID"
|
|
1051
1055
|
).optional().nullable(),
|
|
1052
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1056
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1053
1057
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1054
1058
|
"Must be a valid GUID"
|
|
1055
1059
|
).optional().nullable(),
|
|
1056
|
-
productName: z.object({
|
|
1057
|
-
original: z.string().describe(
|
|
1060
|
+
productName: /* @__PURE__ */ z.object({
|
|
1061
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1058
1062
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1059
1063
|
).min(1).max(200).optional(),
|
|
1060
|
-
translated: z.string().describe(
|
|
1064
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1061
1065
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1062
1066
|
).min(1).max(400).optional().nullable()
|
|
1063
1067
|
}).describe("Name of the item or product.").optional(),
|
|
1064
|
-
url: z.string().describe(
|
|
1068
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1065
1069
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
1066
1070
|
).optional(),
|
|
1067
|
-
itemType: z.intersection(
|
|
1068
|
-
z.object({}),
|
|
1069
|
-
z.xor([
|
|
1070
|
-
z.object({
|
|
1071
|
-
preset: z.never().optional(),
|
|
1072
|
-
custom: z.never().optional()
|
|
1071
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
1072
|
+
/* @__PURE__ */ z.object({}),
|
|
1073
|
+
/* @__PURE__ */ z.xor([
|
|
1074
|
+
/* @__PURE__ */ z.object({
|
|
1075
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1076
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
1073
1077
|
}),
|
|
1074
|
-
z.object({
|
|
1075
|
-
custom: z.never().optional(),
|
|
1076
|
-
preset: z.enum([
|
|
1078
|
+
/* @__PURE__ */ z.object({
|
|
1079
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
1080
|
+
preset: /* @__PURE__ */ z.enum([
|
|
1077
1081
|
"UNRECOGNISED",
|
|
1078
1082
|
"PHYSICAL",
|
|
1079
1083
|
"DIGITAL",
|
|
@@ -1081,30 +1085,30 @@ var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1081
1085
|
"SERVICE"
|
|
1082
1086
|
]).describe("Preset item type.")
|
|
1083
1087
|
}),
|
|
1084
|
-
z.object({
|
|
1085
|
-
preset: z.never().optional(),
|
|
1086
|
-
custom: z.string().describe(
|
|
1088
|
+
/* @__PURE__ */ z.object({
|
|
1089
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1090
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
1087
1091
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
1088
1092
|
)
|
|
1089
1093
|
})
|
|
1090
1094
|
])
|
|
1091
1095
|
).describe("Item type. Either a preset type or custom.").optional(),
|
|
1092
|
-
fullPrice: z.string().describe(
|
|
1096
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
1093
1097
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
1094
1098
|
).optional().nullable(),
|
|
1095
|
-
quantityAvailable: z.number().int().describe(
|
|
1099
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
1096
1100
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
1097
1101
|
).min(0).max(1e5).optional().nullable(),
|
|
1098
|
-
physicalProperties: z.object({
|
|
1099
|
-
weight: z.number().describe(
|
|
1102
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
1103
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
1100
1104
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
1101
1105
|
).optional().nullable(),
|
|
1102
|
-
sku: z.string().describe(
|
|
1106
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
1103
1107
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
1104
1108
|
).max(40).optional().nullable(),
|
|
1105
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1109
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1106
1110
|
}).describe("Physical properties of the item.").optional(),
|
|
1107
|
-
paymentOption: z.enum([
|
|
1111
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
1108
1112
|
"FULL_PAYMENT_ONLINE",
|
|
1109
1113
|
"FULL_PAYMENT_OFFLINE",
|
|
1110
1114
|
"MEMBERSHIP",
|
|
@@ -1114,118 +1118,120 @@ var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1114
1118
|
]).describe(
|
|
1115
1119
|
"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field."
|
|
1116
1120
|
).optional(),
|
|
1117
|
-
serviceProperties: z.object({
|
|
1118
|
-
scheduledDate: z.date().describe(
|
|
1121
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
1122
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
1119
1123
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
1120
1124
|
).optional().nullable(),
|
|
1121
|
-
numberOfParticipants: z.number().int().describe(
|
|
1125
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
1122
1126
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
1123
1127
|
).min(1).max(1e4).optional().nullable()
|
|
1124
1128
|
}).describe(
|
|
1125
1129
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
1126
1130
|
).optional(),
|
|
1127
|
-
rootCatalogItemId: z.string().describe(
|
|
1131
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
1128
1132
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
1129
1133
|
).min(1).max(36).optional().nullable(),
|
|
1130
|
-
depositAmount: z.string().describe(
|
|
1134
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
1131
1135
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
1132
1136
|
).optional().nullable(),
|
|
1133
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
1137
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
1134
1138
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1135
1139
|
"Must be a valid GUID"
|
|
1136
1140
|
).optional().nullable(),
|
|
1137
|
-
catalogReference: z.object({
|
|
1138
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1139
|
-
appId: z.string().describe(
|
|
1141
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
1142
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1143
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1140
1144
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
1141
1145
|
).min(1).optional(),
|
|
1142
|
-
options: z.record(z.string(), z.any()).describe(
|
|
1146
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1143
1147
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
1144
1148
|
).optional().nullable()
|
|
1145
1149
|
}).describe(
|
|
1146
1150
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
1147
1151
|
).optional(),
|
|
1148
|
-
priceUndetermined: z.boolean().describe(
|
|
1152
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
1149
1153
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
1150
1154
|
).optional(),
|
|
1151
|
-
fixedQuantity: z.boolean().describe(
|
|
1155
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
1152
1156
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
1153
1157
|
).optional(),
|
|
1154
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
1158
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
1155
1159
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
1156
1160
|
).min(1).max(1e3).optional().nullable(),
|
|
1157
|
-
savePaymentMethod: z.boolean().describe(
|
|
1161
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
1158
1162
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
1159
1163
|
).optional(),
|
|
1160
|
-
policies: z.array(
|
|
1161
|
-
z.object({
|
|
1162
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1163
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1164
|
+
policies: /* @__PURE__ */ z.array(
|
|
1165
|
+
/* @__PURE__ */ z.object({
|
|
1166
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1167
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1164
1168
|
})
|
|
1165
1169
|
).max(5).optional(),
|
|
1166
|
-
membersOnly: z.boolean().describe(
|
|
1170
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
1167
1171
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
1168
1172
|
).optional(),
|
|
1169
|
-
taxableAddress: z.intersection(
|
|
1170
|
-
z.object({}),
|
|
1171
|
-
z.xor([
|
|
1172
|
-
z.object({
|
|
1173
|
-
|
|
1174
|
-
|
|
1173
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
1174
|
+
/* @__PURE__ */ z.object({}),
|
|
1175
|
+
/* @__PURE__ */ z.xor([
|
|
1176
|
+
/* @__PURE__ */ z.object({
|
|
1177
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
1178
|
+
}),
|
|
1179
|
+
/* @__PURE__ */ z.object({
|
|
1180
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
1175
1181
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
1176
1182
|
)
|
|
1177
1183
|
})
|
|
1178
1184
|
])
|
|
1179
1185
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
1180
|
-
modifierGroups: z.array(
|
|
1181
|
-
z.object({
|
|
1182
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1183
|
-
name: z.object({
|
|
1184
|
-
original: z.string().describe(
|
|
1186
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
1187
|
+
/* @__PURE__ */ z.object({
|
|
1188
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1189
|
+
name: /* @__PURE__ */ z.object({
|
|
1190
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1185
1191
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1186
1192
|
).min(1).max(200).optional(),
|
|
1187
|
-
translated: z.string().describe(
|
|
1193
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1188
1194
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1189
1195
|
).min(1).max(400).optional().nullable()
|
|
1190
1196
|
}).describe("Modifier group name.").optional(),
|
|
1191
|
-
modifiers: z.array(
|
|
1192
|
-
z.object({
|
|
1193
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
1194
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
1195
|
-
label: z.object({
|
|
1196
|
-
original: z.string().describe(
|
|
1197
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
1198
|
+
/* @__PURE__ */ z.object({
|
|
1199
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
1200
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
1201
|
+
label: /* @__PURE__ */ z.object({
|
|
1202
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1197
1203
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1198
1204
|
).min(1).max(200).optional(),
|
|
1199
|
-
translated: z.string().describe(
|
|
1205
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1200
1206
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1201
1207
|
).min(1).max(400).optional().nullable()
|
|
1202
1208
|
}).describe("Primary display label for the modifier.").optional(),
|
|
1203
|
-
details: z.object({
|
|
1204
|
-
original: z.string().describe(
|
|
1209
|
+
details: /* @__PURE__ */ z.object({
|
|
1210
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1205
1211
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1206
1212
|
).min(1).max(200).optional(),
|
|
1207
|
-
translated: z.string().describe(
|
|
1213
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1208
1214
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1209
1215
|
).min(1).max(400).optional().nullable()
|
|
1210
1216
|
}).describe("Additional details.").optional(),
|
|
1211
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
1217
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
1212
1218
|
})
|
|
1213
1219
|
).min(1).max(25).optional()
|
|
1214
1220
|
})
|
|
1215
1221
|
).max(25).optional()
|
|
1216
1222
|
})
|
|
1217
1223
|
).max(300).optional(),
|
|
1218
|
-
couponCode: z.string().describe(
|
|
1224
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
1219
1225
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
1220
1226
|
).optional().nullable(),
|
|
1221
|
-
customContentReference: z.object({
|
|
1222
|
-
appId: z.string().describe(
|
|
1227
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
1228
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1223
1229
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
1224
1230
|
).regex(
|
|
1225
1231
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1226
1232
|
"Must be a valid GUID"
|
|
1227
1233
|
).optional(),
|
|
1228
|
-
componentId: z.string().describe(
|
|
1234
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
1229
1235
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
1230
1236
|
).regex(
|
|
1231
1237
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -1234,14 +1240,14 @@ var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1234
1240
|
}).describe(
|
|
1235
1241
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
1236
1242
|
).optional(),
|
|
1237
|
-
externalReference: z.object({
|
|
1238
|
-
appId: z.string().describe(
|
|
1243
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
1244
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1239
1245
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
1240
1246
|
).regex(
|
|
1241
1247
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1242
1248
|
"Must be a valid GUID"
|
|
1243
1249
|
).optional(),
|
|
1244
|
-
resourceId: z.string().describe(
|
|
1250
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
1245
1251
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
1246
1252
|
).min(1).max(100).optional().nullable()
|
|
1247
1253
|
}).describe(
|
|
@@ -1249,119 +1255,119 @@ var GetCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1249
1255
|
).optional()
|
|
1250
1256
|
});
|
|
1251
1257
|
var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
1252
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
1258
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
1253
1259
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1254
1260
|
"Must be a valid GUID"
|
|
1255
1261
|
),
|
|
1256
|
-
checkoutTemplate: z.object({
|
|
1257
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
1262
|
+
checkoutTemplate: /* @__PURE__ */ z.object({
|
|
1263
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
1258
1264
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1259
1265
|
"Must be a valid GUID"
|
|
1260
1266
|
).optional().nullable(),
|
|
1261
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).optional(),
|
|
1262
|
-
customization: z.object({
|
|
1263
|
-
webClient: z.object({
|
|
1264
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
1267
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).optional(),
|
|
1268
|
+
customization: /* @__PURE__ */ z.object({
|
|
1269
|
+
webClient: /* @__PURE__ */ z.object({
|
|
1270
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
1265
1271
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
1266
1272
|
).optional(),
|
|
1267
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
1273
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
1268
1274
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
1269
1275
|
).optional()
|
|
1270
1276
|
}).describe(
|
|
1271
1277
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
1272
1278
|
).optional(),
|
|
1273
|
-
lockedGiftCard: z.boolean().describe(
|
|
1279
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
1274
1280
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
1275
1281
|
).optional(),
|
|
1276
|
-
lockedCoupon: z.boolean().describe(
|
|
1282
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
1277
1283
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
1278
1284
|
).optional(),
|
|
1279
|
-
disabledManualPayment: z.boolean().describe(
|
|
1285
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
1280
1286
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
1281
1287
|
).optional()
|
|
1282
1288
|
}).describe(
|
|
1283
1289
|
"Custom settings to apply to the checkout page created from this template."
|
|
1284
1290
|
).optional(),
|
|
1285
|
-
lineItems: z.array(
|
|
1286
|
-
z.object({
|
|
1287
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1288
|
-
catalogReference: z.object({
|
|
1289
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1290
|
-
appId: z.string().describe(
|
|
1291
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
1292
|
+
/* @__PURE__ */ z.object({
|
|
1293
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1294
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
1295
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1296
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1291
1297
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
1292
1298
|
).min(1).optional(),
|
|
1293
|
-
options: z.record(z.string(), z.any()).describe(
|
|
1299
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1294
1300
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
1295
1301
|
).optional().nullable()
|
|
1296
1302
|
}).describe(
|
|
1297
1303
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
1298
1304
|
).optional(),
|
|
1299
|
-
catalogOverrideFields: z.object({
|
|
1300
|
-
productName: z.object({
|
|
1301
|
-
original: z.string().describe(
|
|
1305
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
1306
|
+
productName: /* @__PURE__ */ z.object({
|
|
1307
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1302
1308
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1303
1309
|
).min(1).max(200).optional(),
|
|
1304
|
-
translated: z.string().describe(
|
|
1310
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1305
1311
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1306
1312
|
).min(1).max(400).optional().nullable()
|
|
1307
1313
|
}).describe("Item name.").optional(),
|
|
1308
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
1309
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
1310
|
-
descriptionLines: z.array(
|
|
1311
|
-
z.intersection(
|
|
1312
|
-
z.object({
|
|
1313
|
-
name: z.object({
|
|
1314
|
-
original: z.string().describe(
|
|
1314
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
1315
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
1316
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
1317
|
+
/* @__PURE__ */ z.intersection(
|
|
1318
|
+
/* @__PURE__ */ z.object({
|
|
1319
|
+
name: /* @__PURE__ */ z.object({
|
|
1320
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1315
1321
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1316
1322
|
).max(100).optional(),
|
|
1317
|
-
translated: z.string().describe(
|
|
1323
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1318
1324
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1319
1325
|
).max(200).optional().nullable()
|
|
1320
1326
|
}).describe("Description line name.").optional()
|
|
1321
1327
|
}),
|
|
1322
|
-
z.xor([
|
|
1323
|
-
z.object({
|
|
1324
|
-
plainText: z.never().optional(),
|
|
1325
|
-
colorInfo: z.never().optional()
|
|
1328
|
+
/* @__PURE__ */ z.xor([
|
|
1329
|
+
/* @__PURE__ */ z.object({
|
|
1330
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1331
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
1326
1332
|
}),
|
|
1327
|
-
z.object({
|
|
1328
|
-
colorInfo: z.never().optional(),
|
|
1329
|
-
plainText: z.object({
|
|
1330
|
-
original: z.string().describe(
|
|
1333
|
+
/* @__PURE__ */ z.object({
|
|
1334
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
1335
|
+
plainText: /* @__PURE__ */ z.object({
|
|
1336
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1331
1337
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1332
1338
|
).max(600).optional(),
|
|
1333
|
-
translated: z.string().describe(
|
|
1339
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1334
1340
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1335
1341
|
).max(600).optional().nullable()
|
|
1336
1342
|
}).describe("Description line plain text value.")
|
|
1337
1343
|
}),
|
|
1338
|
-
z.object({
|
|
1339
|
-
plainText: z.never().optional(),
|
|
1340
|
-
colorInfo: z.object({
|
|
1341
|
-
original: z.string().describe(
|
|
1344
|
+
/* @__PURE__ */ z.object({
|
|
1345
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1346
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
1347
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1342
1348
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1343
1349
|
).max(500).optional(),
|
|
1344
|
-
translated: z.string().describe(
|
|
1350
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1345
1351
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1346
1352
|
).max(500).optional().nullable(),
|
|
1347
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1353
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1348
1354
|
}).describe("Description line color value.")
|
|
1349
1355
|
})
|
|
1350
1356
|
])
|
|
1351
1357
|
)
|
|
1352
1358
|
).min(0).max(20).optional(),
|
|
1353
|
-
physicalProperties: z.object({
|
|
1354
|
-
weight: z.number().describe(
|
|
1359
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
1360
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
1355
1361
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
1356
1362
|
).optional().nullable(),
|
|
1357
|
-
sku: z.string().describe(
|
|
1363
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
1358
1364
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
1359
1365
|
).max(40).optional().nullable(),
|
|
1360
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1366
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1361
1367
|
}).describe("Physical properties of the item.").optional(),
|
|
1362
|
-
image: z.string().describe("Item image.").optional(),
|
|
1363
|
-
paymentOption: z.object({
|
|
1364
|
-
value: z.enum([
|
|
1368
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
1369
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
1370
|
+
value: /* @__PURE__ */ z.enum([
|
|
1365
1371
|
"FULL_PAYMENT_ONLINE",
|
|
1366
1372
|
"FULL_PAYMENT_OFFLINE",
|
|
1367
1373
|
"MEMBERSHIP",
|
|
@@ -1370,110 +1376,110 @@ var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
1370
1376
|
"MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER"
|
|
1371
1377
|
]).optional()
|
|
1372
1378
|
}).describe("Payment method selected for the item.").optional(),
|
|
1373
|
-
depositAmount: z.string().describe(
|
|
1379
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
1374
1380
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
1375
1381
|
).optional().nullable(),
|
|
1376
|
-
savePaymentMethod: z.boolean().describe(
|
|
1382
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
1377
1383
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
1378
1384
|
).optional().nullable(),
|
|
1379
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
1385
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
1380
1386
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1381
1387
|
"Must be a valid GUID"
|
|
1382
1388
|
).optional().nullable()
|
|
1383
1389
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
1384
1390
|
})
|
|
1385
1391
|
).max(300).optional(),
|
|
1386
|
-
customLineItems: z.array(
|
|
1387
|
-
z.object({
|
|
1388
|
-
quantity: z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1389
|
-
price: z.string().describe(
|
|
1392
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
1393
|
+
/* @__PURE__ */ z.object({
|
|
1394
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1395
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
1390
1396
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
1391
1397
|
).optional(),
|
|
1392
|
-
priceDescription: z.object({
|
|
1393
|
-
original: z.string().describe(
|
|
1398
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
1399
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1394
1400
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1395
1401
|
).min(1).max(100).optional(),
|
|
1396
|
-
translated: z.string().describe(
|
|
1402
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1397
1403
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1398
1404
|
).min(1).max(100).optional().nullable()
|
|
1399
1405
|
}).describe(
|
|
1400
1406
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
1401
1407
|
).optional(),
|
|
1402
|
-
descriptionLines: z.array(
|
|
1403
|
-
z.intersection(
|
|
1404
|
-
z.object({
|
|
1405
|
-
name: z.object({
|
|
1406
|
-
original: z.string().describe(
|
|
1408
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
1409
|
+
/* @__PURE__ */ z.intersection(
|
|
1410
|
+
/* @__PURE__ */ z.object({
|
|
1411
|
+
name: /* @__PURE__ */ z.object({
|
|
1412
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1407
1413
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1408
1414
|
).max(100).optional(),
|
|
1409
|
-
translated: z.string().describe(
|
|
1415
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1410
1416
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1411
1417
|
).max(200).optional().nullable()
|
|
1412
1418
|
}).describe("Description line name.").optional()
|
|
1413
1419
|
}),
|
|
1414
|
-
z.xor([
|
|
1415
|
-
z.object({
|
|
1416
|
-
plainText: z.never().optional(),
|
|
1417
|
-
colorInfo: z.never().optional()
|
|
1420
|
+
/* @__PURE__ */ z.xor([
|
|
1421
|
+
/* @__PURE__ */ z.object({
|
|
1422
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1423
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
1418
1424
|
}),
|
|
1419
|
-
z.object({
|
|
1420
|
-
colorInfo: z.never().optional(),
|
|
1421
|
-
plainText: z.object({
|
|
1422
|
-
original: z.string().describe(
|
|
1425
|
+
/* @__PURE__ */ z.object({
|
|
1426
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
1427
|
+
plainText: /* @__PURE__ */ z.object({
|
|
1428
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1423
1429
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1424
1430
|
).max(600).optional(),
|
|
1425
|
-
translated: z.string().describe(
|
|
1431
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1426
1432
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1427
1433
|
).max(600).optional().nullable()
|
|
1428
1434
|
}).describe("Description line plain text value.")
|
|
1429
1435
|
}),
|
|
1430
|
-
z.object({
|
|
1431
|
-
plainText: z.never().optional(),
|
|
1432
|
-
colorInfo: z.object({
|
|
1433
|
-
original: z.string().describe(
|
|
1436
|
+
/* @__PURE__ */ z.object({
|
|
1437
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1438
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
1439
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1434
1440
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1435
1441
|
).max(500).optional(),
|
|
1436
|
-
translated: z.string().describe(
|
|
1442
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1437
1443
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1438
1444
|
).max(500).optional().nullable(),
|
|
1439
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1445
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1440
1446
|
}).describe("Description line color value.")
|
|
1441
1447
|
})
|
|
1442
1448
|
])
|
|
1443
1449
|
)
|
|
1444
1450
|
).max(10).optional(),
|
|
1445
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
1446
|
-
_id: z.string().describe(
|
|
1451
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
1452
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
1447
1453
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
1448
1454
|
).regex(
|
|
1449
1455
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1450
1456
|
"Must be a valid GUID"
|
|
1451
1457
|
).optional().nullable(),
|
|
1452
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1458
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1453
1459
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1454
1460
|
"Must be a valid GUID"
|
|
1455
1461
|
).optional().nullable(),
|
|
1456
|
-
productName: z.object({
|
|
1457
|
-
original: z.string().describe(
|
|
1462
|
+
productName: /* @__PURE__ */ z.object({
|
|
1463
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1458
1464
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1459
1465
|
).min(1).max(200).optional(),
|
|
1460
|
-
translated: z.string().describe(
|
|
1466
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1461
1467
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1462
1468
|
).min(1).max(400).optional().nullable()
|
|
1463
1469
|
}).describe("Name of the item or product.").optional(),
|
|
1464
|
-
url: z.string().describe(
|
|
1470
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1465
1471
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
1466
1472
|
).optional(),
|
|
1467
|
-
itemType: z.intersection(
|
|
1468
|
-
z.object({}),
|
|
1469
|
-
z.xor([
|
|
1470
|
-
z.object({
|
|
1471
|
-
preset: z.never().optional(),
|
|
1472
|
-
custom: z.never().optional()
|
|
1473
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
1474
|
+
/* @__PURE__ */ z.object({}),
|
|
1475
|
+
/* @__PURE__ */ z.xor([
|
|
1476
|
+
/* @__PURE__ */ z.object({
|
|
1477
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1478
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
1473
1479
|
}),
|
|
1474
|
-
z.object({
|
|
1475
|
-
custom: z.never().optional(),
|
|
1476
|
-
preset: z.enum([
|
|
1480
|
+
/* @__PURE__ */ z.object({
|
|
1481
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
1482
|
+
preset: /* @__PURE__ */ z.enum([
|
|
1477
1483
|
"UNRECOGNISED",
|
|
1478
1484
|
"PHYSICAL",
|
|
1479
1485
|
"DIGITAL",
|
|
@@ -1481,30 +1487,30 @@ var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
1481
1487
|
"SERVICE"
|
|
1482
1488
|
]).describe("Preset item type.")
|
|
1483
1489
|
}),
|
|
1484
|
-
z.object({
|
|
1485
|
-
preset: z.never().optional(),
|
|
1486
|
-
custom: z.string().describe(
|
|
1490
|
+
/* @__PURE__ */ z.object({
|
|
1491
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1492
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
1487
1493
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
1488
1494
|
)
|
|
1489
1495
|
})
|
|
1490
1496
|
])
|
|
1491
1497
|
).describe("Item type. Either a preset type or custom.").optional(),
|
|
1492
|
-
fullPrice: z.string().describe(
|
|
1498
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
1493
1499
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
1494
1500
|
).optional().nullable(),
|
|
1495
|
-
quantityAvailable: z.number().int().describe(
|
|
1501
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
1496
1502
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
1497
1503
|
).min(0).max(1e5).optional().nullable(),
|
|
1498
|
-
physicalProperties: z.object({
|
|
1499
|
-
weight: z.number().describe(
|
|
1504
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
1505
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
1500
1506
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
1501
1507
|
).optional().nullable(),
|
|
1502
|
-
sku: z.string().describe(
|
|
1508
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
1503
1509
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
1504
1510
|
).max(40).optional().nullable(),
|
|
1505
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1511
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1506
1512
|
}).describe("Physical properties of the item.").optional(),
|
|
1507
|
-
paymentOption: z.enum([
|
|
1513
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
1508
1514
|
"FULL_PAYMENT_ONLINE",
|
|
1509
1515
|
"FULL_PAYMENT_OFFLINE",
|
|
1510
1516
|
"MEMBERSHIP",
|
|
@@ -1512,118 +1518,120 @@ var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
1512
1518
|
"MEMBERSHIP_OFFLINE",
|
|
1513
1519
|
"MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER"
|
|
1514
1520
|
]).optional(),
|
|
1515
|
-
serviceProperties: z.object({
|
|
1516
|
-
scheduledDate: z.date().describe(
|
|
1521
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
1522
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
1517
1523
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
1518
1524
|
).optional().nullable(),
|
|
1519
|
-
numberOfParticipants: z.number().int().describe(
|
|
1525
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
1520
1526
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
1521
1527
|
).min(1).max(1e4).optional().nullable()
|
|
1522
1528
|
}).describe(
|
|
1523
1529
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
1524
1530
|
).optional(),
|
|
1525
|
-
rootCatalogItemId: z.string().describe(
|
|
1531
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
1526
1532
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
1527
1533
|
).min(1).max(36).optional().nullable(),
|
|
1528
|
-
depositAmount: z.string().describe(
|
|
1534
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
1529
1535
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
1530
1536
|
).optional().nullable(),
|
|
1531
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
1537
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
1532
1538
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1533
1539
|
"Must be a valid GUID"
|
|
1534
1540
|
).optional().nullable(),
|
|
1535
|
-
catalogReference: z.object({
|
|
1536
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1537
|
-
appId: z.string().describe(
|
|
1541
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
1542
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1543
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1538
1544
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
1539
1545
|
).min(1).optional(),
|
|
1540
|
-
options: z.record(z.string(), z.any()).describe(
|
|
1546
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1541
1547
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
1542
1548
|
).optional().nullable()
|
|
1543
1549
|
}).describe(
|
|
1544
1550
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
1545
1551
|
).optional(),
|
|
1546
|
-
priceUndetermined: z.boolean().describe(
|
|
1552
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
1547
1553
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
1548
1554
|
).optional(),
|
|
1549
|
-
fixedQuantity: z.boolean().describe(
|
|
1555
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
1550
1556
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
1551
1557
|
).optional(),
|
|
1552
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
1558
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
1553
1559
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
1554
1560
|
).min(1).max(1e3).optional().nullable(),
|
|
1555
|
-
savePaymentMethod: z.boolean().describe(
|
|
1561
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
1556
1562
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
1557
1563
|
).optional(),
|
|
1558
|
-
policies: z.array(
|
|
1559
|
-
z.object({
|
|
1560
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1561
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1564
|
+
policies: /* @__PURE__ */ z.array(
|
|
1565
|
+
/* @__PURE__ */ z.object({
|
|
1566
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1567
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1562
1568
|
})
|
|
1563
1569
|
).max(5).optional(),
|
|
1564
|
-
membersOnly: z.boolean().describe(
|
|
1570
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
1565
1571
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
1566
1572
|
).optional(),
|
|
1567
|
-
taxableAddress: z.intersection(
|
|
1568
|
-
z.object({}),
|
|
1569
|
-
z.xor([
|
|
1570
|
-
z.object({
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
1574
|
+
/* @__PURE__ */ z.object({}),
|
|
1575
|
+
/* @__PURE__ */ z.xor([
|
|
1576
|
+
/* @__PURE__ */ z.object({
|
|
1577
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
1578
|
+
}),
|
|
1579
|
+
/* @__PURE__ */ z.object({
|
|
1580
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
1573
1581
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
1574
1582
|
)
|
|
1575
1583
|
})
|
|
1576
1584
|
])
|
|
1577
1585
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
1578
|
-
modifierGroups: z.array(
|
|
1579
|
-
z.object({
|
|
1580
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1581
|
-
name: z.object({
|
|
1582
|
-
original: z.string().describe(
|
|
1586
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
1587
|
+
/* @__PURE__ */ z.object({
|
|
1588
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1589
|
+
name: /* @__PURE__ */ z.object({
|
|
1590
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1583
1591
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1584
1592
|
).min(1).max(200).optional(),
|
|
1585
|
-
translated: z.string().describe(
|
|
1593
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1586
1594
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1587
1595
|
).min(1).max(400).optional().nullable()
|
|
1588
1596
|
}).describe("Modifier group name.").optional(),
|
|
1589
|
-
modifiers: z.array(
|
|
1590
|
-
z.object({
|
|
1591
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
1592
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
1593
|
-
label: z.object({
|
|
1594
|
-
original: z.string().describe(
|
|
1597
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
1598
|
+
/* @__PURE__ */ z.object({
|
|
1599
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
1600
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
1601
|
+
label: /* @__PURE__ */ z.object({
|
|
1602
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1595
1603
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1596
1604
|
).min(1).max(200).optional(),
|
|
1597
|
-
translated: z.string().describe(
|
|
1605
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1598
1606
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1599
1607
|
).min(1).max(400).optional().nullable()
|
|
1600
1608
|
}).describe("Primary display label for the modifier.").optional(),
|
|
1601
|
-
details: z.object({
|
|
1602
|
-
original: z.string().describe(
|
|
1609
|
+
details: /* @__PURE__ */ z.object({
|
|
1610
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1603
1611
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1604
1612
|
).min(1).max(200).optional(),
|
|
1605
|
-
translated: z.string().describe(
|
|
1613
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1606
1614
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1607
1615
|
).min(1).max(400).optional().nullable()
|
|
1608
1616
|
}).describe("Additional details.").optional(),
|
|
1609
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
1617
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
1610
1618
|
})
|
|
1611
1619
|
).min(1).max(25).optional()
|
|
1612
1620
|
})
|
|
1613
1621
|
).max(25).optional()
|
|
1614
1622
|
})
|
|
1615
1623
|
).max(300).optional(),
|
|
1616
|
-
couponCode: z.string().describe(
|
|
1624
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
1617
1625
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
1618
1626
|
).optional().nullable(),
|
|
1619
|
-
customContentReference: z.object({
|
|
1620
|
-
appId: z.string().describe(
|
|
1627
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
1628
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1621
1629
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
1622
1630
|
).regex(
|
|
1623
1631
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1624
1632
|
"Must be a valid GUID"
|
|
1625
1633
|
).optional(),
|
|
1626
|
-
componentId: z.string().describe(
|
|
1634
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
1627
1635
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
1628
1636
|
).regex(
|
|
1629
1637
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -1632,14 +1640,14 @@ var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
1632
1640
|
}).describe(
|
|
1633
1641
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
1634
1642
|
).optional(),
|
|
1635
|
-
externalReference: z.object({
|
|
1636
|
-
appId: z.string().describe(
|
|
1643
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
1644
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1637
1645
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
1638
1646
|
).regex(
|
|
1639
1647
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1640
1648
|
"Must be a valid GUID"
|
|
1641
1649
|
).optional(),
|
|
1642
|
-
resourceId: z.string().describe(
|
|
1650
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
1643
1651
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
1644
1652
|
).min(1).max(100).optional().nullable()
|
|
1645
1653
|
}).describe(
|
|
@@ -1648,116 +1656,116 @@ var UpdateCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
|
1648
1656
|
}).describe("Checkout template info to update.")
|
|
1649
1657
|
});
|
|
1650
1658
|
var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
1651
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
1659
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
1652
1660
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1653
1661
|
"Must be a valid GUID"
|
|
1654
1662
|
).optional().nullable(),
|
|
1655
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
1663
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
1656
1664
|
"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`"
|
|
1657
1665
|
).optional(),
|
|
1658
|
-
customization: z.object({
|
|
1659
|
-
webClient: z.object({
|
|
1660
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
1666
|
+
customization: /* @__PURE__ */ z.object({
|
|
1667
|
+
webClient: /* @__PURE__ */ z.object({
|
|
1668
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
1661
1669
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
1662
1670
|
).optional(),
|
|
1663
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
1671
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
1664
1672
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
1665
1673
|
).optional()
|
|
1666
1674
|
}).describe(
|
|
1667
1675
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
1668
1676
|
).optional(),
|
|
1669
|
-
lockedGiftCard: z.boolean().describe(
|
|
1677
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
1670
1678
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
1671
1679
|
).optional(),
|
|
1672
|
-
lockedCoupon: z.boolean().describe(
|
|
1680
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
1673
1681
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
1674
1682
|
).optional(),
|
|
1675
|
-
disabledManualPayment: z.boolean().describe(
|
|
1683
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
1676
1684
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
1677
1685
|
).optional()
|
|
1678
1686
|
}).describe(
|
|
1679
1687
|
"Custom settings to apply to the checkout page created from this template."
|
|
1680
1688
|
).optional(),
|
|
1681
|
-
lineItems: z.array(
|
|
1682
|
-
z.object({
|
|
1683
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1684
|
-
catalogReference: z.object({
|
|
1685
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1686
|
-
appId: z.string().describe(
|
|
1689
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
1690
|
+
/* @__PURE__ */ z.object({
|
|
1691
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1692
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
1693
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1694
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1687
1695
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
1688
1696
|
).min(1).optional(),
|
|
1689
|
-
options: z.record(z.string(), z.any()).describe(
|
|
1697
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1690
1698
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
1691
1699
|
).optional().nullable()
|
|
1692
1700
|
}).describe(
|
|
1693
1701
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
1694
1702
|
).optional(),
|
|
1695
|
-
catalogOverrideFields: z.object({
|
|
1696
|
-
productName: z.object({
|
|
1697
|
-
original: z.string().describe(
|
|
1703
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
1704
|
+
productName: /* @__PURE__ */ z.object({
|
|
1705
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1698
1706
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1699
1707
|
).min(1).max(200).optional(),
|
|
1700
|
-
translated: z.string().describe(
|
|
1708
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1701
1709
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1702
1710
|
).min(1).max(400).optional().nullable()
|
|
1703
1711
|
}).describe("Item name.").optional(),
|
|
1704
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
1705
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
1706
|
-
descriptionLines: z.array(
|
|
1707
|
-
z.intersection(
|
|
1708
|
-
z.object({
|
|
1709
|
-
name: z.object({
|
|
1710
|
-
original: z.string().describe(
|
|
1712
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
1713
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
1714
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
1715
|
+
/* @__PURE__ */ z.intersection(
|
|
1716
|
+
/* @__PURE__ */ z.object({
|
|
1717
|
+
name: /* @__PURE__ */ z.object({
|
|
1718
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1711
1719
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1712
1720
|
).max(100).optional(),
|
|
1713
|
-
translated: z.string().describe(
|
|
1721
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1714
1722
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1715
1723
|
).max(200).optional().nullable()
|
|
1716
1724
|
}).describe("Description line name.").optional()
|
|
1717
1725
|
}),
|
|
1718
|
-
z.xor([
|
|
1719
|
-
z.object({
|
|
1720
|
-
plainText: z.never().optional(),
|
|
1721
|
-
colorInfo: z.never().optional()
|
|
1726
|
+
/* @__PURE__ */ z.xor([
|
|
1727
|
+
/* @__PURE__ */ z.object({
|
|
1728
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1729
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
1722
1730
|
}),
|
|
1723
|
-
z.object({
|
|
1724
|
-
colorInfo: z.never().optional(),
|
|
1725
|
-
plainText: z.object({
|
|
1726
|
-
original: z.string().describe(
|
|
1731
|
+
/* @__PURE__ */ z.object({
|
|
1732
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
1733
|
+
plainText: /* @__PURE__ */ z.object({
|
|
1734
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1727
1735
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1728
1736
|
).max(600).optional(),
|
|
1729
|
-
translated: z.string().describe(
|
|
1737
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1730
1738
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1731
1739
|
).max(600).optional().nullable()
|
|
1732
1740
|
}).describe("Description line plain text value.")
|
|
1733
1741
|
}),
|
|
1734
|
-
z.object({
|
|
1735
|
-
plainText: z.never().optional(),
|
|
1736
|
-
colorInfo: z.object({
|
|
1737
|
-
original: z.string().describe(
|
|
1742
|
+
/* @__PURE__ */ z.object({
|
|
1743
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1744
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
1745
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1738
1746
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1739
1747
|
).max(500).optional(),
|
|
1740
|
-
translated: z.string().describe(
|
|
1748
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1741
1749
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1742
1750
|
).max(500).optional().nullable(),
|
|
1743
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1751
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1744
1752
|
}).describe("Description line color value.")
|
|
1745
1753
|
})
|
|
1746
1754
|
])
|
|
1747
1755
|
)
|
|
1748
1756
|
).min(0).max(20).optional(),
|
|
1749
|
-
physicalProperties: z.object({
|
|
1750
|
-
weight: z.number().describe(
|
|
1757
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
1758
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
1751
1759
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
1752
1760
|
).optional().nullable(),
|
|
1753
|
-
sku: z.string().describe(
|
|
1761
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
1754
1762
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
1755
1763
|
).max(40).optional().nullable(),
|
|
1756
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1764
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1757
1765
|
}).describe("Physical properties of the item.").optional(),
|
|
1758
|
-
image: z.string().describe("Item image.").optional(),
|
|
1759
|
-
paymentOption: z.object({
|
|
1760
|
-
value: z.enum([
|
|
1766
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
1767
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
1768
|
+
value: /* @__PURE__ */ z.enum([
|
|
1761
1769
|
"FULL_PAYMENT_ONLINE",
|
|
1762
1770
|
"FULL_PAYMENT_OFFLINE",
|
|
1763
1771
|
"MEMBERSHIP",
|
|
@@ -1768,110 +1776,110 @@ var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1768
1776
|
"Type of selected payment option for current item.\n\nDefault: `FULL_PAYMENT_ONLINE`"
|
|
1769
1777
|
).optional()
|
|
1770
1778
|
}).describe("Payment method selected for the item.").optional(),
|
|
1771
|
-
depositAmount: z.string().describe(
|
|
1779
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
1772
1780
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
1773
1781
|
).optional().nullable(),
|
|
1774
|
-
savePaymentMethod: z.boolean().describe(
|
|
1782
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
1775
1783
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
1776
1784
|
).optional().nullable(),
|
|
1777
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
1785
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
1778
1786
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1779
1787
|
"Must be a valid GUID"
|
|
1780
1788
|
).optional().nullable()
|
|
1781
1789
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
1782
1790
|
})
|
|
1783
1791
|
).max(300).optional(),
|
|
1784
|
-
customLineItems: z.array(
|
|
1785
|
-
z.object({
|
|
1786
|
-
quantity: z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1787
|
-
price: z.string().describe(
|
|
1792
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
1793
|
+
/* @__PURE__ */ z.object({
|
|
1794
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Custom line item quantity.\n\nMin: `1`\nMax: `100000`").min(1).max(1e5).optional(),
|
|
1795
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
1788
1796
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
1789
1797
|
).optional(),
|
|
1790
|
-
priceDescription: z.object({
|
|
1791
|
-
original: z.string().describe(
|
|
1798
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
1799
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1792
1800
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1793
1801
|
).min(1).max(100).optional(),
|
|
1794
|
-
translated: z.string().describe(
|
|
1802
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1795
1803
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1796
1804
|
).min(1).max(100).optional().nullable()
|
|
1797
1805
|
}).describe(
|
|
1798
1806
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
1799
1807
|
).optional(),
|
|
1800
|
-
descriptionLines: z.array(
|
|
1801
|
-
z.intersection(
|
|
1802
|
-
z.object({
|
|
1803
|
-
name: z.object({
|
|
1804
|
-
original: z.string().describe(
|
|
1808
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
1809
|
+
/* @__PURE__ */ z.intersection(
|
|
1810
|
+
/* @__PURE__ */ z.object({
|
|
1811
|
+
name: /* @__PURE__ */ z.object({
|
|
1812
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1805
1813
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1806
1814
|
).max(100).optional(),
|
|
1807
|
-
translated: z.string().describe(
|
|
1815
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1808
1816
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1809
1817
|
).max(200).optional().nullable()
|
|
1810
1818
|
}).describe("Description line name.").optional()
|
|
1811
1819
|
}),
|
|
1812
|
-
z.xor([
|
|
1813
|
-
z.object({
|
|
1814
|
-
plainText: z.never().optional(),
|
|
1815
|
-
colorInfo: z.never().optional()
|
|
1820
|
+
/* @__PURE__ */ z.xor([
|
|
1821
|
+
/* @__PURE__ */ z.object({
|
|
1822
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1823
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
1816
1824
|
}),
|
|
1817
|
-
z.object({
|
|
1818
|
-
colorInfo: z.never().optional(),
|
|
1819
|
-
plainText: z.object({
|
|
1820
|
-
original: z.string().describe(
|
|
1825
|
+
/* @__PURE__ */ z.object({
|
|
1826
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
1827
|
+
plainText: /* @__PURE__ */ z.object({
|
|
1828
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1821
1829
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1822
1830
|
).max(600).optional(),
|
|
1823
|
-
translated: z.string().describe(
|
|
1831
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1824
1832
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1825
1833
|
).max(600).optional().nullable()
|
|
1826
1834
|
}).describe("Description line plain text value.")
|
|
1827
1835
|
}),
|
|
1828
|
-
z.object({
|
|
1829
|
-
plainText: z.never().optional(),
|
|
1830
|
-
colorInfo: z.object({
|
|
1831
|
-
original: z.string().describe(
|
|
1836
|
+
/* @__PURE__ */ z.object({
|
|
1837
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
1838
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
1839
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1832
1840
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
1833
1841
|
).max(500).optional(),
|
|
1834
|
-
translated: z.string().describe(
|
|
1842
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1835
1843
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
1836
1844
|
).max(500).optional().nullable(),
|
|
1837
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1845
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
1838
1846
|
}).describe("Description line color value.")
|
|
1839
1847
|
})
|
|
1840
1848
|
])
|
|
1841
1849
|
)
|
|
1842
1850
|
).max(10).optional(),
|
|
1843
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
1844
|
-
_id: z.string().describe(
|
|
1851
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
1852
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
1845
1853
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
1846
1854
|
).regex(
|
|
1847
1855
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1848
1856
|
"Must be a valid GUID"
|
|
1849
1857
|
).optional().nullable(),
|
|
1850
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1858
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
1851
1859
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1852
1860
|
"Must be a valid GUID"
|
|
1853
1861
|
).optional().nullable(),
|
|
1854
|
-
productName: z.object({
|
|
1855
|
-
original: z.string().describe(
|
|
1862
|
+
productName: /* @__PURE__ */ z.object({
|
|
1863
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1856
1864
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1857
1865
|
).min(1).max(200).optional(),
|
|
1858
|
-
translated: z.string().describe(
|
|
1866
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1859
1867
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1860
1868
|
).min(1).max(400).optional().nullable()
|
|
1861
1869
|
}).describe("Name of the item or product.").optional(),
|
|
1862
|
-
url: z.string().describe(
|
|
1870
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
1863
1871
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
1864
1872
|
).optional(),
|
|
1865
|
-
itemType: z.intersection(
|
|
1866
|
-
z.object({}),
|
|
1867
|
-
z.xor([
|
|
1868
|
-
z.object({
|
|
1869
|
-
preset: z.never().optional(),
|
|
1870
|
-
custom: z.never().optional()
|
|
1873
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
1874
|
+
/* @__PURE__ */ z.object({}),
|
|
1875
|
+
/* @__PURE__ */ z.xor([
|
|
1876
|
+
/* @__PURE__ */ z.object({
|
|
1877
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1878
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
1871
1879
|
}),
|
|
1872
|
-
z.object({
|
|
1873
|
-
custom: z.never().optional(),
|
|
1874
|
-
preset: z.enum([
|
|
1880
|
+
/* @__PURE__ */ z.object({
|
|
1881
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
1882
|
+
preset: /* @__PURE__ */ z.enum([
|
|
1875
1883
|
"UNRECOGNISED",
|
|
1876
1884
|
"PHYSICAL",
|
|
1877
1885
|
"DIGITAL",
|
|
@@ -1879,30 +1887,30 @@ var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1879
1887
|
"SERVICE"
|
|
1880
1888
|
]).describe("Preset item type.")
|
|
1881
1889
|
}),
|
|
1882
|
-
z.object({
|
|
1883
|
-
preset: z.never().optional(),
|
|
1884
|
-
custom: z.string().describe(
|
|
1890
|
+
/* @__PURE__ */ z.object({
|
|
1891
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
1892
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
1885
1893
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
1886
1894
|
)
|
|
1887
1895
|
})
|
|
1888
1896
|
])
|
|
1889
1897
|
).describe("Item type. Either a preset type or custom.").optional(),
|
|
1890
|
-
fullPrice: z.string().describe(
|
|
1898
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
1891
1899
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
1892
1900
|
).optional().nullable(),
|
|
1893
|
-
quantityAvailable: z.number().int().describe(
|
|
1901
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
1894
1902
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
1895
1903
|
).min(0).max(1e5).optional().nullable(),
|
|
1896
|
-
physicalProperties: z.object({
|
|
1897
|
-
weight: z.number().describe(
|
|
1904
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
1905
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
1898
1906
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
1899
1907
|
).optional().nullable(),
|
|
1900
|
-
sku: z.string().describe(
|
|
1908
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
1901
1909
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
1902
1910
|
).max(40).optional().nullable(),
|
|
1903
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1911
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
1904
1912
|
}).describe("Physical properties of the item.").optional(),
|
|
1905
|
-
paymentOption: z.enum([
|
|
1913
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
1906
1914
|
"FULL_PAYMENT_ONLINE",
|
|
1907
1915
|
"FULL_PAYMENT_OFFLINE",
|
|
1908
1916
|
"MEMBERSHIP",
|
|
@@ -1912,118 +1920,120 @@ var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
1912
1920
|
]).describe(
|
|
1913
1921
|
"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field."
|
|
1914
1922
|
).optional(),
|
|
1915
|
-
serviceProperties: z.object({
|
|
1916
|
-
scheduledDate: z.date().describe(
|
|
1923
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
1924
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
1917
1925
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
1918
1926
|
).optional().nullable(),
|
|
1919
|
-
numberOfParticipants: z.number().int().describe(
|
|
1927
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
1920
1928
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
1921
1929
|
).min(1).max(1e4).optional().nullable()
|
|
1922
1930
|
}).describe(
|
|
1923
1931
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
1924
1932
|
).optional(),
|
|
1925
|
-
rootCatalogItemId: z.string().describe(
|
|
1933
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
1926
1934
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
1927
1935
|
).min(1).max(36).optional().nullable(),
|
|
1928
|
-
depositAmount: z.string().describe(
|
|
1936
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
1929
1937
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
1930
1938
|
).optional().nullable(),
|
|
1931
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
1939
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
1932
1940
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1933
1941
|
"Must be a valid GUID"
|
|
1934
1942
|
).optional().nullable(),
|
|
1935
|
-
catalogReference: z.object({
|
|
1936
|
-
catalogItemId: z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1937
|
-
appId: z.string().describe(
|
|
1943
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
1944
|
+
catalogItemId: /* @__PURE__ */ z.string().describe("ID of the item within the catalog it belongs to.").min(1).max(36).optional(),
|
|
1945
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
1938
1946
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
1939
1947
|
).min(1).optional(),
|
|
1940
|
-
options: z.record(z.string(), z.any()).describe(
|
|
1948
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
1941
1949
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
1942
1950
|
).optional().nullable()
|
|
1943
1951
|
}).describe(
|
|
1944
1952
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
1945
1953
|
).optional(),
|
|
1946
|
-
priceUndetermined: z.boolean().describe(
|
|
1954
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
1947
1955
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
1948
1956
|
).optional(),
|
|
1949
|
-
fixedQuantity: z.boolean().describe(
|
|
1957
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
1950
1958
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
1951
1959
|
).optional(),
|
|
1952
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
1960
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
1953
1961
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
1954
1962
|
).min(1).max(1e3).optional().nullable(),
|
|
1955
|
-
savePaymentMethod: z.boolean().describe(
|
|
1963
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
1956
1964
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
1957
1965
|
).optional(),
|
|
1958
|
-
policies: z.array(
|
|
1959
|
-
z.object({
|
|
1960
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1961
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1966
|
+
policies: /* @__PURE__ */ z.array(
|
|
1967
|
+
/* @__PURE__ */ z.object({
|
|
1968
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
1969
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
1962
1970
|
})
|
|
1963
1971
|
).max(5).optional(),
|
|
1964
|
-
membersOnly: z.boolean().describe(
|
|
1972
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
1965
1973
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
1966
1974
|
).optional(),
|
|
1967
|
-
taxableAddress: z.intersection(
|
|
1968
|
-
z.object({}),
|
|
1969
|
-
z.xor([
|
|
1970
|
-
z.object({
|
|
1971
|
-
|
|
1972
|
-
|
|
1975
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
1976
|
+
/* @__PURE__ */ z.object({}),
|
|
1977
|
+
/* @__PURE__ */ z.xor([
|
|
1978
|
+
/* @__PURE__ */ z.object({
|
|
1979
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
1980
|
+
}),
|
|
1981
|
+
/* @__PURE__ */ z.object({
|
|
1982
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
1973
1983
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
1974
1984
|
)
|
|
1975
1985
|
})
|
|
1976
1986
|
])
|
|
1977
1987
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
1978
|
-
modifierGroups: z.array(
|
|
1979
|
-
z.object({
|
|
1980
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1981
|
-
name: z.object({
|
|
1982
|
-
original: z.string().describe(
|
|
1988
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
1989
|
+
/* @__PURE__ */ z.object({
|
|
1990
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
1991
|
+
name: /* @__PURE__ */ z.object({
|
|
1992
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1983
1993
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1984
1994
|
).min(1).max(200).optional(),
|
|
1985
|
-
translated: z.string().describe(
|
|
1995
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1986
1996
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1987
1997
|
).min(1).max(400).optional().nullable()
|
|
1988
1998
|
}).describe("Modifier group name.").optional(),
|
|
1989
|
-
modifiers: z.array(
|
|
1990
|
-
z.object({
|
|
1991
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
1992
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
1993
|
-
label: z.object({
|
|
1994
|
-
original: z.string().describe(
|
|
1999
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
2000
|
+
/* @__PURE__ */ z.object({
|
|
2001
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
2002
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
2003
|
+
label: /* @__PURE__ */ z.object({
|
|
2004
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
1995
2005
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
1996
2006
|
).min(1).max(200).optional(),
|
|
1997
|
-
translated: z.string().describe(
|
|
2007
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
1998
2008
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
1999
2009
|
).min(1).max(400).optional().nullable()
|
|
2000
2010
|
}).describe("Primary display label for the modifier.").optional(),
|
|
2001
|
-
details: z.object({
|
|
2002
|
-
original: z.string().describe(
|
|
2011
|
+
details: /* @__PURE__ */ z.object({
|
|
2012
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2003
2013
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2004
2014
|
).min(1).max(200).optional(),
|
|
2005
|
-
translated: z.string().describe(
|
|
2015
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2006
2016
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2007
2017
|
).min(1).max(400).optional().nullable()
|
|
2008
2018
|
}).describe("Additional details.").optional(),
|
|
2009
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
2019
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
2010
2020
|
})
|
|
2011
2021
|
).min(1).max(25).optional()
|
|
2012
2022
|
})
|
|
2013
2023
|
).max(25).optional()
|
|
2014
2024
|
})
|
|
2015
2025
|
).max(300).optional(),
|
|
2016
|
-
couponCode: z.string().describe(
|
|
2026
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
2017
2027
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
2018
2028
|
).optional().nullable(),
|
|
2019
|
-
customContentReference: z.object({
|
|
2020
|
-
appId: z.string().describe(
|
|
2029
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
2030
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2021
2031
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
2022
2032
|
).regex(
|
|
2023
2033
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2024
2034
|
"Must be a valid GUID"
|
|
2025
2035
|
).optional(),
|
|
2026
|
-
componentId: z.string().describe(
|
|
2036
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
2027
2037
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
2028
2038
|
).regex(
|
|
2029
2039
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -2032,14 +2042,14 @@ var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
2032
2042
|
}).describe(
|
|
2033
2043
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
2034
2044
|
).optional(),
|
|
2035
|
-
externalReference: z.object({
|
|
2036
|
-
appId: z.string().describe(
|
|
2045
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
2046
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2037
2047
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
2038
2048
|
).regex(
|
|
2039
2049
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2040
2050
|
"Must be a valid GUID"
|
|
2041
2051
|
).optional(),
|
|
2042
|
-
resourceId: z.string().describe(
|
|
2052
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
2043
2053
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
2044
2054
|
).min(1).max(100).optional().nullable()
|
|
2045
2055
|
}).describe(
|
|
@@ -2047,153 +2057,153 @@ var UpdateCheckoutTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
2047
2057
|
).optional()
|
|
2048
2058
|
});
|
|
2049
2059
|
var DeleteCheckoutTemplateRequest = /* @__PURE__ */ z.object({
|
|
2050
|
-
checkoutTemplateId: z.string().describe("ID of the checkout template to delete.").regex(
|
|
2060
|
+
checkoutTemplateId: /* @__PURE__ */ z.string().describe("ID of the checkout template to delete.").regex(
|
|
2051
2061
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2052
2062
|
"Must be a valid GUID"
|
|
2053
2063
|
)
|
|
2054
2064
|
});
|
|
2055
2065
|
var DeleteCheckoutTemplateResponse = /* @__PURE__ */ z.object({});
|
|
2056
2066
|
var QueryCheckoutTemplatesRequest = /* @__PURE__ */ z.object({
|
|
2057
|
-
query: z.object({
|
|
2058
|
-
filter: z.object({
|
|
2059
|
-
_id: z.object({
|
|
2060
|
-
$eq: z.string(),
|
|
2061
|
-
$exists: z.boolean(),
|
|
2062
|
-
$gt: z.string(),
|
|
2063
|
-
$gte: z.string(),
|
|
2064
|
-
$hasAll: z.array(z.string()),
|
|
2065
|
-
$hasSome: z.array(z.string()),
|
|
2066
|
-
$in: z.array(z.string()),
|
|
2067
|
-
$lt: z.string(),
|
|
2068
|
-
$lte: z.string(),
|
|
2069
|
-
$ne: z.string(),
|
|
2070
|
-
$nin: z.array(z.string()),
|
|
2071
|
-
$startsWith: z.string()
|
|
2067
|
+
query: /* @__PURE__ */ z.object({
|
|
2068
|
+
filter: /* @__PURE__ */ z.object({
|
|
2069
|
+
_id: /* @__PURE__ */ z.object({
|
|
2070
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2071
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2072
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2073
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2074
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2075
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2076
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2077
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2078
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2079
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2080
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2081
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2072
2082
|
}).partial().strict().optional(),
|
|
2073
|
-
status: z.object({
|
|
2074
|
-
$eq: z.string(),
|
|
2075
|
-
$exists: z.boolean(),
|
|
2076
|
-
$gt: z.string(),
|
|
2077
|
-
$gte: z.string(),
|
|
2078
|
-
$hasAll: z.array(z.string()),
|
|
2079
|
-
$hasSome: z.array(z.string()),
|
|
2080
|
-
$in: z.array(z.string()),
|
|
2081
|
-
$lt: z.string(),
|
|
2082
|
-
$lte: z.string(),
|
|
2083
|
-
$ne: z.string(),
|
|
2084
|
-
$nin: z.array(z.string()),
|
|
2085
|
-
$startsWith: z.string()
|
|
2083
|
+
status: /* @__PURE__ */ z.object({
|
|
2084
|
+
$eq: /* @__PURE__ */ z.string(),
|
|
2085
|
+
$exists: /* @__PURE__ */ z.boolean(),
|
|
2086
|
+
$gt: /* @__PURE__ */ z.string(),
|
|
2087
|
+
$gte: /* @__PURE__ */ z.string(),
|
|
2088
|
+
$hasAll: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2089
|
+
$hasSome: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2090
|
+
$in: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2091
|
+
$lt: /* @__PURE__ */ z.string(),
|
|
2092
|
+
$lte: /* @__PURE__ */ z.string(),
|
|
2093
|
+
$ne: /* @__PURE__ */ z.string(),
|
|
2094
|
+
$nin: /* @__PURE__ */ z.array(/* @__PURE__ */ z.string()),
|
|
2095
|
+
$startsWith: /* @__PURE__ */ z.string()
|
|
2086
2096
|
}).partial().strict().optional(),
|
|
2087
|
-
$and: z.array(z.any()).optional(),
|
|
2088
|
-
$or: z.array(z.any()).optional(),
|
|
2089
|
-
$not: z.any().optional()
|
|
2097
|
+
$and: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2098
|
+
$or: /* @__PURE__ */ z.array(/* @__PURE__ */ z.any()).optional(),
|
|
2099
|
+
$not: /* @__PURE__ */ z.any().optional()
|
|
2090
2100
|
}).strict().optional(),
|
|
2091
|
-
sort: z.array(
|
|
2092
|
-
z.object({
|
|
2093
|
-
fieldName: z.enum(["_id", "status"]).optional(),
|
|
2094
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
2101
|
+
sort: /* @__PURE__ */ z.array(
|
|
2102
|
+
/* @__PURE__ */ z.object({
|
|
2103
|
+
fieldName: /* @__PURE__ */ z.enum(["_id", "status"]).optional(),
|
|
2104
|
+
order: /* @__PURE__ */ z.enum(["ASC", "DESC"]).optional()
|
|
2095
2105
|
})
|
|
2096
2106
|
).optional()
|
|
2097
|
-
}).catchall(z.any()).describe("Query options.")
|
|
2107
|
+
}).catchall(/* @__PURE__ */ z.any()).describe("Query options.")
|
|
2098
2108
|
});
|
|
2099
2109
|
var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
2100
|
-
checkoutTemplates: z.array(
|
|
2101
|
-
z.object({
|
|
2102
|
-
_id: z.string().describe("Checkout template ID.").regex(
|
|
2110
|
+
checkoutTemplates: /* @__PURE__ */ z.array(
|
|
2111
|
+
/* @__PURE__ */ z.object({
|
|
2112
|
+
_id: /* @__PURE__ */ z.string().describe("Checkout template ID.").regex(
|
|
2103
2113
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2104
2114
|
"Must be a valid GUID"
|
|
2105
2115
|
).optional().nullable(),
|
|
2106
|
-
status: z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
2116
|
+
status: /* @__PURE__ */ z.enum(["ACTIVE", "INACTIVE"]).describe(
|
|
2107
2117
|
"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`"
|
|
2108
2118
|
).optional(),
|
|
2109
|
-
customization: z.object({
|
|
2110
|
-
webClient: z.object({
|
|
2111
|
-
disabledContinueShoppingButton: z.boolean().describe(
|
|
2119
|
+
customization: /* @__PURE__ */ z.object({
|
|
2120
|
+
webClient: /* @__PURE__ */ z.object({
|
|
2121
|
+
disabledContinueShoppingButton: /* @__PURE__ */ z.boolean().describe(
|
|
2112
2122
|
'Whether to disable the "Continue shopping" button.\n\nDefault: `false`'
|
|
2113
2123
|
).optional(),
|
|
2114
|
-
disabledPolicyAgreementCheckbox: z.boolean().describe(
|
|
2124
|
+
disabledPolicyAgreementCheckbox: /* @__PURE__ */ z.boolean().describe(
|
|
2115
2125
|
"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"
|
|
2116
2126
|
).optional()
|
|
2117
2127
|
}).describe(
|
|
2118
2128
|
"Web client customizations. These customizations only apply to the standard Wix checkout page."
|
|
2119
2129
|
).optional(),
|
|
2120
|
-
lockedGiftCard: z.boolean().describe(
|
|
2130
|
+
lockedGiftCard: /* @__PURE__ */ z.boolean().describe(
|
|
2121
2131
|
"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"
|
|
2122
2132
|
).optional(),
|
|
2123
|
-
lockedCoupon: z.boolean().describe(
|
|
2133
|
+
lockedCoupon: /* @__PURE__ */ z.boolean().describe(
|
|
2124
2134
|
"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"
|
|
2125
2135
|
).optional(),
|
|
2126
|
-
disabledManualPayment: z.boolean().describe(
|
|
2136
|
+
disabledManualPayment: /* @__PURE__ */ z.boolean().describe(
|
|
2127
2137
|
"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"
|
|
2128
2138
|
).optional()
|
|
2129
2139
|
}).describe(
|
|
2130
2140
|
"Custom settings to apply to the checkout page created from this template."
|
|
2131
2141
|
).optional(),
|
|
2132
|
-
lineItems: z.array(
|
|
2133
|
-
z.object({
|
|
2134
|
-
quantity: z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
2135
|
-
catalogReference: z.object({
|
|
2136
|
-
catalogItemId: z.string().describe(
|
|
2142
|
+
lineItems: /* @__PURE__ */ z.array(
|
|
2143
|
+
/* @__PURE__ */ z.object({
|
|
2144
|
+
quantity: /* @__PURE__ */ z.number().int().describe("Item quantity.\n\nMin: `1` <br />\nMax: `100000`").min(1).max(1e5).optional(),
|
|
2145
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
2146
|
+
catalogItemId: /* @__PURE__ */ z.string().describe(
|
|
2137
2147
|
"ID of the item within the catalog it belongs to."
|
|
2138
2148
|
).min(1).max(36).optional(),
|
|
2139
|
-
appId: z.string().describe(
|
|
2149
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2140
2150
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
2141
2151
|
).min(1).optional(),
|
|
2142
|
-
options: z.record(z.string(), z.any()).describe(
|
|
2152
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2143
2153
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
2144
2154
|
).optional().nullable()
|
|
2145
2155
|
}).describe(
|
|
2146
2156
|
"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
2147
2157
|
).optional(),
|
|
2148
|
-
catalogOverrideFields: z.object({
|
|
2149
|
-
productName: z.object({
|
|
2150
|
-
original: z.string().describe(
|
|
2158
|
+
catalogOverrideFields: /* @__PURE__ */ z.object({
|
|
2159
|
+
productName: /* @__PURE__ */ z.object({
|
|
2160
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2151
2161
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2152
2162
|
).min(1).max(200).optional(),
|
|
2153
|
-
translated: z.string().describe(
|
|
2163
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2154
2164
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2155
2165
|
).min(1).max(400).optional().nullable()
|
|
2156
2166
|
}).describe("Item name.").optional(),
|
|
2157
|
-
price: z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
2158
|
-
fullPrice: z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
2159
|
-
descriptionLines: z.array(
|
|
2160
|
-
z.intersection(
|
|
2161
|
-
z.object({
|
|
2162
|
-
name: z.object({
|
|
2163
|
-
original: z.string().describe(
|
|
2167
|
+
price: /* @__PURE__ */ z.string().describe("Item price **after** discounts.").optional().nullable(),
|
|
2168
|
+
fullPrice: /* @__PURE__ */ z.string().describe("Item price **before** discounts.").optional().nullable(),
|
|
2169
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
2170
|
+
/* @__PURE__ */ z.intersection(
|
|
2171
|
+
/* @__PURE__ */ z.object({
|
|
2172
|
+
name: /* @__PURE__ */ z.object({
|
|
2173
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2164
2174
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2165
2175
|
).max(100).optional(),
|
|
2166
|
-
translated: z.string().describe(
|
|
2176
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2167
2177
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2168
2178
|
).max(200).optional().nullable()
|
|
2169
2179
|
}).describe("Description line name.").optional()
|
|
2170
2180
|
}),
|
|
2171
|
-
z.xor([
|
|
2172
|
-
z.object({
|
|
2173
|
-
plainText: z.never().optional(),
|
|
2174
|
-
colorInfo: z.never().optional()
|
|
2181
|
+
/* @__PURE__ */ z.xor([
|
|
2182
|
+
/* @__PURE__ */ z.object({
|
|
2183
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
2184
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
2175
2185
|
}),
|
|
2176
|
-
z.object({
|
|
2177
|
-
colorInfo: z.never().optional(),
|
|
2178
|
-
plainText: z.object({
|
|
2179
|
-
original: z.string().describe(
|
|
2186
|
+
/* @__PURE__ */ z.object({
|
|
2187
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
2188
|
+
plainText: /* @__PURE__ */ z.object({
|
|
2189
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2180
2190
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2181
2191
|
).max(600).optional(),
|
|
2182
|
-
translated: z.string().describe(
|
|
2192
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2183
2193
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2184
2194
|
).max(600).optional().nullable()
|
|
2185
2195
|
}).describe("Description line plain text value.")
|
|
2186
2196
|
}),
|
|
2187
|
-
z.object({
|
|
2188
|
-
plainText: z.never().optional(),
|
|
2189
|
-
colorInfo: z.object({
|
|
2190
|
-
original: z.string().describe(
|
|
2197
|
+
/* @__PURE__ */ z.object({
|
|
2198
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
2199
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
2200
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2191
2201
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2192
2202
|
).max(500).optional(),
|
|
2193
|
-
translated: z.string().describe(
|
|
2203
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2194
2204
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2195
2205
|
).max(500).optional().nullable(),
|
|
2196
|
-
code: z.string().describe(
|
|
2206
|
+
code: /* @__PURE__ */ z.string().describe(
|
|
2197
2207
|
"HEX or RGB color code for display."
|
|
2198
2208
|
).optional().nullable()
|
|
2199
2209
|
}).describe("Description line color value.")
|
|
@@ -2201,18 +2211,18 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2201
2211
|
])
|
|
2202
2212
|
)
|
|
2203
2213
|
).min(0).max(20).optional(),
|
|
2204
|
-
physicalProperties: z.object({
|
|
2205
|
-
weight: z.number().describe(
|
|
2214
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
2215
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
2206
2216
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
2207
2217
|
).optional().nullable(),
|
|
2208
|
-
sku: z.string().describe(
|
|
2218
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
2209
2219
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
2210
2220
|
).max(40).optional().nullable(),
|
|
2211
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
2221
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
2212
2222
|
}).describe("Physical properties of the item.").optional(),
|
|
2213
|
-
image: z.string().describe("Item image.").optional(),
|
|
2214
|
-
paymentOption: z.object({
|
|
2215
|
-
value: z.enum([
|
|
2223
|
+
image: /* @__PURE__ */ z.string().describe("Item image.").optional(),
|
|
2224
|
+
paymentOption: /* @__PURE__ */ z.object({
|
|
2225
|
+
value: /* @__PURE__ */ z.enum([
|
|
2216
2226
|
"FULL_PAYMENT_ONLINE",
|
|
2217
2227
|
"FULL_PAYMENT_OFFLINE",
|
|
2218
2228
|
"MEMBERSHIP",
|
|
@@ -2223,112 +2233,112 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2223
2233
|
"Type of selected payment option for current item.\n\nDefault: `FULL_PAYMENT_ONLINE`"
|
|
2224
2234
|
).optional()
|
|
2225
2235
|
}).describe("Payment method selected for the item.").optional(),
|
|
2226
|
-
depositAmount: z.string().describe(
|
|
2236
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
2227
2237
|
"Only eligible for catalog items with `lineItem.paymentOption.value` type of `DEPOSIT_ONLINE`."
|
|
2228
2238
|
).optional().nullable(),
|
|
2229
|
-
savePaymentMethod: z.boolean().describe(
|
|
2239
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
2230
2240
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
2231
2241
|
).optional().nullable(),
|
|
2232
|
-
inventoryAppId: z.string().describe("ID of the app managing the inventory.").regex(
|
|
2242
|
+
inventoryAppId: /* @__PURE__ */ z.string().describe("ID of the app managing the inventory.").regex(
|
|
2233
2243
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2234
2244
|
"Must be a valid GUID"
|
|
2235
2245
|
).optional().nullable()
|
|
2236
2246
|
}).describe("Overriding values for catalog item properties.").optional()
|
|
2237
2247
|
})
|
|
2238
2248
|
).max(300).optional(),
|
|
2239
|
-
customLineItems: z.array(
|
|
2240
|
-
z.object({
|
|
2241
|
-
quantity: z.number().int().describe(
|
|
2249
|
+
customLineItems: /* @__PURE__ */ z.array(
|
|
2250
|
+
/* @__PURE__ */ z.object({
|
|
2251
|
+
quantity: /* @__PURE__ */ z.number().int().describe(
|
|
2242
2252
|
"Custom line item quantity.\n\nMin: `1`\nMax: `100000`"
|
|
2243
2253
|
).min(1).max(1e5).optional(),
|
|
2244
|
-
price: z.string().describe(
|
|
2254
|
+
price: /* @__PURE__ */ z.string().describe(
|
|
2245
2255
|
"Custom line item price.\n\nMust be a number or a decimal without symbols."
|
|
2246
2256
|
).optional(),
|
|
2247
|
-
priceDescription: z.object({
|
|
2248
|
-
original: z.string().describe(
|
|
2257
|
+
priceDescription: /* @__PURE__ */ z.object({
|
|
2258
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2249
2259
|
"__Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2250
2260
|
).min(1).max(100).optional(),
|
|
2251
|
-
translated: z.string().describe(
|
|
2261
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2252
2262
|
"Price description translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2253
2263
|
).min(1).max(100).optional().nullable()
|
|
2254
2264
|
}).describe(
|
|
2255
2265
|
'Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".'
|
|
2256
2266
|
).optional(),
|
|
2257
|
-
descriptionLines: z.array(
|
|
2258
|
-
z.intersection(
|
|
2259
|
-
z.object({
|
|
2260
|
-
name: z.object({
|
|
2261
|
-
original: z.string().describe(
|
|
2267
|
+
descriptionLines: /* @__PURE__ */ z.array(
|
|
2268
|
+
/* @__PURE__ */ z.intersection(
|
|
2269
|
+
/* @__PURE__ */ z.object({
|
|
2270
|
+
name: /* @__PURE__ */ z.object({
|
|
2271
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2262
2272
|
"Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2263
2273
|
).max(100).optional(),
|
|
2264
|
-
translated: z.string().describe(
|
|
2274
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2265
2275
|
"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2266
2276
|
).max(200).optional().nullable()
|
|
2267
2277
|
}).describe("Description line name.").optional()
|
|
2268
2278
|
}),
|
|
2269
|
-
z.xor([
|
|
2270
|
-
z.object({
|
|
2271
|
-
plainText: z.never().optional(),
|
|
2272
|
-
colorInfo: z.never().optional()
|
|
2279
|
+
/* @__PURE__ */ z.xor([
|
|
2280
|
+
/* @__PURE__ */ z.object({
|
|
2281
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
2282
|
+
colorInfo: /* @__PURE__ */ z.never().optional()
|
|
2273
2283
|
}),
|
|
2274
|
-
z.object({
|
|
2275
|
-
colorInfo: z.never().optional(),
|
|
2276
|
-
plainText: z.object({
|
|
2277
|
-
original: z.string().describe(
|
|
2284
|
+
/* @__PURE__ */ z.object({
|
|
2285
|
+
colorInfo: /* @__PURE__ */ z.never().optional(),
|
|
2286
|
+
plainText: /* @__PURE__ */ z.object({
|
|
2287
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2278
2288
|
"Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2279
2289
|
).max(600).optional(),
|
|
2280
|
-
translated: z.string().describe(
|
|
2290
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2281
2291
|
"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2282
2292
|
).max(600).optional().nullable()
|
|
2283
2293
|
}).describe("Description line plain text value.")
|
|
2284
2294
|
}),
|
|
2285
|
-
z.object({
|
|
2286
|
-
plainText: z.never().optional(),
|
|
2287
|
-
colorInfo: z.object({
|
|
2288
|
-
original: z.string().describe(
|
|
2295
|
+
/* @__PURE__ */ z.object({
|
|
2296
|
+
plainText: /* @__PURE__ */ z.never().optional(),
|
|
2297
|
+
colorInfo: /* @__PURE__ */ z.object({
|
|
2298
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2289
2299
|
"Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope)."
|
|
2290
2300
|
).max(500).optional(),
|
|
2291
|
-
translated: z.string().describe(
|
|
2301
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2292
2302
|
"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."
|
|
2293
2303
|
).max(500).optional().nullable(),
|
|
2294
|
-
code: z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
2304
|
+
code: /* @__PURE__ */ z.string().describe("HEX or RGB color code for display.").optional().nullable()
|
|
2295
2305
|
}).describe("Description line color value.")
|
|
2296
2306
|
})
|
|
2297
2307
|
])
|
|
2298
2308
|
)
|
|
2299
2309
|
).max(10).optional(),
|
|
2300
|
-
media: z.string().describe("Custom line item's media.").optional(),
|
|
2301
|
-
_id: z.string().describe(
|
|
2310
|
+
media: /* @__PURE__ */ z.string().describe("Custom line item's media.").optional(),
|
|
2311
|
+
_id: /* @__PURE__ */ z.string().describe(
|
|
2302
2312
|
"Deprecated. Custom line item ID.\n\nTo maintain a unique value for a custom line item across multiple carts and orders, pass `catalogReference` instead.\nLearn more about [custom items with catalog reference](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/catalog-and-custom-items#custom-item-with-catalog-reference)."
|
|
2303
2313
|
).regex(
|
|
2304
2314
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2305
2315
|
"Must be a valid GUID"
|
|
2306
2316
|
).optional().nullable(),
|
|
2307
|
-
taxGroupId: z.string().describe("Tax group ID for this custom line item.").regex(
|
|
2317
|
+
taxGroupId: /* @__PURE__ */ z.string().describe("Tax group ID for this custom line item.").regex(
|
|
2308
2318
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2309
2319
|
"Must be a valid GUID"
|
|
2310
2320
|
).optional().nullable(),
|
|
2311
|
-
productName: z.object({
|
|
2312
|
-
original: z.string().describe(
|
|
2321
|
+
productName: /* @__PURE__ */ z.object({
|
|
2322
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2313
2323
|
"__Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2314
2324
|
).min(1).max(200).optional(),
|
|
2315
|
-
translated: z.string().describe(
|
|
2325
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2316
2326
|
"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2317
2327
|
).min(1).max(400).optional().nullable()
|
|
2318
2328
|
}).describe("Name of the item or product.").optional(),
|
|
2319
|
-
url: z.string().describe(
|
|
2329
|
+
url: /* @__PURE__ */ z.string().describe(
|
|
2320
2330
|
"URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work."
|
|
2321
2331
|
).optional(),
|
|
2322
|
-
itemType: z.intersection(
|
|
2323
|
-
z.object({}),
|
|
2324
|
-
z.xor([
|
|
2325
|
-
z.object({
|
|
2326
|
-
preset: z.never().optional(),
|
|
2327
|
-
custom: z.never().optional()
|
|
2332
|
+
itemType: /* @__PURE__ */ z.intersection(
|
|
2333
|
+
/* @__PURE__ */ z.object({}),
|
|
2334
|
+
/* @__PURE__ */ z.xor([
|
|
2335
|
+
/* @__PURE__ */ z.object({
|
|
2336
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
2337
|
+
custom: /* @__PURE__ */ z.never().optional()
|
|
2328
2338
|
}),
|
|
2329
|
-
z.object({
|
|
2330
|
-
custom: z.never().optional(),
|
|
2331
|
-
preset: z.enum([
|
|
2339
|
+
/* @__PURE__ */ z.object({
|
|
2340
|
+
custom: /* @__PURE__ */ z.never().optional(),
|
|
2341
|
+
preset: /* @__PURE__ */ z.enum([
|
|
2332
2342
|
"UNRECOGNISED",
|
|
2333
2343
|
"PHYSICAL",
|
|
2334
2344
|
"DIGITAL",
|
|
@@ -2336,30 +2346,30 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2336
2346
|
"SERVICE"
|
|
2337
2347
|
]).describe("Preset item type.")
|
|
2338
2348
|
}),
|
|
2339
|
-
z.object({
|
|
2340
|
-
preset: z.never().optional(),
|
|
2341
|
-
custom: z.string().describe(
|
|
2349
|
+
/* @__PURE__ */ z.object({
|
|
2350
|
+
preset: /* @__PURE__ */ z.never().optional(),
|
|
2351
|
+
custom: /* @__PURE__ */ z.string().describe(
|
|
2342
2352
|
"Custom item type. When none of the preset types are suitable, specifies the custom type."
|
|
2343
2353
|
)
|
|
2344
2354
|
})
|
|
2345
2355
|
])
|
|
2346
2356
|
).describe("Item type. Either a preset type or custom.").optional(),
|
|
2347
|
-
fullPrice: z.string().describe(
|
|
2357
|
+
fullPrice: /* @__PURE__ */ z.string().describe(
|
|
2348
2358
|
"Item price **before** catalog-defined discount. Defaults to `price` when not provided."
|
|
2349
2359
|
).optional().nullable(),
|
|
2350
|
-
quantityAvailable: z.number().int().describe(
|
|
2360
|
+
quantityAvailable: /* @__PURE__ */ z.number().int().describe(
|
|
2351
2361
|
'Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can "infinitely" tick up the number of items in the cart.'
|
|
2352
2362
|
).min(0).max(1e5).optional().nullable(),
|
|
2353
|
-
physicalProperties: z.object({
|
|
2354
|
-
weight: z.number().describe(
|
|
2363
|
+
physicalProperties: /* @__PURE__ */ z.object({
|
|
2364
|
+
weight: /* @__PURE__ */ z.number().describe(
|
|
2355
2365
|
"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."
|
|
2356
2366
|
).optional().nullable(),
|
|
2357
|
-
sku: z.string().describe(
|
|
2367
|
+
sku: /* @__PURE__ */ z.string().describe(
|
|
2358
2368
|
"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."
|
|
2359
2369
|
).max(40).optional().nullable(),
|
|
2360
|
-
shippable: z.boolean().describe("Whether this line item is shippable.").optional()
|
|
2370
|
+
shippable: /* @__PURE__ */ z.boolean().describe("Whether this line item is shippable.").optional()
|
|
2361
2371
|
}).describe("Physical properties of the item.").optional(),
|
|
2362
|
-
paymentOption: z.enum([
|
|
2372
|
+
paymentOption: /* @__PURE__ */ z.enum([
|
|
2363
2373
|
"FULL_PAYMENT_ONLINE",
|
|
2364
2374
|
"FULL_PAYMENT_OFFLINE",
|
|
2365
2375
|
"MEMBERSHIP",
|
|
@@ -2369,120 +2379,122 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2369
2379
|
]).describe(
|
|
2370
2380
|
"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field."
|
|
2371
2381
|
).optional(),
|
|
2372
|
-
serviceProperties: z.object({
|
|
2373
|
-
scheduledDate: z.date().describe(
|
|
2382
|
+
serviceProperties: /* @__PURE__ */ z.object({
|
|
2383
|
+
scheduledDate: /* @__PURE__ */ z.date().describe(
|
|
2374
2384
|
"Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.\nFor example, the start time of a class."
|
|
2375
2385
|
).optional().nullable(),
|
|
2376
|
-
numberOfParticipants: z.number().int().describe(
|
|
2386
|
+
numberOfParticipants: /* @__PURE__ */ z.number().int().describe(
|
|
2377
2387
|
"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."
|
|
2378
2388
|
).min(1).max(1e4).optional().nullable()
|
|
2379
2389
|
}).describe(
|
|
2380
2390
|
"Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."
|
|
2381
2391
|
).optional(),
|
|
2382
|
-
rootCatalogItemId: z.string().describe(
|
|
2392
|
+
rootCatalogItemId: /* @__PURE__ */ z.string().describe(
|
|
2383
2393
|
"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."
|
|
2384
2394
|
).min(1).max(36).optional().nullable(),
|
|
2385
|
-
depositAmount: z.string().describe(
|
|
2395
|
+
depositAmount: /* @__PURE__ */ z.string().describe(
|
|
2386
2396
|
"Partial payment for the given item to be paid upfront during the checkout.\n\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nWhen omitted, the item's price will not be split and is expected to be paid in a single installment."
|
|
2387
2397
|
).optional().nullable(),
|
|
2388
|
-
deliveryProfileId: z.string().describe("Delivery profile ID.").regex(
|
|
2398
|
+
deliveryProfileId: /* @__PURE__ */ z.string().describe("Delivery profile ID.").regex(
|
|
2389
2399
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2390
2400
|
"Must be a valid GUID"
|
|
2391
2401
|
).optional().nullable(),
|
|
2392
|
-
catalogReference: z.object({
|
|
2393
|
-
catalogItemId: z.string().describe(
|
|
2402
|
+
catalogReference: /* @__PURE__ */ z.object({
|
|
2403
|
+
catalogItemId: /* @__PURE__ */ z.string().describe(
|
|
2394
2404
|
"ID of the item within the catalog it belongs to."
|
|
2395
2405
|
).min(1).max(36).optional(),
|
|
2396
|
-
appId: z.string().describe(
|
|
2406
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2397
2407
|
'ID of the app providing the catalog.\n\nYou can get your app\'s ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`\n+ Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`\n+ Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`'
|
|
2398
2408
|
).min(1).optional(),
|
|
2399
|
-
options: z.record(z.string(), z.any()).describe(
|
|
2409
|
+
options: /* @__PURE__ */ z.record(/* @__PURE__ */ z.string(), /* @__PURE__ */ z.any()).describe(
|
|
2400
2410
|
"Additional item details in `key:value` pairs.\n\nUse this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.\n\nFor Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration)\nor [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction)."
|
|
2401
2411
|
).optional().nullable()
|
|
2402
2412
|
}).describe(
|
|
2403
2413
|
"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin."
|
|
2404
2414
|
).optional(),
|
|
2405
|
-
priceUndetermined: z.boolean().describe(
|
|
2415
|
+
priceUndetermined: /* @__PURE__ */ z.boolean().describe(
|
|
2406
2416
|
"Whether the price is not yet defined, and will be updated after the order is created.\n\nDefault: `false`"
|
|
2407
2417
|
).optional(),
|
|
2408
|
-
fixedQuantity: z.boolean().describe(
|
|
2418
|
+
fixedQuantity: /* @__PURE__ */ z.boolean().describe(
|
|
2409
2419
|
"Whether the line item quantity is fixed and cannot be changed.\n\nDefault: `false`"
|
|
2410
2420
|
).optional(),
|
|
2411
|
-
consentRequiredPaymentPolicy: z.string().describe(
|
|
2421
|
+
consentRequiredPaymentPolicy: /* @__PURE__ */ z.string().describe(
|
|
2412
2422
|
"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."
|
|
2413
2423
|
).min(1).max(1e3).optional().nullable(),
|
|
2414
|
-
savePaymentMethod: z.boolean().describe(
|
|
2424
|
+
savePaymentMethod: /* @__PURE__ */ z.boolean().describe(
|
|
2415
2425
|
"Whether to save the payment method on the order.\n\nDefault: `false`"
|
|
2416
2426
|
).optional(),
|
|
2417
|
-
policies: z.array(
|
|
2418
|
-
z.object({
|
|
2419
|
-
title: z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
2420
|
-
content: z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
2427
|
+
policies: /* @__PURE__ */ z.array(
|
|
2428
|
+
/* @__PURE__ */ z.object({
|
|
2429
|
+
title: /* @__PURE__ */ z.string().describe("Policy title - should be translated").min(1).max(29).optional().nullable(),
|
|
2430
|
+
content: /* @__PURE__ */ z.string().describe("Policy content - should be translated").min(1).max(3e3).optional()
|
|
2421
2431
|
})
|
|
2422
2432
|
).max(5).optional(),
|
|
2423
|
-
membersOnly: z.boolean().describe(
|
|
2433
|
+
membersOnly: /* @__PURE__ */ z.boolean().describe(
|
|
2424
2434
|
"Whether the item can only be purchased by site members.\n\nDefault: `false`"
|
|
2425
2435
|
).optional(),
|
|
2426
|
-
taxableAddress: z.intersection(
|
|
2427
|
-
z.object({}),
|
|
2428
|
-
z.xor([
|
|
2429
|
-
z.object({
|
|
2430
|
-
|
|
2431
|
-
|
|
2436
|
+
taxableAddress: /* @__PURE__ */ z.intersection(
|
|
2437
|
+
/* @__PURE__ */ z.object({}),
|
|
2438
|
+
/* @__PURE__ */ z.xor([
|
|
2439
|
+
/* @__PURE__ */ z.object({
|
|
2440
|
+
addressType: /* @__PURE__ */ z.never().optional()
|
|
2441
|
+
}),
|
|
2442
|
+
/* @__PURE__ */ z.object({
|
|
2443
|
+
addressType: /* @__PURE__ */ z.enum(["BUSINESS", "BILLING", "SHIPPING"]).describe(
|
|
2432
2444
|
"taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly."
|
|
2433
2445
|
)
|
|
2434
2446
|
})
|
|
2435
2447
|
])
|
|
2436
2448
|
).describe("Address to use for tax calculation purposes.").optional(),
|
|
2437
|
-
modifierGroups: z.array(
|
|
2438
|
-
z.object({
|
|
2439
|
-
_id: z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
2440
|
-
name: z.object({
|
|
2441
|
-
original: z.string().describe(
|
|
2449
|
+
modifierGroups: /* @__PURE__ */ z.array(
|
|
2450
|
+
/* @__PURE__ */ z.object({
|
|
2451
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier group ID.").min(1).max(36).optional(),
|
|
2452
|
+
name: /* @__PURE__ */ z.object({
|
|
2453
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2442
2454
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2443
2455
|
).min(1).max(200).optional(),
|
|
2444
|
-
translated: z.string().describe(
|
|
2456
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2445
2457
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2446
2458
|
).min(1).max(400).optional().nullable()
|
|
2447
2459
|
}).describe("Modifier group name.").optional(),
|
|
2448
|
-
modifiers: z.array(
|
|
2449
|
-
z.object({
|
|
2450
|
-
_id: z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
2451
|
-
quantity: z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
2452
|
-
label: z.object({
|
|
2453
|
-
original: z.string().describe(
|
|
2460
|
+
modifiers: /* @__PURE__ */ z.array(
|
|
2461
|
+
/* @__PURE__ */ z.object({
|
|
2462
|
+
_id: /* @__PURE__ */ z.string().describe("Modifier ID.").min(1).max(36).optional(),
|
|
2463
|
+
quantity: /* @__PURE__ */ z.number().int().describe("The quantity of this modifier.").min(1).max(1e5).optional().nullable(),
|
|
2464
|
+
label: /* @__PURE__ */ z.object({
|
|
2465
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2454
2466
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2455
2467
|
).min(1).max(200).optional(),
|
|
2456
|
-
translated: z.string().describe(
|
|
2468
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2457
2469
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2458
2470
|
).min(1).max(400).optional().nullable()
|
|
2459
2471
|
}).describe("Primary display label for the modifier.").optional(),
|
|
2460
|
-
details: z.object({
|
|
2461
|
-
original: z.string().describe(
|
|
2472
|
+
details: /* @__PURE__ */ z.object({
|
|
2473
|
+
original: /* @__PURE__ */ z.string().describe(
|
|
2462
2474
|
"__Required.__ String in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).\n\nMin: 1 character.\nMax: 200 characters."
|
|
2463
2475
|
).min(1).max(200).optional(),
|
|
2464
|
-
translated: z.string().describe(
|
|
2476
|
+
translated: /* @__PURE__ */ z.string().describe(
|
|
2465
2477
|
"String translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."
|
|
2466
2478
|
).min(1).max(400).optional().nullable()
|
|
2467
2479
|
}).describe("Additional details.").optional(),
|
|
2468
|
-
price: z.string().describe("The price of the modifier.").optional().nullable()
|
|
2480
|
+
price: /* @__PURE__ */ z.string().describe("The price of the modifier.").optional().nullable()
|
|
2469
2481
|
})
|
|
2470
2482
|
).min(1).max(25).optional()
|
|
2471
2483
|
})
|
|
2472
2484
|
).max(25).optional()
|
|
2473
2485
|
})
|
|
2474
2486
|
).max(300).optional(),
|
|
2475
|
-
couponCode: z.string().describe(
|
|
2487
|
+
couponCode: /* @__PURE__ */ z.string().describe(
|
|
2476
2488
|
"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the Coupons API."
|
|
2477
2489
|
).optional().nullable(),
|
|
2478
|
-
customContentReference: z.object({
|
|
2479
|
-
appId: z.string().describe(
|
|
2490
|
+
customContentReference: /* @__PURE__ */ z.object({
|
|
2491
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2480
2492
|
"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
2481
2493
|
).regex(
|
|
2482
2494
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2483
2495
|
"Must be a valid GUID"
|
|
2484
2496
|
).optional(),
|
|
2485
|
-
componentId: z.string().describe(
|
|
2497
|
+
componentId: /* @__PURE__ */ z.string().describe(
|
|
2486
2498
|
"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/)."
|
|
2487
2499
|
).regex(
|
|
2488
2500
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -2491,14 +2503,14 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2491
2503
|
}).describe(
|
|
2492
2504
|
'Reference IDs for the app and component providing custom checkout page content.\n\nTo access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".\nLearn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).'
|
|
2493
2505
|
).optional(),
|
|
2494
|
-
externalReference: z.object({
|
|
2495
|
-
appId: z.string().describe(
|
|
2506
|
+
externalReference: /* @__PURE__ */ z.object({
|
|
2507
|
+
appId: /* @__PURE__ */ z.string().describe(
|
|
2496
2508
|
"ID of the app associated with the purchase flow.\nFor example, the Wix Pay Links app ID."
|
|
2497
2509
|
).regex(
|
|
2498
2510
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2499
2511
|
"Must be a valid GUID"
|
|
2500
2512
|
).optional(),
|
|
2501
|
-
resourceId: z.string().describe(
|
|
2513
|
+
resourceId: /* @__PURE__ */ z.string().describe(
|
|
2502
2514
|
"Reference to an external resource ID. Used to link the purchase flow to a specific entity in an external system.\nFor example, a Wix Pay Link ID."
|
|
2503
2515
|
).min(1).max(100).optional().nullable()
|
|
2504
2516
|
}).describe(
|
|
@@ -2506,36 +2518,36 @@ var QueryCheckoutTemplatesResponse = /* @__PURE__ */ z.object({
|
|
|
2506
2518
|
).optional()
|
|
2507
2519
|
})
|
|
2508
2520
|
).optional(),
|
|
2509
|
-
pagingMetadata: z.object({
|
|
2510
|
-
count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2511
|
-
cursors: z.object({
|
|
2512
|
-
next: z.string().describe("Cursor pointing to next page in the list of results.").optional().nullable(),
|
|
2513
|
-
prev: z.string().describe(
|
|
2521
|
+
pagingMetadata: /* @__PURE__ */ z.object({
|
|
2522
|
+
count: /* @__PURE__ */ z.number().int().describe("Number of items returned in the response.").optional().nullable(),
|
|
2523
|
+
cursors: /* @__PURE__ */ z.object({
|
|
2524
|
+
next: /* @__PURE__ */ z.string().describe("Cursor pointing to next page in the list of results.").optional().nullable(),
|
|
2525
|
+
prev: /* @__PURE__ */ z.string().describe(
|
|
2514
2526
|
"Cursor pointing to previous page in the list of results."
|
|
2515
2527
|
).optional().nullable()
|
|
2516
2528
|
}).describe("Offset that was requested.").optional(),
|
|
2517
|
-
hasNext: z.boolean().describe(
|
|
2529
|
+
hasNext: /* @__PURE__ */ z.boolean().describe(
|
|
2518
2530
|
"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page."
|
|
2519
2531
|
).optional().nullable()
|
|
2520
2532
|
}).describe("Paging metadata.").optional()
|
|
2521
2533
|
});
|
|
2522
2534
|
var CreateCheckoutFromTemplateRequest = /* @__PURE__ */ z.object({
|
|
2523
|
-
checkoutTemplateId: z.string().describe("ID of the checkout template to use to create a checkout from.").regex(
|
|
2535
|
+
checkoutTemplateId: /* @__PURE__ */ z.string().describe("ID of the checkout template to use to create a checkout from.").regex(
|
|
2524
2536
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2525
2537
|
"Must be a valid GUID"
|
|
2526
2538
|
),
|
|
2527
|
-
siteId: z.string().describe("ID of the site associated with the checkout template.").regex(
|
|
2539
|
+
siteId: /* @__PURE__ */ z.string().describe("ID of the site associated with the checkout template.").regex(
|
|
2528
2540
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2529
2541
|
"Must be a valid GUID"
|
|
2530
2542
|
)
|
|
2531
2543
|
});
|
|
2532
2544
|
var CreateCheckoutFromTemplateResponse = /* @__PURE__ */ z.object({
|
|
2533
|
-
checkoutId: z.string().describe("ID of the created checkout.").regex(
|
|
2545
|
+
checkoutId: /* @__PURE__ */ z.string().describe("ID of the created checkout.").regex(
|
|
2534
2546
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2535
2547
|
"Must be a valid GUID"
|
|
2536
2548
|
).optional(),
|
|
2537
|
-
checkoutUrl: z.string().describe("URL of the created checkout page.").optional(),
|
|
2538
|
-
purchaseFlowId: z.string().describe(
|
|
2549
|
+
checkoutUrl: /* @__PURE__ */ z.string().describe("URL of the created checkout page.").optional(),
|
|
2550
|
+
purchaseFlowId: /* @__PURE__ */ z.string().describe(
|
|
2539
2551
|
"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."
|
|
2540
2552
|
).regex(
|
|
2541
2553
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
@@ -2543,20 +2555,23 @@ var CreateCheckoutFromTemplateResponse = /* @__PURE__ */ z.object({
|
|
|
2543
2555
|
).optional().nullable()
|
|
2544
2556
|
});
|
|
2545
2557
|
var CreateAndRedirectToCheckoutRequest = /* @__PURE__ */ z.object({
|
|
2546
|
-
checkoutTemplateId: z.string().describe("ID of the checkout template to use to create a checkout.").regex(
|
|
2558
|
+
checkoutTemplateId: /* @__PURE__ */ z.string().describe("ID of the checkout template to use to create a checkout.").regex(
|
|
2547
2559
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2548
2560
|
"Must be a valid GUID"
|
|
2549
2561
|
),
|
|
2550
|
-
siteId: z.string().describe("ID of the site associated with the checkout template.").regex(
|
|
2562
|
+
siteId: /* @__PURE__ */ z.string().describe("ID of the site associated with the checkout template.").regex(
|
|
2551
2563
|
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2552
2564
|
"Must be a valid GUID"
|
|
2553
2565
|
)
|
|
2554
2566
|
});
|
|
2555
2567
|
var CreateAndRedirectToCheckoutResponse = /* @__PURE__ */ z.object({
|
|
2556
|
-
body: z.string().optional(),
|
|
2557
|
-
statusCode: z.number().int().optional().nullable(),
|
|
2558
|
-
headers: z.array(
|
|
2559
|
-
|
|
2568
|
+
body: /* @__PURE__ */ z.string().optional(),
|
|
2569
|
+
statusCode: /* @__PURE__ */ z.number().int().optional().nullable(),
|
|
2570
|
+
headers: /* @__PURE__ */ z.array(
|
|
2571
|
+
/* @__PURE__ */ z.object({
|
|
2572
|
+
key: /* @__PURE__ */ z.string().optional(),
|
|
2573
|
+
value: /* @__PURE__ */ z.string().optional()
|
|
2574
|
+
})
|
|
2560
2575
|
).optional()
|
|
2561
2576
|
});
|
|
2562
2577
|
// Annotate the CommonJS export names for ESM import in node:
|