connect-sdk-nodejs/lib/model/types.d.ts

SDK to communicate with the Worldline Global Collect platform using the Worldline Connect Server API

/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" />
import { Readable } from "stream";
import { Agent } from "http";
import { ShoppingCartExtension } from "./domain";
export interface Authenticator {
    getAuthorization(method: string, contentType: string, date: string, headers: Header[], path: string): Promise<string>;
}
export declare type CommunicatorLogger = {
    [level in LogLevel]: (message: any) => void;
};
export interface Configuration {
    host: string;
    scheme?: "http" | "https";
    port?: number;
    enableLogging?: boolean;
    logger?: CommunicatorLogger;
    apiKeyId: string;
    secretApiKey: string;
    integrator: string;
    shoppingCartExtension?: ShoppingCartExtension;
    obfuscationRules?: Record<string, ObfuscationRule>;
    proxy?: ProxyConfiguration;
    connectionOptions?: ConnectionOptions;
}
export interface ConnectionOptions {
    agent?: Agent;
}
export interface FileMetadata {
    contentType: string | null;
    contentLength: string | number | null;
    filename: string | null;
}
export interface Header {
    key: string;
    value: string;
}
export interface HttpEndpoint {
    readonly host: string;
    readonly scheme: "http" | "https";
    readonly port: number;
}
export interface Idempotence {
    key: string;
    requestTimestamp?: string | number;
}
export interface JsonRequest extends SdkRequest {
    body?: object | null;
}
export declare type Logger = (level: LogLevel, message: any) => void;
export declare type LogLevel = "info" | "warn" | "error";
export interface MultipartFormDataObject {
    [key: string]: string | UploadableFile | undefined;
}
export interface MultipartFormDataRequest extends SdkRequest {
    body: MultipartFormDataObject;
}
export declare type ObfuscationRule = (value: string) => string;
export interface ObfuscationRules {
    /**
     * @returns An obfuscation rule that will replace all characters with *.
     */
    all(): ObfuscationRule;
    /**
     * @returns An obfuscation rule that will keep a fixed number of characters at the end, then replaces all other characters with *.
     */
    allButLast(count: number): ObfuscationRule;
    /**
     * @returns An obfuscation rule that will keep a fixed number of characters at the start, then replaces all other characters with *.
     */
    allButFirst(count: number): ObfuscationRule;
    /**
     * @returns An obfuscation rule that will replace values with a fixed length string containing only *.
     */
    withFixedLength(count: number): ObfuscationRule;
}
export interface PaymentContext {
    extraHeaders?: Header[];
    idempotence?: Idempotence;
}
export interface ProxyConfiguration {
    host: string;
    scheme?: "http" | "https";
    port?: number;
    credentials?: string;
}
export interface SdkContext {
    getEndpoint(): HttpEndpoint;
    getProxy(): ProxyConfiguration | undefined;
    getConnectionOptions(): ConnectionOptions | undefined;
    getAuthenticator(): Authenticator;
    getLogger(): Logger;
    setLogger(logger: Logger): void;
    isLoggingEnabled(): boolean;
    setEnableLogging(isLoggingEnabled: boolean): void;
    getIntegrator(): string;
    getShoppingCartExtension(): ShoppingCartExtension | undefined;
    getObfuscationRules(): Record<string, ObfuscationRule>;
}
export interface SdkRequest {
    method: string;
    modulePath: string;
    paymentContext?: PaymentContext | null;
    expectBinaryResponse?: boolean;
}
export interface SdkSuccessResponse<T> {
    status: number;
    body: T;
    isSuccess: true;
}
export interface SdkErrorResponse<E> {
    status: number;
    body: E;
    isSuccess: false;
}
export declare type SdkResponse<T, E> = SdkSuccessResponse<T> | SdkErrorResponse<E>;
export interface SdkBinarySuccessResponse extends SdkSuccessResponse<Readable> {
    file: FileMetadata;
}
export interface SdkBinaryErrorResponse extends SdkSuccessResponse<Readable> {
    file: FileMetadata;
}
export declare type SdkBinaryResponse<E> = SdkBinarySuccessResponse | SdkErrorResponse<E>;
export declare class SdkApiError<E> extends Error {
    readonly status: number;
    readonly body: E;
    constructor(message: string, status: number, body: E);
    name: string;
}
export interface SdkResponseError extends Error {
    status?: number;
    body?: string;
}
export interface UploadableFile {
    fileName: string;
    contentType: string;
    content: Readable | Buffer | string;
    contentLength?: number;
}