Interface ShipEngineAPIConfig

ShipEngine API Client Configuration

Hierarchy

ShipEngineAPIConfig

Index

Properties

baseURL? getSandboxToken? getToken headers? onApiError?

Properties

`Optional` baseURL

baseURL?: string

baseURL is an optional string that represents the base URL to be used for all requests.

`Optional` getSandboxToken

getSandboxToken?: (() => string | Promise<string>)

Type declaration

- (): string | Promise<string>
- getSandboxToken is an optional callback function that returns a token to be used to authenticate sandbox requests.
  
  Returns string | Promise<string>

getToken

getToken: (() => string | Promise<string>)

Type declaration

- (): string | Promise<string>
- getToken is a callback function that returns a token to used to authenticate all requests.
  
  Returns string | Promise<string>

`Optional` headers

headers?: AxiosRequestHeaders

headers are optional HTTP headers to be sent with all requests.

`Optional` onApiError

onApiError?: ((errors: SE.CodedError[], error: ApiError) => void)

Type declaration

- (errors: SE.CodedError[], error: ApiError): void
- onApiError is an optional callback function that will be executed whenever there is an error.
  Parameters
  - errors: SE.CodedError[]
  - error: ApiError
  Returns void

Generated using TypeDoc