Interface IRestApi

Set of actions to interact with Rest API endpoints supported by Gondola

experimental: v1 > Can be changed or removed soon

Hierarchy

IRestApi

Index

Methods

Methods

checkResponseStatus

checkResponseStatus(response: any, expected: number): void

- Defined in builtin.ts:1396
Parses response data.

experimental

v1 > Can be changed or removed soon

Parameters
- response: any
  
  data response from server
- expected: number
  
  expected status value
Returns void

sendDeleteRequest

sendDeleteRequest(url: string, headers: __type): Promise<{ body: any; header: any; status: number }>

- Defined in builtin.ts:1387
Sends a DELETE request.

experimental

v1 > Can be changed or removed soon

Parameters
- url: string
  
  endpoint address
- headers: __type
  
  header parameters
Returns Promise<{ body: any; header: any; status: number }>

sendGetRequest

sendGetRequest(url: string, headers: __type): Promise<{ body: any; header: any; status: number }>

- Defined in builtin.ts:1347
Sends a GET request.

experimental

v1 > Can be changed or removed soon

Parameters
- url: string
  
  endpoint address
- headers: __type
  
  header parameters
Returns Promise<{ body: any; header: any; status: number }>

sendPatchRequest

sendPatchRequest(url: string, payload: __type, headers: __type): Promise<{ body: any; header: any; status: number }>

- Defined in builtin.ts:1367
Sends a PATCH request.

experimental

v1 > Can be changed or removed soon

Parameters
- url: string
  
  endpoint address
- payload: __type
  
  the request body
- headers: __type
  
  header parameters
Returns Promise<{ body: any; header: any; status: number }>

sendPostRequest

sendPostRequest(url: string, payload: __type, headers: __type): Promise<{ body: any; header: any; status: number }>

- Defined in builtin.ts:1357
Sends a POST request.

experimental

v1 > Can be changed or removed soon

Parameters
- url: string
  
  endpoint address
- payload: __type
  
  the request body
- headers: __type
  
  header parameters
Returns Promise<{ body: any; header: any; status: number }>

sendPutRequest

sendPutRequest(url: string, payload: __type, headers: __type): Promise<{ body: any; header: any; status: number }>

- Defined in builtin.ts:1377
Sends a PUT request.

experimental

v1 > Can be changed or removed soon

Parameters
- url: string
  
  endpoint address
- payload: __type
  
  the request body
- headers: __type
  
  header parameters
Returns Promise<{ body: any; header: any; status: number }>

setRequestTimeout

setRequestTimeout(newTimeout: number): void

- Defined in builtin.ts:1338
Sets the timeout for the request.

experimental

v1 > Can be changed or removed soon

Parameters
- newTimeout: number
  
  timeout in milliseconds
Returns void