Constructors
constructor
Parameters
root: string
Optional host: string
Optional region: US | EMEA
Properties
Protected axios
axios: AxiosInstance
Protected host
host: string
Protected root
root: string
Protected Optional token
token: string
Methods
Protected delete
delete( endpoint: string , headers?: {} , scopes: string [] ) : Promise < any >
Parameters
endpoint: string
headers: {} = {}
scopes: string []
Returns Promise < any >
Protected fetch
fetch( config: AxiosRequestConfig ) : Promise < AxiosResponse < any > >
Parameters
config: AxiosRequestConfig
Returns Promise < AxiosResponse < any > >
Protected get
get( endpoint: string , headers?: {} , scopes: string [] , repeatOn202?: boolean ) : Promise < any >
Parameters
endpoint: string
headers: {} = {}
scopes: string []
repeatOn202: boolean = false
Returns Promise < any >
Protected getBuffer
getBuffer( endpoint: string , headers?: {} , scopes: string [] , repeatOn202?: boolean ) : Promise < any >
Parameters
endpoint: string
headers: {} = {}
scopes: string []
repeatOn202: boolean = false
Returns Promise < any >
Protected getStream
getStream( endpoint: string , headers?: {} , scopes: string [] , repeatOn202?: boolean ) : Promise < any >
Parameters
endpoint: string
headers: {} = {}
scopes: string []
repeatOn202: boolean = false
Returns Promise < any >
Protected patch
patch( endpoint: string , data: any , headers?: {} , scopes: string [] ) : Promise < any >
Parameters
endpoint: string
data: any
headers: {} = {}
scopes: string []
Returns Promise < any >
Protected post
post( endpoint: string , data: any , headers?: {} , scopes: string [] ) : Promise < any >
Parameters
endpoint: string
data: any
headers: {} = {}
scopes: string []
Returns Promise < any >
Protected put
put( endpoint: string , data: any , headers?: {} , scopes: string [] ) : Promise < any >
Parameters
endpoint: string
data: any
headers: {} = {}
scopes: string []
Returns Promise < any >
reset
reset( auth?: { client_id: string ; client_secret: string } | { token: string } , host?: string , region?: US | EMEA ) : void
Parameters
Optional auth: { client_id: string ; client_secret: string } | { token: string }
Optional host: string
Optional region: US | EMEA
Returns void
Protected setAuthorization
setAuthorization( options: any , scopes: string [] ) : Promise < void >
Parameters
options: any
scopes: string []
Returns Promise < void >
Legend
Variable
Function
Type alias
Protected property
Protected method
Initializes new client with specific authentication method.