@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.62

package/build/internal/cjs/schemas.js

@@ -43,7 +43,9 @@ __export(schemas_exports, {
   UpdateExtendedFieldsRequest: () => UpdateExtendedFieldsRequest,
   UpdateExtendedFieldsResponse: () => UpdateExtendedFieldsResponse,
   UpdateOrderPaymentRequestRequest: () => UpdateOrderPaymentRequestRequest,
-  UpdateOrderPaymentRequestResponse: () => UpdateOrderPaymentRequestResponse
+  UpdateOrderPaymentRequestResponse: () => UpdateOrderPaymentRequestResponse,
+  VoidOrderPaymentRequestRequest: () => VoidOrderPaymentRequestRequest,
+  VoidOrderPaymentRequestResponse: () => VoidOrderPaymentRequestResponse
 });
 module.exports = __toCommonJS(schemas_exports);
 
@@ -57,15 +59,17 @@ var CreateOrderPaymentRequestRequest = z.object({
         "Must be a valid GUID"
       ).optional().nullable(),
       source: z.object({
-        appId: z.string().describe("App Def ID that created the order payment request.").regex(
+        appId: z.string().describe(
+          "ID of the app that created the order payment request."
+        ).regex(
           /^[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}$/,
           "Must be a valid GUID"
         ).min(1).max(100).optional().nullable(),
         externalId: z.string().describe(
-          "Reference to an ID from an external system, indicating the original source of the order payment request."
+          "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."
         ).min(1).max(100).optional()
       }).describe(
-        "Additional parameters to identify the source of the order payment request."
+        "Details about the source that created the order payment request."
       ).optional(),
       status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
       orderId: z.string().describe("Order ID.").regex(
@@ -80,30 +84,32 @@ var CreateOrderPaymentRequestRequest = z.object({
         "Amount to collect. Set when the order payment request is created and can't be changed afterward."
       ),
       currency: z.string().describe(
-        "Currency code. The value will always match the currency used in the order."
+        "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
       ).optional(),
       paymentGatewayOrderId: z.string().describe(
-        "Payment gateway order id which is associated with this payment request"
+        "Payment gateway order ID associated with this payment request."
       ).min(1).max(100).optional().nullable(),
-      title: z.string().describe(
-        "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."
-      ).min(1).max(200),
+      title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200),
       description: z.string().describe(
-        "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
+        "Description displayed to the customer on the payment page."
       ).max(300).optional().nullable(),
-      expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+      expirationDate: z.date().describe(
+        "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+      ).optional().nullable(),
       extendedFields: z.object({
         namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
           "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)."
         ).optional()
       }).describe(
-        "[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."
+        "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."
       ).optional(),
-      _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-      _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+      _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+      _updatedDate: z.date().describe(
+        "Date and time the order payment request was last updated."
+      ).optional().nullable(),
       image: z.string().describe("Image to display to the customer on the payment page.").optional(),
       blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
-    }).describe("OrderPaymentRequest to be created.").optional()
+    }).describe("Order payment request to create.").optional()
   }).optional()
 });
 var CreateOrderPaymentRequestResponse = z.object({
@@ -112,15 +118,15 @@ var CreateOrderPaymentRequestResponse = z.object({
     "Must be a valid GUID"
   ).optional().nullable(),
   source: z.object({
-    appId: z.string().describe("App Def ID that created the order payment request.").regex(
+    appId: z.string().describe("ID of the app that created the order payment request.").regex(
       /^[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}$/,
       "Must be a valid GUID"
     ).min(1).max(100).optional().nullable(),
     externalId: z.string().describe(
-      "Reference to an ID from an external system, indicating the original source of the order payment request."
+      "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."
     ).min(1).max(100).optional()
   }).describe(
-    "Additional parameters to identify the source of the order payment request."
+    "Details about the source that created the order payment request."
   ).optional(),
   status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
     "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 +143,28 @@ var CreateOrderPaymentRequestResponse = z.object({
     "Amount to collect. Set when the order payment request is created and can't be changed afterward."
   ).optional(),
   currency: z.string().describe(
-    "Currency code. The value will always match the currency used in the order."
+    "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
   ).optional(),
-  paymentGatewayOrderId: z.string().describe(
-    "Payment gateway order id which is associated with this payment request"
-  ).min(1).max(100).optional().nullable(),
-  title: z.string().describe(
-    "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."
-  ).min(1).max(200).optional(),
-  description: z.string().describe(
-    "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
-  ).max(300).optional().nullable(),
-  expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+  paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
+  title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
+  description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
+  expirationDate: z.date().describe(
+    "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+  ).optional().nullable(),
   extendedFields: z.object({
     namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
       "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)."
     ).optional()
   }).describe(
-    "[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."
+    "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."
   ).optional(),
-  _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-  _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+  _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
   image: z.string().describe("Image to display to the customer on the payment page.").optional(),
   blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
 });
 var GetOrderPaymentRequestRequest = z.object({
-  orderPaymentRequestId: z.string().describe("ID of the OrderPaymentRequest to retrieve.").regex(
+  orderPaymentRequestId: z.string().describe("ID of the order payment request to retrieve.").regex(
     /^[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}$/,
     "Must be a valid GUID"
   )
@@ -173,15 +175,15 @@ var GetOrderPaymentRequestResponse = z.object({
     "Must be a valid GUID"
   ).optional().nullable(),
   source: z.object({
-    appId: z.string().describe("App Def ID that created the order payment request.").regex(
+    appId: z.string().describe("ID of the app that created the order payment request.").regex(
       /^[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}$/,
       "Must be a valid GUID"
     ).min(1).max(100).optional().nullable(),
     externalId: z.string().describe(
-      "Reference to an ID from an external system, indicating the original source of the order payment request."
+      "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."
     ).min(1).max(100).optional()
   }).describe(
-    "Additional parameters to identify the source of the order payment request."
+    "Details about the source that created the order payment request."
   ).optional(),
   status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
     "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 +200,23 @@ var GetOrderPaymentRequestResponse = z.object({
     "Amount to collect. Set when the order payment request is created and can't be changed afterward."
   ).optional(),
   currency: z.string().describe(
-    "Currency code. The value will always match the currency used in the order."
+    "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
   ).optional(),
-  paymentGatewayOrderId: z.string().describe(
-    "Payment gateway order id which is associated with this payment request"
-  ).min(1).max(100).optional().nullable(),
-  title: z.string().describe(
-    "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."
-  ).min(1).max(200).optional(),
-  description: z.string().describe(
-    "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
-  ).max(300).optional().nullable(),
-  expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+  paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
+  title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
+  description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
+  expirationDate: z.date().describe(
+    "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+  ).optional().nullable(),
   extendedFields: z.object({
     namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
       "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)."
     ).optional()
   }).describe(
-    "[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."
+    "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."
   ).optional(),
-  _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-  _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+  _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
   image: z.string().describe("Image to display to the customer on the payment page.").optional(),
   blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
 });
@@ -233,15 +231,15 @@ var UpdateOrderPaymentRequestRequest = z.object({
       "Must be a valid GUID"
     ).optional().nullable(),
     source: z.object({
-      appId: z.string().describe("App Def ID that created the order payment request.").regex(
+      appId: z.string().describe("ID of the app that created the order payment request.").regex(
         /^[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}$/,
         "Must be a valid GUID"
       ).min(1).max(100).optional().nullable(),
       externalId: z.string().describe(
-        "Reference to an ID from an external system, indicating the original source of the order payment request."
+        "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."
       ).min(1).max(100).optional()
     }).describe(
-      "Additional parameters to identify the source of the order payment request."
+      "Details about the source that created the order payment request."
     ).optional(),
     status: z.enum(["UNPAID", "PAID", "EXPIRED"]).optional(),
     orderId: z.string().describe("Order ID.").regex(
@@ -256,30 +254,28 @@ var UpdateOrderPaymentRequestRequest = z.object({
       "Amount to collect. Set when the order payment request is created and can't be changed afterward."
     ).optional(),
     currency: z.string().describe(
-      "Currency code. The value will always match the currency used in the order."
+      "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
     ).optional(),
     paymentGatewayOrderId: z.string().describe(
-      "Payment gateway order id which is associated with this payment request"
+      "Payment gateway order ID associated with this payment request."
     ).min(1).max(100).optional().nullable(),
-    title: z.string().describe(
-      "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."
-    ).min(1).max(200).optional(),
-    description: z.string().describe(
-      "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
-    ).max(300).optional().nullable(),
-    expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+    title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
+    description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
+    expirationDate: z.date().describe(
+      "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+    ).optional().nullable(),
     extendedFields: z.object({
       namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
         "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)."
       ).optional()
     }).describe(
-      "[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."
+      "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."
     ).optional(),
-    _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-    _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+    _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
     image: z.string().describe("Image to display to the customer on the payment page.").optional(),
     blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
-  }).describe("OrderPaymentRequest to be updated, may be partial.")
+  }).describe("Order payment request to update.")
 });
 var UpdateOrderPaymentRequestResponse = z.object({
   _id: z.string().describe("Order payment request ID.").regex(
@@ -287,15 +283,15 @@ var UpdateOrderPaymentRequestResponse = z.object({
     "Must be a valid GUID"
   ).optional().nullable(),
   source: z.object({
-    appId: z.string().describe("App Def ID that created the order payment request.").regex(
+    appId: z.string().describe("ID of the app that created the order payment request.").regex(
       /^[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}$/,
       "Must be a valid GUID"
     ).min(1).max(100).optional().nullable(),
     externalId: z.string().describe(
-      "Reference to an ID from an external system, indicating the original source of the order payment request."
+      "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."
     ).min(1).max(100).optional()
   }).describe(
-    "Additional parameters to identify the source of the order payment request."
+    "Details about the source that created the order payment request."
   ).optional(),
   status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
     "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 +308,28 @@ var UpdateOrderPaymentRequestResponse = z.object({
     "Amount to collect. Set when the order payment request is created and can't be changed afterward."
   ).optional(),
   currency: z.string().describe(
-    "Currency code. The value will always match the currency used in the order."
+    "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
   ).optional(),
-  paymentGatewayOrderId: z.string().describe(
-    "Payment gateway order id which is associated with this payment request"
-  ).min(1).max(100).optional().nullable(),
-  title: z.string().describe(
-    "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."
-  ).min(1).max(200).optional(),
-  description: z.string().describe(
-    "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
-  ).max(300).optional().nullable(),
-  expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+  paymentGatewayOrderId: z.string().describe("Payment gateway order ID associated with this payment request.").min(1).max(100).optional().nullable(),
+  title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
+  description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
+  expirationDate: z.date().describe(
+    "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+  ).optional().nullable(),
   extendedFields: z.object({
     namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
       "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)."
     ).optional()
   }).describe(
-    "[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."
+    "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."
   ).optional(),
-  _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-  _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+  _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+  _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
   image: z.string().describe("Image to display to the customer on the payment page.").optional(),
   blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
 });
 var DeleteOrderPaymentRequestRequest = z.object({
-  orderPaymentRequestId: z.string().describe("Id of the OrderPaymentRequest to delete.").regex(
+  orderPaymentRequestId: z.string().describe("ID of the order payment request to delete.").regex(
     /^[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}$/,
     "Must be a valid GUID"
   )
@@ -379,15 +371,15 @@ var QueryOrderPaymentRequestsResponse = z.object({
         "Must be a valid GUID"
       ).optional().nullable(),
       source: z.object({
-        appId: z.string().describe("App Def ID that created the order payment request.").regex(
+        appId: z.string().describe("ID of the app that created the order payment request.").regex(
           /^[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}$/,
           "Must be a valid GUID"
         ).min(1).max(100).optional().nullable(),
         externalId: z.string().describe(
-          "Reference to an ID from an external system, indicating the original source of the order payment request."
+          "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."
         ).min(1).max(100).optional()
       }).describe(
-        "Additional parameters to identify the source of the order payment request."
+        "Details about the source that created the order payment request."
       ).optional(),
       status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
         "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 +396,27 @@ var QueryOrderPaymentRequestsResponse = z.object({
         "Amount to collect. Set when the order payment request is created and can't be changed afterward."
       ).optional(),
       currency: z.string().describe(
-        "Currency code. The value will always match the currency used in the order."
+        "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
       ).optional(),
       paymentGatewayOrderId: z.string().describe(
-        "Payment gateway order id which is associated with this payment request"
+        "Payment gateway order ID associated with this payment request."
       ).min(1).max(100).optional().nullable(),
-      title: z.string().describe(
-        "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."
-      ).min(1).max(200).optional(),
+      title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
       description: z.string().describe(
-        "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
+        "Description displayed to the customer on the payment page."
       ).max(300).optional().nullable(),
-      expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+      expirationDate: z.date().describe(
+        "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+      ).optional().nullable(),
       extendedFields: z.object({
         namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
           "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)."
         ).optional()
       }).describe(
-        "[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."
+        "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."
       ).optional(),
-      _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-      _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+      _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+      _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
       image: z.string().describe("Image to display to the customer on the payment page.").optional(),
       blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
     })
@@ -444,16 +436,16 @@ var QueryOrderPaymentRequestsResponse = z.object({
     hasNext: z.boolean().describe(
       "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."
     ).optional().nullable()
-  }).describe("Paging metadata").optional()
+  }).describe("Paging metadata.").optional()
 });
 var GetOrderPaymentRequestUrlRequest = z.object({
-  orderPaymentRequestId: z.string().describe("Order Payment Request ID.").regex(
+  orderPaymentRequestId: z.string().describe("ID of the order payment request.").regex(
     /^[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}$/,
     "Must be a valid GUID"
   )
 });
 var GetOrderPaymentRequestUrlResponse = z.object({
-  orderPaymentRequestUrl: z.string().describe("Order Payment Request URL.").min(1).max(100).optional()
+  orderPaymentRequestUrl: z.string().describe("Payment page URL for the order payment request.").min(1).max(100).optional()
 });
 var UpdateExtendedFieldsRequest = z.object({
   _id: z.string().describe("ID of the entity to update."),
@@ -473,15 +465,15 @@ var UpdateExtendedFieldsResponse = z.object({
       "Must be a valid GUID"
     ).optional().nullable(),
     source: z.object({
-      appId: z.string().describe("App Def ID that created the order payment request.").regex(
+      appId: z.string().describe("ID of the app that created the order payment request.").regex(
         /^[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}$/,
         "Must be a valid GUID"
       ).min(1).max(100).optional().nullable(),
       externalId: z.string().describe(
-        "Reference to an ID from an external system, indicating the original source of the order payment request."
+        "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."
       ).min(1).max(100).optional()
     }).describe(
-      "Additional parameters to identify the source of the order payment request."
+      "Details about the source that created the order payment request."
     ).optional(),
     status: z.enum(["UNPAID", "PAID", "EXPIRED"]).describe(
       "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,31 +490,36 @@ var UpdateExtendedFieldsResponse = z.object({
       "Amount to collect. Set when the order payment request is created and can't be changed afterward."
     ).optional(),
     currency: z.string().describe(
-      "Currency code. The value will always match the currency used in the order."
+      "Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency."
     ).optional(),
     paymentGatewayOrderId: z.string().describe(
-      "Payment gateway order id which is associated with this payment request"
+      "Payment gateway order ID associated with this payment request."
     ).min(1).max(100).optional().nullable(),
-    title: z.string().describe(
-      "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."
-    ).min(1).max(200).optional(),
-    description: z.string().describe(
-      "Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for."
-    ).max(300).optional().nullable(),
-    expirationDate: z.date().describe("Time and date the order payment request expires.").optional().nullable(),
+    title: z.string().describe("Title displayed to the customer on the payment page.").min(1).max(200).optional(),
+    description: z.string().describe("Description displayed to the customer on the payment page.").max(300).optional().nullable(),
+    expirationDate: z.date().describe(
+      "Date and time the order payment request expires. If not provided, the order payment request doesn't expire."
+    ).optional().nullable(),
     extendedFields: z.object({
       namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
         "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)."
       ).optional()
     }).describe(
-      "[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."
+      "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."
     ).optional(),
-    _createdDate: z.date().describe("Date and time the OrderPaymentRequest was created.").optional().nullable(),
-    _updatedDate: z.date().describe("Date and time the OrderPaymentRequest was last updated.").optional().nullable(),
+    _createdDate: z.date().describe("Date and time the order payment request was created.").optional().nullable(),
+    _updatedDate: z.date().describe("Date and time the order payment request was last updated.").optional().nullable(),
     image: z.string().describe("Image to display to the customer on the payment page.").optional(),
     blockedPaymentMethods: z.array(z.enum(["MANUAL"])).max(1).optional()
-  }).describe("Updated OrderPaymentRequest.").optional()
+  }).describe("Updated order payment request.").optional()
+});
+var VoidOrderPaymentRequestRequest = z.object({
+  orderPaymentRequestId: z.string().describe("ID of the order payment request to void.").regex(
+    /^[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}$/,
+    "Must be a valid GUID"
+  )
 });
+var VoidOrderPaymentRequestResponse = z.object({});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CreateOrderPaymentRequestRequest,
@@ -538,6 +535,8 @@ var UpdateExtendedFieldsResponse = z.object({
   UpdateExtendedFieldsRequest,
   UpdateExtendedFieldsResponse,
   UpdateOrderPaymentRequestRequest,
-  UpdateOrderPaymentRequestResponse
+  UpdateOrderPaymentRequestResponse,
+  VoidOrderPaymentRequestRequest,
+  VoidOrderPaymentRequestResponse
 });
 //# sourceMappingURL=schemas.js.map