@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.61

package/build/cjs/index.typings.d.ts

@@ -9,7 +9,7 @@ interface OrderPaymentRequest {
      */
     _id?: string | null;
     /**
-     * Additional parameters to identify the source of the order payment request.
+     * Details about the source that created the order payment request.
      * @immutable
      */
     source?: Source;
@@ -36,43 +36,47 @@ interface OrderPaymentRequest {
      */
     amount?: Price;
     /**
-     * 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.
      * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
-     * Payment gateway order id which is associated with this payment request
+     * Payment gateway order ID associated with this payment request.
      * @readonly
      * @minLength 1
      * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
     /**
-     * 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.
+     * Title displayed to the customer on the payment page.
      * @minLength 1
      * @maxLength 200
      */
     title?: string;
     /**
-     * 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.
      * @maxLength 300
      */
     description?: string | null;
     /**
-     * Time and date the order payment request expires.
+     * Date and time the order payment request expires. If not provided, the order payment request doesn't expire.
      * @immutable
      */
     expirationDate?: Date | null;
-    /** [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.
+     *
+     * [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.
+     */
     extendedFields?: ExtendedFields;
     /**
-     * Date and time the OrderPaymentRequest was created.
+     * Date and time the order payment request was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the OrderPaymentRequest was last updated.
+     * Date and time the order payment request was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -86,7 +90,7 @@ interface OrderPaymentRequest {
 }
 interface Source {
     /**
-     * App Def ID that created the order payment request.
+     * ID of the app that created the order payment request.
      * @format GUID
      * @minLength 1
      * @maxLength 100
@@ -94,7 +98,7 @@ interface Source {
      */
     appId?: string | null;
     /**
-     * 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.
      * @minLength 1
      * @maxLength 100
      * @immutable
@@ -102,8 +106,11 @@ interface Source {
     externalId?: string;
 }
 declare enum Status {
+    /** Payment is owed but hasn't been collected yet. */
     UNPAID = "UNPAID",
+    /** Payment has been collected. */
     PAID = "PAID",
+    /** The order payment request has passed its `expirationDate` without being paid. */
     EXPIRED = "EXPIRED"
 }
 /** @enumType */
@@ -139,11 +146,13 @@ declare enum PaymentMethod {
 type PaymentMethodWithLiterals = PaymentMethod | 'MANUAL';
 interface ActionLinks {
     /**
-     * A general navigation action link rendered as an anchor in the UI.
+     * Navigation action links rendered as anchors on the payment page.
+     *
+     * Currently supports a single action link.
      * @maxSize 1
      */
     general?: ActionLink[];
-    /** An action link rendered as a button in error messages in the UI. */
+    /** Action link rendered as a button in error messages on the payment page. */
     error?: ActionLink;
 }
 interface ActionLink {
@@ -167,7 +176,7 @@ interface SubscriptionInfo {
      */
     title?: string;
     /**
-     * Description of the charges that will be applied for subscription.
+     * Description of the charges applied for the subscription.
      * @maxLength 1000
      */
     chargeDescription?: string | null;
@@ -179,30 +188,30 @@ interface SubscriptionInfo {
     /** Whether the subscription renews automatically. */
     autoRenewal?: boolean;
 }
-/** Triggered when the order payment request status changes to paid */
+/** Triggered when an order payment request's `status` changes to `PAID`. */
 interface OrderPaymentRequestPaid {
-    /** Order payment request */
+    /** Order payment request that was paid. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-/** Triggered when the order payment request status changes to expired */
+/** Triggered when an order payment request's `status` changes to `EXPIRED`. */
 interface OrderPaymentRequestExpired {
-    /** Order payment request */
+    /** Order payment request that expired. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-/** Triggered when the order payment request status changes to voided */
+/** Triggered when an order payment request's `status` changes to `VOIDED`. */
 interface OrderPaymentRequestVoided {
-    /** Order payment request */
+    /** Order payment request that was voided. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface CreateOrderPaymentRequestRequest {
-    /** OrderPaymentRequest to be created. */
+    /** Order payment request to create. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface CreateOrderPaymentRequestResponse {
-    /** The created OrderPaymentRequest. */
+    /** Created order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
     /**
-     * Order payment request URL.
+     * Payment page URL for the order payment request. Share this URL with the customer so they can complete the payment.
      * @minLength 1
      * @maxLength 100
      */
@@ -210,26 +219,26 @@ interface CreateOrderPaymentRequestResponse {
 }
 interface GetOrderPaymentRequestRequest {
     /**
-     * ID of the OrderPaymentRequest to retrieve.
+     * ID of the order payment request to retrieve.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
 interface GetOrderPaymentRequestResponse {
-    /** The requested OrderPaymentRequest. */
+    /** Retrieved order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface UpdateOrderPaymentRequestRequest {
-    /** OrderPaymentRequest to be updated, may be partial. */
+    /** Order payment request to update. */
     orderPaymentRequest: OrderPaymentRequest;
 }
 interface UpdateOrderPaymentRequestResponse {
-    /** Updated OrderPaymentRequest. */
+    /** Updated order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface DeleteOrderPaymentRequestRequest {
     /**
-     * Id of the OrderPaymentRequest to delete.
+     * ID of the order payment request to delete.
      * @format GUID
      */
     orderPaymentRequestId: string;
@@ -296,11 +305,11 @@ interface CursorPaging {
 }
 interface QueryOrderPaymentRequestsResponse {
     /**
-     * List of payment requests.
+     * List of order payment requests.
      * @maxSize 1000
      */
     orderPaymentRequests?: OrderPaymentRequest[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -330,14 +339,14 @@ interface Cursors {
 }
 interface GetOrderPaymentRequestURLRequest {
     /**
-     * Order Payment Request ID.
+     * ID of the order payment request.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
 interface GetOrderPaymentRequestURLResponse {
     /**
-     * Order Payment Request URL.
+     * Payment page URL for the order payment request.
      * @minLength 1
      * @maxLength 100
      */
@@ -352,7 +361,7 @@ interface UpdateExtendedFieldsRequest {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse {
-    /** Updated OrderPaymentRequest. */
+    /** Updated order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface VoidOrderPaymentRequestRequest {
@@ -532,6 +541,10 @@ type CreateOrderPaymentRequestApplicationErrors = {
     code?: 'INVALID_ORDER_STATUS_FOR_SUBSCRIPTION';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type GetOrderPaymentRequestApplicationErrors = {
@@ -689,7 +702,7 @@ interface OrderPaymentRequestExpiredEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"EXPIRED"`.
+ * Triggered when an order payment request's `status` changes to `EXPIRED`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -710,7 +723,7 @@ interface OrderPaymentRequestPaidEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"PAID"`.
+ * Triggered when an order payment request's `status` changes to `PAID`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -752,7 +765,7 @@ interface OrderPaymentRequestVoidedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"VOIDED"`.
+ * Triggered when an order payment request's `status` changes to `VOIDED`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -769,7 +782,11 @@ interface OrderPaymentRequestVoidedEnvelope {
  */
 declare function onOrderPaymentRequestVoided(handler: (event: OrderPaymentRequestVoidedEnvelope) => void | Promise<void>): void;
 /**
- * Creates a order payment request.
+ * Creates an order payment request.
+ *
+ * The response includes the payment page URL, which you can share with the customer. To retrieve the URL later, call [Get Order Payment Request URL](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/get-order-payment-request-url).
+ *
+ * Creation fails with `ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND` if the site doesn't have a Payment Request Page added and published.
  * @public
  * @documentationMaturity preview
  * @requiredField options.orderPaymentRequest.amount
@@ -777,25 +794,25 @@ declare function onOrderPaymentRequestVoided(handler: (event: OrderPaymentReques
  * @requiredField options.orderPaymentRequest.title
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_CREATE
  * @applicableIdentity APP
- * @returns The created OrderPaymentRequest.
+ * @returns Created order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.CreateOrderPaymentRequest
  */
 declare function createOrderPaymentRequest(options?: NonNullablePaths<CreateOrderPaymentRequestOptions, `orderPaymentRequest.amount` | `orderPaymentRequest.orderId` | `orderPaymentRequest.title`, 3>): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
     __applicationErrorsType?: CreateOrderPaymentRequestApplicationErrors;
 }>;
 interface CreateOrderPaymentRequestOptions {
-    /** OrderPaymentRequest to be created. */
+    /** Order payment request to create. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 /**
- * Retrieves a order payment request.
- * @param orderPaymentRequestId - ID of the OrderPaymentRequest to retrieve.
+ * Retrieves an order payment request.
+ * @param orderPaymentRequestId - ID of the order payment request to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
  * @applicableIdentity APP
- * @returns The requested OrderPaymentRequest.
+ * @returns Retrieved order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequest
  */
 declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
@@ -812,7 +829,7 @@ declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<
  * @requiredField orderPaymentRequest
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
  * @applicableIdentity APP
- * @returns Updated OrderPaymentRequest.
+ * @returns Updated order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateOrderPaymentRequest
  */
 declare function updateOrderPaymentRequest(_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
@@ -826,7 +843,7 @@ interface UpdateOrderPaymentRequest {
      */
     _id?: string | null;
     /**
-     * Additional parameters to identify the source of the order payment request.
+     * Details about the source that created the order payment request.
      * @immutable
      */
     source?: Source;
@@ -853,43 +870,47 @@ interface UpdateOrderPaymentRequest {
      */
     amount?: Price;
     /**
-     * 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.
      * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
-     * Payment gateway order id which is associated with this payment request
+     * Payment gateway order ID associated with this payment request.
      * @readonly
      * @minLength 1
      * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
     /**
-     * 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.
+     * Title displayed to the customer on the payment page.
      * @minLength 1
      * @maxLength 200
      */
     title?: string;
     /**
-     * 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.
      * @maxLength 300
      */
     description?: string | null;
     /**
-     * Time and date the order payment request expires.
+     * Date and time the order payment request expires. If not provided, the order payment request doesn't expire.
      * @immutable
      */
     expirationDate?: Date | null;
-    /** [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.
+     *
+     * [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.
+     */
     extendedFields?: ExtendedFields;
     /**
-     * Date and time the OrderPaymentRequest was created.
+     * Date and time the order payment request was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the OrderPaymentRequest was last updated.
+     * Date and time the order payment request was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -905,7 +926,7 @@ interface UpdateOrderPaymentRequest {
  * Deletes an order payment request.
  *
  * You can delete an order payment request in any status except `PAID`. Attempting to delete a `PAID` order payment request fails with `CANNOT_DELETE_PAID_ORDER_PAYMENT_REQUEST`.
- * @param orderPaymentRequestId - Id of the OrderPaymentRequest to delete.
+ * @param orderPaymentRequestId - ID of the order payment request to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
@@ -917,11 +938,11 @@ declare function deleteOrderPaymentRequest(orderPaymentRequestId: string): Promi
     __applicationErrorsType?: DeleteOrderPaymentRequestApplicationErrors;
 }>;
 /**
- * Retrieves a list of Payment Requests, given the provided [paging, filtering, and sorting][1].
+ * Retrieves a list of up to 1,000 order payment requests, given the provided [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
  *
- * Query Payment Requests runs with these defaults, which you can override:
- * - `createdDate` is sorted in DESC order
- * - `cursorPaging.limit` is 100
+ * Query Order Payment Requests runs with these defaults, which you can override:
+ * - `_createdDate` is sorted in `DESC` order
+ * - `cursorPaging.limit` is `100`
  *
  * To learn about working with _Query_ endpoints, see
  * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
@@ -1104,8 +1125,8 @@ declare const utils: {
     };
 };
 /**
- * Retrieves the order payment request page URL of a specified order payment request.
- * @param orderPaymentRequestId - Order Payment Request ID.
+ * Retrieves the payment page URL for an order payment request.
+ * @param orderPaymentRequestId - ID of the order payment request.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
@@ -1117,7 +1138,7 @@ declare function getOrderPaymentRequestUrl(orderPaymentRequestId: string): Promi
     __applicationErrorsType?: GetOrderPaymentRequestUrlApplicationErrors;
 }>;
 /**
- * Updates extended fields of a order payment request
+ * Updates the extended fields of an order payment request.
  * @param _id - ID of the entity to update.
  * @param namespace - Identifier for the app whose extended fields are being updated.
  * @public