transbank-sdk
Version:
Transbank SDK for Node.js
27 lines (26 loc) • 1.22 kB
TypeScript
/**
* Class containing needed authenticaction and configuration to interact with the API.
* Environment correspond to the environment to use, it can be Integration or Production, each has
* a unique URL.
*/
declare class Options {
/** Unique commerce identifier provided by Transbank */
commerceCode: string;
/** The secret used to authenticate against the API, it must be kept safe at all times. */
apiKey: string;
/** Environment correspond to the environment to use, it can be Integration or
* Production, each has a unique URL. */
environment: string;
/** Timeout for requests in milliseconds */
timeout?: number;
/**
* Create an instance of Options
* @param commerceCode unique commerce identifier provided by Transbank
* @param apiKey the secret used to authenticate against the API, it must be kept safe at all times.
* @param environment Environment correspond to the environment to use, it can be Integration or
* Production, each has a unique URL.
* @param timeout Timeout for requests in milliseconds
*/
constructor(commerceCode: string, apiKey: string, environment: string, timeout?: number);
}
export default Options;