@wix/auto_sdk_ecom_order-payment-requests 1.0.16 → 1.0.18

package/build/internal/{es/src/ecom-v1-order-payment-request-order-payment-requests.universal.d.ts → ecom-v1-order-payment-request-order-payment-requests.universal-59AOR9bE.d.ts}

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface OrderPaymentRequest {
+interface OrderPaymentRequest {
     /**
      * Order payment request ID.
      * @format GUID
@@ -77,8 +76,13 @@ export interface OrderPaymentRequest {
      * @readonly
      */
     _updatedDate?: Date | null;
+    /**
+     * List of payment methods that can't be used for this order payment request.
+     * @maxSize 1
+     */
+    blockedPaymentMethods?: PaymentMethodWithLiterals[];
 }
-export interface Source {
+interface Source {
     /**
      * App Def ID that created the order payment request.
      * @format GUID
@@ -95,15 +99,15 @@ export interface Source {
      */
     externalId?: string;
 }
-export declare enum Status {
+declare enum Status {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     UNPAID = "UNPAID",
     PAID = "PAID",
     EXPIRED = "EXPIRED"
 }
 /** @enumType */
-export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'UNPAID' | 'PAID' | 'EXPIRED';
-export interface Price {
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'UNPAID' | 'PAID' | 'EXPIRED';
+interface Price {
     /**
      * Amount.
      * @decimalValue options { gte:0, lte:1000000000000000 }
@@ -115,7 +119,7 @@ export interface Price {
      */
     formattedAmount?: string;
 }
-export interface ExtendedFields {
+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.
@@ -126,21 +130,28 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+declare enum PaymentMethod {
+    UNKNOWN_PAYMENT_METHOD = "UNKNOWN_PAYMENT_METHOD",
+    /** Manual payment. */
+    MANUAL = "MANUAL"
+}
+/** @enumType */
+type PaymentMethodWithLiterals = PaymentMethod | 'UNKNOWN_PAYMENT_METHOD' | 'MANUAL';
 /** Triggered when the order payment request status changes to paid */
-export interface OrderPaymentRequestPaid {
+interface OrderPaymentRequestPaid {
     /** The order that was updated */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 /** Triggered when the order payment request status changes to expired */
-export interface OrderPaymentRequestExpired {
+interface OrderPaymentRequestExpired {
     /** The order that was updated */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-export interface CreateOrderPaymentRequestRequest {
+interface CreateOrderPaymentRequestRequest {
     /** OrderPaymentRequest to be created. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-export interface CreateOrderPaymentRequestResponse {
+interface CreateOrderPaymentRequestResponse {
     /** The created OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
     /**
@@ -150,39 +161,39 @@ export interface CreateOrderPaymentRequestResponse {
      */
     orderPaymentRequestUrl?: string;
 }
-export interface GetOrderPaymentRequestRequest {
+interface GetOrderPaymentRequestRequest {
     /**
      * ID of the OrderPaymentRequest to retrieve.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-export interface GetOrderPaymentRequestResponse {
+interface GetOrderPaymentRequestResponse {
     /** The requested OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-export interface UpdateOrderPaymentRequestRequest {
+interface UpdateOrderPaymentRequestRequest {
     /** OrderPaymentRequest to be updated, may be partial. */
     orderPaymentRequest: OrderPaymentRequest;
 }
-export interface UpdateOrderPaymentRequestResponse {
+interface UpdateOrderPaymentRequestResponse {
     /** Updated OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-export interface DeleteOrderPaymentRequestRequest {
+interface DeleteOrderPaymentRequestRequest {
     /**
      * Id of the OrderPaymentRequest to delete.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-export interface DeleteOrderPaymentRequestResponse {
+interface DeleteOrderPaymentRequestResponse {
 }
-export interface QueryOrderPaymentRequestsRequest {
+interface QueryOrderPaymentRequestsRequest {
     /** WQL expression. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+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;
     /**
@@ -202,11 +213,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+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;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -215,13 +226,13 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface CursorPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -236,7 +247,7 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryOrderPaymentRequestsResponse {
+interface QueryOrderPaymentRequestsResponse {
     /**
      * List of payment requests.
      * @maxSize 1000
@@ -245,7 +256,7 @@ export interface QueryOrderPaymentRequestsResponse {
     /** Paging metadata */
     pagingMetadata?: CursorPagingMetadata;
 }
-export interface CursorPagingMetadata {
+interface CursorPagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
@@ -258,7 +269,7 @@ export interface CursorPagingMetadata {
      */
     hasNext?: boolean | null;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -270,14 +281,14 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface GetOrderPaymentRequestURLRequest {
+interface GetOrderPaymentRequestURLRequest {
     /**
      * Order Payment Request ID.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
-export interface GetOrderPaymentRequestURLResponse {
+interface GetOrderPaymentRequestURLResponse {
     /**
      * Order Payment Request URL.
      * @minLength 1
@@ -285,7 +296,7 @@ export interface GetOrderPaymentRequestURLResponse {
      */
     orderPaymentRequestUrl?: string;
 }
-export interface UpdateExtendedFieldsRequest {
+interface UpdateExtendedFieldsRequest {
     /** ID of the entity to update. */
     _id: string;
     /** Identifier for the app whose extended fields are being updated. */
@@ -293,11 +304,11 @@ export 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;
 }
-export interface UpdateExtendedFieldsResponse {
+interface UpdateExtendedFieldsResponse {
     /** Updated OrderPaymentRequest. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -332,19 +343,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -352,16 +363,16 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -377,7 +388,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -402,7 +413,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -424,7 +435,7 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
@@ -432,72 +443,12 @@ export declare enum WebhookIdentityType {
     APP = "APP"
 }
 /** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-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 Stores
- * @permissionScopeId SCOPE.STORES.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 {
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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 Stores
- * @permissionScopeId SCOPE.STORES.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 {
+interface UpdateOrderPaymentRequest {
     /**
      * Order payment request ID.
      * @format GUID
@@ -575,50 +526,12 @@ export interface UpdateOrderPaymentRequest {
      * @readonly
      */
     _updatedDate?: Date | null;
+    /**
+     * List of payment methods that can't be used for this order payment request.
+     * @maxSize 1
+     */
+    blockedPaymentMethods?: PaymentMethodWithLiterals[];
 }
-/**
- * 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 Stores
- * @permissionScopeId SCOPE.STORES.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 Stores
- * @permissionScopeId SCOPE.STORES.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;
@@ -626,13 +539,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface OrderPaymentRequestsQueryResult extends QueryCursorResult {
+interface OrderPaymentRequestsQueryResult extends QueryCursorResult {
     items: OrderPaymentRequest[];
     query: OrderPaymentRequestsQueryBuilder;
     next: () => Promise<OrderPaymentRequestsQueryResult>;
     prev: () => Promise<OrderPaymentRequestsQueryResult>;
 }
-export interface OrderPaymentRequestsQueryBuilder {
+interface OrderPaymentRequestsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -647,22 +560,22 @@ export interface OrderPaymentRequestsQueryBuilder {
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    ge: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
+    ge: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'amount.amount' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    gt: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
+    gt: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'amount.amount' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    le: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
+    le: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'amount.amount' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
      */
-    lt: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
+    lt: (propertyName: '_id' | 'source.appId' | 'source.externalId' | 'orderId' | 'orderNumber' | 'amount.amount' | 'paymentGatewayOrderId' | 'title' | 'description' | 'expirationDate' | '_createdDate' | '_updatedDate', value: any) => OrderPaymentRequestsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
      * @documentationMaturity preview
@@ -696,49 +609,9 @@ export 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
- * @permissionScope Manage Stores - all permissions
- * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
- * @permissionScope Manage Stores
- * @permissionScopeId SCOPE.STORES.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 Stores
- * @permissionScopeId SCOPE.STORES.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 {
+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 {};
+
+export { type EntityCreatedEvent as A, type EntityUpdatedEvent as B, type CreateOrderPaymentRequestOptions as C, type DeleteOrderPaymentRequestRequest as D, type ExtendedFields as E, type EntityDeletedEvent as F, type GetOrderPaymentRequestURLResponse as G, type ActionEvent as H, type Empty as I, type IdentificationData as J, type IdentificationDataIdOneOf as K, type OrderPaymentRequestsQueryResult as L, type MessageEnvelope as M, type OrderPaymentRequest as O, PaymentMethod 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 Price as f, type OrderPaymentRequestPaid as g, type OrderPaymentRequestExpired as h, type CreateOrderPaymentRequestRequest as i, type CreateOrderPaymentRequestResponse as j, type GetOrderPaymentRequestRequest as k, type GetOrderPaymentRequestResponse as l, type UpdateOrderPaymentRequestRequest as m, type UpdateOrderPaymentRequestResponse as n, type DeleteOrderPaymentRequestResponse as o, type CursorQuery as p, type CursorQueryPagingMethodOneOf as q, type Sorting as r, type CursorPaging as s, type QueryOrderPaymentRequestsResponse as t, type CursorPagingMetadata as u, type Cursors as v, type GetOrderPaymentRequestURLRequest as w, type UpdateExtendedFieldsRequest as x, type DomainEvent as y, type DomainEventBodyOneOf as z };

package/build/internal/index.d.mts

@@ -0,0 +1,84 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreateOrderPaymentRequestOptions, O as OrderPaymentRequest, U as UpdateOrderPaymentRequest, a as OrderPaymentRequestsQueryBuilder, G as GetOrderPaymentRequestURLResponse, b as UpdateExtendedFieldsOptions, c as UpdateExtendedFieldsResponse } from './ecom-v1-order-payment-request-order-payment-requests.universal-59AOR9bE.mjs';
+export { H as ActionEvent, i as CreateOrderPaymentRequestRequest, j as CreateOrderPaymentRequestResponse, s as CursorPaging, u as CursorPagingMetadata, p as CursorQuery, q as CursorQueryPagingMethodOneOf, v as Cursors, D as DeleteOrderPaymentRequestRequest, o as DeleteOrderPaymentRequestResponse, y as DomainEvent, z as DomainEventBodyOneOf, I as Empty, A as EntityCreatedEvent, F as EntityDeletedEvent, B as EntityUpdatedEvent, E as ExtendedFields, k as GetOrderPaymentRequestRequest, l as GetOrderPaymentRequestResponse, w as GetOrderPaymentRequestURLRequest, J as IdentificationData, K as IdentificationDataIdOneOf, M as MessageEnvelope, h as OrderPaymentRequestExpired, g as OrderPaymentRequestPaid, L as OrderPaymentRequestsQueryResult, P as PaymentMethod, f as Price, Q as QueryOrderPaymentRequestsRequest, t as QueryOrderPaymentRequestsResponse, R as RestoreInfo, d as SortOrder, r as Sorting, e as Source, S as Status, x as UpdateExtendedFieldsRequest, m as UpdateOrderPaymentRequestRequest, n as UpdateOrderPaymentRequestResponse, W as WebhookIdentityType } from './ecom-v1-order-payment-request-order-payment-requests.universal-59AOR9bE.mjs';
+
+declare function createOrderPaymentRequest$1(httpClient: HttpClient): CreateOrderPaymentRequestSignature;
+interface CreateOrderPaymentRequestSignature {
+    /**
+     * Creates a order payment request.
+     * @returns The created OrderPaymentRequest.
+     */
+    (options?: CreateOrderPaymentRequestOptions | undefined): Promise<OrderPaymentRequest>;
+}
+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.
+     */
+    (orderPaymentRequestId: string): Promise<OrderPaymentRequest>;
+}
+declare function updateOrderPaymentRequest$1(httpClient: HttpClient): UpdateOrderPaymentRequestSignature;
+interface UpdateOrderPaymentRequestSignature {
+    /**
+     * Updates a order payment request.
+     *
+     * Please note that only `UNPAID` payment requests can be updated.
+     * @param - Order payment request ID.
+     * @returns Updated OrderPaymentRequest.
+     */
+    (_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<OrderPaymentRequest>;
+}
+declare function deleteOrderPaymentRequest$1(httpClient: HttpClient): DeleteOrderPaymentRequestSignature;
+interface DeleteOrderPaymentRequestSignature {
+    /**
+     * Deletes a order payment request.
+     *
+     * Please note that only `UNPAID` payment requests can be deleted.
+     * @param - Id of the OrderPaymentRequest to delete.
+     */
+    (orderPaymentRequestId: string): Promise<void>;
+}
+declare function queryOrderPaymentRequests$1(httpClient: HttpClient): QueryOrderPaymentRequestsSignature;
+interface QueryOrderPaymentRequestsSignature {
+    /**
+     * 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).
+     */
+    (): OrderPaymentRequestsQueryBuilder;
+}
+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.
+     */
+    (orderPaymentRequestId: string): Promise<GetOrderPaymentRequestURLResponse>;
+}
+declare function updateExtendedFields$1(httpClient: HttpClient): UpdateExtendedFieldsSignature;
+interface UpdateExtendedFieldsSignature {
+    /**
+     * Updates extended fields of a 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: UpdateExtendedFieldsOptions): Promise<UpdateExtendedFieldsResponse>;
+}
+
+declare const createOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof createOrderPaymentRequest$1> & typeof createOrderPaymentRequest$1>;
+declare const getOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof getOrderPaymentRequest$1> & typeof getOrderPaymentRequest$1>;
+declare const updateOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof updateOrderPaymentRequest$1> & typeof updateOrderPaymentRequest$1>;
+declare const deleteOrderPaymentRequest: MaybeContext<BuildRESTFunction<typeof deleteOrderPaymentRequest$1> & typeof deleteOrderPaymentRequest$1>;
+declare const queryOrderPaymentRequests: MaybeContext<BuildRESTFunction<typeof queryOrderPaymentRequests$1> & typeof queryOrderPaymentRequests$1>;
+declare const getOrderPaymentRequestUrl: MaybeContext<BuildRESTFunction<typeof getOrderPaymentRequestUrl$1> & typeof getOrderPaymentRequestUrl$1>;
+declare const updateExtendedFields: MaybeContext<BuildRESTFunction<typeof updateExtendedFields$1> & typeof updateExtendedFields$1>;
+
+export { CreateOrderPaymentRequestOptions, GetOrderPaymentRequestURLResponse, OrderPaymentRequest, OrderPaymentRequestsQueryBuilder, UpdateExtendedFieldsOptions, UpdateExtendedFieldsResponse, UpdateOrderPaymentRequest, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, queryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest };