@wix/auto_sdk_ecom_order-payment-requests 1.0.61 → 1.0.63

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

@@ -217,6 +217,73 @@ interface CreateOrderPaymentRequestResponse {
      */
     orderPaymentRequestUrl?: string;
 }
+interface BulkCreateOrderPaymentRequestsRequest {
+    /**
+     * Order payment requests to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    orderPaymentRequests: OrderPaymentRequest[];
+    /**
+     * Whether to return the created order payment requests and their payment page URLs in the response.
+     * Default: `false`.
+     */
+    returnEntity?: boolean;
+}
+interface BulkCreateOrderPaymentRequestsResponse {
+    /**
+     * Results of the bulk create operation in the same order as the request items.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkOrderPaymentRequestResult[];
+    /** Metadata about the bulk create operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkOrderPaymentRequestItem {
+    /** Created order payment request. */
+    orderPaymentRequest?: OrderPaymentRequest;
+    /**
+     * Payment page URL for the created order payment request.
+     * @format WEB_URL
+     */
+    orderPaymentRequestUrl?: string;
+}
+interface BulkOrderPaymentRequestResult {
+    /** Metadata about this item, including its original request index and any error. */
+    itemMetadata?: ItemMetadata;
+    /** Created order payment request and its payment page URL. Returned when `returnEntity` is `true`. */
+    item?: BulkOrderPaymentRequestItem;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 interface GetOrderPaymentRequestRequest {
     /**
      * ID of the order payment request to retrieve.
@@ -373,6 +440,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;
@@ -600,6 +687,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.
@@ -804,6 +913,13 @@ interface CreateOrderPaymentRequestOptions {
     /** Order payment request to create. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
+interface BulkCreateOrderPaymentRequestsOptions {
+    /**
+     * Whether to return the created order payment requests and their payment page URLs in the response.
+     * Default: `false`.
+     */
+    returnEntity?: boolean;
+}
 /**
  * Retrieves an order payment request.
  * @param orderPaymentRequestId - ID of the order payment request to retrieve.
@@ -1156,5 +1272,27 @@ interface UpdateExtendedFieldsOptions {
     /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
     namespaceData: Record<string, any> | null;
 }
+/**
+ * Voids the given order payment request.
+ *
+ * Only `UNPAID` order payment requests can be voided. Voiding an order payment request that is already `VOIDED` succeeds without making any changes. Voiding a `PAID` or `EXPIRED` order payment request fails.
+ * @param orderPaymentRequestId - ID of the order payment request to void.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.VoidOrderPaymentRequest
+ */
+declare function voidOrderPaymentRequest(orderPaymentRequestId: string): Promise<void & {
+    __applicationErrorsType?: VoidOrderPaymentRequestApplicationErrors;
+}>;
+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 BaseEventMetadata, 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 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, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils };
+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, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };

package/build/cjs/index.typings.js

@@ -24,6 +24,8 @@ __export(index_typings_exports, {
   SortOrder: () => SortOrder,
   Status: () => Status,
   WebhookIdentityType: () => WebhookIdentityType,
+  bulkCreateOrderPaymentRequests: () => bulkCreateOrderPaymentRequests2,
+  chargeOrderPaymentRequest: () => chargeOrderPaymentRequest2,
   createOrderPaymentRequest: () => createOrderPaymentRequest2,
   deleteOrderPaymentRequest: () => deleteOrderPaymentRequest2,
   getOrderPaymentRequest: () => getOrderPaymentRequest2,
@@ -130,6 +132,49 @@ function createOrderPaymentRequest(payload) {
   }
   return __createOrderPaymentRequest;
 }
+function bulkCreateOrderPaymentRequests(payload) {
+  function __bulkCreateOrderPaymentRequests({ host }) {
+    const serializedData = (0, import_transform_paths.transformPaths)(payload, [
+      {
+        transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "orderPaymentRequests.expirationDate" },
+          { path: "orderPaymentRequests.createdDate" },
+          { path: "orderPaymentRequests.updatedDate" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.ecom.v1.order_payment_request",
+      method: "POST",
+      methodFqn: "wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.BulkCreateOrderPaymentRequests",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEcomOrderPaymentRequestApiV1OrderPaymentRequestsServiceUrl(
+        {
+          protoPath: "/v1/bulk/order-payment-requests/create",
+          data: serializedData,
+          host
+        }
+      ),
+      data: serializedData,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_timestamp2.transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "results.item.orderPaymentRequest.expirationDate" },
+            { path: "results.item.orderPaymentRequest.createdDate" },
+            { path: "results.item.orderPaymentRequest.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __bulkCreateOrderPaymentRequests;
+}
 function getOrderPaymentRequest(payload) {
   function __getOrderPaymentRequest({ host }) {
     const metadata = {
@@ -333,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");
@@ -405,6 +469,52 @@ async function createOrderPaymentRequest2(options) {
     throw transformedError;
   }
 }
+async function bulkCreateOrderPaymentRequests2(orderPaymentRequests, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_transform_paths2.transformPaths)(
+    (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+      orderPaymentRequests,
+      returnEntity: options?.returnEntity
+    }),
+    [
+      {
+        transformFn: import_image.transformSDKImageToRESTImage,
+        paths: [{ path: "orderPaymentRequests.image" }]
+      }
+    ]
+  );
+  const reqOpts = bulkCreateOrderPaymentRequests(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(
+      (0, import_transform_paths2.transformPaths)(result.data, [
+        {
+          transformFn: import_image2.transformRESTImageToSDKImage,
+          paths: [{ path: "results.item.orderPaymentRequest.image" }]
+        }
+      ])
+    );
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          orderPaymentRequests: "$[0]",
+          returnEntity: "$[1].returnEntity"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["orderPaymentRequests", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function getOrderPaymentRequest2(orderPaymentRequestId) {
   const { httpClient, sideEffects } = arguments[1];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
@@ -677,12 +787,43 @@ 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,
   SortOrder,
   Status,
   WebhookIdentityType,
+  bulkCreateOrderPaymentRequests,
+  chargeOrderPaymentRequest,
   createOrderPaymentRequest,
   deleteOrderPaymentRequest,
   getOrderPaymentRequest,