Http | iland-sdk

Iland API HTTP Client.

Hierarchy

Http

Index

Constructors

constructor

Methods

Constructors

constructor

new Http(baseUrl: string): Http

- Defined in service/http/http.ts:14
Constructs a new Http instance.

Parameters
- baseUrl: string
  
  the base URL of the iland Cloud API
Returns Http

Methods

delete

delete(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse>

- Defined in service/http/http.ts:126
Perform a DELETE request against the iland Cloud API.

throws

{ApiError} if the server responds with an error

Parameters
- url: string
  
  the URL path
- Optional config: AxiosRequestConfig
  
  request configuration
Returns Promise<AxiosResponse>

promise that resolves with the server response

get

get(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse>

- Defined in service/http/http.ts:115
Perform a GET request against the iland Cloud API.

throws

{ApiError} if the server responds with an error

Parameters
- url: string
  
  the URL path
- Optional config: AxiosRequestConfig
  
  request configuration
Returns Promise<AxiosResponse>

promise that resolves with server response

post

post(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse>

- Defined in service/http/http.ts:138
Perform a POST request against the iland Cloud API.

throws

{ApiError} if the server responds with an error

Parameters
- url: string
  
  the URL path
- Optional data: any
  
  the data to include in the request body
- Optional config: AxiosRequestConfig
  
  request configuration
Returns Promise<AxiosResponse>

promise that resolves with the server response

put

put(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse>

- Defined in service/http/http.ts:150
Perform a PUT request against the iland Cloud API.

throws

{ApiError} if the server responds with an error

Parameters
- url: string
  
  the URL path
- Optional data: any
  
  the data to include in the request body
- Optional config: AxiosRequestConfig
  
  request configuration
Returns Promise<AxiosResponse>

promise that resolves with the server response

request

request(config: AxiosRequestConfig): Promise<AxiosResponse>

- Defined in service/http/http.ts:104
Performs a request against the iland Cloud API.

throws

{ApiError} if the server responds with an error

Parameters
- config: AxiosRequestConfig
  
  request configuration
Returns Promise<AxiosResponse>

promise that resolves with the server response

Static versionMime

versionMime(mime: string, version?: undefined | number): string

- Defined in service/http/http.ts:84
Gets a formatted Accept header from a standard MIME and optional version number.

Parameters
- mime: string
  
  the standard MIME string
- Optional version: undefined | number
  
  the targeted version (defaults to the SDK version)
Returns string

the formatted MIME type

Generated using TypeDoc