Client

View on Github

Client is for making HTTP requests to the API.

Under the hood, it uses superagent. When a method is called, you can call any number of superagent functions on it and then call end() to complete and send the request.

Methods

get(endpointstring)

GET request for retrieving a resource from the API.

endpoint

The path of the API endpoint.

post(endpointstring)

POST request for sending a new resource to the API.

endpoint

The path of the API endpoint.

put(endpointstring)

PUT request for replacing a resource in the API.

endpoint

The path of the API endpoint.

patch(endpointstring)

PATCH request for performing partial updates to a resource in the API.

endpoint

The path of the API endpoint.

delete(endpointstring)

DELETE request for deleting a resource from the API.

endpoint

The path of the API endpoint.

Services

    API

      General