{"id":13879903,"url":"https://github.com/taylorbrooks/closeio","last_synced_at":"2025-10-13T16:20:52.882Z","repository":{"id":10106627,"uuid":"12171085","full_name":"taylorbrooks/closeio","owner":"taylorbrooks","description":"A Ruby wrapper for the Close.io API","archived":false,"fork":false,"pushed_at":"2025-06-12T15:09:12.000Z","size":168,"stargazers_count":45,"open_issues_count":6,"forks_count":59,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-09-30T07:54:17.509Z","etag":null,"topics":["api","closeio","ruby"],"latest_commit_sha":null,"homepage":"http://developer.close.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taylorbrooks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-08-17T00:41:49.000Z","updated_at":"2025-06-12T15:09:14.000Z","dependencies_parsed_at":"2023-02-10T06:30:59.183Z","dependency_job_id":"e30a3d10-f715-4a99-9cbd-6afb80059038","html_url":"https://github.com/taylorbrooks/closeio","commit_stats":{"total_commits":191,"total_committers":28,"mean_commits":6.821428571428571,"dds":0.2984293193717278,"last_synced_commit":"f7271f84c10316781857b78b970aec7b8199c544"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/taylorbrooks/closeio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taylorbrooks%2Fcloseio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taylorbrooks%2Fcloseio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taylorbrooks%2Fcloseio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taylorbrooks%2Fcloseio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taylorbrooks","download_url":"https://codeload.github.com/taylorbrooks/closeio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taylorbrooks%2Fcloseio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000825,"owners_count":26082950,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","closeio","ruby"],"created_at":"2024-08-06T08:02:38.416Z","updated_at":"2025-10-13T16:20:52.864Z","avatar_url":"https://github.com/taylorbrooks.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"### A Ruby wrapper for the Close.com API\n\nLearn about the Close API at http://developer.close.com.\n\nI :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.\n\n### Installation\nAdd this line to your application's Gemfile:\n````ruby\n  # in your Gemfile\n  gem 'closeio', '~\u003e 3.9.0'\n\n  # then...\n  bundle install\n````\n\n### Usage\n````ruby\n  client = Closeio::Client.new(\"api key\")\n\n  # Find a specific lead\n  lead = client.find_lead('lead_xxxxxxxxxxxx')\n\n  # See some data about the lead\n  lead[\"addresses\"]\n  lead[\"contacts\"]\n  lead[\"opportunities\"]\n\n  # Update the lead\n  client.update_lead(lead[\"id\"],\n    name: \"Bluth Company\",\n    addresses: [{\n      \"address_1\": \"747 Howard St\",\n      \"city\": \"San Francisco\"\n    }]\n  )\n\n  # Delete the lead\n  client.delete_lead(lead[\"id\"])\n\n  # Given two lead objects with an id property, merge two leads into one\n  client.merge_leads(source_lead.id, destination_lead.id)\n\n  # Find leads that match field\n  client.list_leads(name: \"Wayne Enterprises\")\n\n  # Find leads that match custom field\n  client.list_leads('\"custom.Favorite Color\":\"cornflower blue\"')\n\n  # Use paginate: true to fetch all the leads\n  client.list_leads(name: \"Wayne Enterprises\", paginate: true)\n\n  # Create a lead\n  client.create_lead(\n    name: \"Bluth Company\",\n    contacts: [{\n      name: \"Buster Bluth\",\n      emails: [{type: \"office\", email: \"cartographer@bluthcompany.com\"}]\n    }]\n  )\n\n  # Create a bulk edit job for leads filtered by a custom field\n  client.bulk_edit(\n    query: '\"custom.International Database ID\":12345',\n    type: 'set_custom_field',\n    custom_field_name: 'Local Database ID',\n    custom_field_value: '123'\n  )\n````\n\n### Options\n\nYou can disable the logger by passing in a second argument when creating a new client:\n```ruby\n  client = Closeio::Client.new(\"api key\", false)\n```\n\nSome servers running on SSL need [specific configurations](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates) for the Faraday dependency.\nIf you're running on Heroku with SSL enabled, you need to pass in the path of the CA certificate when creating a new client:\n```ruby\n  client = Closeio::Client.new(\"api key\", true, '/usr/lib/ssl/certs/ca-certificates.crt')\n```\n\nTimezone Offsets\nFor 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.\n```ruby\n  utc_offset = Time.zone.utc_offset.to_f / 1.hour\n  client = Closeio::Client.new(\"api key\", utc_offset: utc_offset)\n```\n\n\n### History\n\nView the [changelog](https://github.com/taylorbrooks/closeio/blob/master/CHANGELOG.md)\nThis gem follows [Semantic Versioning](http://semver.org/)\n\n### Contributing\n\nEveryone is encouraged to help improve this project. Here are a few ways you can help:\n\n- [Report bugs](https://github.com/taylorbrooks/closeio/issues)\n- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/closeio/pulls)\n- Write, clarify, or fix documentation\n- Suggest or add new features\n\n### Copyright\nCopyright (c) 2019 Taylor Brooks. See LICENSE for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaylorbrooks%2Fcloseio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaylorbrooks%2Fcloseio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaylorbrooks%2Fcloseio/lists"}