Defines an API request.
constructFormdata() Constructs a FormData instance from an object.
the object to generate the FormData from
POST /api/circles/name-check/ - promises to check if a circle name is available
The desired name
PUT /api/circles/ - promises to create a new circle
The circle's properties
delete() DELETE request
DELETE /api/circles/:id/ - promises to delete a circle
The ID of the circle
generateHeaders() A function used to generate the headers that need to be passed to the request performee.
get() GET request
GET /api/circles/:id/ - promises to get a circle
The ID of the circle
GET /api/circles/ - promises to retrieve all circles
patch() PATCH request
Request body
patchFormdata() PATCH request (multipart/form-data, application/x-www-form-urlencoded)
post() POST request
Request body
postFormdata() POST request (multipart/form-data, application/x-www-form-urlencoded)
put() PUT request
Request body
putFormdata() PUT request (multipart/form-data, application/x-www-form-urlencoded)
PATCH /api/circles/:id/ - promises to update a circle
The ID of the circle
Generated using TypeDoc
public CirclesAPI - Provides methods to interact with the Circles API