Ruby SDK - Essal Developer Docs

The essal-ruby gem provides an idiomatic Ruby client for the Essal API. It supports Ruby 3.0+.

Installation

Add to your Gemfile:

gem "essal", "~> 1.0"

Then run:

bundle install

Initialisation

require "essal"

client = Essal::Client.new(
  api_key: ENV["ESSAL_API_KEY"],
  environment: :production # :production, :staging, :sandbox
)

Usage Examples

# List documents
docs = client.office.documents.list(limit: 20)
docs.each { |doc| puts doc.title }

# Create a Sales contact
contact = client.sales.contacts.create(
  display_name: "Jane Smith",
  email: "jane@acmecorp.com",
  organization_name: "Acme Corp"
)

# Create a Project task
task = client.project.tasks.create(
  project_id: "proj_01HXYZ9876",
  title: "Design review",
  priority: "high"
)

Pagination

client.office.documents.list(limit: 50).auto_paging_each do |doc|
  puts doc.title
end

Error Handling

begin
  contact = client.sales.contacts.get("cnt_nonexistent")
rescue Essal::ResourceNotFoundError => e
  puts "Not found: #{e.message}"
rescue Essal::RateLimitError => e
  sleep(e.retry_after)
  retry
end