@wix/auto_sdk_ecom_order-payment-requests 1.0.16 → 1.0.18

package/build/index.d.ts

@@ -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.js';
+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.js';
+
+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 };