{"id":13879949,"url":"https://github.com/nylas/nylas-ruby","last_synced_at":"2025-07-16T16:30:34.302Z","repository":{"id":19718567,"uuid":"22974275","full_name":"nylas/nylas-ruby","owner":"nylas","description":"Ruby bindings for the Nylas Platform APIs","archived":false,"fork":false,"pushed_at":"2025-07-03T20:12:01.000Z","size":1279,"stargazers_count":101,"open_issues_count":2,"forks_count":132,"subscribers_count":66,"default_branch":"main","last_synced_at":"2025-07-03T21:20:36.885Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nylas.com/docs","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/nylas.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"Contributing.md","funding":null,"license":"LICENSE.txt","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":"2014-08-15T01:29:08.000Z","updated_at":"2025-06-23T19:05:31.000Z","dependencies_parsed_at":"2023-07-14T11:15:49.427Z","dependency_job_id":"d3723e3e-6b73-49d2-9c78-52e8fa7f9351","html_url":"https://github.com/nylas/nylas-ruby","commit_stats":{"total_commits":690,"total_committers":76,"mean_commits":9.078947368421053,"dds":0.8043478260869565,"last_synced_commit":"860d8b665f2d55359fc2f5bd41d42ed623292e04"},"previous_names":["inboxapp/inbox-ruby"],"tags_count":111,"template":false,"template_full_name":null,"purl":"pkg:github/nylas/nylas-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nylas%2Fnylas-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nylas%2Fnylas-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nylas%2Fnylas-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nylas%2Fnylas-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nylas","download_url":"https://codeload.github.com/nylas/nylas-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nylas%2Fnylas-ruby/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263405155,"owners_count":23461425,"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","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":[],"created_at":"2024-08-06T08:02:40.255Z","updated_at":"2025-07-16T16:30:34.288Z","avatar_url":"https://github.com/nylas.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"\u003ca href=\"https://www.nylas.com/\"\u003e\n    \u003cimg src=\"https://brand.nylas.com/assets/downloads/logo_horizontal_png/Nylas-Logo-Horizontal-Blue_.png\" alt=\"Aimeos logo\" title=\"Aimeos\" align=\"right\" height=\"60\" /\u003e\n\u003c/a\u003e\n\n# Nylas Ruby SDK\n\n[![Gem (including prereleases)](https://img.shields.io/gem/v/nylas?include_prereleases)](https://rubygems.org/gems/nylas)\n[![codecov](https://codecov.io/gh/nylas/nylas-ruby/branch/main/graph/badge.svg?token=IKH0YMH4KA)](https://codecov.io/gh/nylas/nylas-ruby)\n\nThis is the GitHub repository for the Nylas Ruby SDK. This repo is primarily for anyone who wants to make contributions to the SDK or install it from source. For documentation on how to use this SDK to access the Nylas Email, Calendar, or Contacts APIs, see the official [Ruby SDK Quickstart Guide](https://developer.nylas.com/docs/sdks/ruby/).\n\nThe Nylas Communications Platform provides REST APIs for [Email](https://developer.nylas.com/docs/email/), [Calendar](https://developer.nylas.com/docs/calendar/), and [Contacts](https://developer.nylas.com/docs/contacts/), and the Nylas SDK is the quickest way to build your integration using Ruby.\n\nHere are some resources to help you get started:\n\n- [Sign up for the Nylas v3 Beta program to access the v3 Dashboard](https://info.nylas.com/apiv3betasignup.html?utm_source=github\u0026utm_medium=devrel-surfaces\u0026utm_campaign=\u0026utm_content=ruby-sdk-upgrade)\n- [Nylas API v3 Quickstart Guide](https://developer.nylas.com/docs/v3-beta/v3-quickstart/)\n- [Nylas SDK Reference](https://nylas-ruby-sdk-reference.pages.dev/)\n- [Nylas API Reference](https://developer.nylas.com/docs/api/v3-beta/)\n- [Nylas Samples repo for code samples and example applications](https://github.com/orgs/nylas-samples/repositories?q=\u0026type=all\u0026language=ruby)\n\nIf you have a question about the Nylas Communications Platform, [contact Nylas Support](https://support.nylas.com/) for help.\n\n## ⚙️ Install\n\n### Prerequisites\n\n- Ruby 3.0 or above.\n- Ruby Frameworks: `httparty` and `yajl-ruby`.\n\n### Install\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'nylas'\n```\n\nAnd then execute:\n\n```bash\nbundle\n```\n\nTo run scripts that use the Nylas Ruby SDK, install the `nylas` gem.\n\n```bash\ngem install nylas\n```\n\nTo install the SDK from source, clone this repo and install with bundle.\n\n```bash\ngit clone https://github.com/nylas/nylas-ruby.git \u0026\u0026 cd nylas-ruby\nbundle install\n```\n\n### Set up Ruby SDK for Development\n\nInstall [RubyGems](https://rubygems.org/pages/download) if you don't already have it:\n\n```shell\ngem install bundler\ngem update --system\n```\n\nInstall the SDK from source\n\n```shell\nbundle install\n```\n\nYou can run tests locally using ```rspec```:\n\n```shell\nrspec spec\n```\n\n## ⚡️ Usage\n\nTo use this SDK, you must first [sign up for the v3 Beta and get a free Nylas account](https://info.nylas.com/apiv3betasignup.html?utm_source=github\u0026utm_medium=devrel-surfaces\u0026utm_campaign=\u0026utm_content=ruby-sdk-upgrade).\n\nThen, follow the Quickstart guide to [set up your first app and get your API keys](https://developer.nylas.com/docs/v3-beta/v3-quickstart/).\n\nFor code examples that demonstrate how to use this SDK, take a look at our [Ruby repos in the Nylas Samples collection](https://github.com/orgs/nylas-samples/repositories?q=\u0026type=all\u0026language=ruby).\n\n### 🚀 Making Your First Request\n\nAll of the functionality of the Nylas Communications Platform is available through the `Client` object. To access data for an account that’s connected to Nylas, create a new API client object and pass in your Nylas API key. In the following example, replace `NYLAS_API_KEY` with your Nylas API Key, and you can provide other additional configurations such as the Nylas API url and the timeout.\n\n```ruby\nrequire 'nylas'\n\nnylas = Nylas::Client.new(\n  api_key: \"NYLAS_API_KEY\",\n)\n```\n\nNow, you can use `nylas` to access full email, calendar, and contacts functionality, for example to list all the calendars for a given account:\n\n```ruby\ncalendars, _request_ids = nylas.calendars.list(identifier: \"GRANT_ID\")\n```\n\n## 📚 Documentation\n\nNylas maintains a [reference guide for the Ruby SDK](https://nylas-ruby-sdk-reference.pages.dev/) to help you get familiar with the available methods and classes.\n\n## ✨ Upgrading from 5.x\n\nSee [UPGRADE.md](UPGRADE.md) for instructions on upgrading from 5.x to 6.x.\n\n**Note**: The Ruby SDK v6.x is not compatible with the Nylas API earlier than v3-beta. If you are using Nylas v2.7 or earlier, continue using the v5.x Nylas Ruby SDK.\n\n## 💙 Contributing\n\nPlease refer to [Contributing](Contributing.md) for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.\n\n## 📝 License\n\nThis project is licensed under the terms of the MIT license. Please refer to [LICENSE](LICENSE.txt) for the full terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnylas%2Fnylas-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnylas%2Fnylas-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnylas%2Fnylas-ruby/lists"}