Interface IApiClientOptions

Options for 'ApiClient' class.

interface IApiClientOptions {
    auth: {
        clientId: string;
        clientSecret: string;
    };
    axiosOptions?: null | AxiosRequestConfig<any>;
    baseURL: string;
    headers?: any;
    language?: null | string;
    oAuthPath?: null | string;
    pathPrefix?: null | string;
}

Properties

auth axiosOptions? baseURL headers? language? oAuthPath? pathPrefix?

Properties

auth

auth: {
    clientId: string;
    clientSecret: string;
}

Auth options.

Type declaration

  • clientId: string

    The client ID.

  • clientSecret: string

    The client secret.

Optional axiosOptions

axiosOptions?: null | AxiosRequestConfig<any>

Custom options for the internal axios instance.

baseURL

baseURL: string

The base URL.

Optional headers

headers?: any

Additional / custom request headers.

Optional language

language?: null | string

The default language, like 'de' or 'en'.

Optional oAuthPath

oAuthPath?: null | string

The custom oAuth path. Default: '/auth/v1/oauth2/token'

Optional pathPrefix

pathPrefix?: null | string

A custom path prefix.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc