Git Product home page Git Product logo

big_machines's Introduction

BigMachines

Build Status

Ruby gem for the undocumented BigMachines SOAP API

Implemented Operations

  • Security API - login, logout, getUserInfo, setSessionCurrency
  • Commerce API - getTransaction, updateTransaction (partial)

Services Not Implemented

  • Configuration, Parts, Data Tables, Users, Groups, Exchange Rates

Installation

Add this line to your application's Gemfile:

gem 'big_machines'

And then execute:

$ bundle

Or install it yourself as:

$ gem install big_machines

Usage

Create Client

client = BigMachines::Client.new('subdomain')
# Specify process name
client = BigMachines::Client.new('subdomain', process_name: 'quotes_process')

Authenticate

client.login('foo', 'password')

set_session_currency

client.set_session_currency('USD')
# => Hash[:status]

get_user_info

client.get_user_info
# => Hash[:user_info]

Commerce

get_transaction

# Find transaction by id
client.get_transaction(id)
# => BigMachines::Transaction

update_transaction

# Update transaction (quote_process)
client.update_transaction(id, data={notesCMPM_es: "Sample Notes"})
# => Hash[:status]

Attachments

get_attachment

# Retrieve Single File Attachment
client.get_attachment(transaction_id, "uploadTemplate_File")
# => BigMachines::Attachment

upload_attachment

# Upload File Attachment
client.upload_attachment(transaction_id, file, "uploadTemplate_File")
# => {status: true, message: '...'}

delete_attachment

# Delete File Attachement
client.delete_attachment(transaction_id, "uploadTemplate_File")
# => {status: true, message: '...'}

logout

client.logout

Contributing

  1. Fork it ( http://github.com/TinderBox/big_machines/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 new Pull Request

big_machines's People

Contributors

jheth avatar

Stargazers

 avatar

Watchers

Clayton Parker avatar Dustin Sapp avatar  avatar Josh Kramer avatar James Cloos avatar  avatar Ryan Cook avatar Sam Kreter 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.