@wix/auto_sdk_ecom_order-payment-requests 1.0.59 → 1.0.60

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
-import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { CreateOrderPaymentRequestOptions, OrderPaymentRequest, CreateOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, OrderPaymentRequestsQueryBuilder, OrderPaymentRequestQuery, typedQueryOrderPaymentRequests } from './index.typings.js';
-export { AccountInfo, ActionEvent, ActionLink, ActionLinks, CommonQueryWithEntityContext, CreateOrderPaymentRequestRequest, CreateOrderPaymentRequestResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteOrderPaymentRequestRequest, DeleteOrderPaymentRequestResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, 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 { 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';
 
 declare function createOrderPaymentRequest$1(httpClient: HttpClient): CreateOrderPaymentRequestSignature;
 interface CreateOrderPaymentRequestSignature {
@@ -26,9 +26,9 @@ interface GetOrderPaymentRequestSignature {
 declare function updateOrderPaymentRequest$1(httpClient: HttpClient): UpdateOrderPaymentRequestSignature;
 interface UpdateOrderPaymentRequestSignature {
     /**
-     * Updates a order payment request.
+     * Updates an order payment request.
      *
-     * Please note that only `UNPAID` payment requests can be updated.
+     * 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.
      */
@@ -39,9 +39,9 @@ interface UpdateOrderPaymentRequestSignature {
 declare function deleteOrderPaymentRequest$1(httpClient: HttpClient): DeleteOrderPaymentRequestSignature;
 interface DeleteOrderPaymentRequestSignature {
     /**
-     * Deletes a order payment request.
+     * Deletes an order payment request.
      *
-     * Please note that only `UNPAID` and `VOIDED` payment requests can be deleted.
+     * 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.
      */
     (orderPaymentRequestId: string): Promise<void & {
@@ -67,6 +67,12 @@ interface UpdateExtendedFieldsSignature {
      */
     (_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 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">;
+declare const onOrderPaymentRequestPaid$1: EventDefinition<OrderPaymentRequestPaidEnvelope, "wix.ecom.v1.order_payment_request_paid">;
+declare const onOrderPaymentRequestUpdated$1: EventDefinition<OrderPaymentRequestUpdatedEnvelope, "wix.ecom.v1.order_payment_request_updated">;
+declare const onOrderPaymentRequestVoided$1: EventDefinition<OrderPaymentRequestVoidedEnvelope, "wix.ecom.v1.order_payment_request_voided">;
 
 declare function customQueryOrderPaymentRequests(httpClient: HttpClient): {
     (): OrderPaymentRequestsQueryBuilder;
@@ -79,5 +85,29 @@ declare const deleteOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof d
 declare const getOrderPaymentRequestUrl: MaybeContext<BuildRESTFunction<typeof getOrderPaymentRequestUrl$1> & typeof getOrderPaymentRequestUrl$1>;
 declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
 declare const queryOrderPaymentRequests: MaybeContext<BuildRESTFunction<typeof customQueryOrderPaymentRequests> & typeof customQueryOrderPaymentRequests>;
+/**
+ * Triggered when an order payment request is created.
+ */
+declare const onOrderPaymentRequestCreated: BuildEventDefinition<typeof onOrderPaymentRequestCreated$1> & typeof onOrderPaymentRequestCreated$1;
+/**
+ * Triggered when an order payment request is deleted.
+ */
+declare const onOrderPaymentRequestDeleted: BuildEventDefinition<typeof onOrderPaymentRequestDeleted$1> & typeof onOrderPaymentRequestDeleted$1;
+/**
+ * Triggered when an order payment request status is updated to `"EXPIRED"`.
+ */
+declare const onOrderPaymentRequestExpired: BuildEventDefinition<typeof onOrderPaymentRequestExpired$1> & typeof onOrderPaymentRequestExpired$1;
+/**
+ * Triggered when an order payment request status is updated to `"PAID"`.
+ */
+declare const onOrderPaymentRequestPaid: BuildEventDefinition<typeof onOrderPaymentRequestPaid$1> & typeof onOrderPaymentRequestPaid$1;
+/**
+ * Triggered when an order payment request is updated.
+ */
+declare const onOrderPaymentRequestUpdated: BuildEventDefinition<typeof onOrderPaymentRequestUpdated$1> & typeof onOrderPaymentRequestUpdated$1;
+/**
+ * Triggered when an order payment request status is updated to `"VOIDED"`.
+ */
+declare const onOrderPaymentRequestVoided: BuildEventDefinition<typeof onOrderPaymentRequestVoided$1> & typeof onOrderPaymentRequestVoided$1;
 
-export { CreateOrderPaymentRequestApplicationErrors, CreateOrderPaymentRequestOptions, DeleteOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestApplicationErrors, GetOrderPaymentRequestURLResponse, GetOrderPaymentRequestUrlApplicationErrors, OrderPaymentRequest, OrderPaymentRequestQuery, OrderPaymentRequestsQueryBuilder, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateOrderPaymentRequest, UpdateOrderPaymentRequestApplicationErrors, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, queryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest };
+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 };

package/build/cjs/index.js

@@ -28,6 +28,12 @@ __export(index_exports, {
   deleteOrderPaymentRequest: () => deleteOrderPaymentRequest4,
   getOrderPaymentRequest: () => getOrderPaymentRequest4,
   getOrderPaymentRequestUrl: () => getOrderPaymentRequestUrl4,
+  onOrderPaymentRequestCreated: () => onOrderPaymentRequestCreated2,
+  onOrderPaymentRequestDeleted: () => onOrderPaymentRequestDeleted2,
+  onOrderPaymentRequestExpired: () => onOrderPaymentRequestExpired2,
+  onOrderPaymentRequestPaid: () => onOrderPaymentRequestPaid2,
+  onOrderPaymentRequestUpdated: () => onOrderPaymentRequestUpdated2,
+  onOrderPaymentRequestVoided: () => onOrderPaymentRequestVoided2,
   queryOrderPaymentRequests: () => queryOrderPaymentRequests4,
   updateExtendedFields: () => updateExtendedFields4,
   updateOrderPaymentRequest: () => updateOrderPaymentRequest4,
@@ -36,6 +42,13 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/ecom-v1-order-payment-request-order-payment-requests.public.ts
+var import_rename_all_nested_keys2 = require("@wix/sdk-runtime/rename-all-nested-keys");
+var import_image3 = require("@wix/sdk-runtime/transformations/image");
+var import_timestamp3 = require("@wix/sdk-runtime/transformations/timestamp");
+var import_transform_paths3 = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_sdk_types = require("@wix/sdk-types");
+
 // src/ecom-v1-order-payment-request-order-payment-requests.universal.ts
 var import_transform_error = require("@wix/sdk-runtime/transform-error");
 var import_query_builder = require("@wix/sdk-runtime/query-builder");
@@ -743,9 +756,136 @@ function voidOrderPaymentRequest3(httpClient) {
     { httpClient }
   );
 }
+var onOrderPaymentRequestCreated = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_created",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.expirationDate" },
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "entity.image" }]
+      }
+    ])
+  )
+)();
+var onOrderPaymentRequestDeleted = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_deleted",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.expirationDate" },
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "entity.image" }]
+      }
+    ])
+  )
+)();
+var onOrderPaymentRequestExpired = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_expired",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "data.orderPaymentRequest.expirationDate" },
+          { path: "data.orderPaymentRequest.createdDate" },
+          { path: "data.orderPaymentRequest.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "data.orderPaymentRequest.image" }]
+      }
+    ])
+  )
+)();
+var onOrderPaymentRequestPaid = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_paid",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "data.orderPaymentRequest.expirationDate" },
+          { path: "data.orderPaymentRequest.createdDate" },
+          { path: "data.orderPaymentRequest.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "data.orderPaymentRequest.image" }]
+      }
+    ])
+  )
+)();
+var onOrderPaymentRequestUpdated = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_updated",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "entity.expirationDate" },
+          { path: "entity.createdDate" },
+          { path: "entity.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "entity.image" }]
+      }
+    ])
+  )
+)();
+var onOrderPaymentRequestVoided = (0, import_sdk_types.EventDefinition)(
+  "wix.ecom.v1.order_payment_request_voided",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths3.transformPaths)(event, [
+      {
+        transformFn: import_timestamp3.transformRESTTimestampToSDKTimestamp,
+        paths: [
+          { path: "data.orderPaymentRequest.expirationDate" },
+          { path: "data.orderPaymentRequest.createdDate" },
+          { path: "data.orderPaymentRequest.updatedDate" },
+          { path: "metadata.eventTime" }
+        ]
+      },
+      {
+        transformFn: import_image3.transformRESTImageToSDKImage,
+        paths: [{ path: "data.orderPaymentRequest.image" }]
+      }
+    ])
+  )
+)();
 
 // src/ecom-v1-order-payment-request-order-payment-requests.context.ts
 var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
 var import_query_method_router = require("@wix/sdk-runtime/query-method-router");
 function customQueryOrderPaymentRequests(httpClient) {
   const router = (0, import_query_method_router.createQueryOverloadRouter)({
@@ -766,6 +906,24 @@ var getOrderPaymentRequestUrl4 = /* @__PURE__ */ (0, import_rest_modules3.create
 var updateExtendedFields4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateExtendedFields3);
 var voidOrderPaymentRequest4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(voidOrderPaymentRequest3);
 var queryOrderPaymentRequests4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryOrderPaymentRequests);
+var onOrderPaymentRequestCreated2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestCreated
+);
+var onOrderPaymentRequestDeleted2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestDeleted
+);
+var onOrderPaymentRequestExpired2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestExpired
+);
+var onOrderPaymentRequestPaid2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestPaid
+);
+var onOrderPaymentRequestUpdated2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestUpdated
+);
+var onOrderPaymentRequestVoided2 = (0, import_event_definition_modules.createEventModule)(
+  onOrderPaymentRequestVoided
+);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PaymentMethod,
@@ -776,6 +934,12 @@ var queryOrderPaymentRequests4 = /* @__PURE__ */ (0, import_rest_modules3.create
   deleteOrderPaymentRequest,
   getOrderPaymentRequest,
   getOrderPaymentRequestUrl,
+  onOrderPaymentRequestCreated,
+  onOrderPaymentRequestDeleted,
+  onOrderPaymentRequestExpired,
+  onOrderPaymentRequestPaid,
+  onOrderPaymentRequestUpdated,
+  onOrderPaymentRequestVoided,
   queryOrderPaymentRequests,
   updateExtendedFields,
   updateOrderPaymentRequest,