import { HttpTypes, SelectParams } from "@medusajs/types"; import { Client } from "../client.js"; import { ClientHeaders } from "../types.js"; export declare class Payment { /** * @ignore */ private client; /** * @ignore */ constructor(client: Client); /** * This method retrieves a paginated list of payments. It sends a request to the * [List Payments](https://docs.medusajs.com/api/admin#payments_getpayments) API route. * * @param query - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The paginated list of payments. * * @example * To retrieve the list of payments: * * ```ts * sdk.admin.payment.list() * .then(({ payments, count, limit, offset }) => { * console.log(payments) * }) * ``` * * To configure the pagination, pass the `limit` and `offset` query parameters. * * For example, to retrieve only 10 items and skip 10 items: * * ```ts * sdk.admin.payment.list({ * limit: 10, * offset: 10 * }) * .then(({ payments, count, limit, offset }) => { * console.log(payments) * }) * ``` * * Using the `fields` query parameter, you can specify the fields and relations to retrieve * in each payment: * * ```ts * sdk.admin.payment.list({ * fields: "id,*payment_collection" * }) * .then(({ payments, count, limit, offset }) => { * console.log(payments) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations). */ list(query?: HttpTypes.AdminPaymentFilters, headers?: ClientHeaders): Promise; /** * This method retrieves a paginated list of payment providers. It sends a request to the * [List Payment Providers](https://docs.medusajs.com/api/admin#payments_getpaymentspaymentproviders) API route. * * @param query - Filters and pagination configurations. * @param headers - Headers to pass in the request. * @returns The paginated list of payment providers. * * @example * To retrieve the list of payment providers: * * ```ts * sdk.admin.payment.listPaymentProviders() * .then(({ payment_providers, count, limit, offset }) => { * console.log(payment_providers) * }) * ``` * * To configure the pagination, pass the `limit` and `offset` query parameters. * * For example, to retrieve only 10 items and skip 10 items: * * ```ts * sdk.admin.payment.listPaymentProviders({ * limit: 10, * offset: 10 * }) * .then(({ payment_providers, count, limit, offset }) => { * console.log(payment_providers) * }) * ``` * * Using the `fields` query parameter, you can specify the fields and relations to retrieve * in each payment provider: * * ```ts * sdk.admin.payment.listPaymentProviders({ * fields: "id,is_enabled" * }) * .then(({ payment_providers, count, limit, offset }) => { * console.log(payment_providers) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations). */ listPaymentProviders(query?: HttpTypes.AdminGetPaymentProvidersParams, headers?: ClientHeaders): Promise; /** * This method retrieves a payment's details. It sends a request to the * [Get Payment](https://docs.medusajs.com/api/admin#payments_getpaymentsid) * API route. * * @param id - The payment's ID. * @param query - Configure the fields to retrieve in the payment. * @param headers - Headers to pass in the request * @returns The payment's details. * * @example * To retrieve a payment by its ID: * * ```ts * sdk.admin.payment.retrieve("pay_123") * .then(({ payment }) => { * console.log(payment) * }) * ``` * * To specify the fields and relations to retrieve: * * ```ts * sdk.admin.payment.retrieve("pay_123", { * fields: "id,*payment_collection" * }) * .then(({ payment }) => { * console.log(payment) * }) * ``` * * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations). */ retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise; /** * This method captures a payment. It sends a request to the * [Capture Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidcapture) API route. * * The API route uses the `capturePayment` method of the payment provider associated with the payment's collection. * * @param id - The payment's ID. * @param body - The capture's details. * @param query - Configure the fields to retrieve in the payment. * @param headers - Headers to pass in the request * @returns The payment's details. * * @example * sdk.admin.payment.capture("paycol_123", {}) * .then(({ payment }) => { * console.log(payment) * }) */ capture(id: string, body: HttpTypes.AdminCapturePayment, query?: SelectParams, headers?: ClientHeaders): Promise; /** * This method refunds a payment. It sends a request to the * [Refund Payment](https://docs.medusajs.com/api/admin#payments_postpaymentsidrefund) API route. * * The API route uses the `refundPayment` method of the payment provider associated with the payment's collection. * * @param id - The payment's ID. * @param body - The refund's details. * @param query - Configure the fields to retrieve in the payment. * @param headers - Headers to pass in the request * @returns The payment's details. * * @example * sdk.admin.payment.refund("paycol_123", {}) * .then(({ payment }) => { * console.log(payment) * }) */ refund(id: string, body: HttpTypes.AdminRefundPayment, query?: SelectParams, headers?: ClientHeaders): Promise; } //# sourceMappingURL=payment.d.ts.map