README.md

ZuoraRestClient

This is a simple Zuora client for Ruby. It mainly consists of methods that wrap the operations described in the Zuora API Reference (https://www.zuora.com/developer/api-reference), as well as a few helper methods.

Most of the methods take either the query parameters and/or a hash representing the JSON request body as arguments. The methods return a ZuoraRestClient::Result object which represents ths JSON response.

Installation

Add this line to your application's Gemfile:

gem 'zuora_rest_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zuora_rest_client

Usage

First, construct a client object:

username = '[email protected]'
password = 'mypassword'
client = ZuoraRestClient::Client.new(username, password) # Create a production client

For an API Sandbox tenant, you can specify the following:

client = ZuoraRestClient::Client.new(username, password, :api_sandbox) # Create an api sandbox client

For a Zuora Central Sandbox tenant, you can specify the following:

client = ZuoraRestClient::Client.new(username, password, :test) # Create an zuora central sandbox client

For a "serivcesNNN" tenant, where NNN is the number that follows "services", you may also need an API proxy port number to invoke calls to /action/* and /object/*. Assuming your services tenant is services000 and your API proxy port number is 1234, you can specify the following:

client = ZuoraRestClient::Client.new(username, password, :services000, api_proxy_port: 1234) # Create an api services000 client

Call one of the client methods. For example, to create an account:

account_to_create = {
    Batch: 'Batch1',
    BillCycleDay: 15,
    Currency: 'USD',
    Name: 'Test Account',
    PaymentTerm: 'Due Upon Receipt',
    Status: 'Draft' }
result = client.create_account_object(account_to_create) # Returns an object representation of the JSON response

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/FronteraConsulting/zuora_rest_client.