@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.61

package/build/cjs/index.d.ts

@@ -5,8 +5,12 @@ export { AccountInfo, AccountInfoMetadata, ActionEvent, ActionLink, ActionLinks,
 declare function createOrderPaymentRequest$1(httpClient: HttpClient): CreateOrderPaymentRequestSignature;
 interface CreateOrderPaymentRequestSignature {
     /**
-     * Creates a order payment request.
-     * @returns The created OrderPaymentRequest.
+     * 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.
+     * @returns Created order payment request.
      */
     (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;
@@ -15,9 +19,9 @@ interface CreateOrderPaymentRequestSignature {
 declare function getOrderPaymentRequest$1(httpClient: HttpClient): GetOrderPaymentRequestSignature;
 interface GetOrderPaymentRequestSignature {
     /**
-     * Retrieves a order payment request.
-     * @param - ID of the OrderPaymentRequest to retrieve.
-     * @returns The requested OrderPaymentRequest.
+     * Retrieves an order payment request.
+     * @param - ID of the order payment request to retrieve.
+     * @returns Retrieved order payment request.
      */
     (orderPaymentRequestId: string): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
         __applicationErrorsType?: GetOrderPaymentRequestApplicationErrors;
@@ -30,7 +34,7 @@ interface UpdateOrderPaymentRequestSignature {
      *
      * Only `UNPAID` order payment requests can be updated. The `amount` can't be changed after the order payment request is created.
      * @param - Order payment request ID.
-     * @returns Updated OrderPaymentRequest.
+     * @returns Updated order payment request.
      */
     (_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
         __applicationErrorsType?: UpdateOrderPaymentRequestApplicationErrors;
@@ -42,7 +46,7 @@ interface DeleteOrderPaymentRequestSignature {
      * 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 - Id of the OrderPaymentRequest to delete.
+     * @param - ID of the order payment request to delete.
      */
     (orderPaymentRequestId: string): Promise<void & {
         __applicationErrorsType?: DeleteOrderPaymentRequestApplicationErrors;
@@ -51,8 +55,8 @@ interface DeleteOrderPaymentRequestSignature {
 declare function getOrderPaymentRequestUrl$1(httpClient: HttpClient): GetOrderPaymentRequestUrlSignature;
 interface GetOrderPaymentRequestUrlSignature {
     /**
-     * Retrieves the order payment request page URL of a specified order payment request.
-     * @param - Order Payment Request ID.
+     * Retrieves the payment page URL for an order payment request.
+     * @param - ID of the order payment request.
      */
     (orderPaymentRequestId: string): Promise<NonNullablePaths<GetOrderPaymentRequestURLResponse, `orderPaymentRequestUrl`, 2> & {
         __applicationErrorsType?: GetOrderPaymentRequestUrlApplicationErrors;
@@ -61,7 +65,7 @@ interface GetOrderPaymentRequestUrlSignature {
 declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
 interface UpdateExtendedFieldsSignature {
     /**
-     * Updates extended fields of a order payment request
+     * Updates the extended fields of an order payment request.
      * @param - ID of the entity to update.
      * @param - Identifier for the app whose extended fields are being updated.
      */
@@ -94,11 +98,11 @@ declare const onOrderPaymentRequestCreated: BuildEventDefinition<typeof onOrderP
  */
 declare const onOrderPaymentRequestDeleted: BuildEventDefinition<typeof onOrderPaymentRequestDeleted$1> & typeof onOrderPaymentRequestDeleted$1;
 /**
- * Triggered when an order payment request status is updated to `"EXPIRED"`.
+ * Triggered when an order payment request's `status` changes to `EXPIRED`.
  */
 declare const onOrderPaymentRequestExpired: BuildEventDefinition<typeof onOrderPaymentRequestExpired$1> & typeof onOrderPaymentRequestExpired$1;
 /**
- * Triggered when an order payment request status is updated to `"PAID"`.
+ * Triggered when an order payment request's `status` changes to `PAID`.
  */
 declare const onOrderPaymentRequestPaid: BuildEventDefinition<typeof onOrderPaymentRequestPaid$1> & typeof onOrderPaymentRequestPaid$1;
 /**
@@ -106,7 +110,7 @@ declare const onOrderPaymentRequestPaid: BuildEventDefinition<typeof onOrderPaym
  */
 declare const onOrderPaymentRequestUpdated: BuildEventDefinition<typeof onOrderPaymentRequestUpdated$1> & typeof onOrderPaymentRequestUpdated$1;
 /**
- * Triggered when an order payment request status is updated to `"VOIDED"`.
+ * Triggered when an order payment request's `status` changes to `VOIDED`.
  */
 declare const onOrderPaymentRequestVoided: BuildEventDefinition<typeof onOrderPaymentRequestVoided$1> & typeof onOrderPaymentRequestVoided$1;