@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.
@@ -8,15 +8,17 @@ var CreateOrderPaymentRequestRequest = z.object({
8
8
  "Must be a valid GUID"
9
9
  ).optional().nullable(),
10
10
  source: z.object({
11
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
11
+ appId: z.string().describe(
12
+ "ID of the app that created the order payment request."
13
+ ).regex(
12
14
  /^[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}$/,
13
15
  "Must be a valid GUID"
14
16
  ).min(1).max(100).optional().nullable(),
15
17
  externalId: z.string().describe(
16
- "Reference to an ID from an external system, indicating the original source of the order payment request."
18
+ "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."
17
19
  ).min(1).max(100).optional()
18
20
  }).describe(
19
- "Additional parameters to identify the source of the order payment request."
21
+ "Details about the source that created the order payment request."
20
22
  ).optional(),
21
23
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
22
24
  orderId: z.string().describe("Order ID.").regex(
@@ -31,30 +33,32 @@ var CreateOrderPaymentRequestRequest = z.object({
31
33
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
32
34
  ),
33
35
  currency: z.string().describe(
34
- "Currency code. The value will always match the currency used in the order."
36
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
35
37
  ).optional(),
36
38
  paymentGatewayOrderId: z.string().describe(
37
- "Payment gateway order id which is associated with this payment request"
39
+ "Payment gateway order ID associated with this payment request."
38
40
  ).min(1).max(100).optional().nullable(),
39
- title: z.string().describe(
40
- "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."
41
- ).min(1).max(200),
41
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200),
42
42
  description: z.string().describe(
43
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
43
+ "Description displayed to the customer on the payment page."
44
44
  ).max(300).optional().nullable(),
45
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
45
+ expirationDate: z.date().describe(
46
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
47
+ ).optional().nullable(),
46
48
  extendedFields: z.object({
47
49
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
48
50
  "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)."
49
51
  ).optional()
50
52
  }).describe(
51
- "[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."
53
+ "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."
52
54
  ).optional(),
53
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
54
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
55
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
56
+ _updatedDate: z.date().describe(
57
+ "Date and time the order payment request was last updated."
58
+ ).optional().nullable(),
55
59
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
56
60
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
57
- }).describe("OrderPaymentRequest to be created.").optional()
61
+ }).describe("Order payment request to create.").optional()
58
62
  }).optional()
59
63
  });
60
64
  var CreateOrderPaymentRequestResponse = z.object({
@@ -63,15 +67,15 @@ var CreateOrderPaymentRequestResponse = z.object({
63
67
  "Must be a valid GUID"
64
68
  ).optional().nullable(),
65
69
  source: z.object({
66
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
70
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
67
71
  /^[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}$/,
68
72
  "Must be a valid GUID"
69
73
  ).min(1).max(100).optional().nullable(),
70
74
  externalId: z.string().describe(
71
- "Reference to an ID from an external system, indicating the original source of the order payment request."
75
+ "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."
72
76
  ).min(1).max(100).optional()
73
77
  }).describe(
74
- "Additional parameters to identify the source of the order payment request."
78
+ "Details about the source that created the order payment request."
75
79
  ).optional(),
76
80
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
77
81
  "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."
@@ -88,32 +92,28 @@ var CreateOrderPaymentRequestResponse = z.object({
88
92
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
89
93
  ).optional(),
90
94
  currency: z.string().describe(
91
- "Currency code. The value will always match the currency used in the order."
95
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
92
96
  ).optional(),
93
- paymentGatewayOrderId: z.string().describe(
94
- "Payment gateway order id which is associated with this payment request"
95
- ).min(1).max(100).optional().nullable(),
96
- title: z.string().describe(
97
- "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."
98
- ).min(1).max(200).optional(),
99
- description: z.string().describe(
100
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
101
- ).max(300).optional().nullable(),
102
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
97
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
98
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
99
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
100
+ expirationDate: z.date().describe(
101
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
102
+ ).optional().nullable(),
103
103
  extendedFields: z.object({
104
104
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
105
105
  "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)."
106
106
  ).optional()
107
107
  }).describe(
108
- "[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."
108
+ "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."
109
109
  ).optional(),
110
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
111
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
110
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
111
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
112
112
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
113
113
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
114
114
  });
115
115
  var GetOrderPaymentRequestRequest = z.object({
116
- orderPaymentRequestId: z.string().describe("ID of the OrderPaymentRequest to retrieve.").regex(
116
+ orderPaymentRequestId: z.string().describe("ID of the order payment request to retrieve.").regex(
117
117
  /^[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}$/,
118
118
  "Must be a valid GUID"
119
119
  )
@@ -124,15 +124,15 @@ var GetOrderPaymentRequestResponse = z.object({
124
124
  "Must be a valid GUID"
125
125
  ).optional().nullable(),
126
126
  source: z.object({
127
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
127
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
128
128
  /^[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}$/,
129
129
  "Must be a valid GUID"
130
130
  ).min(1).max(100).optional().nullable(),
131
131
  externalId: z.string().describe(
132
- "Reference to an ID from an external system, indicating the original source of the order payment request."
132
+ "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."
133
133
  ).min(1).max(100).optional()
134
134
  }).describe(
135
- "Additional parameters to identify the source of the order payment request."
135
+ "Details about the source that created the order payment request."
136
136
  ).optional(),
137
137
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
138
138
  "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."
@@ -149,27 +149,23 @@ var GetOrderPaymentRequestResponse = z.object({
149
149
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
150
150
  ).optional(),
151
151
  currency: z.string().describe(
152
- "Currency code. The value will always match the currency used in the order."
152
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
153
153
  ).optional(),
154
- paymentGatewayOrderId: z.string().describe(
155
- "Payment gateway order id which is associated with this payment request"
156
- ).min(1).max(100).optional().nullable(),
157
- title: z.string().describe(
158
- "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."
159
- ).min(1).max(200).optional(),
160
- description: z.string().describe(
161
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
162
- ).max(300).optional().nullable(),
163
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
154
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
155
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
156
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
157
+ expirationDate: z.date().describe(
158
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
159
+ ).optional().nullable(),
164
160
  extendedFields: z.object({
165
161
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
166
162
  "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)."
167
163
  ).optional()
168
164
  }).describe(
169
- "[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."
165
+ "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."
170
166
  ).optional(),
171
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
172
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
167
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
168
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
173
169
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
174
170
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
175
171
  });
@@ -184,15 +180,15 @@ var UpdateOrderPaymentRequestRequest = z.object({
184
180
  "Must be a valid GUID"
185
181
  ).optional().nullable(),
186
182
  source: z.object({
187
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
183
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
188
184
  /^[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}$/,
189
185
  "Must be a valid GUID"
190
186
  ).min(1).max(100).optional().nullable(),
191
187
  externalId: z.string().describe(
192
- "Reference to an ID from an external system, indicating the original source of the order payment request."
188
+ "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."
193
189
  ).min(1).max(100).optional()
194
190
  }).describe(
195
- "Additional parameters to identify the source of the order payment request."
191
+ "Details about the source that created the order payment request."
196
192
  ).optional(),
197
193
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
198
194
  orderId: z.string().describe("Order ID.").regex(
@@ -207,30 +203,28 @@ var UpdateOrderPaymentRequestRequest = z.object({
207
203
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
208
204
  ).optional(),
209
205
  currency: z.string().describe(
210
- "Currency code. The value will always match the currency used in the order."
206
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
211
207
  ).optional(),
212
208
  paymentGatewayOrderId: z.string().describe(
213
- "Payment gateway order id which is associated with this payment request"
209
+ "Payment gateway order ID associated with this payment request."
214
210
  ).min(1).max(100).optional().nullable(),
215
- title: z.string().describe(
216
- "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."
217
- ).min(1).max(200).optional(),
218
- description: z.string().describe(
219
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
220
- ).max(300).optional().nullable(),
221
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
211
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
212
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
213
+ expirationDate: z.date().describe(
214
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
215
+ ).optional().nullable(),
222
216
  extendedFields: z.object({
223
217
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
224
218
  "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)."
225
219
  ).optional()
226
220
  }).describe(
227
- "[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."
221
+ "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."
228
222
  ).optional(),
229
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
230
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
223
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
224
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
231
225
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
232
226
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
233
- }).describe("OrderPaymentRequest to be updated, may be partial.")
227
+ }).describe("Order payment request to update.")
234
228
  });
235
229
  var UpdateOrderPaymentRequestResponse = z.object({
236
230
  _id: z.string().describe("Order payment request ID.").regex(
@@ -238,15 +232,15 @@ var UpdateOrderPaymentRequestResponse = z.object({
238
232
  "Must be a valid GUID"
239
233
  ).optional().nullable(),
240
234
  source: z.object({
241
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
235
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
242
236
  /^[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}$/,
243
237
  "Must be a valid GUID"
244
238
  ).min(1).max(100).optional().nullable(),
245
239
  externalId: z.string().describe(
246
- "Reference to an ID from an external system, indicating the original source of the order payment request."
240
+ "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."
247
241
  ).min(1).max(100).optional()
248
242
  }).describe(
249
- "Additional parameters to identify the source of the order payment request."
243
+ "Details about the source that created the order payment request."
250
244
  ).optional(),
251
245
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
252
246
  "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."
@@ -263,32 +257,28 @@ var UpdateOrderPaymentRequestResponse = z.object({
263
257
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
264
258
  ).optional(),
265
259
  currency: z.string().describe(
266
- "Currency code. The value will always match the currency used in the order."
260
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
267
261
  ).optional(),
268
- paymentGatewayOrderId: z.string().describe(
269
- "Payment gateway order id which is associated with this payment request"
270
- ).min(1).max(100).optional().nullable(),
271
- title: z.string().describe(
272
- "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."
273
- ).min(1).max(200).optional(),
274
- description: z.string().describe(
275
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
276
- ).max(300).optional().nullable(),
277
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
262
+ paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
263
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
264
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
265
+ expirationDate: z.date().describe(
266
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
267
+ ).optional().nullable(),
278
268
  extendedFields: z.object({
279
269
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
280
270
  "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)."
281
271
  ).optional()
282
272
  }).describe(
283
- "[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."
273
+ "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."
284
274
  ).optional(),
285
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
286
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
275
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
276
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
287
277
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
288
278
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
289
279
  });
290
280
  var DeleteOrderPaymentRequestRequest = z.object({
291
- orderPaymentRequestId: z.string().describe("Id of the OrderPaymentRequest to delete.").regex(
281
+ orderPaymentRequestId: z.string().describe("ID of the order payment request to delete.").regex(
292
282
  /^[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}$/,
293
283
  "Must be a valid GUID"
294
284
  )
@@ -330,15 +320,15 @@ var QueryOrderPaymentRequestsResponse = z.object({
330
320
  "Must be a valid GUID"
331
321
  ).optional().nullable(),
332
322
  source: z.object({
333
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
323
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
334
324
  /^[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}$/,
335
325
  "Must be a valid GUID"
336
326
  ).min(1).max(100).optional().nullable(),
337
327
  externalId: z.string().describe(
338
- "Reference to an ID from an external system, indicating the original source of the order payment request."
328
+ "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."
339
329
  ).min(1).max(100).optional()
340
330
  }).describe(
341
- "Additional parameters to identify the source of the order payment request."
331
+ "Details about the source that created the order payment request."
342
332
  ).optional(),
343
333
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
344
334
  "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."
@@ -355,27 +345,27 @@ var QueryOrderPaymentRequestsResponse = z.object({
355
345
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
356
346
  ).optional(),
357
347
  currency: z.string().describe(
358
- "Currency code. The value will always match the currency used in the order."
348
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
359
349
  ).optional(),
360
350
  paymentGatewayOrderId: z.string().describe(
361
- "Payment gateway order id which is associated with this payment request"
351
+ "Payment gateway order ID associated with this payment request."
362
352
  ).min(1).max(100).optional().nullable(),
363
- title: z.string().describe(
364
- "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."
365
- ).min(1).max(200).optional(),
353
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
366
354
  description: z.string().describe(
367
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
355
+ "Description displayed to the customer on the payment page."
368
356
  ).max(300).optional().nullable(),
369
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
357
+ expirationDate: z.date().describe(
358
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
359
+ ).optional().nullable(),
370
360
  extendedFields: z.object({
371
361
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
372
362
  "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)."
373
363
  ).optional()
374
364
  }).describe(
375
- "[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."
365
+ "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."
376
366
  ).optional(),
377
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
378
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
367
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
368
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
379
369
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
380
370
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
381
371
  })
@@ -395,16 +385,16 @@ var QueryOrderPaymentRequestsResponse = z.object({
395
385
  hasNext: z.boolean().describe(
396
386
  "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."
397
387
  ).optional().nullable()
398
- }).describe("Paging metadata").optional()
388
+ }).describe("Paging metadata.").optional()
399
389
  });
400
390
  var GetOrderPaymentRequestUrlRequest = z.object({
401
- orderPaymentRequestId: z.string().describe("Order Payment Request ID.").regex(
391
+ orderPaymentRequestId: z.string().describe("ID of the order payment request.").regex(
402
392
  /^[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}$/,
403
393
  "Must be a valid GUID"
404
394
  )
405
395
  });
406
396
  var GetOrderPaymentRequestUrlResponse = z.object({
407
- orderPaymentRequestUrl: z.string().describe("Order Payment Request URL.").min(1).max(100).optional()
397
+ orderPaymentRequestUrl: z.string().describe("Payment page URL for the order payment request.").min(1).max(100).optional()
408
398
  });
409
399
  var UpdateExtendedFieldsRequest = z.object({
410
400
  _id: z.string().describe("ID of the entity to update."),
@@ -424,15 +414,15 @@ var UpdateExtendedFieldsResponse = z.object({
424
414
  "Must be a valid GUID"
425
415
  ).optional().nullable(),
426
416
  source: z.object({
427
- appId: z.string().describe("App Def ID that created the order payment request.").regex(
417
+ appId: z.string().describe("ID of the app that created the order payment request.").regex(
428
418
  /^[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
419
  "Must be a valid GUID"
430
420
  ).min(1).max(100).optional().nullable(),
431
421
  externalId: z.string().describe(
432
- "Reference to an ID from an external system, indicating the original source of the order payment request."
422
+ "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."
433
423
  ).min(1).max(100).optional()
434
424
  }).describe(
435
- "Additional parameters to identify the source of the order payment request."
425
+ "Details about the source that created the order payment request."
436
426
  ).optional(),
437
427
  status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
438
428
  "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."
@@ -449,30 +439,28 @@ var UpdateExtendedFieldsResponse = z.object({
449
439
  "Amount to collect. Set when the order payment request is created and can't be changed afterward."
450
440
  ).optional(),
451
441
  currency: z.string().describe(
452
- "Currency code. The value will always match the currency used in the order."
442
+ "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
453
443
  ).optional(),
454
444
  paymentGatewayOrderId: z.string().describe(
455
- "Payment gateway order id which is associated with this payment request"
445
+ "Payment gateway order ID associated with this payment request."
456
446
  ).min(1).max(100).optional().nullable(),
457
- title: z.string().describe(
458
- "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."
459
- ).min(1).max(200).optional(),
460
- description: z.string().describe(
461
- "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
462
- ).max(300).optional().nullable(),
463
- expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
447
+ title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
448
+ description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
449
+ expirationDate: z.date().describe(
450
+ "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
451
+ ).optional().nullable(),
464
452
  extendedFields: z.object({
465
453
  namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
466
454
  "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)."
467
455
  ).optional()
468
456
  }).describe(
469
- "[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."
457
+ "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."
470
458
  ).optional(),
471
- _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
472
- _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
459
+ _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
460
+ _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
473
461
  image: z.string().describe("Image to display to the customer on the payment page.").optional(),
474
462
  blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
475
- }).describe("Updated OrderPaymentRequest.").optional()
463
+ }).describe("Updated order payment request.").optional()
476
464
  });
477
465
  export {
478
466
  CreateOrderPaymentRequestRequest,