@getopenpay/client/models/CheckoutProcessorsPreferencesOutput.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { PaymentProviderType } from './PaymentProviderType';
import type { ProcessorProviderPair } from './ProcessorProviderPair';
/**
 * Preferences for payment processors during checkout.
 * @export
 * @interface CheckoutProcessorsPreferencesOutput
 */
export interface CheckoutProcessorsPreferencesOutput {
    /**
     * If not empty, the enabled providers will be filtered by this list.
     * @type {Array<PaymentProviderType>}
     * @memberof CheckoutProcessorsPreferencesOutput
     */
    filterProviders?: Array<PaymentProviderType>;
    /**
     * If not empty, only the processors with these ids will be accepted.
     * @type {Array<string>}
     * @memberof CheckoutProcessorsPreferencesOutput
     */
    idsWhitelist?: Array<string>;
    /**
     * If not empty, only the processors with these names will be accepted.
     * @type {Array<string>}
     * @memberof CheckoutProcessorsPreferencesOutput
     */
    namesWhitelist?: Array<string>;
    /**
     * A list of processor-provider pairs that will bypass the names_whitelist and ids_whitelist restrictions. For example, if a pair with processor_id "pp_prod_stripe" and provider "CREDIT_CARD" is in this list, credit card processors will not be filtered out by the whitelist filters even if they are not in the whitelists.
     * @type {Array<ProcessorProviderPair>}
     * @memberof CheckoutProcessorsPreferencesOutput
     */
    processorProviderPairsWhitelist?: Array<ProcessorProviderPair>;
}
/**
 * Check if a given object implements the CheckoutProcessorsPreferencesOutput interface.
 */
export declare function instanceOfCheckoutProcessorsPreferencesOutput(value: object): value is CheckoutProcessorsPreferencesOutput;
export declare function CheckoutProcessorsPreferencesOutputFromJSON(json: any): CheckoutProcessorsPreferencesOutput;
export declare function CheckoutProcessorsPreferencesOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutProcessorsPreferencesOutput;
export declare function CheckoutProcessorsPreferencesOutputToJSON(json: any): CheckoutProcessorsPreferencesOutput;
export declare function CheckoutProcessorsPreferencesOutputToJSONTyped(value?: CheckoutProcessorsPreferencesOutput | null, ignoreDiscriminator?: boolean): any;