@adyen/api-library/lib/src/config.d.ts

The Adyen API Library for NodeJS enables you to work with Adyen APIs.

export declare const TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
/**
 * Supported environments for the Adyen APIs.
 */
export declare enum EnvironmentEnum {
    LIVE = "LIVE",
    TEST = "TEST"
}
/**
 * Supported Regions for Terminal API integration.
 */
export declare enum RegionEnum {
    EU = "EU",
    AU = "AU",
    US = "US",
    APSE = "APSE"
}
export declare const TERMINAL_API_ENDPOINTS_MAP: Record<RegionEnum, string>;
interface ConfigConstructor {
    username?: string;
    password?: string;
    environment?: EnvironmentEnum;
    marketPayEndpoint?: string;
    applicationName?: string;
    apiKey?: string;
    connectionTimeoutMillis?: number;
    certificatePath?: string;
    terminalApiCloudEndpoint?: string;
    terminalApiLocalEndpoint?: string;
    liveEndpointUrlPrefix?: string;
    region?: RegionEnum;
    enable308Redirect?: boolean;
}
declare class Config {
    username?: string;
    password?: string;
    environment?: EnvironmentEnum;
    marketPayEndpoint?: string;
    applicationName?: string;
    apiKey?: string;
    connectionTimeoutMillis?: number;
    certificatePath?: string;
    terminalApiCloudEndpoint?: string;
    terminalApiLocalEndpoint?: string;
    liveEndpointUrlPrefix?: string;
    region?: RegionEnum;
    enable308Redirect?: boolean;
    constructor(options?: ConfigConstructor);
    /**
     * Checks if the provided environment is valid.
     * @param environment - The environment to validate.
     * @returns true if the environment exists in EnvironmentEnum, false otherwise.
     */
    static isEnvironmentValid(environment: EnvironmentEnum): boolean;
    /**
     * Checks if the provided region is a valid supported.
     * @param region - The region to validate.
     * @returns true if the region exists in RegionEnum, false otherwise.
     */
    static isRegionValid(region: RegionEnum): boolean;
    /**
     * Returns the Terminal API endpoint for the given region.
     * If the region is not valid, returns the EU endpoint.
     * @param region - The region to get the endpoint for.
     * @returns The Terminal API endpoint URL.
     */
    static getTerminalApiEndpoint(region: RegionEnum): string;
}
export default Config;