@wix/auto_sdk_ecom_order-payment-requests 1.0.60 → 1.0.62

package/build/internal/cjs/index.typings.d.ts

@@ -9,7 +9,7 @@ interface OrderPaymentRequest {
      */
     _id?: string | null;
     /**
-     * Additional parameters to identify the source of the order payment request.
+     * Details about the source that created the order payment request.
      * @immutable
      */
     source?: Source;
@@ -36,43 +36,47 @@ interface OrderPaymentRequest {
      */
     amount?: Price;
     /**
-     * Currency code. The value will always match the currency used in the order.
+     * Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency.
      * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
-     * Payment gateway order id which is associated with this payment request
+     * Payment gateway order ID associated with this payment request.
      * @readonly
      * @minLength 1
      * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
     /**
-     * Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for.
+     * Title displayed to the customer on the payment page.
      * @minLength 1
      * @maxLength 200
      */
     title?: string;
     /**
-     * Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for.
+     * Description displayed to the customer on the payment page.
      * @maxLength 300
      */
     description?: string | null;
     /**
-     * Time and date the order payment request expires.
+     * Date and time the order payment request expires. If not provided, the order payment request doesn't expire.
      * @immutable
      */
     expirationDate?: Date | null;
-    /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
+    /**
+     * Custom field data for this order payment request.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
     extendedFields?: ExtendedFields;
     /**
-     * Date and time the OrderPaymentRequest was created.
+     * Date and time the order payment request was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the OrderPaymentRequest was last updated.
+     * Date and time the order payment request was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -84,14 +88,12 @@ interface OrderPaymentRequest {
      */
     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.
+     * Action links rendered by the payment page, such as navigation links or error resolution URLs.
      * @internal
      */
     actionLinks?: ActionLinks;
     /**
-     * Charges information for each subscription in the order.
+     * Subscription charges for the order. Displayed to the customer on the payment page so they're aware that paying activates a subscription.
      * @internal
      * @maxSize 100
      * @readonly
@@ -100,7 +102,7 @@ interface OrderPaymentRequest {
 }
 interface Source {
     /**
-     * App Def ID that created the order payment request.
+     * ID of the app that created the order payment request.
      * @format GUID
      * @minLength 1
      * @maxLength 100
@@ -108,7 +110,7 @@ interface Source {
      */
     appId?: string | null;
     /**
-     * Reference to an ID from an external system, indicating the original source of the order payment request.
+     * Reference to a record in the source system. For example, if the payment request was created from a paylink or invoice, use this field to store the paylink ID or invoice ID.
      * @minLength 1
      * @maxLength 100
      * @immutable
@@ -116,10 +118,15 @@ interface Source {
     externalId?: string;
 }
 declare enum Status {
+    /** Payment is owed but hasn't been collected yet. */
     UNPAID = "UNPAID",
+    /** Payment has been collected. */
     PAID = "PAID",
+    /** The order payment request has passed its `expirationDate` without being paid. */
     EXPIRED = "EXPIRED",
-    /** @documentationMaturity preview
+    /**
+     * The order payment request was voided and can no longer be paid.
+     * @documentationMaturity preview
      * @internal
      */
     VOIDED = "VOIDED"
@@ -157,11 +164,13 @@ declare enum PaymentMethod {
 type PaymentMethodWithLiterals = PaymentMethod | 'MANUAL';
 interface ActionLinks {
     /**
-     * A general navigation action link rendered as an anchor in the UI.
+     * Navigation action links rendered as anchors on the payment page.
+     *
+     * Currently supports a single action link.
      * @maxSize 1
      */
     general?: ActionLink[];
-    /** An action link rendered as a button in error messages in the UI. */
+    /** Action link rendered as a button in error messages on the payment page. */
     error?: ActionLink;
 }
 interface ActionLink {
@@ -185,7 +194,7 @@ interface SubscriptionInfo {
      */
     title?: string;
     /**
-     * Description of the charges that will be applied for subscription.
+     * Description of the charges applied for the subscription.
      * @maxLength 1000
      */
     chargeDescription?: string | null;
@@ -197,57 +206,124 @@ interface SubscriptionInfo {
     /** Whether the subscription renews automatically. */
     autoRenewal?: boolean;
 }
-/** Triggered when the order payment request status changes to paid */
+/** Triggered when an order payment request's `status` changes to `PAID`. */
 interface OrderPaymentRequestPaid {
-    /** Order payment request */
+    /** Order payment request that was paid. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-/** Triggered when the order payment request status changes to expired */
+/** Triggered when an order payment request's `status` changes to `EXPIRED`. */
 interface OrderPaymentRequestExpired {
-    /** Order payment request */
+    /** Order payment request that expired. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
-/** Triggered when the order payment request status changes to voided */
+/** Triggered when an order payment request's `status` changes to `VOIDED`. */
 interface OrderPaymentRequestVoided {
-    /** Order payment request */
+    /** Order payment request that was voided. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface CreateOrderPaymentRequestRequest {
-    /** OrderPaymentRequest to be created. */
+    /** Order payment request to create. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface CreateOrderPaymentRequestResponse {
-    /** The created OrderPaymentRequest. */
+    /** Created order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
     /**
-     * Order payment request URL.
+     * Payment page URL for the order payment request. Share this URL with the customer so they can complete the payment.
      * @minLength 1
      * @maxLength 100
      */
     orderPaymentRequestUrl?: string;
 }
+interface BulkCreateOrderPaymentRequestsRequest {
+    /**
+     * Order payment requests to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    orderPaymentRequests: OrderPaymentRequest[];
+    /**
+     * Whether to return the created order payment requests and their payment page URLs in the response.
+     * Default: `false`.
+     */
+    returnEntity?: boolean;
+}
+interface BulkCreateOrderPaymentRequestsResponse {
+    /**
+     * Results of the bulk create operation in the same order as the request items.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkOrderPaymentRequestResult[];
+    /** Metadata about the bulk create operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+     * @format GUID
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkOrderPaymentRequestItem {
+    /** Created order payment request. */
+    orderPaymentRequest?: OrderPaymentRequest;
+    /**
+     * Payment page URL for the created order payment request.
+     * @format WEB_URL
+     */
+    orderPaymentRequestUrl?: string;
+}
+interface BulkOrderPaymentRequestResult {
+    /** Metadata about this item, including its original request index and any error. */
+    itemMetadata?: ItemMetadata;
+    /** Created order payment request and its payment page URL. Returned when `returnEntity` is `true`. */
+    item?: BulkOrderPaymentRequestItem;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
 interface GetOrderPaymentRequestRequest {
     /**
-     * ID of the OrderPaymentRequest to retrieve.
+     * ID of the order payment request to retrieve.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
 interface GetOrderPaymentRequestResponse {
-    /** The requested OrderPaymentRequest. */
+    /** Retrieved order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface UpdateOrderPaymentRequestRequest {
-    /** OrderPaymentRequest to be updated, may be partial. */
+    /** Order payment request to update. */
     orderPaymentRequest: OrderPaymentRequest;
 }
 interface UpdateOrderPaymentRequestResponse {
-    /** Updated OrderPaymentRequest. */
+    /** Updated order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface DeleteOrderPaymentRequestRequest {
     /**
-     * Id of the OrderPaymentRequest to delete.
+     * ID of the order payment request to delete.
      * @format GUID
      */
     orderPaymentRequestId: string;
@@ -314,11 +390,11 @@ interface CursorPaging {
 }
 interface QueryOrderPaymentRequestsResponse {
     /**
-     * List of payment requests.
+     * List of order payment requests.
      * @maxSize 1000
      */
     orderPaymentRequests?: OrderPaymentRequest[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -348,14 +424,14 @@ interface Cursors {
 }
 interface GetOrderPaymentRequestURLRequest {
     /**
-     * Order Payment Request ID.
+     * ID of the order payment request.
      * @format GUID
      */
     orderPaymentRequestId: string;
 }
 interface GetOrderPaymentRequestURLResponse {
     /**
-     * Order Payment Request URL.
+     * Payment page URL for the order payment request.
      * @minLength 1
      * @maxLength 100
      */
@@ -370,7 +446,7 @@ interface UpdateExtendedFieldsRequest {
     namespaceData: Record<string, any> | null;
 }
 interface UpdateExtendedFieldsResponse {
-    /** Updated OrderPaymentRequest. */
+    /** Updated order payment request. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 interface VoidOrderPaymentRequestRequest {
@@ -550,6 +626,10 @@ type CreateOrderPaymentRequestApplicationErrors = {
     code?: 'INVALID_ORDER_STATUS_FOR_SUBSCRIPTION';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type GetOrderPaymentRequestApplicationErrors = {
@@ -707,7 +787,7 @@ interface OrderPaymentRequestExpiredEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"EXPIRED"`.
+ * Triggered when an order payment request's `status` changes to `EXPIRED`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -728,7 +808,7 @@ interface OrderPaymentRequestPaidEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"PAID"`.
+ * Triggered when an order payment request's `status` changes to `PAID`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -770,7 +850,7 @@ interface OrderPaymentRequestVoidedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order payment request status is updated to `"VOIDED"`.
+ * Triggered when an order payment request's `status` changes to `VOIDED`.
  * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Manage Stores
@@ -787,7 +867,11 @@ interface OrderPaymentRequestVoidedEnvelope {
  */
 declare function onOrderPaymentRequestVoided(handler: (event: OrderPaymentRequestVoidedEnvelope) => void | Promise<void>): void;
 /**
- * Creates a order payment request.
+ * 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.
  * @public
  * @documentationMaturity preview
  * @requiredField options.orderPaymentRequest.amount
@@ -795,25 +879,55 @@ declare function onOrderPaymentRequestVoided(handler: (event: OrderPaymentReques
  * @requiredField options.orderPaymentRequest.title
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_CREATE
  * @applicableIdentity APP
- * @returns The created OrderPaymentRequest.
+ * @returns Created order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.CreateOrderPaymentRequest
  */
 declare function createOrderPaymentRequest(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;
 }>;
 interface CreateOrderPaymentRequestOptions {
-    /** OrderPaymentRequest to be created. */
+    /** Order payment request to create. */
     orderPaymentRequest?: OrderPaymentRequest;
 }
 /**
- * Retrieves a order payment request.
- * @param orderPaymentRequestId - ID of the OrderPaymentRequest to retrieve.
+ * Creates multiple order payment requests in a single request. Works synchronously.
+ *
+ * The response contains an item-level result for every requested order payment request. Items are processed independently, so some may succeed while others fail.
+ *
+ * Per-item failures are returned in `results[].itemMetadata.error`. Possible application error codes are:
+ * - `ORDER_NOT_FOUND`: The referenced order wasn't found.
+ * - `PARTIAL_PAYMENT_NOT_SUPPORTED_FOR_SUBSCRIPTION`: The requested amount doesn't equal the subscription order total.
+ * - `INVALID_ORDER_STATUS_FOR_SUBSCRIPTION`: The subscription order isn't in `INITIALIZED` status.
+ * - `SITE_NOT_PUBLISHED`: The site isn't published.
+ * - `ORDER_PAYMENT_REQUEST_PAGE_NOT_FOUND`: The Payment Request Page isn't available on the site.
+ * @param orderPaymentRequests - Order payment requests to create.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField orderPaymentRequests
+ * @requiredField orderPaymentRequests.amount
+ * @requiredField orderPaymentRequests.orderId
+ * @requiredField orderPaymentRequests.source.externalId
+ * @requiredField orderPaymentRequests.title
+ * @permissionId ecom:v1:order_payment_request:bulk_create_order_payment_requests
+ * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.BulkCreateOrderPaymentRequests
+ */
+declare function bulkCreateOrderPaymentRequests(orderPaymentRequests: NonNullablePaths<OrderPaymentRequest, `amount` | `orderId` | `source.externalId` | `title`, 3>[], options?: BulkCreateOrderPaymentRequestsOptions): Promise<NonNullablePaths<BulkCreateOrderPaymentRequestsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.orderPaymentRequest.status` | `results.${number}.item.orderPaymentRequest.orderId` | `results.${number}.item.orderPaymentRequest.currency` | `results.${number}.item.orderPaymentRequest.title` | `results.${number}.item.orderPaymentRequestUrl` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+interface BulkCreateOrderPaymentRequestsOptions {
+    /**
+     * Whether to return the created order payment requests and their payment page URLs in the response.
+     * Default: `false`.
+     */
+    returnEntity?: boolean;
+}
+/**
+ * Retrieves an order payment request.
+ * @param orderPaymentRequestId - ID of the order payment request to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_READ
  * @applicableIdentity APP
- * @returns The requested OrderPaymentRequest.
+ * @returns Retrieved order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.GetOrderPaymentRequest
  */
 declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
@@ -830,7 +944,7 @@ declare function getOrderPaymentRequest(orderPaymentRequestId: string): Promise<
  * @requiredField orderPaymentRequest
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
  * @applicableIdentity APP
- * @returns Updated OrderPaymentRequest.
+ * @returns Updated order payment request.
  * @fqn wix.ecom.order_payment_request.api.v1.OrderPaymentRequestsService.UpdateOrderPaymentRequest
  */
 declare function updateOrderPaymentRequest(_id: string, orderPaymentRequest: UpdateOrderPaymentRequest): Promise<NonNullablePaths<OrderPaymentRequest, `source.externalId` | `status` | `orderId` | `amount.amount` | `amount.formattedAmount` | `currency` | `title` | `blockedPaymentMethods`, 3> & {
@@ -844,7 +958,7 @@ interface UpdateOrderPaymentRequest {
      */
     _id?: string | null;
     /**
-     * Additional parameters to identify the source of the order payment request.
+     * Details about the source that created the order payment request.
      * @immutable
      */
     source?: Source;
@@ -871,43 +985,47 @@ interface UpdateOrderPaymentRequest {
      */
     amount?: Price;
     /**
-     * Currency code. The value will always match the currency used in the order.
+     * Three-letter currency code in [ISO-4217 alphabetic format](http://en.wikipedia.org/wiki/ISO_4217). Always matches the order's currency.
      * @format CURRENCY
      * @readonly
      */
     currency?: string;
     /**
-     * Payment gateway order id which is associated with this payment request
+     * Payment gateway order ID associated with this payment request.
      * @readonly
      * @minLength 1
      * @maxLength 100
      */
     paymentGatewayOrderId?: string | null;
     /**
-     * Title to be displayed to the customer on the payment page. Provide a clear and descriptive title to inform the customer about what they are paying for.
+     * Title displayed to the customer on the payment page.
      * @minLength 1
      * @maxLength 200
      */
     title?: string;
     /**
-     * Description to be displayed to the customer on the payment page. Write a detailed description so the customer understands what they are paying for.
+     * Description displayed to the customer on the payment page.
      * @maxLength 300
      */
     description?: string | null;
     /**
-     * Time and date the order payment request expires.
+     * Date and time the order payment request expires. If not provided, the order payment request doesn't expire.
      * @immutable
      */
     expirationDate?: Date | null;
-    /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls. */
+    /**
+     * Custom field data for this order payment request.
+     *
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
+     */
     extendedFields?: ExtendedFields;
     /**
-     * Date and time the OrderPaymentRequest was created.
+     * Date and time the order payment request was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the OrderPaymentRequest was last updated.
+     * Date and time the order payment request was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -919,14 +1037,12 @@ interface UpdateOrderPaymentRequest {
      */
     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.
+     * Action links rendered by the payment page, such as navigation links or error resolution URLs.
      * @internal
      */
     actionLinks?: ActionLinks;
     /**
-     * Charges information for each subscription in the order.
+     * Subscription charges for the order. Displayed to the customer on the payment page so they're aware that paying activates a subscription.
      * @internal
      * @maxSize 100
      * @readonly
@@ -937,7 +1053,7 @@ interface UpdateOrderPaymentRequest {
  * 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 orderPaymentRequestId - Id of the OrderPaymentRequest to delete.
+ * @param orderPaymentRequestId - ID of the order payment request to delete.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
@@ -949,11 +1065,11 @@ declare function deleteOrderPaymentRequest(orderPaymentRequestId: string): Promi
     __applicationErrorsType?: DeleteOrderPaymentRequestApplicationErrors;
 }>;
 /**
- * Retrieves a list of Payment Requests, given the provided [paging, filtering, and sorting][1].
+ * Retrieves a list of up to 1,000 order payment requests, given the provided [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
  *
- * Query Payment Requests runs with these defaults, which you can override:
- * - `createdDate` is sorted in DESC order
- * - `cursorPaging.limit` is 100
+ * Query Order 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
@@ -1136,8 +1252,8 @@ declare const utils: {
     };
 };
 /**
- * Retrieves the order payment request page URL of a specified order payment request.
- * @param orderPaymentRequestId - Order Payment Request ID.
+ * Retrieves the payment page URL for an order payment request.
+ * @param orderPaymentRequestId - ID of the order payment request.
  * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
@@ -1149,7 +1265,7 @@ declare function getOrderPaymentRequestUrl(orderPaymentRequestId: string): Promi
     __applicationErrorsType?: GetOrderPaymentRequestUrlApplicationErrors;
 }>;
 /**
- * Updates extended fields of a order payment request
+ * Updates the extended fields of an order payment request.
  * @param _id - ID of the entity to update.
  * @param namespace - Identifier for the app whose extended fields are being updated.
  * @public
@@ -1172,7 +1288,7 @@ interface UpdateExtendedFieldsOptions {
  *
  * 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 orderPaymentRequestId - ID of the order payment request to void.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField orderPaymentRequestId
  * @permissionId ECOM.ORDER_PAYMENT_REQUEST_UPDATE
@@ -1183,4 +1299,4 @@ declare function voidOrderPaymentRequest(orderPaymentRequestId: string): Promise
     __applicationErrorsType?: VoidOrderPaymentRequestApplicationErrors;
 }>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ActionLink, type ActionLinks, type BaseEventMetadata, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, 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 EventMetadata, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestCreatedEnvelope, type OrderPaymentRequestDeletedEnvelope, type OrderPaymentRequestExpired, type OrderPaymentRequestExpiredEnvelope, type OrderPaymentRequestPaid, type OrderPaymentRequestPaidEnvelope, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestUpdatedEnvelope, type OrderPaymentRequestVoided, type OrderPaymentRequestVoidedEnvelope, 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 SubscriptionInfo, 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, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ActionLink, type ActionLinks, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateOrderPaymentRequestsOptions, type BulkCreateOrderPaymentRequestsRequest, type BulkCreateOrderPaymentRequestsResponse, type BulkOrderPaymentRequestItem, type BulkOrderPaymentRequestResult, type CommonQueryWithEntityContext, type CreateOrderPaymentRequestApplicationErrors, 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 EventMetadata, type ExtendedFields, type GetOrderPaymentRequestApplicationErrors, type GetOrderPaymentRequestRequest, type GetOrderPaymentRequestResponse, type GetOrderPaymentRequestURLRequest, type GetOrderPaymentRequestURLResponse, type GetOrderPaymentRequestUrlApplicationErrors, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type MessageEnvelope, type OrderPaymentRequest, type OrderPaymentRequestCreatedEnvelope, type OrderPaymentRequestDeletedEnvelope, type OrderPaymentRequestExpired, type OrderPaymentRequestExpiredEnvelope, type OrderPaymentRequestPaid, type OrderPaymentRequestPaidEnvelope, type OrderPaymentRequestQuery, type OrderPaymentRequestQuerySpec, type OrderPaymentRequestUpdatedEnvelope, type OrderPaymentRequestVoided, type OrderPaymentRequestVoidedEnvelope, 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 SubscriptionInfo, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateOrderPaymentRequest, type UpdateOrderPaymentRequestApplicationErrors, type UpdateOrderPaymentRequestRequest, type UpdateOrderPaymentRequestResponse, type VoidOrderPaymentRequestApplicationErrors, type VoidOrderPaymentRequestRequest, type VoidOrderPaymentRequestResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateOrderPaymentRequests, createOrderPaymentRequest, deleteOrderPaymentRequest, getOrderPaymentRequest, getOrderPaymentRequestUrl, onOrderPaymentRequestCreated, onOrderPaymentRequestDeleted, onOrderPaymentRequestExpired, onOrderPaymentRequestPaid, onOrderPaymentRequestUpdated, onOrderPaymentRequestVoided, queryOrderPaymentRequests, typedQueryOrderPaymentRequests, updateExtendedFields, updateOrderPaymentRequest, utils, voidOrderPaymentRequest };