Attribute

This gem is a fork of nutshell-crm created by [email protected].

Description

Nutshell Crm is a Ruby wrapper for the Nutshell Crm API.

Reference

NutshellCrmAPI::Client

Install

gem install nutshell-crm-api

Install

gem install nutshell-crm

Example Usage

require "nutshell-crm"

# Instantiate the Nutshell client.
nutshell = NutshellCrm::Client.new "[email protected]", "MY_API_KEY"

# Get the first open lead with stub data (default).
nutshell.find_leads({status: 0}).first
#=> {"stub"=>true, "id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil}

# Enable non-stub responses.
nutshell.stub_responses = false

# Get the first open lead with full data.
nutshell.find_leads({status: 0}).first
#=> {"id"=>1001, "entityType"=>"Leads", "name"=>"Lead\u20131001", "status"=>0, "primaryAccountName"=>nil, "creator"=>{}}