@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.62

package/build/cjs/index.d.ts

@@ -1,12 +1,16 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { CreateOrderPaymentRequestOptions, OrderPaymentRequest, CreateOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, OrderPaymentRequestCreatedEnvelope, OrderPaymentRequestDeletedEnvelope, OrderPaymentRequestExpiredEnvelope, OrderPaymentRequestPaidEnvelope, OrderPaymentRequestUpdatedEnvelope, OrderPaymentRequestVoidedEnvelope, OrderPaymentRequestsQueryBuilder, OrderPaymentRequestQuery, typedQueryOrderPaymentRequests } from './index.typings.js';
-export { AccountInfo, AccountInfoMetadata, ActionEvent, ActionLink, ActionLinks, BaseEventMetadata, CommonQueryWithEntityContext, CreateOrderPaymentRequestRequest, CreateOrderPaymentRequestResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteOrderPaymentRequestRequest, DeleteOrderPaymentRequestResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetOrderPaymentRequestRequest, GetOrderPaymentRequestResponse, GetOrderPaymentRequestURLRequest, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, OrderPaymentRequestExpired, OrderPaymentRequestPaid, OrderPaymentRequestQuerySpec, OrderPaymentRequestVoided, OrderPaymentRequestsQueryResult, PaymentMethod, PaymentMethodWithLiterals, Price, QueryOrderPaymentRequestsRequest, QueryOrderPaymentRequestsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Source, Status, StatusWithLiterals, SubscriptionInfo, UpdateExtendedFieldsRequest, UpdateOrderPaymentRequestRequest, UpdateOrderPaymentRequestResponse, VoidOrderPaymentRequestApplicationErrors, VoidOrderPaymentRequestRequest, VoidOrderPaymentRequestResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+import { CreateOrderPaymentRequestOptions, OrderPaymentRequest, CreateOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, VoidOrderPaymentRequestApplicationErrors, OrderPaymentRequestCreatedEnvelope, OrderPaymentRequestDeletedEnvelope, OrderPaymentRequestExpiredEnvelope, OrderPaymentRequestPaidEnvelope, OrderPaymentRequestUpdatedEnvelope, OrderPaymentRequestVoidedEnvelope, OrderPaymentRequestsQueryBuilder, OrderPaymentRequestQuery, typedQueryOrderPaymentRequests } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, ActionLink, ActionLinks, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateOrderPaymentRequestsOptions, BulkCreateOrderPaymentRequestsRequest, BulkCreateOrderPaymentRequestsResponse, BulkOrderPaymentRequestItem, BulkOrderPaymentRequestResult, CommonQueryWithEntityContext, CreateOrderPaymentRequestRequest, CreateOrderPaymentRequestResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteOrderPaymentRequestRequest, DeleteOrderPaymentRequestResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetOrderPaymentRequestRequest, GetOrderPaymentRequestResponse, GetOrderPaymentRequestURLRequest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, OrderPaymentRequestExpired, OrderPaymentRequestPaid, OrderPaymentRequestQuerySpec, OrderPaymentRequestVoided, OrderPaymentRequestsQueryResult, PaymentMethod, PaymentMethodWithLiterals, Price, QueryOrderPaymentRequestsRequest, QueryOrderPaymentRequestsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Source, Status, StatusWithLiterals, SubscriptionInfo, UpdateExtendedFieldsRequest, UpdateOrderPaymentRequestRequest, UpdateOrderPaymentRequestResponse, VoidOrderPaymentRequestRequest, VoidOrderPaymentRequestResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
 
 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,12 +65,24 @@ 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.
      */
     (_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 2>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `orderPaymentRequest.source.externalId` | `orderPaymentRequest.status` | `orderPaymentRequest.orderId` | `orderPaymentRequest.amount.amount` | `orderPaymentRequest.amount.formattedAmount` | `orderPaymentRequest.currency` | `orderPaymentRequest.title` | `orderPaymentRequest.blockedPaymentMethods`, 4>>;
 }
+declare function voidOrderPaymentRequest$1(httpClient: HttpClient): VoidOrderPaymentRequestSignature;
+interface VoidOrderPaymentRequestSignature {
+    /**
+     * 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 - ID of the order payment request to void.
+     */
+    (orderPaymentRequestId: string): Promise<void & {
+        __applicationErrorsType?: VoidOrderPaymentRequestApplicationErrors;
+    }>;
+}
 declare const onOrderPaymentRequestCreated$1: EventDefinition<OrderPaymentRequestCreatedEnvelope, "wix.ecom.v1.order_payment_request_created">;
 declare const onOrderPaymentRequestDeleted$1: EventDefinition<OrderPaymentRequestDeletedEnvelope, "wix.ecom.v1.order_payment_request_deleted">;
 declare const onOrderPaymentRequestExpired$1: EventDefinition<OrderPaymentRequestExpiredEnvelope, "wix.ecom.v1.order_payment_request_expired">;
@@ -84,6 +100,7 @@ declare const updateOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof u
 declare const deleteOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof deleteOrderPaymentRequest$1> & typeof deleteOrderPaymentRequest$1>;
 declare const getOrderPaymentRequestUrl: MaybeContext<BuildRESTFunction<typeof getOrderPaymentRequestUrl$1> & typeof getOrderPaymentRequestUrl$1>;
 declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
+declare const voidOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof voidOrderPaymentRequest$1> & typeof voidOrderPaymentRequest$1>;
 declare const queryOrderPaymentRequests: MaybeContext<BuildRESTFunction<typeof customQueryOrderPaymentRequests> & typeof customQueryOrderPaymentRequests>;
 /**
  * Triggered when an order payment request is created.
@@ -94,11 +111,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,8 +123,8 @@ 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;
 
-export { CreateOrderPaymentRequestApplicationErrors, CreateOrderPaymentRequestOptions, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, OrderPaymentRequest, OrderPaymentRequestCreatedEnvelope, OrderPaymentRequestDeletedEnvelope, OrderPaymentRequestExpiredEnvelope, OrderPaymentRequestPaidEnvelope, OrderPaymentRequestQuery, OrderPaymentRequestUpdatedEnvelope, OrderPaymentRequestVoidedEnvelope, OrderPaymentRequestsQueryBuilder, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest };
+export { CreateOrderPaymentRequestApplicationErrors, CreateOrderPaymentRequestOptions, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, OrderPaymentRequest, OrderPaymentRequestCreatedEnvelope, OrderPaymentRequestDeletedEnvelope, OrderPaymentRequestExpiredEnvelope, OrderPaymentRequestPaidEnvelope, OrderPaymentRequestQuery, OrderPaymentRequestUpdatedEnvelope, OrderPaymentRequestVoidedEnvelope, OrderPaymentRequestsQueryBuilder, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, VoidOrderPaymentRequestApplicationErrors, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, voidOrderPaymentRequest };

package/build/cjs/index.js

@@ -24,6 +24,7 @@ __export(index_exports, {
   SortOrder: () => SortOrder,
   Status: () => Status,
   WebhookIdentityType: () => WebhookIdentityType,
+  bulkCreateOrderPaymentRequests: () => bulkCreateOrderPaymentRequests4,
   createOrderPaymentRequest: () => createOrderPaymentRequest4,
   deleteOrderPaymentRequest: () => deleteOrderPaymentRequest4,
   getOrderPaymentRequest: () => getOrderPaymentRequest4,
@@ -142,6 +143,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 = {
@@ -417,6 +461,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)({
@@ -698,6 +788,14 @@ function createOrderPaymentRequest3(httpClient) {
     { httpClient }
   );
 }
+function bulkCreateOrderPaymentRequests3(httpClient) {
+  return (orderPaymentRequests, options) => bulkCreateOrderPaymentRequests2(
+    orderPaymentRequests,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function getOrderPaymentRequest3(httpClient) {
   return (orderPaymentRequestId) => getOrderPaymentRequest2(
     orderPaymentRequestId,
@@ -899,6 +997,7 @@ function customQueryOrderPaymentRequests(httpClient) {
   return overloadedQuery;
 }
 var createOrderPaymentRequest4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(createOrderPaymentRequest3);
+var bulkCreateOrderPaymentRequests4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkCreateOrderPaymentRequests3);
 var getOrderPaymentRequest4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getOrderPaymentRequest3);
 var updateOrderPaymentRequest4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateOrderPaymentRequest3);
 var deleteOrderPaymentRequest4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteOrderPaymentRequest3);
@@ -930,6 +1029,7 @@ var onOrderPaymentRequestVoided2 = (0, import_event_definition_modules.createEve
   SortOrder,
   Status,
   WebhookIdentityType,
+  bulkCreateOrderPaymentRequests,
   createOrderPaymentRequest,
   deleteOrderPaymentRequest,
   getOrderPaymentRequest,