RingCentral (RingCentral v0.2.1) View Source
A thin RingCentral API wrapper in Elixir.
Link to this section Summary
Functions
Build the RingCentral client, used by functions in both RingCentral.OAuth
and RingCentral.API
Returns the production API server URL: https://platform.ringcentral.com
Returns the sandbox API server URL: https://platform.devtest.ringcentral.com
Link to this section Types
Specs
Link to this section Functions
Specs
Build the RingCentral client, used by functions in both RingCentral.OAuth
and RingCentral.API
Options
server_url
: Optional, the API server URL, default to the value ofRingCentral.production_server_url/0
client_id
: Required, the client IDclient_secret
: Required, the client Secrettoken_info
: Required if used byRingCentral.API
to make API calls, should be set to the result ofRingCentral.OAuth.get_token/2
http_client
: Optional, the module used to make HTTP calls, default toRingCentral.HTTPClient.DefaultClient
json_coder
: Optional, the module used as JSON encoder & decoder, default toRingCentral.JSON.DefaultCoder
Specs
production_server_url() :: String.t()
Returns the production API server URL: https://platform.ringcentral.com
Specs
sandbox_server_url() :: String.t()
Returns the sandbox API server URL: https://platform.devtest.ringcentral.com