nylas 6.8.1 → 6.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 537c2669d5e30d03ad70d6acbd18c782865038fcff32779ffca36ece16234900
-  data.tar.gz: bf78777657d01f6907505b473d5304419d95a8f8984455604fe59c86e5a1279b
+  metadata.gz: dd4f82c67af569b7d104e68c7dc95e078b20e23dd13f773ba2b7ed2d1936e78b
+  data.tar.gz: 644b49eb5d7f85fbc648185ce9c4b5a5606383d349cd7aca5f1f29abdb5240f3
 SHA512:
-  metadata.gz: bb7bca82b3c7dbb97b8365a4ef5882d86f41256952e17f854e03e1eff92d16a8cee53f57a971a8bc70209d26a7f5721915a6d458b8582adc24aaf9a055257469
-  data.tar.gz: 52196420bcaeb94ea0b31c2a513b57dee5a8dd7eed2f5689564cba0d84e2b63b91751a0616881e0813b63a02a29cd16a1064d78f0a57b6e1e6c4ce31fa0e395f
+  metadata.gz: 13043c7a48867fa7c6e640e2c599664ca5f4b7b368964593ae468fd49e5758db2bb603ad26e3b98f1c74a092d561ea0fa69273798026e8b75bdcb9249afcf340
+  data.tar.gz: 0cacad52c7aaff32ca2c7cfeada427743a9ef6a85fe559c86b3ed1527688120918a3a0e159296ef21385137bc8027c5cf4d234ea6049acf6e5e9630cb346c035

data/CHANGELOG.md

@@ -0,0 +1,407 @@
+# Changelog
+
+### [6.9.0] / 2026-10-26
+* Required HTTParty 0.24.0 or later to exclude versions affected by CVE-2025-68696 (potential SSRF and API key leakage)
+* Treat 207 Multi-Status responses as successful, so a response that carries partial results is returned instead of raising an error
+* Documented `tracking_options.domain_name` hash support for custom link and open tracking hostnames. See the [message tracking documentation](https://developer.nylas.com/docs/v3/email/message-tracking/)
+* Documented Contact `metadata` and `metadata_pair` hashes, and added `contact.updated` and `contact.deleted` webhook trigger constants
+* Updated CI runner images and SDK reference documentation deployment, made Ruby 3.0/3.1/3.2 versions explicit, and added gem builds to the Ruby test matrix
+* Corrected gem metadata and SDK reference links, and included the changelog, README, and license in the gem package
+* Updated the local test command to match the supported Ruby 3.0+ test suite
+* Declared the RDoc development dependency so SDK reference documentation also builds on Ruby 4.0, and verified documentation output in CI
+* Required YARD 0.9.44 or later for development to exclude known documentation server path traversal vulnerabilities
+* Updated the coverage formatter for compatibility with current REXML releases
+
+### [6.8.1]
+* Documented `tentative_as_busy` support in the `Calendars#get_free_busy` request body, consistent with other Nylas SDKs
+
+### [6.8.0]
+* Added Policies resource for managing application policies
+* Added Rules resource for managing inbox rules and listing rule evaluations
+* Added Lists resource support for creating application lists
+* Added Workspaces resource for managing workspaces, auto-grouping, manual assignment, `default`, `policy_id`, and `rule_ids`
+* Added Domains resource and `ServiceAccountSigner` support for signed Service Account Manage Domains requests, including canonical signed bodies, encoded domain paths, info, and verify operations
+* Added Applications update support (PATCH /v3/applications)
+* Documented Applications update `callback_uris` ID preservation and Workspaces `auto_group` filters
+* Corrected RedirectUris update verb from PUT to PATCH
+* Fixed HTTParty content type issue when request body is nil - POST, PUT, PATCH, and DELETE now default to empty object to ensure Content-Type: application/json is sent (#536)
+* Added support for request_body parameter on DELETE (e.g. cancellation_reason for bookings) (#536)
+
+### [6.7.1]
+* Fix large attachment handling with string keys and custom content_ids
+
+### [6.7.0]
+* Added access to response headers
+
+### [6.6.0]
+* Added support for `single_level` query parameter in Folders API for Microsoft accounts
+* Added support for `include_hidden_folders` query parameter in folders list endpoint for Microsoft accounts to control whether hidden folders are included in the response
+* Added support for passing in string contents for multipart and base64 (<3MB) attachments (#528) 
+* Fixed HTTParty encoding compatibility issue with multipart requests (#528)
+
+### 6.5.0 / 2025-06-13
+* Replaced `rest-client` dependency with `httparty` for improved maintainability and security
+  - `rest-client` is no longer actively maintained and has known security vulnerabilities
+  - `httparty` is actively maintained and provides better performance
+  - All existing functionality remains backwards compatible - no customer code changes required
+  - Removed workaround for `rest-client` cookie jar threading bug
+* Added support for new `fields` query parameter values in Messages API:
+  - `include_tracking_options`: Returns messages and their tracking settings
+  - `raw_mime`: Returns the grant_id, object, id, and raw_mime fields only
+* Added support for `tracking_options` field in message responses containing:
+  - `opens`: Boolean indicating if message open tracking is enabled
+  - `thread_replies`: Boolean indicating if thread replied tracking is enabled
+  - `links`: Boolean indicating if link clicked tracking is enabled
+  - `label`: String label describing the message tracking purpose
+* Added support for `raw_mime` field in message responses containing Base64url-encoded message data
+* Added `MessageFields` module with constants for all valid field values to improve developer experience
+* Fixed multipart email sending bug where large attachments would fail due to multipart flag key mismatch (#525)
+  - `FileUtils.handle_message_payload` transforms keys to symbols (`:multipart`)
+  - `HttpClient.build_request` was only checking for string keys (`"multipart"`)
+  - Now checks for both string and symbol keys to maintain full backwards compatibility
+  - Prevents encoding errors when sending emails with attachments larger than 3MB
+
+### 6.4.0 / 2025-04-30
+* Added support for Notetaker APIs
+* Added support for Notetaker via the calendar and event APIs
+* Added MESSAGE_BOUNCE_DETECTED to the webhook triggers
+* Fixed issue to raise an explicit exception when the response lacks a JSON body (#520)
+
+### 6.3.0 / 2025-03-03
+* Removed `file_path` from `File` object to match the Send API schema
+* Added events import function to the RubySDK
+* Added response headers to Ruby SDK 
+
+### 6.2.3 / 2025-01-23
+* Fixed issue where errors were not properly thrown due to an instance type of `String` instead of `Hash`
+
+### 6.2.2 / 2024-12-02
+* Added support for private Scheduling configuration.
+* Added ability to add optional `content_id` to support inline image on `send`.
+* Added custom filename support for large attachments.
+* Adjusted the gendoc to show that the `provider_error` is a Hash.
+
+### 6.2.1 / 2024-11-12
+* Added support for scheduler APIs
+* Added `query_params` field to `Folders` & `Threads` find
+* Added custom filename support for attachments
+
+
+### 6.2.0 / 2024-09-24
+* Added query support for folders
+* Added dependency on `ostruct` gem
+* Enable SDK to reattach large files to messages on retry
+* Downgraded `rest-client` to `2.0` for better compatibility
+
+### 6.1.1 / 2024-08-20
+* Fixed sending attachments less than 3MB
+
+### 6.1.0 / 2024-06-25
+* Added query support for messages
+* Added support for clean messages
+* Added support for getting access token info
+* Added new webhook triggers
+
+### 6.0.3 / 2024-03-05
+* Improved message sending and draft create/update performance
+* Change default timeout to match API (90 seconds)
+* Fixed error when invoking `Auth.detect_provider`
+
+### 6.0.2 / 2024-02-27
+* Fixed the HTTP operation of updating grants
+* Fixed endpoint URL of rotating webhooks
+
+### 6.0.1 / 2024-02-12
+* Fixed a bug during OAuth URL building
+* Fixed a bug where the `next_cursor` field was omitted for list responses
+
+### 6.0.0 / 2024-02-05
+* **BREAKING CHANGE**: Ruby SDK v6 supports the Nylas API v3 exclusively, dropping support for any endpoints that are not available in v3.
+* **BREAKING CHANGE**: Officially support minimum Ruby v3
+* **BREAKING CHANGE**: Removed all models and typing from the SDK
+* **REMOVED**: Local Webhook development support is removed due to incompatibility
+* Rewritten the majority of SDK to be more modular and efficient
+* Created error classes for the different API errors as well as SDK-specific errors
+* Added a configurable timeout for outgoing calls to the API
+
+### 5.17.0 / 2022-04-04
+* Add support for verifying webhook signatures
+* Add `event.updated_at`
+* Allow native authentication to return the full response like the `exchange_code_for_token`
+
+### 5.16.0 / 2022-03-14
+* Add missing `provider_id` attribute to `Label`
+* Add `organizer_email` and `organizer_name` to `Event`
+* Add missing job status webhook triggers
+* Fix `MESSAGE_LINK_CLICKED` trigger
+
+### 5.15.0 / 2022-02-02
+* Add local webhook testing support
+* Add `tzinfo`, `faye-websocket`, `eventmachine` as runtime dependencies
+
+### 5.14.0 / 2022-12-16
+* Added support for rate limit errors
+* Added `disable_provider_selection` option for building auth URL
+* Improved performance by skipping creating instance of StringIO before parsing JSON
+
+### 5.13.0 / 2022-10-21
+* Add timezone fields to the `When` class
+* Adds visibility attribute to `Event` class
+* Add support for calendar colors (for Microsoft calendars)
+
+### 5.12.1 / 2022-08-12
+* Add support for getting `ids` and `count` for collections not supported by the API
+* Fix Ruby 3.x compatibility for expanding keyword arguments
+
+### 5.12.0 / 2022-07-29
+* Add missing hosted authentication parameters
+* Add `reply_to_message_id` field in `Messages`
+* Fix calendar availability failing when `round_robin` is `nil`
+
+### 5.11.0 / 2022-07-08
+* Add support for event reminders
+* Add `metadata` field to `JobStatus`
+
+### 5.10.0 / 2022-05-10
+* Support collective and group events
+* Fix `ModelNotFilterableError` when querying for accounts with metadata
+
+### 5.9.2 / 2022-05-04
+* Fix calendar availability not serializing `FreeBusy` and `OpenHours` properly
+* Fix Authentication demo app using deprecated Google scopes
+
+### 5.9.1 / 2022-04-20
+* Add missing `phone_number` field in `Participant`
+* Fix `NoMethodError` when calling `NewMessage#send!`
+
+### 5.9.0 / 2022-04-07
+* Add Outbox support
+* Add new `authentication_type` field in Account
+* Add support for basic authentication
+* Enable Nylas API v2.5 support
+
+### 5.8.0 / 2022-03-18
+* Improved support for `Webhook` objects
+* Support `calendars` for availability methods
+* Fix `interval_minutes` keyword for availability methods
+
+### 5.7.0 / 2022-01-21
+* Add job status support
+* Add `Event` to ICS support
+* Add support for getting access token information
+* Improved support for Application Details
+* Enable ability to delete `Account` objects
+* Fix saving and deleting `Folder` objects
+
+### 5.6.1 / 2021-12-13
+* Enabled support for adding metadata to a `NewMessage`/`Draft`
+* Fix bug where updating an Event results in an API error
+
+### 5.6.0 / 2021-11-22
+* Add support for event notifications
+* Add more Scheduler support
+* Add metadata support for `Calendar`, `Message` and `Account`
+* Modify `exchange_code_for_token` to allow returning a full body
+
+### 5.5.0 / 2021-10-28
+* Add Component CRUD Support
+* Add Scheduler support
+* Add support for calendar availability
+* Add support for `File` delete operation
+* Fix issue where `file_ids` get reset to empty
+
+### 5.4.1 / 2021-09-27
+* Fix draft send method to send existing draft when tracking is enabled
+
+### 5.4.0 / 2021-09-23
+* Add support for Event Conferencing
+* Fix update draft failing if version is not explicitly set
+* Fix draft `.send` logic
+
+### 5.3.0 / 2021-08-18
+* Add support for Neural API
+* Fix issue where `Delta` did not have a header attribute for expanded headers
+* Fix ArgumentError when calling `Nylas::API#send!` due to missing double splat (**)
+* Fix issue where server errors are not reported if HTML is returned
+* Fix issue where expanded `Thread` objects were not returning messages
+
+### 5.2.0 / 2021-06-07
+* Add support for `Room Resource`
+* Fix issue where "302 Redirect" response codes were treated as errors
+* Fix issue where `api` value was overriden when calling `message.expanded`
+
+### 5.1.0 / 2021-06-07
+* Add support for read only attributes
+* Add `save_all_attributes` and `update_all_attributes` methods to support
+  nullifying attributes.
+* Add support new `Event` metadata feature
+* Fix attributes assignment for `Delta`
+* Fix issue where files couldn't be attached to drafts
+* Fix exception raise when content-type is not JSON
+* Fix issue where draft version wouldn't update after `update` or `save`
+
+### 5.0.0 / 2021-05-07
+
+* Send `Nylas-API-Version` header to API with latest supported version.
+* Fix issue sending message using raw mime type.
+* Support for `messages.expanded.find(id)` to return expanded message.
+* Add support for hosted authentication
+* Fix bug to not send `id`, `object` and `account_id` on events update call
+
+### 4.6.7 / 2021-04-22
+
+* Support for Ruby 3.
+* Add support for `/free-busy` endpoint
+* Fix issue where download a file fetch via `find` failed,
+
+### 4.6.6 / 2021-04-06
+
+* Add support for `notify_participants` when creating events
+* Add provider attribute to account
+
+### 4.6.5 / 2021-02-22
+
+* Add `content_disposition` field to File
+* Fix thread-safety issue in HTTP::CookieJar loading
+
+### 4.6.4 / 2021-02-03
+
+* fix failing http_client spec after merging main
+* Skip parsing response if content is not JSON
+* Add missing http status codes / errors.
+* Add reply_to to NewMessage
+* Add message tracking to drafts.
+* Truncate the returned filename so it's less than 256 characters and compatible with rb_sysopen.
+* Bump required rest client dep to >= 2.0, remove travis ci tests for rest client 1, ruby v2.3
+* Use to_json helper instead of JSON.dump.
+
+### 4.6.3 / 2020-12-18
+
+* Remove folder on message.save for updates
+* Fix JSON parsing behavior
+* Fix rubocop warnings for http_client and spec
+* No longer rescue json parse errors, use Yajl instead of JSON for parsing responses (due to unicode issue).
+* Add specs for changes to message.save
+* Store folder id in folder_id and remove folder if present before saving.
+* Adding secondary_address field to physical address model
+
+### 4.6.2 / 2020-09-08
+
+* Add support to move `message` and `thread` between `folder`.
+* Handle new attributes added to API gracefully
+* Add is_primary and other new Calendar attributes
+
+### 4.6.1 / 2020-01-06
+
+* Fix a bug with `when` blocks when creating events
+* Add support for the Event.ical_uid field
+
+### 4.6.0 / 2019-09-25
+
+* Add support for `/contacts/groups` endpoint.
+* Fix issue when calling `.save` on `message` (https://github.com/nylas/nylas-ruby/pull/233)
+* Add support for Rails 6.
+* Fix issue for updating `message` with sending `label_ids` (https://github.com/nylas/nylas-ruby/pull/231)
+* Support for `when` in `Nylas::Event` for more attributes.
+* Add internal transfer api to support initialize related objects.
+* Fix encoding issues when downloading attachments.
+
+### 4.5.0 / 2019-04-15
+
+* Add support for `source` attribute in Contact model
+
+### 4.4.0 / 2019-04-05
+
+* Add support for `/ip_addresses` endpoint
+* Add optional argument for `Model#to_json`
+* Reintroduce support for Ruby 2.3
+* Add Rails 4 bundler support to setup script
+* Specify gemfiles called in test script
+
+### 4.3.0 / 2019-03-18
+
+* Drop support for Ruby 2.2 and 2.3: they have reached end-of-life
+* Add support for Ruby 2.5 and 2.6
+* Add `scopes` argument to `Nylas::API#authenticate` for
+  [selective sync](https://docs.nylas.com/docs/how-to-use-selective-sync)
+* Add `Account#revoke_all`
+* Add X-Nylas-Client-Id header for HTTP requests
+
+### 4.2.4 / 2018-08-07
+* Enables silent addition of fields to API without impact to SDK
+* Fixes api attribute breakage on enumeration (https://github.com/nylas/nylas-ruby/issues/188)
+
+### 4.0.0 / 2018-01-??
+* Drop support for ruby 2.0 and below
+* Add support for v2 of the Contacts API
+* Switch to an ActiveModel/ActiveQuery compliant interface for interacting with
+  objects and APIs
+
+### 3.2.0 / 2017-11-16
+* Add support for Ruby 2.4+
+* Add support for Rails 4+
+* Filters now work correctly for all models
+* `.each` now pages requests
+* Numerous other bug fixes
+
+### 3.1.1 / 2017-06-23
+* Fix deleting event request (https://github.com/nylas/nylas-ruby/issues/101)
+
+### 3.1.0 / 2017-05-10
+* Adds support for message tracking (https://github.com/cberkom)
+
+### 3.0.0 / 2016-11-04
+
+* Removes `interpret_http_status` to be included in `interpret_response`
+* Improve error handling
+* Add native authentication example code
+* Add webhooks example code
+* Removes experimental JRuby support
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v2.0.1...v3.0.0)
+
+### 2.0.1 / 2016-02-12
+
+* Fix folders and labels updates for threads and messages
+* Revert pull request #71
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v2.0.0...v2.0.1)
+
+### 2.0.0 / 2016-02-05
+
+* Remove get_cursor method that calls deprecated generate_cursor endpoint
+* Modify `delta_stream method` to remove built-in `EventMachine.run` block and allow for multiple streams. `delta_stream` must now be called from inside an `EventMachine.run` block
+* `url_for_authentication` now accepts a `:state` parameter (see https://nylas.com/docs#server_side_explicit_flow for more details)
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v1.3.0...v2.0.0)
+
+### 1.3.0 / 2015-12-07
+
+* Deprecate the tags API
+* Remove the archive!/unarchive! methods
+* Expose `starred`, `unread`, `has_attachments` in Nylas::Thread
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v1.2.1...v1.3.0)
+
+### 1.2.0 / 2015-11-19
+
+* Add `Messages#files?` [Issue #40](https://github.com/nylas/nylas-ruby/issues/40)
+* Return an external Enumerator when no block given. [Issue #42](https://github.com/nylas/nylas-ruby/issues/42) ([Steven Harman](https://github.com/stevenharman))
+* Expose `folders` in the Delta Stream API.
+* Add `Inbox::Error` base class for all errors. ([Steven Harman](https://github.com/stevenharman))
+* Expose `sync_state` on the `/account` API. ([Steven Harman](https://github.com/stevenharman))
+* Return Enumerator for #deltas when no block given
+* Ruby < 1.9.3 no longer supported
+* Add travis support for Mac OS X
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v1.1.0...v1.2.0)
+
+
+### 1.1.0 / 2015-09-22
+
+* `Message#expanded` returns an expanded version of a message
+* Expose the `server_error` field when failing to send messages
+* minor bug fixes
+* various test cleanups ([Steven Harman](https://github.com/stevenharman))
+
+[full changelog](https://github.com/nylas/nylas-ruby/compare/v1.0.0...v1.1.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+----
+
+Copyright (c) 2016 Nylas, Inc. and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+<div align="center">
+  <a href="https://www.nylas.com/">
+    <img width="100%" alt="Nylas" src="https://github.com/user-attachments/assets/137517ae-244d-47a5-8ca7-b12984971fc4" />
+  </a>
+
+  <h1>Nylas Ruby SDK</h1>
+
+  <p>
+    <strong>The official Ruby SDK for Nylas — the infrastructure that powers communications</strong>
+  </p>
+
+  <p>
+    <a href="https://rubygems.org/gems/nylas"><img src="https://img.shields.io/gem/v/nylas" alt="version" /></a>
+    <a href="https://codecov.io/gh/nylas/nylas-ruby"><img src="https://codecov.io/gh/nylas/nylas-ruby/branch/main/graph/badge.svg?token=IKH0YMH4KA" alt="code coverage" /></a>
+    <a href="https://rubygems.org/gems/nylas"><img src="https://img.shields.io/gem/dt/nylas" alt="downloads" /></a>
+    <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" /></a>
+  </p>
+
+  <p>
+    <a href="https://developer.nylas.com/docs/v3/sdks/ruby/">📖 SDK Guide</a> ·
+    <a href="https://developer.nylas.com/docs/api/v3/">📚 API Reference</a> ·
+    <a href="https://dashboard-v3.nylas.com/register">🚀 Sign up</a> ·
+    <a href="https://github.com/orgs/nylas-samples/repositories?q=ruby">💡 Samples</a> ·
+    <a href="https://forums.nylas.com">💬 Forum</a>
+  </p>
+</div>
+
+<br />
+
+The official Ruby SDK for [Nylas](https://developer.nylas.com/docs/v3/) — the infrastructure that powers communications. Integrate with Gmail, Microsoft, IMAP, Zoom, and 250+ email, calendar, and meeting providers in 5 minutes. Covers [Email](https://developer.nylas.com/docs/v3/email/), [Calendar](https://developer.nylas.com/docs/v3/calendar/), [Contacts](https://developer.nylas.com/docs/v3/email/contacts/), [Scheduler](https://developer.nylas.com/docs/v3/scheduler/), [Notetaker](https://developer.nylas.com/docs/v3/notetaker/), and [Agent Accounts](https://developer.nylas.com/docs/v3/agent-accounts/).
+
+This repository is for contributors and anyone installing the SDK from source. If you just want to use the SDK in your app, head straight to the **[Ruby SDK guide](https://developer.nylas.com/docs/v3/sdks/ruby/)** on developer.nylas.com.
+
+## Get started
+
+1. [Sign up for a free Nylas account](https://dashboard-v3.nylas.com/register).
+2. Follow the [getting started guide](https://developer.nylas.com/docs/v3/getting-started/) to provision an application and create your API key.
+3. Bootstrap a project with the Nylas CLI:
+
+   ```bash
+   brew install nylas/nylas-cli/nylas
+   nylas init
+   ```
+
+## ⚙️  Install
+
+> **Requirements:** Ruby 3.0 or later.
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "nylas"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install nylas
+```
+
+### Build from source
+
+```bash
+git clone https://github.com/nylas/nylas-ruby.git
+cd nylas-ruby
+bundle install
+```
+
+Run the test suite with `rspec spec`.
+
+## ⚡️ Usage
+
+Initialize the client with your API key:
+
+```ruby
+require "nylas"
+
+nylas = Nylas::Client.new(
+  api_key: "NYLAS_API_KEY"
+)
+```
+
+Then make a request — for example, list a grant's calendars:
+
+```ruby
+calendars, request_id, next_cursor = nylas.calendars.list(identifier: "GRANT_ID")
+```
+
+Every SDK call returns a tuple. List endpoints return `[data, request_id, next_cursor, headers]`; single-record endpoints return `[data, request_id]`. Destructure the elements you need and ignore the rest with `_`. Use `next_cursor` to paginate:
+
+```ruby
+cursor = nil
+loop do
+  page, _request_id, cursor = nylas.calendars.list(
+    identifier: "GRANT_ID",
+    query_params: { page_token: cursor }
+  )
+  page.each { |calendar| puts calendar[:name] }
+  break unless cursor
+end
+```
+
+For step-by-step walkthroughs, see the developer guides:
+
+- [Email](https://developer.nylas.com/docs/v3/email/)
+- [Calendar](https://developer.nylas.com/docs/v3/calendar/)
+- [Scheduler](https://developer.nylas.com/docs/v3/scheduler/)
+- [Notetaker](https://developer.nylas.com/docs/v3/notetaker/)
+- [Agent Accounts](https://developer.nylas.com/docs/v3/agent-accounts/)
+- [Notifications & webhooks](https://developer.nylas.com/docs/v3/notifications/)
+
+### Error handling
+
+The SDK raises typed errors you can rescue. API failures raise `Nylas::NylasApiError` (with `type`, `status_code`, `request_id`, `provider_error`, `headers`); OAuth failures raise `Nylas::NylasOAuthError`; request timeouts raise `Nylas::NylasSdkTimeoutError`.
+
+```ruby
+begin
+  nylas.messages.find(identifier: "GRANT_ID", message_id: "MESSAGE_ID")
+rescue Nylas::NylasApiError => e
+  warn "Nylas API error #{e.status_code} (#{e.type}): #{e.message}"
+rescue Nylas::NylasSdkTimeoutError => e
+  warn "Request to #{e.url} timed out after #{e.timeout}s"
+end
+```
+
+## 💡 Examples
+
+- Local examples live in [`examples/`](examples/) (messages, events, folders, notetaker).
+- The [Nylas Samples org](https://github.com/orgs/nylas-samples/repositories?q=ruby) has end-to-end Ruby apps you can clone and run.
+
+## 🤖 AI agents
+
+[nylas/skills](https://github.com/nylas/skills) drops Nylas into Claude Code, Cursor, Codex, and other agents that support the skills format:
+
+```bash
+npx skills add nylas/skills
+/plugin marketplace add nylas/skills   # Claude Code
+```
+
+The CLI also installs an MCP server for Claude Desktop, Claude Code, Cursor, Windsurf, or VS Code:
+
+```bash
+brew install nylas/nylas-cli/nylas
+nylas mcp install
+```
+
+Walkthrough: [give AI agents email access via MCP](https://cli.nylas.com/guides/give-ai-agents-email-access-via-mcp).
+
+## 📚 Reference
+
+- [Ruby SDK guide](https://developer.nylas.com/docs/v3/sdks/ruby/)
+- [API reference](https://developer.nylas.com/docs/api/v3/)
+- [Getting started](https://developer.nylas.com/docs/v3/getting-started/)
+- [Email](https://developer.nylas.com/docs/v3/email/) · [Calendar](https://developer.nylas.com/docs/v3/calendar/) · [Scheduler](https://developer.nylas.com/docs/v3/scheduler/) · [Notetaker](https://developer.nylas.com/docs/v3/notetaker/) · [Agent Accounts](https://developer.nylas.com/docs/v3/agent-accounts/) · [Notifications](https://developer.nylas.com/docs/v3/notifications/)
+- [Data residency](https://developer.nylas.com/docs/dev-guide/platform/data-residency/)
+- [Nylas CLI](https://cli.nylas.com)
+- [Forum](https://forums.nylas.com)
+
+## ✨ Upgrading
+
+See [CHANGELOG.md](CHANGELOG.md) for release notes, and [UPGRADE.md](UPGRADE.md) for the 5.x → 6.x migration guide. The 6.x line targets Nylas API v3; if you're still on v2.7 or earlier, stay on the 5.x SDK.
+
+## 💙 Contributing
+
+Bug reports, questions, and pull requests are welcome. See [Contributing.md](Contributing.md) for the workflow, and the [Nylas Forum](https://forums.nylas.com) for broader discussion.
+
+## 🔒 Security
+
+To report a security vulnerability, follow the [Nylas Vulnerability Disclosure Policy](https://www.nylas.com/security/vulnerability-disclosure-policy/). Please don't open a public GitHub issue for security reports.
+
+## 🔗 Other Nylas SDKs
+
+- [nylas-nodejs](https://github.com/nylas/nylas-nodejs)
+- [nylas-python](https://github.com/nylas/nylas-python)
+- [nylas-java](https://github.com/nylas/nylas-java) (Java & Kotlin)
+
+## 📝 License
+
+MIT — see [LICENSE.txt](LICENSE.txt).

data/lib/nylas/errors.rb

@@ -83,5 +83,5 @@ module Nylas
     end
   end
 
-  HTTP_SUCCESS_CODES = [200, 201, 202, 302].freeze
+  HTTP_SUCCESS_CODES = [200, 201, 202, 207, 302].freeze
 end

data/lib/nylas/resources/auth.rb

@@ -19,7 +19,7 @@ module Nylas
     # Get info about a specific token based on the identifier you include.
     # Use either the ID Token or Access Token.
     #
-    # @param ID of the request.
+    # @param query_params [Hash, nil] Query parameters containing the token to inspect.
     # @return [Hash] Token Info.
     def access_token_info(query_params: nil)
       get(

data/lib/nylas/resources/contacts.rb

@@ -14,7 +14,10 @@ module Nylas
     # Return all contacts.
     #
     # @param identifier [String] Grant ID or email account to query.
-    # @param query_params [Hash, nil] Query params to pass to the request.
+    # @param query_params [Hash, nil] Query params to pass to the request. Use
+    #   `metadata_pair: { key1: "value" }` to filter by one indexed metadata
+    #   key (`key1` through `key5`). Metadata filters cannot be combined with
+    #   provider-side contact filters.
     # @return [Array(Array(Hash), String, String)] The list of contacts, API Request ID, and next cursor.
     def list(identifier:, query_params: nil)
       get_list(
@@ -39,7 +42,8 @@ module Nylas
     # Create a contact.
     #
     # @param identifier [String] Grant ID or email account in which to create the object.
-    # @param request_body [Hash] The values to create the contact with.
+    # @param request_body [Hash] The values to create the contact with. The
+    #   optional `metadata` hash is stored by Nylas, not by the provider.
     # @return [Array(Hash, String)] The created contact and API Request ID.
     def create(identifier:, request_body:)
       post(
@@ -52,7 +56,9 @@ module Nylas
     #
     # @param identifier [String] Grant ID or email account in which to update an object.
     # @param contact_id [String] The id of the contact to update.
-    # @param request_body [Hash] The values to update the contact with
+    # @param request_body [Hash] The values to update the contact with. Omitting
+    #   `metadata` or setting it to `nil` preserves existing metadata, a hash
+    #   replaces it, and an empty hash clears it.
     # @return [Array(Hash, String)] The updated contact and API Request ID.
     def update(identifier:, contact_id:, request_body:)
       put(

data/lib/nylas/resources/drafts.rb

@@ -39,9 +39,12 @@ module Nylas
     #
     # @param identifier [String] Grant ID or email account in which to create the draft.
     # @param request_body [Hash] The values to create the message with.
+    #   Use `:tracking_options` with `:links` or `:opens` enabled to track the draft. To use a custom
+    #   tracking hostname, set `:domain_name` inside `:tracking_options` to an active hostname owned
+    #   by your organization.
     #   If you're attaching files, you must pass an array of [File] objects, or
     #   you can pass in base64 encoded strings if the total attachment size is less than 3mb.
-    #   You can also use {FileUtils::attach_file_request_builder} to build each object attach.
+    #   You can also use {Nylas::FileUtils.attach_file_request_builder} to build each attachment.
     # @return [Array(Hash, String)] The created draft and API Request ID.
     def create(identifier:, request_body:)
       payload, opened_files = FileUtils.handle_message_payload(request_body)
@@ -61,9 +64,12 @@ module Nylas
     # @param identifier [String] Grant ID or email account in which to update the draft.
     # @param draft_id [String] The id of the draft to update.
     # @param request_body [Hash] The values to create the message with.
+    #   To replace the draft's custom tracking hostname, set `:tracking_options` with `:links` or
+    #   `:opens` enabled and a `:domain_name`. Omit `:tracking_options` to preserve the draft's
+    #   existing tracking settings.
     #   If you're attaching files, you must pass an array of [File] objects, or
     #   you can pass in base64 encoded strings if the total attachment size is less than 3mb.
-    #   You can also use {FileUtils::attach_file_request_builder} to build each object attach.
+    #   You can also use {Nylas::FileUtils.attach_file_request_builder} to build each attachment.
     # @return [Array(Hash, String)] The updated draft and API Request ID.
     def update(identifier:, draft_id:, request_body:)
       payload, opened_files = FileUtils.handle_message_payload(request_body)

data/lib/nylas/resources/messages.rb

@@ -114,9 +114,14 @@ module Nylas
     #
     # @param identifier [String] Grant ID or email account from which to delete an object.
     # @param request_body [Hash] The values to create the message with.
+    #   Use `:tracking_options` with `:links` or `:opens` enabled to track a message. To use a custom
+    #   tracking hostname, set `:domain_name` inside `:tracking_options` to an active hostname owned
+    #   by your organization. Omit `:domain_name` to use the default Nylas tracking hostname.
+    #   Set `:send_at` to a Unix timestamp to schedule the message; custom tracking hostnames are
+    #   validated when the send is scheduled and revalidated before delivery.
     #   If you're attaching files, you must pass an array of [File] objects, or
     #   you can pass in base64 encoded strings if the total attachment size is less than 3mb.
-    #   You can also use {FileUtils::attach_file_request_builder} to build each object attach.
+    #   You can also use {Nylas::FileUtils.attach_file_request_builder} to build each attachment.
     # @return [Array(Hash, String)] The sent message and the API Request ID.
     def send(identifier:, request_body:)
       payload, opened_files = FileUtils.handle_message_payload(request_body)

data/lib/nylas/resources/webhooks.rb

@@ -5,11 +5,16 @@ require_relative "../handler/api_operations"
 
 module Nylas
   # Module representing the possible 'trigger' values in a Webhook.
+  # Native iCloud contacts support CONTACT_UPDATED and CONTACT_DELETED. Yahoo
+  # contacts support neither trigger, including for changes made through the
+  # Nylas API. There is no CONTACT_CREATED trigger.
   # @see https://developer.nylas.com/docs/api#post/a/client_id/webhooks
   module WebhookTrigger
     CALENDAR_CREATED = "calendar.created"
     CALENDAR_UPDATED = "calendar.updated"
     CALENDAR_DELETED = "calendar.deleted"
+    CONTACT_UPDATED = "contact.updated"
+    CONTACT_DELETED = "contact.deleted"
     EVENT_CREATED = "event.created"
     EVENT_UPDATED = "event.updated"
     EVENT_DELETED = "event.deleted"

data/lib/nylas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nylas
-  VERSION = "6.8.1"
+  VERSION = "6.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 6.8.1
+  version: 6.9.0
 platform: ruby
 authors:
 - Nylas, Inc.
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -119,20 +119,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.44
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 0.9.44
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -243,14 +263,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +297,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/nylas.rb
 - lib/nylas/client.rb
 - lib/nylas/config.rb
@@ -314,12 +337,13 @@ files:
 - lib/nylas/resources/workspaces.rb
 - lib/nylas/utils/file_utils.rb
 - lib/nylas/version.rb
+homepage: https://www.nylas.com
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/nylas/nylas-ruby/issues
-  changelog_uri: https://github.com/nylas/nylas-ruby/blob/master/CHANGELOG.md
-  documentation_uri: https://developer.nylas.com/docs/sdks/ruby/
+  changelog_uri: https://github.com/nylas/nylas-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://developer.nylas.com/docs/v3/sdks/ruby/
   homepage_uri: https://www.nylas.com
   source_code_uri: https://github.com/nylas/nylas-ruby
   github_repo: https://github.com/nylas/nylas-ruby
@@ -337,7 +361,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Gem for interacting with the Nylas API
 test_files: []