@types/braintree-web/vault-manager.d.ts

TypeScript definitions for braintree-web

import { Client } from "./client";
import { callback } from "./core";
import { GooglePaymentDetails } from "./google-payment";
import { HostedFieldsAccountDetails } from "./hosted-fields";
import { PayPalAccountDetails } from "./paypal";
import { ThreeDSecureAccountDetails } from "./three-d-secure";
import { UnionPayAccountDetails } from "./unionpay";
import { VenmoAccountDetails } from "./venmo";

/**
 * Manages customer's payment methods.
 * @see https://braintree.github.io/braintree-web/3.75.0/module-braintree-web_vault-manager.html
 */
export class VaultManager {
    /**
     * Fetches payment methods owned by the customer whose id was used to generate the client token used to create the client.
     * @see https://braintree.github.io/braintree-web/3.75.0/VaultManager.html#fetchPaymentMethods
     */
    fetchPaymentMethods(options?: { defaultFirst: boolean }): Promise<FetchPaymentMethodsPayload[]>;
    fetchPaymentMethods(options: { defaultFirst: boolean }, callback: callback<FetchPaymentMethodsPayload[]>): void;
    fetchPaymentMethods(callback: callback<FetchPaymentMethodsPayload[]>): void;

    /**
     * Cleanly tear down anything set up by create.
     * @see https://braintree.github.io/braintree-web/3.75.0/VaultManager.html#teardown
     */
    teardown(): Promise<void>;
    teardown(callback: callback<void>): void;
}

/**
 * The customer's payment methods.
 * @see https://braintree.github.io/braintree-web/3.75.0/VaultManager.html#~fetchPaymentMethodsPayload
 */
export interface FetchPaymentMethodsPayload {
    nonce: string;
    default: boolean;
    details?:
        | HostedFieldsAccountDetails
        | ThreeDSecureAccountDetails
        | GooglePaymentDetails
        | PayPalAccountDetails
        | UnionPayAccountDetails
        | VenmoAccountDetails
        | Record<string, any>
        | undefined;
    type: string;
    description: string | null;
    binData?: Record<string, any> | undefined;
}

export function create(options: {
    client?: Client | undefined;
    authorization?: string | undefined;
}): Promise<VaultManager>;
export function create(
    options: { client?: Client | undefined; authorization?: string | undefined },
    callback: callback<VaultManager>,
): void;