ex_webexteams

v0.1.6

ex_webexteams v0.1.6 ExWebexteams.Api View Source

Interface to Webex Teams API through a rate limiter

Rate limiting

All calls are rate limied by default through ex_rated. The defaults are as follows and can be configured via configs or environment variables (see source). By default we allow five requests every 10 seconds.

  • limit_bucket = "webexteams-rate-limit"
  • limit_scale = 10000 - timescale in milliseconds (10000 = 10 seconds )
  • limit_limit = 5 - we can make 5 requests in limit_scale milliseconds

Link to this section Summary

Types

error()
json()
response()

Functions

delete(path)

http delete request

get(path)

http get request

get(path, params)

http get request with query parameters

post(body, path)

http post request

Link to this section Types

Link to this type

error() View Source 
error() :: %{}

Link to this type

json() View Source 
json() :: String.t()

Link to this type

response() View Source 
response() :: %{}

Link to this section Functions

Link to this function

delete(path) View Source 
delete(String.t()) :: response() | error()

http delete request

Link to this function

get(path) View Source 
get(String.t()) :: response() | error()

http get request

Link to this function

get(path, params) View Source 
get(String.t(), term()) :: response() | error()

http get request with query parameters

Link to this function

post(body, path) View Source 
post(json(), String.t()) :: response() | error()

http post request