@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.61

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.
@@ -57,15 +57,17 @@ var CreateOrderPaymentRequestRequest = z.object({
57
57
  "Must be a valid GUID"
58
58
  ).optional().nullable(),
59
59
  source: z.object({
60
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
60
+ appId: z.string().describe(
61
+ "ID of the app that created the order payment request."
62
+ ).regex(
61
63
  /^[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}$/,
62
64
  "Must be a valid GUID"
63
65
  ).min(1).max(100).optional().nullable(),
64
66
  externalId: z.string().describe(
65
- "Reference to an ID from an external system, indicating the original source of the order payment request."
67
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
66
68
  ).min(1).max(100).optional()
67
69
  }).describe(
68
- "Additional parameters to identify the source of the order payment request."
70
+ "Details about the source that created the order payment request."
69
71
  ).optional(),
70
72
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
71
73
  orderId: z.string().describe("Order ID.").regex(
@@ -80,30 +82,32 @@ var CreateOrderPaymentRequestRequest = z.object({
80
82
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
81
83
  ),
82
84
  currency: z.string().describe(
83
- "Currency code. The value will always match the currency used in the order."
85
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
84
86
  ).optional(),
85
87
  paymentGatewayOrderId: z.string().describe(
86
- "Payment gateway order id which is associated with this payment request"
88
+ "Payment gateway order ID associated with this payment request."
87
89
  ).min(1).max(100).optional().nullable(),
88
- title: z.string().describe(
89
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
90
- ).min(1).max(200),
90
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200),
91
91
  description: z.string().describe(
92
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
92
+ "Description displayed to the customer on the payment page."
93
93
  ).max(300).optional().nullable(),
94
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
94
+ expirationDate: z.date().describe(
95
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
96
+ ).optional().nullable(),
95
97
  extendedFields: z.object({
96
98
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
97
99
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
98
100
  ).optional()
99
101
  }).describe(
100
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
102
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
101
103
  ).optional(),
102
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
103
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
104
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
105
+ _updatedDate: z.date().describe(
106
+ "Date and time the order payment request was last updated."
107
+ ).optional().nullable(),
104
108
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
105
109
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
106
- }).describe("OrderPaymentRequest to be created.").optional()
110
+ }).describe("Order payment request to create.").optional()
107
111
  }).optional()
108
112
  });
109
113
  var CreateOrderPaymentRequestResponse = z.object({
@@ -112,15 +116,15 @@ var CreateOrderPaymentRequestResponse = z.object({
112
116
  "Must be a valid GUID"
113
117
  ).optional().nullable(),
114
118
  source: z.object({
115
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
119
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
116
120
  /^[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}$/,
117
121
  "Must be a valid GUID"
118
122
  ).min(1).max(100).optional().nullable(),
119
123
  externalId: z.string().describe(
120
- "Reference to an ID from an external system, indicating the original source of the order payment request."
124
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
121
125
  ).min(1).max(100).optional()
122
126
  }).describe(
123
- "Additional parameters to identify the source of the order payment request."
127
+ "Details about the source that created the order payment request."
124
128
  ).optional(),
125
129
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
126
130
  "Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided."
@@ -137,32 +141,28 @@ var CreateOrderPaymentRequestResponse = z.object({
137
141
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
138
142
  ).optional(),
139
143
  currency: z.string().describe(
140
- "Currency code. The value will always match the currency used in the order."
144
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
141
145
  ).optional(),
142
- paymentGatewayOrderId: z.string().describe(
143
- "Payment gateway order id which is associated with this payment request"
144
- ).min(1).max(100).optional().nullable(),
145
- title: z.string().describe(
146
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
147
- ).min(1).max(200).optional(),
148
- description: z.string().describe(
149
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
150
- ).max(300).optional().nullable(),
151
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
146
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
147
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
148
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
149
+ expirationDate: z.date().describe(
150
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
151
+ ).optional().nullable(),
152
152
  extendedFields: z.object({
153
153
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
154
154
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
155
155
  ).optional()
156
156
  }).describe(
157
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
157
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
158
158
  ).optional(),
159
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
160
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
159
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
160
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
161
161
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
162
162
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
163
163
  });
164
164
  var GetOrderPaymentRequestRequest = z.object({
165
- orderPaymentRequestId: z.string().describe("ID of the OrderPaymentRequest to retrieve.").regex(
165
+ orderPaymentRequestId: z.string().describe("ID of the order payment request to retrieve.").regex(
166
166
  /^[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}$/,
167
167
  "Must be a valid GUID"
168
168
  )
@@ -173,15 +173,15 @@ var GetOrderPaymentRequestResponse = z.object({
173
173
  "Must be a valid GUID"
174
174
  ).optional().nullable(),
175
175
  source: z.object({
176
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
176
+ appId: z.string().describe("ID of the app that created the order payment request.").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
  ).min(1).max(100).optional().nullable(),
180
180
  externalId: z.string().describe(
181
- "Reference to an ID from an external system, indicating the original source of the order payment request."
181
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
182
182
  ).min(1).max(100).optional()
183
183
  }).describe(
184
- "Additional parameters to identify the source of the order payment request."
184
+ "Details about the source that created the order payment request."
185
185
  ).optional(),
186
186
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
187
187
  "Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided."
@@ -198,27 +198,23 @@ var GetOrderPaymentRequestResponse = z.object({
198
198
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
199
199
  ).optional(),
200
200
  currency: z.string().describe(
201
- "Currency code. The value will always match the currency used in the order."
201
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
202
202
  ).optional(),
203
- paymentGatewayOrderId: z.string().describe(
204
- "Payment gateway order id which is associated with this payment request"
205
- ).min(1).max(100).optional().nullable(),
206
- title: z.string().describe(
207
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
208
- ).min(1).max(200).optional(),
209
- description: z.string().describe(
210
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
211
- ).max(300).optional().nullable(),
212
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
203
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
204
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
205
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
206
+ expirationDate: z.date().describe(
207
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
208
+ ).optional().nullable(),
213
209
  extendedFields: z.object({
214
210
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
215
211
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
216
212
  ).optional()
217
213
  }).describe(
218
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
214
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
219
215
  ).optional(),
220
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
221
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
216
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
217
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
222
218
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
223
219
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
224
220
  });
@@ -233,15 +229,15 @@ var UpdateOrderPaymentRequestRequest = z.object({
233
229
  "Must be a valid GUID"
234
230
  ).optional().nullable(),
235
231
  source: z.object({
236
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
232
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
237
233
  /^[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}$/,
238
234
  "Must be a valid GUID"
239
235
  ).min(1).max(100).optional().nullable(),
240
236
  externalId: z.string().describe(
241
- "Reference to an ID from an external system, indicating the original source of the order payment request."
237
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
242
238
  ).min(1).max(100).optional()
243
239
  }).describe(
244
- "Additional parameters to identify the source of the order payment request."
240
+ "Details about the source that created the order payment request."
245
241
  ).optional(),
246
242
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
247
243
  orderId: z.string().describe("Order ID.").regex(
@@ -256,30 +252,28 @@ var UpdateOrderPaymentRequestRequest = z.object({
256
252
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
257
253
  ).optional(),
258
254
  currency: z.string().describe(
259
- "Currency code. The value will always match the currency used in the order."
255
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
260
256
  ).optional(),
261
257
  paymentGatewayOrderId: z.string().describe(
262
- "Payment gateway order id which is associated with this payment request"
258
+ "Payment gateway order ID associated with this payment request."
263
259
  ).min(1).max(100).optional().nullable(),
264
- title: z.string().describe(
265
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
266
- ).min(1).max(200).optional(),
267
- description: z.string().describe(
268
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
269
- ).max(300).optional().nullable(),
270
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
260
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
261
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
262
+ expirationDate: z.date().describe(
263
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
264
+ ).optional().nullable(),
271
265
  extendedFields: z.object({
272
266
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
273
267
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
274
268
  ).optional()
275
269
  }).describe(
276
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
270
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
277
271
  ).optional(),
278
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
279
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
272
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
273
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
280
274
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
281
275
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
282
- }).describe("OrderPaymentRequest to be updated, may be partial.")
276
+ }).describe("Order payment request to update.")
283
277
  });
284
278
  var UpdateOrderPaymentRequestResponse = z.object({
285
279
  _id: z.string().describe("Order payment request ID.").regex(
@@ -287,15 +281,15 @@ var UpdateOrderPaymentRequestResponse = z.object({
287
281
  "Must be a valid GUID"
288
282
  ).optional().nullable(),
289
283
  source: z.object({
290
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
284
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
291
285
  /^[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}$/,
292
286
  "Must be a valid GUID"
293
287
  ).min(1).max(100).optional().nullable(),
294
288
  externalId: z.string().describe(
295
- "Reference to an ID from an external system, indicating the original source of the order payment request."
289
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
296
290
  ).min(1).max(100).optional()
297
291
  }).describe(
298
- "Additional parameters to identify the source of the order payment request."
292
+ "Details about the source that created the order payment request."
299
293
  ).optional(),
300
294
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
301
295
  "Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided."
@@ -312,32 +306,28 @@ var UpdateOrderPaymentRequestResponse = z.object({
312
306
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
313
307
  ).optional(),
314
308
  currency: z.string().describe(
315
- "Currency code. The value will always match the currency used in the order."
309
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
316
310
  ).optional(),
317
- paymentGatewayOrderId: z.string().describe(
318
- "Payment gateway order id which is associated with this payment request"
319
- ).min(1).max(100).optional().nullable(),
320
- title: z.string().describe(
321
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
322
- ).min(1).max(200).optional(),
323
- description: z.string().describe(
324
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
325
- ).max(300).optional().nullable(),
326
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
311
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
312
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
313
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
314
+ expirationDate: z.date().describe(
315
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
316
+ ).optional().nullable(),
327
317
  extendedFields: z.object({
328
318
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
329
319
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
330
320
  ).optional()
331
321
  }).describe(
332
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
322
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
333
323
  ).optional(),
334
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
335
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
324
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
325
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
336
326
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
337
327
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
338
328
  });
339
329
  var DeleteOrderPaymentRequestRequest = z.object({
340
- orderPaymentRequestId: z.string().describe("Id of the OrderPaymentRequest to delete.").regex(
330
+ orderPaymentRequestId: z.string().describe("ID of the order payment request to delete.").regex(
341
331
  /^[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}$/,
342
332
  "Must be a valid GUID"
343
333
  )
@@ -379,15 +369,15 @@ var QueryOrderPaymentRequestsResponse = z.object({
379
369
  "Must be a valid GUID"
380
370
  ).optional().nullable(),
381
371
  source: z.object({
382
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
372
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
383
373
  /^[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}$/,
384
374
  "Must be a valid GUID"
385
375
  ).min(1).max(100).optional().nullable(),
386
376
  externalId: z.string().describe(
387
- "Reference to an ID from an external system, indicating the original source of the order payment request."
377
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
388
378
  ).min(1).max(100).optional()
389
379
  }).describe(
390
- "Additional parameters to identify the source of the order payment request."
380
+ "Details about the source that created the order payment request."
391
381
  ).optional(),
392
382
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
393
383
  "Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided."
@@ -404,27 +394,27 @@ var QueryOrderPaymentRequestsResponse = z.object({
404
394
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
405
395
  ).optional(),
406
396
  currency: z.string().describe(
407
- "Currency code. The value will always match the currency used in the order."
397
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
408
398
  ).optional(),
409
399
  paymentGatewayOrderId: z.string().describe(
410
- "Payment gateway order id which is associated with this payment request"
400
+ "Payment gateway order ID associated with this payment request."
411
401
  ).min(1).max(100).optional().nullable(),
412
- title: z.string().describe(
413
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
414
- ).min(1).max(200).optional(),
402
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
415
403
  description: z.string().describe(
416
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
404
+ "Description displayed to the customer on the payment page."
417
405
  ).max(300).optional().nullable(),
418
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
406
+ expirationDate: z.date().describe(
407
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
408
+ ).optional().nullable(),
419
409
  extendedFields: z.object({
420
410
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
421
411
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
422
412
  ).optional()
423
413
  }).describe(
424
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
414
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
425
415
  ).optional(),
426
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
427
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
416
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
417
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
428
418
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
429
419
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
430
420
  })
@@ -444,16 +434,16 @@ var QueryOrderPaymentRequestsResponse = z.object({
444
434
  hasNext: z.boolean().describe(
445
435
  "Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."
446
436
  ).optional().nullable()
447
- }).describe("Paging metadata").optional()
437
+ }).describe("Paging metadata.").optional()
448
438
  });
449
439
  var GetOrderPaymentRequestUrlRequest = z.object({
450
- orderPaymentRequestId: z.string().describe("Order Payment Request ID.").regex(
440
+ orderPaymentRequestId: z.string().describe("ID of the order payment request.").regex(
451
441
  /^[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}$/,
452
442
  "Must be a valid GUID"
453
443
  )
454
444
  });
455
445
  var GetOrderPaymentRequestUrlResponse = z.object({
456
- orderPaymentRequestUrl: z.string().describe("Order Payment Request URL.").min(1).max(100).optional()
446
+ orderPaymentRequestUrl: z.string().describe("Payment page URL for the order payment request.").min(1).max(100).optional()
457
447
  });
458
448
  var UpdateExtendedFieldsRequest = z.object({
459
449
  _id: z.string().describe("ID of the entity to update."),
@@ -473,15 +463,15 @@ var UpdateExtendedFieldsResponse = z.object({
473
463
  "Must be a valid GUID"
474
464
  ).optional().nullable(),
475
465
  source: z.object({
476
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
466
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
477
467
  /^[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}$/,
478
468
  "Must be a valid GUID"
479
469
  ).min(1).max(100).optional().nullable(),
480
470
  externalId: z.string().describe(
481
- "Reference to an ID from an external system, indicating the original source of the order payment request."
471
+ "Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID."
482
472
  ).min(1).max(100).optional()
483
473
  }).describe(
484
- "Additional parameters to identify the source of the order payment request."
474
+ "Details about the source that created the order payment request."
485
475
  ).optional(),
486
476
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
487
477
  "Payment request status. Set by the system. A new order payment request starts as `UNPAID`, unless `expirationDate` is already in the past at creation time, in which case it is created as `EXPIRED`. The system sets the status to `PAID` once payment is collected, `EXPIRED` when the expiration date passes, or `VOIDED` when the request is voided."
@@ -498,30 +488,28 @@ var UpdateExtendedFieldsResponse = z.object({
498
488
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
499
489
  ).optional(),
500
490
  currency: z.string().describe(
501
- "Currency code. The value will always match the currency used in the order."
491
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
502
492
  ).optional(),
503
493
  paymentGatewayOrderId: z.string().describe(
504
- "Payment gateway order id which is associated with this payment request"
494
+ "Payment gateway order ID associated with this payment request."
505
495
  ).min(1).max(100).optional().nullable(),
506
- title: z.string().describe(
507
- "Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for."
508
- ).min(1).max(200).optional(),
509
- description: z.string().describe(
510
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
511
- ).max(300).optional().nullable(),
512
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
496
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
497
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
498
+ expirationDate: z.date().describe(
499
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
500
+ ).optional().nullable(),
513
501
  extendedFields: z.object({
514
502
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
515
503
  "Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
516
504
  ).optional()
517
505
  }).describe(
518
- "[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls."
506
+ "Custom field data for this order payment request.\n\n[Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls."
519
507
  ).optional(),
520
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
521
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
508
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
509
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
522
510
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
523
511
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
524
- }).describe("Updated OrderPaymentRequest.").optional()
512
+ }).describe("Updated order payment request.").optional()
525
513
  });
526
514
  // Annotate the CommonJS export names for ESM import in node:
527
515
  0 && (module.exports = {