@metamask/ramps-controller 20.3.0 → 22.0.0

package/dist/RampsService.d.cts

@@ -1,944 +0,0 @@
-import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
-import type { Messenger } from "@metamask/messenger";
-import type { AuthenticationController } from "@metamask/profile-sync-controller";
-import type { RampsServiceMethodActions } from "./RampsService-method-action-types.cjs";
-/**
- * Represents phone number information for a country.
- */
-export type CountryPhone = {
-    prefix: string;
-    placeholder: string;
-    template: string;
-};
-/**
- * Indicates whether a region supports buy and/or sell actions.
- */
-export type SupportedActions = {
-    /**
-     * Whether buy actions are supported.
-     */
-    buy: boolean;
-    /**
-     * Whether sell actions are supported.
-     */
-    sell: boolean;
-};
-/**
- * Represents a state/province within a country.
- */
-export type State = {
-    /**
-     * State identifier. Can be in path format (e.g., "/regions/us-ut") or ISO code format (e.g., "us-ut").
-     */
-    id?: string;
-    /**
-     * State name.
-     */
-    name?: string;
-    /**
-     * ISO state code (e.g., "UT", "NY").
-     */
-    stateId?: string;
-    /**
-     * Whether this state is supported for buy and/or sell ramp actions.
-     */
-    supported?: SupportedActions;
-    /**
-     * Whether this state is recommended.
-     */
-    recommended?: boolean;
-};
-/**
- * Represents a provider link.
- */
-export type ProviderLink = {
-    name: string;
-    url: string;
-};
-/**
- * Represents provider logos.
- */
-export type ProviderLogos = {
-    light: string;
-    dark: string;
-    height: number;
-    width: number;
-};
-/**
- * Browser type for provider buy features.
- */
-export type ProviderBrowserType = 'APP_BROWSER' | 'IN_APP_OS_BROWSER' | null;
-/**
- * Fiat amount limits for a provider and payment method.
- */
-export type ProviderLimit = {
-    minAmount: number;
-    maxAmount: number;
-    feeFixedRate: number;
-    feeDynamicRate: number;
-};
-/**
- * Fiat buy limits keyed by lowercased fiat short code, then payment method id.
- */
-export type ProviderFiatLimits = Record<string, Record<string, ProviderLimit>>;
-/**
- * Provider limits exposed by the regions providers endpoint.
- */
-export type ProviderLimits = {
-    fiat?: ProviderFiatLimits;
-};
-/**
- * Represents a ramp provider.
- */
-export type Provider = {
-    id: string;
-    name: string;
-    /**
-     * Provider classification from the v2 API: 'native' (first-party
-     * integration, e.g. Transak Native) or 'aggregator' (third-party redirect).
-     * May be absent on responses that predate the v2 type field.
-     */
-    type?: 'aggregator' | 'native';
-    environmentType: string;
-    description: string;
-    hqAddress: string;
-    links: ProviderLink[];
-    logos: ProviderLogos;
-    supportedCryptoCurrencies?: Record<string, boolean>;
-    supportedFiatCurrencies?: Record<string, boolean>;
-    supportedPaymentMethods?: Record<string, boolean>;
-    limits?: ProviderLimits;
-};
-/**
- * Backend-defined ordering for providers.
- */
-export type ProviderSortOrder = {
-    sortBy: string;
-    ids: string[];
-};
-/**
- * Response from the region providers API.
- */
-export type ProvidersResponse = {
-    providers: Provider[];
-    sorted?: ProviderSortOrder[];
-};
-/**
- * Represents a payment method for funding a purchase.
- */
-export type PaymentMethod = {
-    /**
-     * Canonical payment method ID (e.g., "/payments/debit-credit-card").
-     */
-    id: string;
-    /**
-     * Payment type identifier (e.g., "debit-credit-card", "bank-transfer").
-     */
-    paymentType: string;
-    /**
-     * User-facing name for the payment method.
-     */
-    name: string;
-    /**
-     * Score for sorting payment methods (higher is better).
-     */
-    score: number;
-    /**
-     * Icon identifier for the payment method.
-     */
-    icon: string;
-    /**
-     * Localized disclaimer text (optional).
-     */
-    disclaimer?: string;
-    /**
-     * Delay in minutes (e.g., [5, 10]).
-     */
-    delay?: number[];
-    /**
-     * Localized pending order description (optional).
-     */
-    pendingOrderDescription?: string;
-    /**
-     * Whether this payment method is a manual bank transfer.
-     */
-    isManualBankTransfer?: boolean;
-};
-/**
- * Response from the paymentMethods API.
- */
-export type PaymentMethodsResponse = {
-    /**
-     * List of available payment methods.
-     */
-    payments: PaymentMethod[];
-    /**
-     * Recommended sorting for payment methods.
-     */
-    sort?: {
-        ids: string[];
-        sortBy: string;
-    };
-};
-/**
- * Sort criteria for quotes.
- */
-export type QuoteSortBy = 'price' | 'reliability';
-/**
- * Represents crypto translation info for a quote.
- */
-export type QuoteCryptoTranslation = {
-    /**
-     * The crypto currency ID.
-     */
-    id?: string;
-    /**
-     * The crypto symbol.
-     */
-    symbol?: string;
-    /**
-     * The chain ID.
-     */
-    chainId?: string;
-};
-/**
- * Widget information for executing a buy order.
- */
-export type BuyWidget = {
-    /**
-     * The widget URL to open for the user to complete the purchase.
-     */
-    url: string;
-    /**
-     * The browser type to use for opening the widget.
-     */
-    browser?: ProviderBrowserType;
-    /**
-     * Order ID if already created.
-     */
-    orderId?: string | null;
-};
-/**
- * Represents an individual quote from a provider.
- */
-export type Quote = {
-    /**
-     * The provider ID (e.g., "/providers/moonpay").
-     */
-    provider: string;
-    /**
-     * The quote details.
-     */
-    quote: {
-        /**
-         * The amount the user is paying (in fiat for buy, crypto for sell).
-         */
-        amountIn: number | string;
-        /**
-         * The amount the user will receive (in crypto for buy, fiat for sell).
-         */
-        amountOut: number | string;
-        /**
-         * The payment method used for this quote.
-         */
-        paymentMethod: string;
-        /**
-         * The fiat value of the output amount (for buy actions).
-         */
-        amountOutInFiat?: number;
-        /**
-         * Crypto translation info for display.
-         */
-        cryptoTranslation?: QuoteCryptoTranslation;
-        /**
-         * Total fees in the source currency.
-         */
-        totalFees?: number | string;
-        /**
-         * Network fees.
-         */
-        networkFee?: number | string;
-        /**
-         * Provider fees.
-         */
-        providerFee?: number | string;
-        /**
-         * Buy URL endpoint that returns the actual provider widget URL.
-         *
-         * This is a MetaMask-hosted endpoint that, when fetched, returns JSON with the provider's widget URL.
-         *
-         * @deprecated Use buyWidget instead - it's embedded in the quote response.
-         */
-        buyURL?: string;
-        /**
-         * Widget information embedded in the quote response.
-         * Contains the widget URL, browser type, and optional pre-order tracking ID.
-         */
-        buyWidget?: BuyWidget;
-    };
-    /**
-     * Metadata about the quote.
-     */
-    metadata?: {
-        /**
-         * Reliability score for the provider (0-100).
-         */
-        reliability?: number;
-        /**
-         * Tags for the quote.
-         */
-        tags?: {
-            /**
-             * Whether this is the best rate quote.
-             */
-            isBestRate?: boolean;
-            /**
-             * Whether this is the most reliable provider.
-             */
-            isMostReliable?: boolean;
-        };
-    };
-};
-/**
- * Represents an error from a provider when fetching quotes.
- */
-export type QuoteError = {
-    /**
-     * The provider ID that failed.
-     */
-    provider: string;
-    /**
-     * Error message.
-     */
-    error?: string;
-};
-/**
- * Sort order information for quotes.
- */
-export type QuoteSortOrder = {
-    /**
-     * The sort criteria.
-     */
-    sortBy: QuoteSortBy;
-    /**
-     * Provider IDs in sorted order.
-     */
-    ids: string[];
-};
-/**
- * Custom action for a provider (e.g., Apple Pay).
- */
-export type QuoteCustomAction = {
-    /**
-     * Buy action details.
-     */
-    buy: {
-        /**
-         * Provider ID.
-         */
-        providerId: string;
-    };
-    /**
-     * Payment method ID this action applies to.
-     */
-    paymentMethodId: string;
-    /**
-     * Supported payment method IDs.
-     */
-    supportedPaymentMethodIds: string[];
-};
-/**
- * Response from the quotes API.
- */
-export type QuotesResponse = {
-    /**
-     * Successfully retrieved quotes.
-     */
-    success: Quote[];
-    /**
-     * Sort orders for the quotes.
-     */
-    sorted: QuoteSortOrder[];
-    /**
-     * Errors from providers that failed to return quotes.
-     */
-    error: QuoteError[];
-    /**
-     * Custom actions available from providers.
-     */
-    customActions: QuoteCustomAction[];
-};
-/**
- * Parameters for fetching quotes.
- */
-export type GetQuotesParams = {
-    /**
-     * The region code (e.g., "us", "us-ca").
-     */
-    region: string;
-    /**
-     * Array of payment method IDs to get quotes for.
-     */
-    paymentMethods: string[];
-    /**
-     * The CAIP-19 asset ID (e.g., "eip155:1/erc20:0x...").
-     */
-    assetId: string;
-    /**
-     * The fiat currency code (e.g., "usd").
-     */
-    fiat: string;
-    /**
-     * The amount (in fiat for buy, crypto for sell).
-     */
-    amount: number;
-    /**
-     * The destination wallet address.
-     */
-    walletAddress: string;
-    /**
-     * Optional redirect URL after order completion.
-     */
-    redirectUrl?: string;
-    /**
-     * Optional provider IDs to filter quotes.
-     */
-    providers?: string[];
-    /**
-     * The ramp action type. Defaults to 'buy'.
-     */
-    action?: RampAction;
-};
-/**
- * Represents a country returned from the regions/countries API.
- */
-export type Country = {
-    /**
-     * ISO-2 country code (e.g., "US", "GB").
-     */
-    isoCode: string;
-    /**
-     * Country identifier. Can be in path format (e.g., "/regions/us") or ISO code format.
-     * If not provided, defaults to isoCode.
-     */
-    id?: string;
-    /**
-     * Country flag emoji or code.
-     */
-    flag: string;
-    /**
-     * Country name.
-     */
-    name: string;
-    /**
-     * Phone number information.
-     */
-    phone: CountryPhone;
-    /**
-     * Default currency code.
-     */
-    currency: string;
-    /**
-     * Whether this country is supported for buy and/or sell ramp actions.
-     */
-    supported: SupportedActions;
-    /**
-     * Whether this country is recommended.
-     */
-    recommended?: boolean;
-    /**
-     * Array of state objects.
-     */
-    states?: State[];
-    /**
-     * Default amount for ramps transactions.
-     */
-    defaultAmount?: number;
-    /**
-     * Quick amount options for ramps transactions.
-     */
-    quickAmounts?: number[];
-};
-/**
- * Represents a token returned from the regions/{region}/tokens API.
- */
-export type RampsToken = {
-    /**
-     * The asset identifier in CAIP-19 format (e.g., "eip155:1/erc20:0x...").
-     */
-    assetId: string;
-    /**
-     * The chain identifier in CAIP-2 format (e.g., "eip155:1").
-     */
-    chainId: string;
-    /**
-     * Token name (e.g., "USD Coin").
-     */
-    name: string;
-    /**
-     * Token symbol (e.g., "USDC").
-     */
-    symbol: string;
-    /**
-     * Number of decimals for the token.
-     */
-    decimals: number;
-    /**
-     * URL to the token icon.
-     */
-    iconUrl: string;
-    /**
-     * Whether this token is supported.
-     */
-    tokenSupported: boolean;
-};
-/**
- * Response from the regions/{region}/tokens API.
- */
-export type TokensResponse = {
-    /**
-     * Top/popular tokens for the region.
-     */
-    topTokens: RampsToken[];
-    /**
-     * All available tokens for the region.
-     */
-    allTokens: RampsToken[];
-};
-/**
- * Possible statuses for a ramps order.
- */
-export declare enum RampsOrderStatus {
-    Unknown = "UNKNOWN",
-    Precreated = "PRECREATED",
-    Created = "CREATED",
-    Pending = "PENDING",
-    Failed = "FAILED",
-    Completed = "COMPLETED",
-    Cancelled = "CANCELLED",
-    IdExpired = "ID_EXPIRED"
-}
-/**
- * Network information associated with an order.
- */
-export type RampsOrderNetwork = {
-    name: string;
-    chainId: string;
-};
-/**
- * Crypto currency information associated with an order.
- */
-export type RampsOrderCryptoCurrency = {
-    assetId?: string;
-    name?: string;
-    chainId?: string;
-    decimals?: number;
-    iconUrl?: string;
-    symbol: string;
-};
-/**
- * Payment method information associated with an order.
- */
-export type RampsOrderPaymentMethod = {
-    id: string;
-    name?: string;
-    shortName?: string;
-    duration?: string;
-    icon?: string;
-    isManualBankTransfer?: boolean;
-};
-/**
- * Bank transfer instruction fields attached to an order by providers
- * that require manual payment (e.g. SEPA, wire transfer).
- */
-export type OrderPaymentDetail = {
-    fiatCurrency: string;
-    paymentMethod: string;
-    fields: {
-        name: string;
-        id: string;
-        value: string;
-    }[];
-};
-/**
- * Fiat currency information associated with an order.
- */
-export type RampsOrderFiatCurrency = {
-    id?: string;
-    symbol: string;
-    name?: string;
-    decimals?: number;
-    denomSymbol?: string;
-};
-/**
- * A unified order type returned from the V2 API.
- * The V2 endpoint normalizes all provider responses into this shape.
- */
-export type RampsOrder = {
-    id?: string;
-    isOnlyLink: boolean;
-    provider?: Provider;
-    success: boolean;
-    cryptoAmount: string | number;
-    fiatAmount: number;
-    cryptoCurrency?: RampsOrderCryptoCurrency;
-    fiatCurrency?: RampsOrderFiatCurrency;
-    providerOrderId: string;
-    providerOrderLink: string;
-    createdAt: number;
-    paymentMethod?: RampsOrderPaymentMethod;
-    totalFeesFiat: number;
-    txHash: string;
-    walletAddress: string;
-    status: RampsOrderStatus;
-    network: RampsOrderNetwork;
-    canBeUpdated: boolean;
-    idHasExpired: boolean;
-    idExpirationDate?: number;
-    excludeFromPurchases: boolean;
-    timeDescriptionPending: string;
-    fiatAmountInUsd?: number;
-    feesInUsd?: number;
-    region?: string;
-    orderType: string;
-    exchangeRate?: number;
-    pollingSecondsMinimum?: number;
-    statusDescription?: string;
-    partnerFees?: number;
-    networkFees?: number;
-    paymentDetails?: OrderPaymentDetail[];
-};
-/**
- * The SDK version to send with API requests. (backwards-compatibility)
- */
-export declare const RAMPS_SDK_VERSION = "2.1.6";
-/**
- * The type of ramp action: 'buy' or 'sell'.
- */
-export type RampAction = 'buy' | 'sell';
-/**
- * The name of the {@link RampsService}, used to namespace the
- * service's actions and events.
- */
-export declare const serviceName = "RampsService";
-/**
- * The environment to use for API requests.
- */
-export declare enum RampsEnvironment {
-    Production = "production",
-    Staging = "staging",
-    Development = "development",
-    Local = "local"
-}
-/**
- * The type of ramps API service.
- * Determines which base URL to use (cache vs standard).
- */
-export declare enum RampsApiService {
-    Regions = "regions",
-    Orders = "orders"
-}
-/**
- * Actions that {@link RampsService} exposes to other consumers.
- */
-export type RampsServiceActions = RampsServiceMethodActions;
-/**
- * Actions from other messengers that {@link RampsService} calls.
- */
-type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerTokenAction;
-/**
- * Events that {@link RampsService} exposes to other consumers.
- */
-export type RampsServiceEvents = never;
-/**
- * Events from other messengers that {@link RampsService} subscribes to.
- */
-type AllowedEvents = never;
-/**
- * The messenger which is restricted to actions and events accessed by
- * {@link RampsService}.
- */
-export type RampsServiceMessenger = Messenger<typeof serviceName, RampsServiceActions | AllowedActions, RampsServiceEvents | AllowedEvents>;
-/**
- * Derives the default redirect ("fake callback") URL for the widened Headless
- * Buy quote fetch from the ramps environment.
- *
- * The quotes API only embeds a `buyURL`/`buyWidget` (the WebView page a
- * non-native provider needs) when a `redirectUrl` is present, so the widened
- * aggregator path supplies this default when the caller omits one. Production
- * and staging serve the callback from the `on-ramp-content` CDN hosts;
- * development has no `on-ramp-content.dev-api` deployment, so it uses the
- * `on-ramp.dev-api` host (which serves `/regions/fake-callback` and returns
- * 200). This intentionally does not reuse {@link getBaseUrl}, whose Regions
- * host is `on-ramp{-cache}`, not `on-ramp-content`.
- *
- * This is the canonical environment-to-callback map for the whole package.
- * Prefer the `RampsService:getDefaultRedirectCallbackUrl` messenger action at
- * runtime so the value always follows the environment the service is actually
- * configured with. Call this function directly only where a synchronous,
- * messenger-free value is needed (for example client UI that matches the
- * callback URL in a WebView), and pass the same environment the service was
- * constructed with.
- *
- * @param environment - The environment to derive the callback URL for.
- * @returns The default redirect callback URL for that environment.
- */
-export declare function getDefaultRedirectCallbackUrl(environment: RampsEnvironment): string;
-/**
- * This service object is responsible for interacting with the Ramps API.
- *
- * @example
- *
- * ``` ts
- * import { Messenger } from '@metamask/messenger';
- * import type {
- *   RampsServiceActions,
- *   RampsServiceEvents,
- * } from '@metamask/ramps-controller';
- *
- * const rootMessenger = new Messenger<
- *   'Root',
- *   RampsServiceActions
- *   RampsServiceEvents
- * >({ namespace: 'Root' });
- * const rampsServiceMessenger = new Messenger<
- *   'RampsService',
- *   RampsServiceActions,
- *   RampsServiceEvents,
- *   typeof rootMessenger,
- * >({
- *   namespace: 'RampsService',
- *   parent: rootMessenger,
- * });
- * // Instantiate the service to register its actions on the messenger
- * new RampsService({
- *   messenger: rampsServiceMessenger,
- *   environment: RampsEnvironment.Production,
- *   context: 'mobile-ios',
- *   fetch,
- * });
- *
- * // Later...
- * // Get the user's geolocation
- * const geolocation = await rootMessenger.call(
- *   'RampsService:getGeolocation',
- * );
- * // ... Do something with the geolocation ...
- * ```
- */
-export declare class RampsService {
-    #private;
-    /**
-     * The name of the service.
-     */
-    readonly name: typeof serviceName;
-    /**
-     * Constructs a new RampsService object.
-     *
-     * @param args - The constructor arguments.
-     * @param args.messenger - The messenger suited for this service.
-     * @param args.environment - The environment to use for API requests.
-     * @param args.context - The context for API requests (e.g., 'mobile-ios', 'mobile-android').
-     * @param args.fetch - A function that can be used to make an HTTP request. If
-     * your JavaScript environment supports `fetch` natively, you'll probably want
-     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
-     * `node-fetch`).
-     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
-     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
-     * @param args.baseUrlOverride - Optional base URL override for local development.
-     * @param args.clientProduct - Optional MetaMask product id (`metamask-mobile`).
-     * @param args.clientVersion - Optional app SemVer (not the ramps-controller package version).
-     */
-    constructor({ messenger, environment, context, fetch: fetchFunction, policyOptions, baseUrlOverride, clientProduct, clientVersion, }: {
-        messenger: RampsServiceMessenger;
-        environment?: RampsEnvironment;
-        context: string;
-        fetch: typeof fetch;
-        policyOptions?: CreateServicePolicyOptions;
-        baseUrlOverride?: string;
-        clientProduct?: string;
-        clientVersion?: string;
-    });
-    /**
-     * Returns the default redirect ("fake callback") URL for this service's
-     * environment.
-     *
-     * The quotes API only embeds a `buyURL`/`buyWidget` (the WebView page a
-     * non-native provider needs) when a `redirectUrl` is present, so callers
-     * that omit one (MM Pay's widened Headless Buy fetch) use this value.
-     * Exposing it here makes the service's environment the single runtime source
-     * of truth, so the callback can never point at a different environment than
-     * the one the quotes themselves came from.
-     *
-     * `baseUrlOverride` deliberately does not apply. That option overrides the
-     * ramps API base URL for local development. In production and staging the
-     * callback lives on a different host (`on-ramp-content` versus
-     * `on-ramp{-cache}`), so an API override says nothing about where
-     * `/regions/fake-callback` lives. In development the callback already shares
-     * the API host family (`on-ramp.dev-api`). The redirect URL is also handed
-     * to the provider and matched by client UI to detect flow completion, so
-     * returning an unrelated local API origin here would break completion
-     * detection rather than help it. Point `environment` at
-     * {@link RampsEnvironment.Local} for a localhost callback, noting that URL
-     * is pinned to `http://localhost:3000` and does not follow a non-3000
-     * `baseUrlOverride`.
-     *
-     * @returns The default redirect callback URL for the configured environment.
-     */
-    getDefaultRedirectCallbackUrl(): string;
-    /**
-     * Registers a handler that will be called after a request returns a non-500
-     * response, causing a retry. Primarily useful in tests where timers are being
-     * mocked.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): ReturnType<ServicePolicy['onRetry']>;
-    /**
-     * Registers a handler that will be called after a set number of retry rounds
-     * prove that requests to the API endpoint consistently return a 5xx response.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     * @see {@link createServicePolicy}
-     */
-    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): ReturnType<ServicePolicy['onBreak']>;
-    /**
-     * Registers a handler that will be called under one of two circumstances:
-     *
-     * 1. After a set number of retries prove that requests to the API
-     * consistently result in one of the following failures:
-     *    1. A connection initiation error
-     *    2. A connection reset error
-     *    3. A timeout error
-     *    4. A non-JSON response
-     *    5. A 502, 503, or 504 response
-     * 2. After a successful request is made to the API, but the response takes
-     * longer than a set duration to return.
-     *
-     * @param listener - The handler to be called.
-     * @returns An object that can be used to unregister the handler. See
-     * {@link CockatielEvent}.
-     */
-    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): ReturnType<ServicePolicy['onDegraded']>;
-    /**
-     * Makes a request to the API in order to retrieve the user's geolocation
-     * based on their IP address.
-     *
-     * @returns The user's country/region code (e.g., "US-UT" for Utah, USA).
-     */
-    getGeolocation(): Promise<string>;
-    /**
-     * Makes a request to the cached API to retrieve the list of supported countries.
-     * The API returns countries with support information for both buy and sell actions.
-     * Filters countries based on aggregator support (preserves OnRampSDK logic).
-     *
-     * @returns An array of countries filtered by aggregator support.
-     */
-    getCountries(): Promise<Country[]>;
-    /**
-     * Fetches the list of available tokens for a given region and action.
-     * Supports optional provider filter.
-     *
-     * @param region - The region code (e.g., "us", "fr", "us-ny").
-     * @param action - The ramp action type ('buy' or 'sell').
-     * @param options - Optional query parameters for filtering tokens.
-     * @param options.provider - Provider ID(s) to filter by.
-     * @returns The tokens response containing topTokens and allTokens.
-     */
-    getTokens(region: string, action?: RampAction, options?: {
-        provider?: string | string[];
-    }): Promise<TokensResponse>;
-    /**
-     * Fetches the list of providers for a given region.
-     * Supports optional query filters: provider, crypto, payments.
-     * Region local fiat filtering is applied server-side when `fiat` is omitted.
-     *
-     * @param regionCode - The region code (e.g., "us", "fr", "us-ny").
-     * @param options - Optional query parameters for filtering providers.
-     * @param options.provider - Provider ID(s) to filter by.
-     * @param options.crypto - Crypto currency ID(s) to filter by.
-     * @param options.payments - Payment method ID(s) to filter by.
-     * @returns The providers response containing providers array.
-     */
-    getProviders(regionCode: string, options?: {
-        provider?: string | string[];
-        crypto?: string | string[];
-        payments?: string | string[];
-    }): Promise<ProvidersResponse>;
-    /**
-     * Fetches the list of payment methods for a given region, asset, and provider.
-     *
-     * Region local fiat filtering is applied server-side when `fiat` is omitted.
-     *
-     * @param options - Query parameters for filtering payment methods.
-     * @param options.region - User's region code (e.g., "us-al").
-     * @param options.assetId - CAIP-19 cryptocurrency identifier.
-     * @param options.provider - Provider ID path.
-     * @returns The payment methods response containing payments array.
-     */
-    getPaymentMethods(options: {
-        region: string;
-        assetId: string;
-        provider: string;
-    }): Promise<PaymentMethodsResponse>;
-    /**
-     * Fetches quotes from all providers for a given set of parameters.
-     * Uses the V2 orders API to get quotes for multiple payment methods at once.
-     *
-     * @param params - The parameters for fetching quotes.
-     * @param params.region - User's region code (e.g., "us", "us-ca").
-     * @param params.paymentMethods - Array of payment method IDs.
-     * @param params.assetId - CAIP-19 cryptocurrency identifier.
-     * @param params.fiat - Fiat currency code (e.g., "usd").
-     * @param params.amount - The amount (in fiat for buy, crypto for sell).
-     * @param params.walletAddress - The destination wallet address.
-     * @param params.redirectUrl - Optional redirect URL after order completion.
-     * @param params.providers - Optional provider IDs to filter quotes.
-     * @param params.action - The ramp action type. Defaults to 'buy'.
-     * @returns The quotes response containing success, sorted, error, and customActions.
-     */
-    getQuotes(params: GetQuotesParams): Promise<QuotesResponse>;
-    /**
-     * Fetches the buy widget data from a buy URL endpoint.
-     * Makes a request to the buyURL (as provided in a quote) to get the actual
-     * provider widget URL, browser type, and order ID.
-     *
-     * @param buyUrl - The full buy URL endpoint to fetch from.
-     * @returns The buy widget data containing the provider widget URL.
-     */
-    getBuyWidgetUrl(buyUrl: string): Promise<BuyWidget>;
-    /**
-     * Fetches an order from the unified V2 API endpoint.
-     * This endpoint returns a normalized `RampsOrder` (DepositOrder shape)
-     * for all provider types, including both aggregator and native providers.
-     *
-     * @param providerCode - The provider code (e.g., "transak", "transak-native", "moonpay"),
-     *   with or without the `/providers/` prefix.
-     * @param orderCode - The order identifier.
-     * @param wallet - The wallet address associated with the order.
-     * @returns The unified order data.
-     */
-    getOrder(providerCode: string, orderCode: string, wallet: string): Promise<RampsOrder>;
-    /**
-     * Extracts an order from a provider callback URL.
-     * Sends the callback URL to the V2 API backend, which knows how to parse
-     * each provider's callback format and extract the order ID. Then fetches
-     * the full order using that ID.
-     *
-     * This is the V2 equivalent of the aggregator SDK's `getOrderFromCallback`.
-     *
-     * @param providerCode - The provider code (e.g., "transak", "moonpay"),
-     *   with or without the `/providers/` prefix.
-     * @param callbackUrl - The full callback URL the provider redirected to.
-     * @param wallet - The wallet address associated with the order.
-     * @returns The unified order data.
-     */
-    getOrderFromCallback(providerCode: string, callbackUrl: string, wallet: string): Promise<RampsOrder>;
-}
-export {};
-//# sourceMappingURL=RampsService.d.cts.map