API client for Locaweb Email Marketing

Trial account: http://emailmarketing.locaweb.com.br/trial

client = Locaweb::Emailmarketing::Client.new auth_token: "TOKEN",
                                             base_url: 'https://emailmarketing.locaweb.com.br/api/v1',
                                             account_id: 'ID'

• list: client.accounts.all
• get: client.acccounts.get("ID")
• update: client.accounts.update("ID", hash_options)
  available options: return_path_domain

• list: client.campaigns.all
• get: client.campaigns.get("ID")
• create: client.campaigns.create(options)
  available options: name, description
• update: client.campaigns.update("ID", options)
  available options: name, description
• destroy: client.campaigns.destroy("ID")

• list: client.contact_imports.all
• get: client.contact_imports.get("ID")
• create: client.contact_imports.create(options)
  available options: required: [:name, :list_tokens, :url], optional: [:description]

• list: client.contacts.all
• get: client.contacts.get("ID")
• create: client.contacts.create(options)
  available options: required: [], optional: [:custom_fields, :list_tokens]
• update: client.contacts.update("ID", options)
  available options: required: [:email, :list_ids], optional: [:custom_fields]
• destroy: client.contacts.destroy("ID")

• list: client.custom_fields.all
• get: client.custom_fields.get("ID")
• create: client.custom_fields.create(options)
  available options: name, type
• update: client.custom_fields.update("ID", options)
  available options: name
• destroy: client.custom_fields.destroy("ID")

• list: client.domains.all
• get: client.domains.get("ID")
• create: client.domains.create(options)
  available options: required: [:name]
• update: client.domains.update("ID", options)
  available options: required: [:name, :default]
• destroy: client.domains.destroy("ID")

• list: client.lists.all
• get: client.lists.get("ID")
• create: client.lists.create(options)
  available options: name
• update: client.lists.update("ID", options)
  available options: name
• destroy: client.lists.destroy("ID")

• list: client.messages.all
• get: client.messages.get("ID")
• create: client.messages.create(options)
  Example:

    client.messages.create({
      domain_id: "50f8e28abf8d79f935000002",
      html_body: "lala popo",
      list_ids: ["50f95cbd38a582091f002907"],
      name: "lala",
      sender_name: "name",
      sender: "trial@emailmarketing.locaweb.com.br",
      subject: "teste lala popo",
      scheduled_to: "2013-01-20"
    })

• update: client.messages.update("ID", options)
  Example:

    client.messages.update("ID", {subject: "lalapopo2"})

• destroy: client.messages.destroy("ID")

More info: http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Mensagens

• overview: client.messages.overview("ID")
• openings: client.messages.openings("ID")
• uniq_openings: client.messages.uniq_openings("ID")
• links: client.messages.links("ID")
• clicks: client.messages.clicks("ID")
• bounces: client.messages.bounces("ID")

More info: http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Relatorios

• list: client.senders.all
• get: client.senders.get("ID")
• create: client.senders.create(options)
  available options: email
• destroy: client.senders.destroy("ID")

• list: client.unsubscribe_reasons.all
• get: client.unsubscribe_reasons.get("ID")
• create: client.unsubscribe_reasons.create(options)
  available options: name
• update: client.unsubscribe_reasons.update("ID", options)
  available options: name
• destroy: client.unsubscribe_reasons.destroy("ID")

To return a specif page, pass param to method all like this:

  client.contacts.all(4)