The mailman-client API

0.1

A Node.js client for mailman-core

ApiRequest Class

Extends BaseRequest
Module: ApiRequest
Parent Module: mailman-client

ApiRequest extends BaseRequest with custom properties and methods

Properties

_options Object private

Inherited from BaseRequest but overwritten in lib/shared/ApiRequest.js:24

Configuration options such as the endpoint of the API, auth parameters etc.

Default: {}

_params Object private

The object containing the query parameters

Default: {}

_path Object private

Object containing request path variables used to assemble the request URI (This will be overwritten by each of the child constructor classes i.e Client, List, etc.)

Default: {}

_queryParams Boolean private

A boolean flag that is set when there are query parameters to be rendered

Default: false

_supportedMethods Array private

Supported HTTP methods for this BaseRequest instance (Each of the child constructor classes i.e Client, List etc. define their own subset of supported methods)

Default: [ 'head', 'get', 'put', 'post', 'delete', 'patch' ]

_template String private

The URI template used to generate the URI to request (This will be overwritten by each of the child constructor classes i.e Client, List, etc.)

Default: ''

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Constructor

ApiRequest
(
  • options
)

Parameters:

  • options Object

    A hash of options for configuring the BaseRequest instance

    • endpoint String

      The endpoint URI to request

    • [username] String optional

      A username for authenticating API requests

    • [password] String optional

      A password for authenticating API requests

Methods

_auth () Object private

Performs auth on the superagent request object if implied externally

Returns:

Object: The superagent request object by performing auth on it

_checkAuthParameters () Boolean private

Checks if authentication is externally forced on the request object by passing in username & password

Returns:

Boolean: Returns true if auth is forced else false

_checkMethodSupport
(
  • method
)
Boolean private

Verify that the request object in use supports a HTTP method

Parameters:

  • method String
    An HTTP method to check ('get', 'post', etc)

Returns:

Boolean: Returns true if the HTTP method is supported else it will throw

_renderPath () String private

Renders the request path by using _path and _template

Returns:

String: The rendered path string

_renderQuery () String private

Compose query string by using the recorded query parameters

Returns:

String:

Returns the query string to be appended in the final URI

_renderURI () String private

Renders the URI to request after checking for query parameters

Returns:

String: The URI enpoint to request

delete
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional
    A callback to invoke with the results of the DELETE request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

get
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional
    A callback to invoke with the results of the GET request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

head
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional
    A callback to invoke with the results of the HEAD request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

patch
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object
    The patch data
  • [callback] Function optional
    A callback to invoke with the results of the PATCH request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

post
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object
    The post data
  • [callback] Function optional
    A callback to invoke with the results of the POST request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

put
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object
    The put data
  • [callback] Function optional
    A callback to invoke with the results of the PUT request
    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String
    Flag to get the full response object by passing in identity

Returns:

Promise: A promise to the results of the HTTP request

query
(
  • key
  • [value]
)
Object chainable

Record query parameters to be rendered in the final URI

Parameters:

  • key String | Object

    The name of the query parameter or an object containing query parameters as key,val pairs repectively

  • [value] String | Array optional

    If the supplied key is a String, then value can be of type Array or String

Returns:

Object:

Returns the ApiRequest instance itself if the arguments are in the required form else throw an Error

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index