Class RestClient

Index

Methods

createBinaryBody createJsonBody createPlainTextBody createXmlBody delete get head options patch post put

Methods

`Static`createBinaryBody

createBinaryBody(data: string, filename: string): BinaryBody
Creates new instance of BinaryBody.
Parameters
- data: string
  Base64 encoded binary data.
- filename: string
  Filename of the binary data.
Returns BinaryBody
New instance of BinaryBody.
- Defined in project.d.ts:366

`Static`createJsonBody

createJsonBody(data: any): JsonBody
Creates new instance of JsonBody.
Parameters
- data: any
  JSON data.
Returns JsonBody
New instance of JsonBody.
- Defined in project.d.ts:344

`Static`createPlainTextBody

createPlainTextBody(data: string): PlainTextBody
Creates new instance of PlainTextBody.
Parameters
- data: string
  Plain text data.
Returns PlainTextBody
New instance of PlainTextBody.
- Defined in project.d.ts:358

`Static`createXmlBody

createXmlBody(data: string): XmlBody
Creates new instance of XmlBody.
Parameters
- data: string
  XML data.
Returns XmlBody
New instance of XmlBody.
- Defined in project.d.ts:351

`Static`delete

delete(url: string, parameters?: any, headers?: any): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:319

`Static`get

get(url: string, parameters?: any, headers?: any): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:310

`Static`head

head(url: string, parameters?: any, headers?: any): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:328

`Static`options

options(url: string, parameters?: any, headers?: any): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:337

`Static`patch

patch(url: string, parameters?: any, headers?: any, body?: IBody): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
- Optionalbody: IBody
  Body of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:301

`Static`post

post(url: string, parameters?: any, headers?: any, body?: IBody): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
- Optionalbody: IBody
  Body of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:281

`Static`put

put(url: string, parameters?: any, headers?: any, body?: IBody): RestResponse
Makes GET request to specified url.
Parameters
- url: string
  Url of the request.
- Optionalparameters: any
  Query parameters of the request.
- Optionalheaders: any
  Headers of the request.
- Optionalbody: IBody
  Body of the request.
Returns RestResponse
Response object of the request.
- Defined in project.d.ts:291