Giter VIP home page Giter VIP logo

office_autopilot's Introduction

The OfficeAutopilot Ruby Gem

A Ruby wrapper for the OfficeAutopilot API

Installation

gem install office_autopilot_api

Usage Examples

require "rubygems"
require "office_autopilot_api"

client = OfficeAutopilotApi::Client.new(:api_id => 'xxx', :api_key => 'yyy')

# Search Contacts
puts client.contacts_search(:field => 'E-Mail', :op => 'e', :value => '[email protected]')
   # results truncated for brevity but ALL fields (including custom fields) are returned
   => [{"id"=>"7",
         "Contact Information"=>{"First Name"=>"testing", "Last Name"=>"testing", "E-Mail"=>"[email protected]"},
        "Lead Information"=>{"Contact Owner"=>"XXX", "First Referrer"=>"", "Last Referrer"=>""},
        "Sequences and Tags"=>{"Sequences"=>"*/*", "Contact Tags"=>""},
        "Purchase History"=>{}
      }]

# Add Contact
puts client.contacts_add({ 'Contact Information' => {'First Name' => 'Turtle', 'Last Name' => 'Jones', 'E-Mail' => '[email protected]'} })
   => {"id"=>"24", "Contact Information"=>{"First Name"=>"Turtle", "Last Name"=>"Jones", "E-Mail"=>"[email protected]"}}

Documentation

Currently supported API methods:

Contacts:

  • contacts_search

  • contacts_add

  • contacts_pull_tag

  • contacts_fetch_sequences

  • contacts_key

  • contacts_fetch

OfficeAutopilot API Docs

Todo

  • support ALL API calls

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add documentation for your feature or bug fix.
  5. Add specs for your feature or bug fix.
  6. Run bundle exec rake spec. If your changes are not 100% covered, go back to step 5.
  7. Commit and push your changes.
  8. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.)

Copyright

Copyright (c) 2011 Prashant Nadarajan. See LICENSE for details.

office_autopilot's People

Contributors

grahamlyus avatar isieo avatar parasquid avatar prashantrajan avatar ryanholoubek avatar

Watchers

 avatar  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.