Methods
(static) HttpApi#connect(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized CONNECT request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#delete(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized DELETE request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#get(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized GET request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#head(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized HEAD request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#options(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized OPTIONS request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#patch(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized PATCH request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#post(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized POST request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#put(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized PUT request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) HttpApi#trace(params, optionsopt, callbackopt) → {Object|Promise.<never>|*}
Make a customized TRACE request.
Parameters:
| Name |
Type |
Attributes |
Description |
params |
Object
|
|
Properties
| Name |
Type |
Attributes |
Description |
path |
Object
|
|
The URL of the request |
querystring |
Object
|
<optional>
|
The querystring parameters |
headers |
Object
|
<optional>
|
The request headers |
body |
Object
|
<optional>
|
The request body |
|
options |
Object
|
<optional>
|
Options for Transport#request |
callback |
function
|
<optional>
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*