ElibomEx v0.1.1 ElibomEx.Client View Source
Wrap api calls
Link to this section Summary
Types
Describes the different type of responses from Elibom’s API
Functions
Cancels a scheduled sms
consults account details
Consults the current state of an already sent sms
Consults the state of an scheduled sms
Fetch users attached to the current session
Requests to Elibom’s service to dispatch a new sms
Link to this section Types
http_error_calling_service() :: {:error, String.t}
http_error_in_request() :: {:error, map, number}
Describes the different type of responses from Elibom’s API
Link to this section Functions
cancel_scheduled_sms(String.t) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
Cancels a scheduled sms
Raises ArgumentError
exception if the schedule_id is nil or empty
consult_account :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
consults account details
consult_delivery(String.t) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
Consults the current state of an already sent sms.
Raises ArgumentError
exception if the delivery_id is nil or empty
consult_scheduled_deliveries(String.t) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
Consults the state of an scheduled sms.
Raises ArgumentError
exception if the schedule_id is nil or empty
Fetch users attached to the current session
consult_users(nil) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
consult_users(integer) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
deliver_sms(map) :: http_succeed | http_error_in_request | http_error_calling_service | http_empty_response
Requests to Elibom’s service to dispatch a new sms.
Raises ArgumentError
exception when one or more of the required parameters
are nil or empty.