@wix/auto_sdk_ecom_order-payment-requests 1.0.24 → 1.0.26

package/build/{cjs/ecom-v1-order-payment-request-order-payment-requests.universal-Bfgzg5Ab.d.ts → internal/cjs/index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface OrderPaymentRequest {
     /**
      * Order payment request ID.
@@ -76,6 +78,19 @@ interface OrderPaymentRequest {
     _updatedDate?: Date | null;
     /** Image to display to the customer on the payment page. */
     image?: string;
+    /**
+     * List of payment methods that can't be used for this order payment request.
+     * @internal
+     * @maxSize 1
+     */
+    blockedPaymentMethods?: PaymentMethodWithLiterals[];
+    /**
+     * A collection of action links (e.g., navigation or error resolution URLs) intended for client-side use.
+     *
+     * These actions are optional and may be conditionally rendered based on the client context.
+     * @internal
+     */
+    actionLinks?: ActionLinks;
 }
 interface Source {
     /**
@@ -130,6 +145,8 @@ declare enum PaymentMethod {
     /** Manual payment. */
     MANUAL = "MANUAL"
 }
+/** @enumType */
+type PaymentMethodWithLiterals = PaymentMethod | 'UNKNOWN_PAYMENT_METHOD' | 'MANUAL';
 interface ActionLinks {
     /**
      * A general navigation action link rendered as an anchor in the UI.
@@ -473,10 +490,101 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type GetOrderPaymentRequestApplicationErrors = {
+    code?: 'ORDER_PAYMENT_REQUEST_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+type UpdateOrderPaymentRequestApplicationErrors = {
+    code?: 'CANNOT_UPDATE_PAID_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_UPDATE_EXPIRED_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_UPDATE_VOIDED_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+};
+type DeleteOrderPaymentRequestApplicationErrors = {
+    code?: 'CANNOT_DELETE_PAID_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+};
+type GetOrderPaymentRequestUrlApplicationErrors = {
+    code?: 'ORDER_PAYMENT_REQUEST_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+type VoidOrderPaymentRequestApplicationErrors = {
+    code?: 'ORDER_PAYMENT_REQUEST_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_VOID_PAID_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CANNOT_VOID_EXPIRED_ORDER_PAYMENT_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+};
+type OrderPaymentRequestNonNullablePaths = `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title`;
+/**
+ * Creates a order payment request.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.orderPaymentRequest.amount
+ * @requiredField options.orderPaymentRequest.orderId
+ * @requiredField options.orderPaymentRequest.title
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_CREATE
+ * @applicableIdentity APP
+ * @returns The created OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.CreateOrderPaymentRequest
+ */
+declare function createOrderPaymentRequest(options?: NonNullablePaths<CreateOrderPaymentRequestOptions, `orderPaymentRequest.amount` | `orderPaymentRequest.orderId` | `orderPaymentRequest.title`>): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths>>;
 interface CreateOrderPaymentRequestOptions {
     /** OrderPaymentRequest to be created. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
+/**
+ * Retrieves a order payment request.
+ * @param orderPaymentRequestId - ID of the OrderPaymentRequest to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The requested OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequest
+ */
+declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths> & {
+    __applicationErrorsType?: GetOrderPaymentRequestApplicationErrors;
+}>;
+/**
+ * Updates a order payment request.
+ *
+ * Please note that only `UNPAID` payment requests can be updated.
+ * @param _id - Order payment request ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField orderPaymentRequest
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateOrderPaymentRequest
+ */
+declare function updateOrderPaymentRequest(_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths> & {
+    __applicationErrorsType?: UpdateOrderPaymentRequestApplicationErrors;
+}>;
 interface UpdateOrderPaymentRequest {
     /**
      * Order payment request ID.
@@ -555,7 +663,53 @@ interface UpdateOrderPaymentRequest {
     _updatedDate?: Date | null;
     /** Image to display to the customer on the payment page. */
     image?: string;
-}
+    /**
+     * List of payment methods that can't be used for this order payment request.
+     * @internal
+     * @maxSize 1
+     */
+    blockedPaymentMethods?: PaymentMethodWithLiterals[];
+    /**
+     * A collection of action links (e.g., navigation or error resolution URLs) intended for client-side use.
+     *
+     * These actions are optional and may be conditionally rendered based on the client context.
+     * @internal
+     */
+    actionLinks?: ActionLinks;
+}
+/**
+ * Deletes a order payment request.
+ *
+ * Please note that only `UNPAID` and `VOIDED` payment requests can be deleted.
+ * @param orderPaymentRequestId - Id of the OrderPaymentRequest to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.DeleteOrderPaymentRequest
+ */
+declare function deleteOrderPaymentRequest(orderPaymentRequestId: string): Promise<void & {
+    __applicationErrorsType?: DeleteOrderPaymentRequestApplicationErrors;
+}>;
+/**
+ * Retrieves a list of Payment Requests, given the provided [paging, filtering, and sorting][1].
+ *
+ * Query Payment Requests runs with these defaults, which you can override:
+ * - `createdDate` is sorted in DESC order
+ * - `cursorPaging.limit` is 100
+ *
+ * To learn about working with _Query_ endpoints, see
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
+ * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.QueryOrderPaymentRequests
+ */
+declare function queryOrderPaymentRequests(): OrderPaymentRequestsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -633,9 +787,55 @@ interface OrderPaymentRequestsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<OrderPaymentRequestsQueryResult>;
 }
+/**
+ * Retrieves the order payment request page URL of a specified order payment request.
+ * @param orderPaymentRequestId - Order Payment Request ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequestURL
+ */
+declare function getOrderPaymentRequestUrl(orderPaymentRequestId: string): Promise<NonNullablePaths<GetOrderPaymentRequestURLResponse, `orderPaymentRequestUrl`> & {
+    __applicationErrorsType?: GetOrderPaymentRequestUrlApplicationErrors;
+}>;
+/**
+ * Updates extended fields of a order payment request
+ * @param _id - ID of the entity to update.
+ * @param namespace - Identifier for the app whose extended fields are being updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField namespace
+ * @requiredField options
+ * @requiredField options.namespaceData
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
+ * @applicableIdentity APP
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateExtendedFields
+ */
+declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+    [P in OrderPaymentRequestNonNullablePaths]: `orderPaymentRequest.${P}`;
+}[OrderPaymentRequestNonNullablePaths]>>;
 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
+ *
+ * Please note that only `UNPAID` payment requests can be voided.
+ * @param orderPaymentRequestId - ID of the order payment request to void.
+ * @internal
+ * @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;
+}>;
 
-export { type ActionLinks as A, type VoidOrderPaymentRequestResponse as B, type CreateOrderPaymentRequestOptions as C, type DeleteOrderPaymentRequestRequest as D, type ExtendedFields as E, type DomainEvent as F, type GetOrderPaymentRequestURLResponse as G, type DomainEventBodyOneOf as H, type EntityCreatedEvent as I, type EntityUpdatedEvent as J, type EntityDeletedEvent as K, type ActionEvent as L, type Empty as M, type MessageEnvelope as N, type OrderPaymentRequest as O, PaymentMethod as P, type QueryOrderPaymentRequestsRequest as Q, type RestoreInfo as R, Status as S, type IdentificationData as T, type UpdateOrderPaymentRequest as U, type VoidOrderPaymentRequestRequest as V, WebhookIdentityType as W, type IdentificationDataIdOneOf as X, type OrderPaymentRequestsQueryResult as Y, type OrderPaymentRequestsQueryBuilder as a, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, SortOrder as d, type Source as e, type Price as f, type ActionLink as g, type OrderPaymentRequestPaid as h, type OrderPaymentRequestExpired as i, type OrderPaymentRequestVoided as j, type CreateOrderPaymentRequestRequest as k, type CreateOrderPaymentRequestResponse as l, type GetOrderPaymentRequestRequest as m, type GetOrderPaymentRequestResponse as n, type UpdateOrderPaymentRequestRequest as o, type UpdateOrderPaymentRequestResponse as p, type DeleteOrderPaymentRequestResponse as q, type CursorQuery as r, type CursorQueryPagingMethodOneOf as s, type Sorting as t, type CursorPaging as u, type QueryOrderPaymentRequestsResponse as v, type CursorPagingMetadata as w, type Cursors as x, type GetOrderPaymentRequestURLRequest as y, type UpdateExtendedFieldsRequest as z };
+export { type ActionEvent, type ActionLink, type ActionLinks, 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 ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestExpired, type OrderPaymentRequestPaid, type OrderPaymentRequestVoided, 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 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, queryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, voidOrderPaymentRequest };