@wix/auto_sdk_ecom_order-payment-requests 1.0.8 → 1.0.10

package/build/{ecom-v1-order-payment-request-order-payment-requests.universal-BdicmKpU.d.mts → cjs/src/ecom-v1-order-payment-request-order-payment-requests.universal.d.ts}

@@ -1,4 +1,5 @@
-interface OrderPaymentRequest {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface OrderPaymentRequest {
     /**
      * Order payment request ID.
      * @format GUID
@@ -77,7 +78,7 @@ interface OrderPaymentRequest {
      */
     _updatedDate?: Date | null;
 }
-interface Source {
+export interface Source {
     /**
      * App Def ID that created the order payment request.
      * @format GUID
@@ -94,13 +95,13 @@ interface Source {
      */
     externalId?: string;
 }
-declare enum Status {
+export declare enum Status {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     UNPAID = "UNPAID",
     PAID = "PAID",
     EXPIRED = "EXPIRED"
 }
-interface Price {
+export interface Price {
     /**
      * Amount.
      * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -112,7 +113,7 @@ interface Price {
      */
     formattedAmount?: string;
 }
-interface ExtendedFields {
+export interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -124,20 +125,20 @@ interface ExtendedFields {
     namespaces?: Record<string, Record<string, any>>;
 }
 /** Triggered when the order payment request status changes to paid */
-interface OrderPaymentRequestPaid {
+export interface OrderPaymentRequestPaid {
     /** The order that was updated */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 /** Triggered when the order payment request status changes to expired */
-interface OrderPaymentRequestExpired {
+export interface OrderPaymentRequestExpired {
     /** The order that was updated */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface CreateOrderPaymentRequestRequest {
+export interface CreateOrderPaymentRequestRequest {
     /** OrderPaymentRequest to be created. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface CreateOrderPaymentRequestResponse {
+export interface CreateOrderPaymentRequestResponse {
     /** The created OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
     /**
@@ -147,39 +148,39 @@ interface CreateOrderPaymentRequestResponse {
      */
     orderPaymentRequestUrl?: string;
 }
-interface GetOrderPaymentRequestRequest {
+export interface GetOrderPaymentRequestRequest {
     /**
      * ID of the OrderPaymentRequest to retrieve.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-interface GetOrderPaymentRequestResponse {
+export interface GetOrderPaymentRequestResponse {
     /** The requested OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface UpdateOrderPaymentRequestRequest {
+export interface UpdateOrderPaymentRequestRequest {
     /** OrderPaymentRequest to be updated, may be partial. */
     orderPaymentRequest: OrderPaymentRequest;
 }
-interface UpdateOrderPaymentRequestResponse {
+export interface UpdateOrderPaymentRequestResponse {
     /** Updated OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface DeleteOrderPaymentRequestRequest {
+export interface DeleteOrderPaymentRequestRequest {
     /**
      * Id of the OrderPaymentRequest to delete.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-interface DeleteOrderPaymentRequestResponse {
+export interface DeleteOrderPaymentRequestResponse {
 }
-interface QueryOrderPaymentRequestsRequest {
+export interface QueryOrderPaymentRequestsRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
@@ -199,11 +200,11 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-interface CursorQueryPagingMethodOneOf {
+export interface CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-interface Sorting {
+export interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -212,11 +213,11 @@ interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-declare enum SortOrder {
+export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-interface CursorPaging {
+export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -231,7 +232,7 @@ interface CursorPaging {
      */
     cursor?: string | null;
 }
-interface QueryOrderPaymentRequestsResponse {
+export interface QueryOrderPaymentRequestsResponse {
     /**
      * List of payment requests.
      * @maxSize 1000
@@ -240,7 +241,7 @@ interface QueryOrderPaymentRequestsResponse {
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
 }
-interface CursorPagingMetadata {
+export interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -253,7 +254,7 @@ interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-interface Cursors {
+export interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -265,14 +266,14 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface GetOrderPaymentRequestURLRequest {
+export interface GetOrderPaymentRequestURLRequest {
     /**
      * Order Payment Request ID.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-interface GetOrderPaymentRequestURLResponse {
+export interface GetOrderPaymentRequestURLResponse {
     /**
      * Order Payment Request URL.
      * @minLength 1
@@ -280,7 +281,7 @@ interface GetOrderPaymentRequestURLResponse {
      */
     orderPaymentRequestUrl?: string;
 }
-interface UpdateExtendedFieldsRequest {
+export interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
@@ -288,11 +289,11 @@ interface UpdateExtendedFieldsRequest {
     /** 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;
 }
-interface UpdateExtendedFieldsResponse {
+export interface UpdateExtendedFieldsResponse {
     /** Updated OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -335,19 +336,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+export interface EntityUpdatedEvent {
     /**
      * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
      * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -355,16 +356,16 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface Empty {
+export interface Empty {
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -380,7 +381,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -405,7 +406,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -427,18 +428,72 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface CreateOrderPaymentRequestOptions {
+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
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @returns The created OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.CreateOrderPaymentRequest
+ */
+export declare function createOrderPaymentRequest(options?: NonNullablePaths<CreateOrderPaymentRequestOptions, `orderPaymentRequest.amount` | `orderPaymentRequest.orderId` | `orderPaymentRequest.title`>): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths>>;
+export interface CreateOrderPaymentRequestOptions {
     /** OrderPaymentRequest to be created. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-interface UpdateOrderPaymentRequest {
+/**
+ * Retrieves a order payment request.
+ * @param orderPaymentRequestId - ID of the OrderPaymentRequest to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The requested OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequest
+ */
+export declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths>>;
+/**
+ * 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
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @returns Updated OrderPaymentRequest.
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateOrderPaymentRequest
+ */
+export declare function updateOrderPaymentRequest(_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<NonNullablePaths<OrderPaymentRequest, OrderPaymentRequestNonNullablePaths>>;
+export interface UpdateOrderPaymentRequest {
     /**
      * Order payment request ID.
      * @format GUID
@@ -517,6 +572,45 @@ interface UpdateOrderPaymentRequest {
      */
     _updatedDate?: Date | null;
 }
+/**
+ * Deletes a order payment request.
+ *
+ * Please note that only `UNPAID` payment requests can be deleted.
+ * @param orderPaymentRequestId - Id of the OrderPaymentRequest to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequestId
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_DELETE
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.DeleteOrderPaymentRequest
+ */
+export declare function deleteOrderPaymentRequest(orderPaymentRequestId: string): Promise<void>;
+/**
+ * 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
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.QueryOrderPaymentRequests
+ */
+export declare function queryOrderPaymentRequests(): OrderPaymentRequestsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -524,13 +618,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-interface OrderPaymentRequestsQueryResult extends QueryCursorResult {
+export interface OrderPaymentRequestsQueryResult extends QueryCursorResult {
     items: OrderPaymentRequest[];
     query: OrderPaymentRequestsQueryBuilder;
     next: () => Promise<OrderPaymentRequestsQueryResult>;
     prev: () => Promise<OrderPaymentRequestsQueryResult>;
 }
-interface OrderPaymentRequestsQueryBuilder {
+export interface OrderPaymentRequestsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -594,9 +688,45 @@ interface OrderPaymentRequestsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<OrderPaymentRequestsQueryResult>;
 }
-interface UpdateExtendedFieldsOptions {
+/**
+ * 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
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequestURL
+ */
+export declare function getOrderPaymentRequestUrl(orderPaymentRequestId: string): Promise<NonNullablePaths<GetOrderPaymentRequestURLResponse, `orderPaymentRequestUrl`>>;
+/**
+ * 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
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @applicableIdentity APP
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateExtendedFields
+ */
+export declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
+    [P in OrderPaymentRequestNonNullablePaths]: `orderPaymentRequest.${P}`;
+}[OrderPaymentRequestNonNullablePaths]>>;
+export 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;
 }
-
-export { type EntityUpdatedEvent as A, type EntityDeletedEvent as B, type CreateOrderPaymentRequestOptions as C, type DeleteOrderPaymentRequestRequest as D, type ExtendedFields as E, type ActionEvent as F, type GetOrderPaymentRequestURLResponse as G, type Empty as H, type IdentificationData as I, type IdentificationDataIdOneOf as J, type OrderPaymentRequestsQueryResult as K, type MessageEnvelope as M, type OrderPaymentRequest as O, type Price as P, type QueryOrderPaymentRequestsRequest as Q, type RestoreInfo as R, Status as S, type UpdateOrderPaymentRequest as U, WebhookIdentityType as W, type OrderPaymentRequestsQueryBuilder as a, type UpdateExtendedFieldsOptions as b, type UpdateExtendedFieldsResponse as c, SortOrder as d, type Source as e, type OrderPaymentRequestPaid as f, type OrderPaymentRequestExpired as g, type CreateOrderPaymentRequestRequest as h, type CreateOrderPaymentRequestResponse as i, type GetOrderPaymentRequestRequest as j, type GetOrderPaymentRequestResponse as k, type UpdateOrderPaymentRequestRequest as l, type UpdateOrderPaymentRequestResponse as m, type DeleteOrderPaymentRequestResponse as n, type CursorQuery as o, type CursorQueryPagingMethodOneOf as p, type Sorting as q, type CursorPaging as r, type QueryOrderPaymentRequestsResponse as s, type CursorPagingMetadata as t, type Cursors as u, type GetOrderPaymentRequestURLRequest as v, type UpdateExtendedFieldsRequest as w, type DomainEvent as x, type DomainEventBodyOneOf as y, type EntityCreatedEvent as z };
+export {};