Git Product home page Git Product logo

benchmark-email-client's Introduction

BenchmarkEmailApi

This is a Gem built to use the ruby wrapper for Benchmark Email marketing. It has two main methods: one method creates a client object using the Benchmark credentials, the other is a method_missing. The methods you can call are documented in Benchmark's API docs.

[http://www.benchmarkemail.com/API/Library]

The parameters are the same minus the token ( always the first one to be passed according to the docs) because the client object already has it.

Installation

Add this line to your application's Gemfile:

gem 'benchmark_email_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install benchmark_email_api

Usage

Instantiate a Client object.

BMEApi = BenchmarkEmailApi::Client.new(username,password, api_url)

The Api Url is usually a constant: 'https://api.benchmarkemail.com/1.0/'.

All parameters for the client instantiation are strings.

Call the methods on the api docs.

BMEApi.listsGet

This is a lists method that will be sent to the Benchmark Api throught the Client.

BMEApi.batchAddContacts(list_id, contacts)

Notice how we didn't need to pass the token as the docs suggested: [http://www.benchmarkemail.com/API/Doc/batchAddContacts]

Contributing

  1. Fork it ( https://github.com/[my-github-username]/benchmark_email_api/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

benchmark-email-client's People

Contributors

resj avatar scott avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.