feat: Add Notetaker API support (#519)

* feat: Added support for Notetaker APIs

* feat: Added support for Notetaker via the calendar and event APIs

Added examples and fixed some of the notetaker paths

fix errors

Fixed examples

fix failing actions

fixed coverage issues

PR feedback

pr feedback comments

* fix issues with linting

Author: AaronDDM

.github/workflows/sdk-reference.yaml

@@ -22,7 +22,7 @@ jobs:
         with:
           ruby-version: 3.0
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-      - name: Run rubocop
+      - name: Generate documentation
         run: bundle exec yard
       - name: Set env BRANCH
         run: echo "BRANCH=$(echo $GITHUB_REF | cut -d'/' -f 3)" >> $GITHUB_ENV

.rubocop.yml

@@ -1,6 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-capybara
+
 AllCops:
   TargetRubyVersion: 3.0
   DisplayCopNames: true

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### Unreleased
+* Added support for Notetaker APIs
+* Added support for Notetaker via the calendar and event APIs
+
 ### 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
@@ -53,7 +57,7 @@
 * **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
-* Rewrote the majority of SDK to be more modular and efficient
+* 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
 

Gemfile

@@ -3,3 +3,5 @@
 source "https://rubygems.org"
 
 gemspec name: "nylas"
+
+gem "rake", "~> 13.2", group: :development

examples/README.md

@@ -0,0 +1,73 @@
+# Nylas Ruby SDK Examples
+
+This directory contains example applications and scripts that demonstrate how to use the Nylas Ruby SDK.
+
+## Directory Structure
+
+```
+examples/
+├── README.md                 # This file
+├── events/                   # Event-related examples
+│   └── event_notetaker_example.rb    # Example of creating events with Notetaker
+└── notetaker/               # Standalone Notetaker examples
+    ├── README.md            # Notetaker-specific documentation
+    └── notetaker_example.rb # Basic Notetaker functionality example
+```
+
+## Running the Examples
+
+Before running any example, make sure to:
+
+1. Install the required dependencies:
+   ```bash
+   bundle install
+   ```
+
+2. Set up your environment variables:
+   ```bash
+   export NYLAS_API_KEY="your_api_key"
+   export NYLAS_API_URI="https://api.us.nylas.com"  # Optional, defaults to this value
+   ```
+
+3. Some examples may require additional environment variables. Check the specific example's documentation or code for details.
+
+## Available Examples
+
+### Events
+- `events/event_notetaker_example.rb`: Demonstrates how to create calendar events with Notetaker integration, including:
+  - Creating an event with a Notetaker bot
+  - Retrieving Notetaker details
+  - Updating event and Notetaker settings
+
+### Notetaker
+- `notetaker/notetaker_example.rb`: Shows basic Notetaker functionality, including:
+  - Inviting a Notetaker to a meeting
+  - Listing all Notetakers
+  - Getting media from a Notetaker (recordings and transcripts)
+  - Leaving a Notetaker session
+
+  Prerequisites:
+  - Ruby 3.0 or later
+  - A Nylas API key
+  - A meeting URL (Zoom, Google Meet, or Microsoft Teams)
+
+  Additional environment variables needed:
+  ```bash
+  export MEETING_LINK="your_meeting_link_here"
+  ```
+
+## Contributing
+
+When adding new examples:
+
+1. Create them in the appropriate subdirectory based on functionality
+2. Include clear documentation and comments in the code
+3. List any required environment variables at the top of the file
+4. Update this README.md with information about the new example
+
+## Support
+
+If you encounter any issues or have questions about these examples, please:
+1. Check the [Nylas documentation](https://developer.nylas.com)
+2. Visit our [GitHub repository](https://github.com/nylas/nylas-ruby)
+3. Contact [Nylas support](https://support.nylas.com) 

examples/events/event_notetaker_example.rb

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __dir__)
+require "nylas"
+require "json"
+require "time"
+
+# Initialize the Nylas client
+nylas = Nylas::Client.new(
+  api_key: ENV["NYLAS_API_KEY"],
+  api_uri: ENV["NYLAS_API_URI"] || "https://api.us.nylas.com"
+)
+
+def create_event_with_notetaker(nylas)
+  puts "\n=== Creating Event with Notetaker ==="
+  
+  # Create the event time
+  start_time = Time.now + (24 * 60 * 60) # tomorrow
+  end_time = start_time + (60 * 60) # 1 hour later
+  
+  request_body = {
+    title: "Project Planning Meeting",
+    description: "Initial project planning and resource allocation",
+    when: {
+      start_time: start_time.to_i,
+      end_time: end_time.to_i
+    },
+    metadata: {
+      project_id: "PROJ-123",
+      priority: "high"
+    },
+    conferencing: {
+      provider: "Google Meet",
+      autocreate: {}
+    },
+    notetaker: {
+      name: "Nylas Notetaker",
+      meeting_settings: {
+        video_recording: true,
+        audio_recording: true,
+        transcription: true
+      }
+    }
+  }
+  
+  query_params = {
+    calendar_id: ENV["NYLAS_CALENDAR_ID"]
+  }
+  
+  puts "Creating event with request body: #{JSON.pretty_generate(request_body)}"
+  
+  event, request_id = nylas.events.create(
+    identifier: ENV["NYLAS_GRANT_ID"],
+    request_body: request_body,
+    query_params: query_params
+  )
+  
+  puts "Created event with ID: #{event[:id]}"
+  puts "Event Notetaker ID: #{event[:notetaker][:id]}"
+  puts "Request ID: #{request_id}"
+  
+  event
+end
+
+def get_event_notetaker(nylas, event_id)
+  puts "\n=== Retrieving Event Notetaker ==="
+  
+  # First get the event to get the Notetaker ID
+  begin
+    event, request_id = nylas.events.find(
+      identifier: ENV["NYLAS_GRANT_ID"],
+      event_id: event_id,
+      query_params: { calendar_id: ENV["NYLAS_CALENDAR_ID"] }
+    )
+  rescue StandardError => e
+    puts "Error getting event: #{e.message}"
+    return nil
+  end
+  
+  unless event[:notetaker] && event[:notetaker][:id]
+    puts "No Notetaker found for event #{event_id}"
+    return nil
+  end
+  
+  notetaker, request_id = nylas.notetakers.find(
+    notetaker_id: event[:notetaker][:id],
+    identifier: ENV["NYLAS_GRANT_ID"]
+  )
+  
+  puts "Found Notetaker for event #{event_id}:"
+  puts "- ID: #{notetaker[:id]}"
+  puts "- State: #{notetaker[:state]}"
+  puts "- Meeting Provider: #{notetaker[:meeting_provider]}"
+  puts "- Meeting Settings:"
+  puts "  - Video Recording: #{notetaker[:meeting_settings][:video_recording]}"
+  puts "  - Audio Recording: #{notetaker[:meeting_settings][:audio_recording]}"
+  puts "  - Transcription: #{notetaker[:meeting_settings][:transcription]}"
+  puts "Request ID: #{request_id}"
+  
+  notetaker
+end
+
+def update_event_and_notetaker(nylas, event_id, notetaker_id)
+  puts "\n=== Updating Event and Notetaker ==="
+  
+  request_body = {
+    title: "Updated Project Planning Meeting",
+    description: "Revised project planning with new timeline",
+    metadata: {
+      project_id: "PROJ-123",
+      priority: "urgent"
+    },
+    notetaker: {
+      id: notetaker_id,
+      name: "Updated Nylas Notetaker",
+      meeting_settings: {
+        video_recording: false,
+        audio_recording: true,
+        transcription: false
+      }
+    }
+  }
+  
+  query_params = {
+    calendar_id: ENV["NYLAS_CALENDAR_ID"]
+  }
+  
+  updated_event, request_id = nylas.events.update(
+    identifier: ENV["NYLAS_GRANT_ID"],
+    event_id: event_id,
+    request_body: request_body,
+    query_params: query_params
+  )
+  
+  puts "Updated event with ID: #{updated_event[:id]}"
+  puts "Request ID: #{request_id}"
+  
+  updated_event
+end
+
+def main
+  # Check for required environment variables
+  required_env_vars = %w[NYLAS_API_KEY NYLAS_GRANT_ID NYLAS_CALENDAR_ID]
+  missing_vars = required_env_vars.select { |var| ENV[var].nil? }
+  
+  unless missing_vars.empty?
+    raise "Missing required environment variables: #{missing_vars.join(', ')}"
+  end
+  
+  puts "Using API key: #{ENV['NYLAS_API_KEY'][0..4]}..."
+  
+  # Initialize Nylas client
+  nylas = Nylas::Client.new(
+    api_key: ENV["NYLAS_API_KEY"],
+    api_uri: ENV["NYLAS_API_URI"] || "https://api.us.nylas.com"
+  )
+  
+  begin
+    # Create an event with a Notetaker
+    event = create_event_with_notetaker(nylas)
+    unless event
+      puts "Failed to create event"
+      return
+    end
+    
+    # Get the Notetaker for the event
+    notetaker = get_event_notetaker(nylas, event[:id])
+    unless notetaker
+      puts "Failed to get Notetaker for event #{event[:id]}"
+      return
+    end
+    
+    # Update both the event and its Notetaker
+    updated_event = update_event_and_notetaker(nylas, event[:id], notetaker[:id])
+    unless updated_event
+      puts "Failed to update event #{event[:id]}"
+      return
+    end
+    
+  rescue StandardError => e
+    puts "An error occurred: #{e.message}"
+  end
+end
+
+main if __FILE__ == $PROGRAM_NAME