@wix/auto_sdk_ecom_order-payment-requests 1.0.62 → 1.0.63

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

@@ -458,6 +458,26 @@ interface VoidOrderPaymentRequestRequest {
 }
 interface VoidOrderPaymentRequestResponse {
 }
+interface ChargeOrderPaymentRequestRequest {
+    /**
+     * ID of the order payment request to charge.
+     * @format GUID
+     */
+    orderPaymentRequestId: string;
+    /**
+     * Token representing the payment details the customer entered, including their card and payment provider. Obtain it by calling `paymentsApi.initializePayment()` on the `paymentsApi` object provided by the Wix Cashier payments client SDK. Valid for a single charge attempt.
+     * @maxLength 100
+     */
+    paymentToken?: string | null;
+}
+interface ChargeOrderPaymentRequestResponse {
+    /**
+     * Token for completing a payment that requires an additional step from the customer, such as 3D Secure verification or an off-site redirect. Returned only when such a step is required. Pass it to `paymentsApi.continuePayment()` in the Wix Cashier payments client SDK.
+     * @minLength 1
+     * @maxLength 1000
+     */
+    paymentResponseToken?: string | null;
+}
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
@@ -685,6 +705,28 @@ type VoidOrderPaymentRequestApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
+type ChargeOrderPaymentRequestApplicationErrors = {
+    code?: 'ORDER_PAYMENT_REQUEST_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_CHARGE_PAID_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_CHARGE_EXPIRED_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_CHARGE_VOIDED_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PAYMENT_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1298,5 +1340,36 @@ interface UpdateExtendedFieldsOptions {
 declare function voidOrderPaymentRequest(orderPaymentRequestId: string): Promise<void & {
     __applicationErrorsType?: VoidOrderPaymentRequestApplicationErrors;
 }>;
+/**
+ * Charges an order payment request.
+ *
+ * Collects the order payment request's `amount` from the payment method the customer entered in the Wix Cashier payments widget on your page. Before calling this method, call `paymentsApi.initializePayment()` on the `paymentsApi` object provided by the Wix Cashier payments client SDK to collect the customer's payment details, then pass the token it returns as `paymentToken`.
+ *
+ * A successful response doesn't mean the payment was collected:
+ * - If `paymentResponseToken` is returned, the customer must complete an additional step, such as 3D Secure verification or an off-site redirect. Pass the token to `paymentsApi.continuePayment()` to complete the payment.
+ * - If `paymentResponseToken` isn't returned, no further step is needed. The payment was either collected or declined by the payment provider.
+ *
+ * Either way, the order payment request's `status` is the authoritative outcome. It changes to `PAID` asynchronously, after the payment provider settles the transaction, which can happen after this method returns. To be notified, listen to the [Order Payment Request Paid](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/order-payment-request-paid) webhook, or poll [Get Order Payment Request](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-payment-requests/get-order-payment-request).
+ *
+ * Charging requires a client-side Wix Cashier payments session, so a backend-only integration can't obtain a `paymentToken` or complete a payment that needs an additional step.
+ *
+ * At most one charge attempt is processed per order payment request, so retrying is safe. While an attempt is still in progress, further calls fail with `PAYMENT_IN_PROGRESS`. Once the payment is collected, further calls fail with `CANNOT_CHARGE_PAID_ORDER_PAYMENT_REQUEST`. The customer isn't charged twice for the same order payment request.
+ * @param orderPaymentRequestId - ID of the order payment request to charge.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ecom:v1:order_payment_request:charge_order_payment_request
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.ChargeOrderPaymentRequest
+ */
+declare function chargeOrderPaymentRequest(orderPaymentRequestId: string, options?: ChargeOrderPaymentRequestOptions): Promise<ChargeOrderPaymentRequestResponse & {
+    __applicationErrorsType?: ChargeOrderPaymentRequestApplicationErrors;
+}>;
+interface ChargeOrderPaymentRequestOptions {
+    /**
+     * Token representing the payment details the customer entered, including their card and payment provider. Obtain it by calling `paymentsApi.initializePayment()` on the `paymentsApi` object provided by the Wix Cashier payments client SDK. Valid for a single charge attempt.
+     * @maxLength 100
+     */
+    paymentToken?: string | null;
+}
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ActionLink, type ActionLinks, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateOrderPaymentRequestsOptions, type BulkCreateOrderPaymentRequestsRequest, type BulkCreateOrderPaymentRequestsResponse, type BulkOrderPaymentRequestItem, type BulkOrderPaymentRequestResult, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, type CreateOrderPaymentRequestOptions, type CreateOrderPaymentRequestRequest, type CreateOrderPaymentRequestResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteOrderPaymentRequestApplicationErrors, type DeleteOrderPaymentRequestRequest, type DeleteOrderPaymentRequestResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestCreatedEnvelope, type OrderPaymentRequestDeletedEnvelope, type OrderPaymentRequestExpired, type OrderPaymentRequestExpiredEnvelope, type OrderPaymentRequestPaid, type OrderPaymentRequestPaidEnvelope, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestUpdatedEnvelope, type OrderPaymentRequestVoided, type OrderPaymentRequestVoidedEnvelope, type OrderPaymentRequestsQueryBuilder, type OrderPaymentRequestsQueryResult, PaymentMethod, type PaymentMethodWithLiterals, type Price, type QueryOrderPaymentRequestsRequest, type QueryOrderPaymentRequestsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, Status, type StatusWithLiterals, type SubscriptionInfo, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateOrderPaymentRequest, type UpdateOrderPaymentRequestApplicationErrors, type UpdateOrderPaymentRequestRequest, type UpdateOrderPaymentRequestResponse, type VoidOrderPaymentRequestApplicationErrors, type VoidOrderPaymentRequestRequest, type VoidOrderPaymentRequestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateOrderPaymentRequests, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ActionLink, type ActionLinks, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateOrderPaymentRequestsOptions, type BulkCreateOrderPaymentRequestsRequest, type BulkCreateOrderPaymentRequestsResponse, type BulkOrderPaymentRequestItem, type BulkOrderPaymentRequestResult, type ChargeOrderPaymentRequestApplicationErrors, type ChargeOrderPaymentRequestOptions, type ChargeOrderPaymentRequestRequest, type ChargeOrderPaymentRequestResponse, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, type CreateOrderPaymentRequestOptions, type CreateOrderPaymentRequestRequest, type CreateOrderPaymentRequestResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteOrderPaymentRequestApplicationErrors, type DeleteOrderPaymentRequestRequest, type DeleteOrderPaymentRequestResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestCreatedEnvelope, type OrderPaymentRequestDeletedEnvelope, type OrderPaymentRequestExpired, type OrderPaymentRequestExpiredEnvelope, type OrderPaymentRequestPaid, type OrderPaymentRequestPaidEnvelope, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestUpdatedEnvelope, type OrderPaymentRequestVoided, type OrderPaymentRequestVoidedEnvelope, type OrderPaymentRequestsQueryBuilder, type OrderPaymentRequestsQueryResult, PaymentMethod, type PaymentMethodWithLiterals, type Price, type QueryOrderPaymentRequestsRequest, type QueryOrderPaymentRequestsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, Status, type StatusWithLiterals, type SubscriptionInfo, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateOrderPaymentRequest, type UpdateOrderPaymentRequestApplicationErrors, type UpdateOrderPaymentRequestRequest, type UpdateOrderPaymentRequestResponse, type VoidOrderPaymentRequestApplicationErrors, type VoidOrderPaymentRequestRequest, type VoidOrderPaymentRequestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateOrderPaymentRequests, chargeOrderPaymentRequest, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };

package/build/internal/cjs/index.typings.js

@@ -25,6 +25,7 @@ __export(index_typings_exports, {
   Status: () => Status,
   WebhookIdentityType: () => WebhookIdentityType,
   bulkCreateOrderPaymentRequests: () => bulkCreateOrderPaymentRequests2,
+  chargeOrderPaymentRequest: () => chargeOrderPaymentRequest2,
   createOrderPaymentRequest: () => createOrderPaymentRequest2,
   deleteOrderPaymentRequest: () => deleteOrderPaymentRequest2,
   getOrderPaymentRequest: () => getOrderPaymentRequest2,
@@ -377,6 +378,25 @@ function voidOrderPaymentRequest(payload) {
   }
   return __voidOrderPaymentRequest;
 }
+function chargeOrderPaymentRequest(payload) {
+  function __chargeOrderPaymentRequest({ host }) {
+    const metadata = {
+      entityFqdn: "wix.ecom.v1.order_payment_request",
+      method: "POST",
+      methodFqn: "wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.ChargeOrderPaymentRequest",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEcomOrderPaymentRequestApiV1OrderPaymentRequestsServiceUrl(
+        { protoPath: "/v1/order-payment-requests/charge", data: payload, host }
+      ),
+      data: payload
+    };
+    return metadata;
+  }
+  return __chargeOrderPaymentRequest;
+}
 
 // src/ecom-v1-order-payment-request-order-payment-requests.universal.ts
 var import_image = require("@wix/sdk-runtime/transformations/image");
@@ -767,6 +787,35 @@ async function voidOrderPaymentRequest2(orderPaymentRequestId) {
     throw transformedError;
   }
 }
+async function chargeOrderPaymentRequest2(orderPaymentRequestId, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    orderPaymentRequestId,
+    paymentToken: options?.paymentToken
+  });
+  const reqOpts = chargeOrderPaymentRequest(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          orderPaymentRequestId: "$[0]",
+          paymentToken: "$[1].paymentToken"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["orderPaymentRequestId", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PaymentMethod,
@@ -774,6 +823,7 @@ async function voidOrderPaymentRequest2(orderPaymentRequestId) {
   Status,
   WebhookIdentityType,
   bulkCreateOrderPaymentRequests,
+  chargeOrderPaymentRequest,
   createOrderPaymentRequest,
   deleteOrderPaymentRequest,
   getOrderPaymentRequest,