Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taylorbrooks/closeio
A Ruby wrapper for the Close.io API
https://github.com/taylorbrooks/closeio
api closeio ruby
Last synced: 3 months ago
JSON representation
A Ruby wrapper for the Close.io API
- Host: GitHub
- URL: https://github.com/taylorbrooks/closeio
- Owner: taylorbrooks
- License: mit
- Created: 2013-08-17T00:41:49.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-01-29T23:41:20.000Z (10 months ago)
- Last Synced: 2024-06-18T22:59:43.007Z (5 months ago)
- Topics: api, closeio, ruby
- Language: Ruby
- Homepage: http://developer.close.com
- Size: 155 KB
- Stars: 46
- Watchers: 9
- Forks: 59
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
### A Ruby wrapper for the Close.com API
Learn about the Close API at http://developer.close.com.
I :heart: Close, so if you have problems using the gem or would like to see support for new endpoints, please open a GitHub issue -- I'll get it resolved as quick as I can.
### Installation
Add this line to your application's Gemfile:
````ruby
# in your Gemfile
gem 'closeio', '~> 3.9.0'
# then...
bundle install
````
### Usage
````ruby
client = Closeio::Client.new("api key")
# Find a specific lead
client.find_lead('lead_xxxxxxxxxxxx')
# See some data about the lead
lead[:data][:addresses]
lead[:data][:contacts]
lead[:data][:opportunities]
# Update the lead
client.update_lead(lead.id,
name: "Bluth Company",
addresses: [{
"address_1": "747 Howard St",
"city": "San Francisco"
}]
)
# Delete the lead
client.delete_lead(lead.id)
# Merge two leads into one
client.merge_leads(source_lead.id, destination_lead.id)
# Find leads that match field
client.list_leads(name: "Wayne Enterprises")
# Find leads that match custom field
client.list_leads('"custom.Favorite Color":"cornflower blue"')
# Use paginate: true to fetch all the leads
client.list_leads(name: "Wayne Enterprises", paginate: true)
# Create a lead
client.create_lead(
name: "Bluth Company",
contacts: [{
name: "Buster Bluth",
emails: [{type: "office", email: "[email protected]"}]
}]
)
# Create a bulk edit job for leads filtered by a custom field
client.bulk_edit(
query: '"custom.International Database ID":12345',
type: 'set_custom_field',
custom_field_name: 'Local Database ID',
custom_field_value: '123'
)
# Saved Search (SmartView)
smart_view = client.list_smart_views
smart_views[:data][:leads]
````
### Options
You can disable the logger by passing in a second argument when creating a new client:
```ruby
client = Closeio::Client.new("api key", false)
```
Some servers running on SSL need [specific configurations](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates) for the Faraday dependency.
If you're running on Heroku with SSL enabled, you need to pass in the path of the CA certificate when creating a new client:
```ruby
client = Closeio::Client.new("api key", true, '/usr/lib/ssl/certs/ca-certificates.crt')
```
Timezone Offsets
For requests that include date filters like date_created or date_start, you can use the `utc_offset` named parameter to pass your timezone's UTC offset as part of your request. By default all API calls uses the UTC time.
```ruby
utc_offset = Time.zone.utc_offset.to_f / 1.hour
client = Closeio::Client.new("api key", utc_offset: utc_offset)
```
### History
View the [changelog](https://github.com/taylorbrooks/closeio/blob/master/CHANGELOG.md)
This gem follows [Semantic Versioning](http://semver.org/)
### Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/taylorbrooks/closeio/issues)
- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/closeio/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
### Copyright
Copyright (c) 2019 Taylor Brooks. See LICENSE for details.