SMSFactor.Contacts (SMSFactor v0.5.0)

View Source

Wrappers around Contacts section of SMSFactor API.

Summary

Types

contact_list_params()

Params for defining contacts list.

contact_params()

Params for defining a contact.

Functions

add_contact(client, params)
deduplicate_list(client, list_id)
insert_to_blacklist(client, params)
insert_to_npai_list(client, params)
remove_contact(client, contact_id)
remove_contact_from_blacklist(client, contact_id)
update_contact(client, contact_id, params)

Types

contact_list_params()

@type contact_list_params() :: %{list: %{required(atom()) => String.t()}}

Params for defining contacts list.

Example

{
  "list": {
    "listId": 50433,
    "contacts": {
      "gsm": [
        {
          "value": "33612345678",
          "info1": "Hiroo",
          "info2": "Onoda"
        },
        {
          "value": "33612345677",
          "info1": "Grace",
          "info2": "Hopper"
        },
        {
          "value": "33612345676",
          "info1": "Hedy",
          "info2": "Lamarr",
          "info3": "Extase",
          "info4": "1933"
        }
      ]
    }
  }
}

contact_params()

@type contact_params() :: %{required(atom()) => String.t()}

Params for defining a contact.

Example

{
  "value": "33612345676",
  "info1": "Hedy",
  "info2": "Lamarr",
  "info3": "Extase",
  "info4": "1933"
}

Functions

add_contact(client, params)

@spec add_contact(Tesla.Client.t(), contact_list_params()) :: Tesla.Env.result()

deduplicate_list(client, list_id)

@spec deduplicate_list(Tesla.Client.t(), integer()) :: Tesla.Env.result()

insert_to_blacklist(client, params)

@spec insert_to_blacklist(Tesla.Client.t(), contact_list_params()) ::
  Tesla.Env.result()

insert_to_npai_list(client, params)

@spec insert_to_npai_list(Tesla.Client.t(), contact_list_params()) ::
  Tesla.Env.result()

remove_contact(client, contact_id)

@spec remove_contact(Tesla.Client.t(), integer()) :: Tesla.Env.result()

remove_contact_from_blacklist(client, contact_id)

@spec remove_contact_from_blacklist(Tesla.Client.t(), integer()) :: Tesla.Env.result()

update_contact(client, contact_id, params)

@spec update_contact(Tesla.Client.t(), integer(), contact_params()) ::
  Tesla.Env.result()