RingCentral.API (RingCentral v0.2.0) View Source

The Main module to interact with RingCentral REST APIs.

Link to this section Summary

Functions

Send a DELETE request to the REST API.

Send a GET request to the REST API.

Send a POST request to the REST API.

Send a PUT request to the REST API.

Link to this section Functions

Link to this function

delete(ringcentral, path, headers \\ [])

View Source

Specs

delete(RingCentral.t(), String.t(), list()) ::
  :ok | {:error, RingCentral.Error.t()} | {:ok, RingCentral.Response.t()}

Send a DELETE request to the REST API.

It will uses ringcentral.http_client to send the request to RingCentral API, which by default is the RingCentral.HTTPClient.DefaultClient.

Link to this function

get(ringcentral, path, headers \\ [])

View Source

Specs

get(RingCentral.t(), String.t(), list()) ::
  {:error, RingCentral.Error.t()} | {:ok, RingCentral.Response.t()}

Send a GET request to the REST API.

It will uses ringcentral.http_client to send the request to RingCentral API, which by default is the RingCentral.HTTPClient.DefaultClient.

Link to this function

post(ringcentral, path, body, headers \\ [])

View Source

Specs

post(RingCentral.t(), String.t(), map(), list()) ::
  {:error, RingCentral.Error.t()} | {:ok, RingCentral.Response.t()}

Send a POST request to the REST API.

It will uses ringcentral.http_client to send the request to RingCentral API, which by default is the RingCentral.HTTPClient.DefaultClient.

Link to this function

put(ringcentral, path, body, headers \\ [])

View Source

Specs

put(RingCentral.t(), String.t(), map(), list()) ::
  {:error, RingCentral.Error.t()} | {:ok, RingCentral.Response.t()}

Send a PUT request to the REST API.

It will uses ringcentral.http_client to send the request to RingCentral API, which by default is the RingCentral.HTTPClient.DefaultClient.