Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

christoph-buente/retentiongrid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Retentiongrid

Gem Version Build Status Coverage Status Code Climate License

A ruby client for retentiongrid.com API

Installation

Add this line to your application's Gemfile:

gem 'retentiongrid'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install retentiongrid

Usage

set you API key

require 'retentiongrid'
Retentiongrid::Api.api_key = "your_api_key"

Read from retentiongrid

order = Retentiongrid::Order.find(1234)

Write to retentiongrid

order = Retentiongrid::Order.new({
  status:           'ok',
  order_id:         'R123',
  customer_id:      'C321',
  currency:         'EUR',
  total_price:      35.99,
  total_discounts:  0.0,
  order_created_at: Time.now,
})
order.save

Contributing

  1. Fork it ( https://github.com/[my-github-username]/retentiongrid/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

About

A ruby client for retentiongrid.com API

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.txt

Stars

Watchers

Forks

Packages

No packages published

Languages