Interface SdkConfiguration

Hierarchy

  • SdkConfiguration

Properties

apiVersion? axiosAdapter? baseApiUrl? clientID? cookieOptions? timeoutInMilliseconds?

Properties

Optional apiVersion

apiVersion?: string

At the time of writing there is only one version of the API

Defaults to: v1

Optional axiosAdapter

axiosAdapter?: AxiosAdapter

provide a custom axios adapter to handle dispatching request/responses

Optional baseApiUrl

baseApiUrl?: string

The apiurl that will be used to talk to the ordercloud API. It may be useful to change this to interact with different environments

Defaults to: https://api.ordercloud.io

Optional clientID

clientID?: string

when set is used to call the refresh token endpoint to obtain a new access token when exired (provided a refresh token is set in the sdk) this functionality is only intended for users that interact with at most one client per sdk instance

Optional cookieOptions

cookieOptions?: CookieOptions

Optional timeoutInMilliseconds

timeoutInMilliseconds?: number

specifies the number of milliseconds before the request times out. If the request takes longer than timeoutInMilliseconds, the request will be aborted. Default timeout is 10,000 milliseconds or 10 seconds

Settings

Member Visibility

Theme

Generated using TypeDoc