SMSFactor.AccountManaging (SMSFactor v0.5.0)
View SourceWrappers around Account Managing section of SMSFactor API.
Summary
Types
Params to create account or sub-account.
email(required) : The email of the accountpassword(required) : The password must be at least 6 characters long (25 max)country_code(required if main account) : The country code associated to the account (ISO 3166-1 alpha-2)firstname: The firstname associated to the accountlastname: The lastname associated to the accountcity: The city associated to the accountphone: The phone number associated to the accountaddress1: The address associated to the accountaddress2: Further information about the addresszip: The zip codecompany: The company associated to the accounttype: Select one between : company, association, administration, privatesender: The default sender that will be used for your sendingsdescription: Feel free to write anything about this accountisChild: integer 0 for a main account, 1 for a sub-accountunlimited(required if isChild) : Is the account unlimited ? If unlimited, the sub-account uses the parent's credits. If not, the main account has to give a certain amount of credits to its sub-account.
Example
{
"account":{
"email" : "vasili@sovietnavy.com",
"password" : "av01d_nuc13Ar_War",
"firstname" : "Vasili",
"lastname": "Arkhipov",
"city" : "Zvorkovo",
"phone": "33612345678",
"address1": "Somewhere in Zvorkovo",
"zip": "386",
"country_code" : "ru",
"isChild" : 1,
"unlimited" : 0
}
}
Params for updating retention.
Supports the following options :
message: The data retention time of your messageslist: The data retention time of your lists (-1 for endless expiration)survey: The data retention time of your surveyscampaign: The data retention time of your campaigns
After your number put a 'd' for day and a 'm' for month.
Example
{
"retention":{
"message": "2d",
"survey": "5m",
"list": "2m",
"campaign": "5m"
}
}
Functions
@spec create_account(Tesla.Client.t(), account_params()) :: Tesla.Env.result()
@spec credits(Tesla.Client.t()) :: Tesla.Env.result()
@spec get_retention(Tesla.Client.t()) :: Tesla.Env.result()
@spec retrieve_account(Tesla.Client.t()) :: Tesla.Env.result()
@spec retrieve_sub_accounts(Tesla.Client.t()) :: Tesla.Env.result()
@spec update_retention(Tesla.Client.t(), retention_params()) :: Tesla.Env.result()