nylas 5.7.0 → 5.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d8d9639941076724b3e9ae95b85a2e4a48c8f663a35b03f5f26473c5c87b208
-  data.tar.gz: 4b2733e86538a6dd7ac3069dc5738997ea8db1b7be13b1a8de9bef5c868ec1d5
+  metadata.gz: c1e352b09e650aa0cbc5dff7363b8a0997aab35c94e73a5f4a77b5503de70448
+  data.tar.gz: a7830ea4cc6a9028669ca6c0e502cba4f2dfc70402a2c00f85cd1f6d315d0594
 SHA512:
-  metadata.gz: 56b9216d9e5f37a0c449d999891a76a06e1ed8dd8925efe5186d8d59d16105da76ea3b8a5599d88a9e8e83bd2862bc71cc7491957ac8c8da8718a825af2a2a2a
-  data.tar.gz: 5fa04ae09e9692f0c954926ae8e7d541388597a12a154dd8bf82b78c40e91b7b9b73508c5d39b6a2c604ed5d53f5eec86379687dc9b79da81b4a8571d0500460
+  metadata.gz: 7aeed921859461105491d8394f845b79d6419ecc10a17ae0989f2239382cce8e4ad1fb3936bd7a4cebd730e40bac60b28dafe8e145e63a10d424a9e9b46915f0
+  data.tar.gz: 47fdeaa77f5e1037934fc421b7b869edc031f956aad054d2888d29aee0a75ecb537c063e4c89e3c30e4f14f2be2da0860b5ec546e39034590f137773b73ef3cc

data/lib/nylas/account.rb

@@ -9,12 +9,15 @@ module Nylas
     self.showable = true
     self.updatable = true
     self.destroyable = true
+    self.filterable = true
+    self.auth_method = HttpClient::AuthMethod::BASIC
 
     attribute :id, :string, read_only: true
     attribute :account_id, :string, read_only: true
     attribute :billing_state, :string, read_only: true
     attribute :sync_state, :string, read_only: true
     attribute :provider, :string, read_only: true
+    attribute :authentication_type, :string, read_only: true
 
     attribute :email, :string, read_only: true
     attribute :trial, :boolean, read_only: true

data/lib/nylas/api.rb

@@ -35,15 +35,19 @@ module Nylas
       )
     end
 
-    def authentication_url(redirect_uri:, scopes:, response_type: "code", login_hint: nil, state: nil)
+    def authentication_url(redirect_uri:, scopes:, response_type: "code", login_hint: nil, state: nil,
+                           provider: nil, redirect_on_error: nil)
       params = {
         client_id: app_id,
         redirect_uri: redirect_uri,
         response_type: response_type,
         login_hint: login_hint
       }
+
       params[:state] = state if state
       params[:scopes] = scopes.join(",") if scopes
+      params[:provider] = provider if provider
+      params[:redirect_on_error] = redirect_on_error if redirect_on_error
 
       "#{api_server}/oauth/authorize?#{URI.encode_www_form(params)}"
     end
@@ -132,7 +136,12 @@ module Nylas
 
     # @return[Collection<JobStatus>] A queryable collection of {JobStatus} objects
     def job_statuses
-      @job_statuses ||= Collection.new(model: JobStatus, api: self)
+      @job_statuses ||= JobStatusCollection.new(model: JobStatus, api: self)
+    end
+
+    # @return[OutboxCollection] A collection of Outbox operations
+    def outbox
+      @outbox ||= Outbox.new(api: self)
     end
 
     # @return[SchedulerCollection<Scheduler>] A queryable collection of {Scheduler} objects
@@ -143,7 +152,7 @@ module Nylas
       @scheduler ||= SchedulerCollection.new(model: Scheduler, api: scheduler_api)
     end
 
-    # @return[Neural] A {Neural} object that provides
+    # @return[Neural] A collection of Neural operations
     def neural
       @neural ||= Neural.new(api: self)
     end
@@ -163,7 +172,11 @@ module Nylas
     # Returns the application details
     # @return [ApplicationDetail] The application details
     def application_details
-      response = client.as(client.app_secret).execute(method: :get, path: "/a/#{app_id}")
+      response = client.as(client.app_secret).execute(
+        method: :get,
+        path: "/a/#{app_id}",
+        auth_method: HttpClient::AuthMethod::BASIC
+      )
       ApplicationDetail.new(**response)
     end
 
@@ -174,7 +187,8 @@ module Nylas
       response = client.as(client.app_secret).execute(
         method: :put,
         path: "/a/#{app_id}",
-        payload: JSON.dump(application_details.to_h)
+        payload: JSON.dump(application_details.to_h),
+        auth_method: HttpClient::AuthMethod::BASIC
       )
       ApplicationDetail.new(**response)
     end
@@ -184,7 +198,7 @@ module Nylas
     # hash has keys of :updated_at (unix timestamp) and :ip_addresses (array of strings)
     def ip_addresses
       path = "/a/#{app_id}/ip_addresses"
-      client.as(client.app_secret).get(path: path)
+      client.as(client.app_secret).get(path: path, auth_method: HttpClient::AuthMethod::BASIC)
     end
 
     # @param message [Hash, String, #send!]

data/lib/nylas/calendar.rb

@@ -6,8 +6,14 @@ module Nylas
   class Calendar
     include Model
     self.resources_path = "/calendars"
-    allows_operations(creatable: true, listable: true, filterable: true, showable: true, updatable: true,
-                      destroyable: true)
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.filterable = true
+    self.updatable = true
+    self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string
     attribute :account_id, :string

data/lib/nylas/calendar_collection.rb

@@ -4,48 +4,86 @@ module Nylas
   # Additional methods for some of Calendar's other functionality
   # @see https://developer.nylas.com/docs/connectivity/calendar
   class CalendarCollection < Collection
+    # Check multiple calendars to find available time slots for a single meeting
+    # @param duration_minutes [Integer] The total number of minutes the event should last
+    # @param interval_minutes [Integer] How many minutes it should check for availability
+    # @param start_time [Integer] The timestamp for the beginning of the event
+    # @param end_time [Integer] The timestamp for the end of the event
+    # @param emails [Array<String>] Emails on the same domain to check
+    # @param buffer [Integer] The amount of buffer time in minutes that you want around existing meetings
+    # @param round_robin [String] Finds available meeting times in a round-robin style
+    # @param event_collection_id [String] Unique identifier for a collection of events that are created
+    # @param free_busy [Array<Nylas::FreeBusy>] A list of free-busy data for users not in your organization
+    # @param open_hours [Array<Nylas::OpenHours>] Additional times email accounts are available
+    # @param calendars [Array] Check account and calendar IDs for free/busy status
+    # @return [Hash] The availability information; a list of time slots where all participants are available
     def availability(duration_minutes:,
-                     interval:,
+                     interval_minutes:,
                      start_time:,
                      end_time:,
-                     emails:,
+                     emails: [],
                      buffer: nil,
                      round_robin: nil,
+                     event_collection_id: nil,
                      free_busy: [],
-                     open_hours: [])
+                     open_hours: [],
+                     calendars: [])
+      validate_calendars_or_emails(calendars, emails)
       validate_open_hours(emails, free_busy, open_hours) unless open_hours.empty?
 
-      execute_availability("/calendars/availability",
-                           duration_minutes: duration_minutes,
-                           interval: interval,
-                           start_time: start_time,
-                           end_time: end_time,
-                           emails: emails,
-                           buffer: buffer,
-                           round_robin: round_robin,
-                           free_busy: free_busy,
-                           open_hours: open_hours)
+      payload = {
+        duration_minutes: duration_minutes,
+        interval_minutes: interval_minutes,
+        start_time: start_time,
+        end_time: end_time,
+        emails: emails,
+        free_busy: free_busy.map(&:to_h),
+        open_hours: open_hours.map(&:to_h),
+        calendars: calendars
+      }
+      payload[:buffer] = buffer if buffer
+      payload[:round_robin] = round_robin if round_robin
+      payload[:event_collection_id] = event_collection_id if event_collection_id
+
+      execute_availability("/calendars/availability", **payload)
     end
 
+    # Check multiple calendars to find availability for multiple meetings with several participants
+    # @param duration_minutes [Integer] The total number of minutes the event should last
+    # @param interval_minutes [Integer] How many minutes it should check for availability
+    # @param start_time [Integer] The timestamp for the beginning of the event
+    # @param end_time [Integer] The timestamp for the end of the event
+    # @param emails [Array<Array<String>>] Emails on the same domain to check
+    # @param buffer [Integer] The amount of buffer time in minutes that you want around existing meetings
+    # @param free_busy [Array<Nylas::FreeBusy>] A list of free-busy data for users not in your organization
+    # @param open_hours [Array<Nylas::OpenHours>] Additional times email accounts are available
+    # @param calendars [Array] Check account and calendar IDs for free/busy status
+    # @return [Hash] The availability information; a list of all possible groupings that share time slots
     def consecutive_availability(duration_minutes:,
-                                 interval:,
+                                 interval_minutes:,
                                  start_time:,
                                  end_time:,
-                                 emails:,
+                                 emails: [],
                                  buffer: nil,
                                  free_busy: [],
-                                 open_hours: [])
+                                 open_hours: [],
+                                 calendars: [])
+      validate_calendars_or_emails(emails, calendars)
       validate_open_hours(emails, free_busy, open_hours) unless open_hours.empty?
 
-      execute_availability("/calendars/availability/consecutive",
-                           duration_minutes: duration_minutes,
-                           interval: interval,
-                           start_time: start_time,
-                           end_time: end_time,
-                           emails: emails,
-                           buffer: buffer,
-                           free_busy: free_busy,
-                           open_hours: open_hours)
+      payload = {
+        duration_minutes: duration_minutes,
+        interval_minutes: interval_minutes,
+        start_time: start_time,
+        end_time: end_time,
+        emails: emails,
+        free_busy: free_busy.map(&:to_h),
+        open_hours: open_hours.map(&:to_h),
+        calendars: calendars
+      }
+      payload[:buffer] = buffer if buffer
+
+      execute_availability("/calendars/availability/consecutive", **payload)
     end
 
     private
@@ -58,6 +96,12 @@ module Nylas
       )
     end
 
+    def validate_calendars_or_emails(calendars, emails)
+      return unless calendars.empty? && emails.empty?
+
+      raise ArgumentError, "You must provide at least one of 'emails' or 'calendars'"
+    end
+
     def validate_open_hours(emails, free_busy, open_hours)
       raise TypeError, "open_hours' must be an array." unless open_hours.is_a?(Array)
 

data/lib/nylas/collection.rb

@@ -17,7 +17,7 @@ module Nylas
 
     # Instantiates a new model
     def new(**attributes)
-      model.new(attributes.merge(api: api))
+      model.new(**attributes.merge(api: api))
     end
 
     def create(**attributes)
@@ -51,7 +51,14 @@ module Nylas
 
     # @return [Integer]
     def count
-      self.class.new(model: model, api: api, constraints: constraints.merge(view: "count")).execute[:count]
+      collection = self.class.new(model: model, api: api, constraints: constraints)
+
+      if model.countable
+        collection.constraints = collection.constraints.merge(view: "count")
+        collection.execute[:count]
+      else
+        collection.find_each.map.count
+      end
     end
 
     # @return [Collection<Model>]
@@ -61,7 +68,14 @@ module Nylas
 
     # @return [Array<String>]
     def ids
-      self.class.new(model: model, api: api, constraints: constraints.merge(view: "ids")).execute
+      collection = self.class.new(model: model, api: api, constraints: constraints)
+
+      if model.id_listable
+        collection.constraints = collection.constraints.merge(view: "ids")
+        collection.execute
+      else
+        collection.find_each.map(&:id)
+      end
     end
 
     # Iterates over a single page of results based upon current pagination settings
@@ -139,7 +153,7 @@ module Nylas
     # @return [Hash] Specification for request to be passed to {API#execute}
     def to_be_executed
       { method: :get, path: resources_path, query: constraints.to_query,
-        headers: constraints.to_headers }
+        headers: constraints.to_headers, auth_method: model.auth_method }
     end
 
     # Retrieves the data from the API for the particular constraints

data/lib/nylas/component.rb

@@ -4,8 +4,13 @@ module Nylas
   # Structure to represent a the Component Schema.
   class Component
     include Model
-    allows_operations(creatable: true, listable: true, filterable: true, showable: true, updatable: true,
-                      destroyable: true)
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.filterable = true
+    self.updatable = true
+    self.destroyable = true
+    self.auth_method = HttpClient::AuthMethod::BASIC
 
     attribute :id, :string, read_only: true
     attribute :account_id, :string

data/lib/nylas/deltas.rb

@@ -8,7 +8,7 @@ module Nylas
   class Deltas
     include Model
     self.resources_path = "/delta"
-    allows_operations(filterable: true)
+    self.filterable = true
     has_n_of_attribute :deltas, :delta
     attribute :cursor_start, :string
     attribute :cursor_end, :string

data/lib/nylas/draft.rb

@@ -6,7 +6,13 @@ module Nylas
   class Draft
     include Model
     self.resources_path = "/drafts"
-    allows_operations(creatable: true, showable: true, listable: true, updatable: true, destroyable: true)
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.updatable = true
+    self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string
     attribute :object, :string

data/lib/nylas/event.rb

@@ -6,8 +6,14 @@ module Nylas
   class Event
     include Model
     self.resources_path = "/events"
-    allows_operations(creatable: true, listable: true, filterable: true, showable: true, updatable: true,
-                      destroyable: true)
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.filterable = true
+    self.updatable = true
+    self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string, read_only: true
     attribute :object, :string, read_only: true
@@ -16,7 +22,9 @@ module Nylas
     attribute :master_event_id, :string
     attribute :message_id, :string
     attribute :ical_uid, :string
+    attribute :event_collection_id, :string
 
+    attribute :capacity, :integer
     attribute :busy, :boolean
     attribute :description, :string
     attribute :location, :string
@@ -30,7 +38,10 @@ module Nylas
     attribute :metadata, :hash
     attribute :conferencing, :event_conferencing
     has_n_of_attribute :notifications, :event_notification
+    has_n_of_attribute :round_robin_order, :string
     attribute :original_start_time, :unix_timestamp
+    attribute :reminder_minutes, :string
+    attribute :reminder_method, :string
     attribute :job_status_id, :string, read_only: true
 
     attr_accessor :notify_participants
@@ -44,12 +55,8 @@ module Nylas
     end
 
     def save
-      if conferencing
-        body = to_h
-        if body.dig(:conferencing, :details) && body.dig(:conferencing, :autocreate)
-          raise ArgumentError, "Cannot set both 'details' and 'autocreate' in conferencing object."
-        end
-      end
+      validate
+      format_reminder_minutes
 
       super
     end
@@ -81,6 +88,18 @@ module Nylas
 
     private
 
+    def validate
+      if conferencing
+        body = to_h
+        if body.dig(:conferencing, :details) && body.dig(:conferencing, :autocreate)
+          raise ArgumentError, "Cannot set both 'details' and 'autocreate' in conferencing object."
+        end
+      end
+      return unless capacity && capacity != -1 && participants && participants.length > capacity
+
+      raise ArgumentError, "The number of participants in the event exceeds the set capacity."
+    end
+
     def build_ics_event_payload(ical_uid, method, prodid)
       payload = {}
       if id
@@ -101,6 +120,13 @@ module Nylas
       payload
     end
 
+    # Formats the reminder minute field to match the API format: "[%d]"
+    def format_reminder_minutes
+      return if reminder_minutes.nil? || reminder_minutes.empty? || reminder_minutes.match(/\[\d+\]/)
+
+      self.reminder_minutes = "[#{reminder_minutes}]"
+    end
+
     def query_params
       if notify_participants.nil?
         {}

data/lib/nylas/file.rb

@@ -6,7 +6,13 @@ module Nylas
   class File
     include Model
     self.resources_path = "/files"
-    allows_operations(listable: true, showable: true, filterable: true, creatable: true, destroyable: true)
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.filterable = true
+    self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string
     attribute :account_id, :string

data/lib/nylas/folder.rb

@@ -12,6 +12,8 @@ module Nylas
     self.filterable = false
     self.updatable = true
     self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string, read_only: true
     attribute :account_id, :string, read_only: true

data/lib/nylas/http_client.rb

@@ -2,10 +2,16 @@
 
 module Nylas
   require "yajl"
+  require "base64"
 
   # Plain HTTP client that can be used to interact with the Nylas API sans any type casting.
-  class HttpClient # rubocop:disable Metrics/ClassLength
-    HTTP_SUCCESS_CODES = [200, 201, 302].freeze
+  class HttpClient
+    module AuthMethod
+      BEARER = 1
+      BASIC = 2
+    end
+
+    HTTP_SUCCESS_CODES = [200, 201, 202, 302].freeze
 
     HTTP_CODE_TO_EXCEPTIONS = {
       400 => InvalidRequest,
@@ -33,7 +39,8 @@ module Nylas
       "/delta/longpoll" => 3650,
       "/delta/streaming" => 3650
     }.freeze
-    SUPPORTED_API_VERSION = "2.2"
+
+    SUPPORTED_API_VERSION = "2.5"
 
     include Logging
     attr_accessor :api_server
@@ -73,9 +80,10 @@ module Nylas
     # @param query [Hash] (Optional, defaults to {}) - Hash of names and values to include in the query
     #                      section of the URI fragment
     # @param payload [String,Hash] (Optional, defaults to nil) - Body to send with the request.
+    # @param auth_method [AuthMethod] (Optional, defaults to BEARER) - The authentication method.
     # @return [Array Hash Stringn]
     # rubocop:disable Metrics/MethodLength
-    def execute(method:, path: nil, headers: {}, query: {}, payload: nil)
+    def execute(method:, path: nil, headers: {}, query: {}, payload: nil, auth_method: nil)
       timeout = ENDPOINT_TIMEOUTS.fetch(path, 230)
       request = build_request(
         method: method,
@@ -83,7 +91,8 @@ module Nylas
         headers: headers,
         query: query,
         payload: payload,
-        timeout: timeout
+        timeout: timeout,
+        auth_method: auth_method || AuthMethod::BEARER
       )
       rest_client_execute(**request) do |response, _request, result|
         content_type = nil
@@ -107,35 +116,64 @@ module Nylas
     inform_on :execute, level: :debug,
                         also_log: { result: true, values: %i[method url path headers query payload] }
 
-    def build_request(method:, path: nil, headers: {}, query: {}, payload: nil, timeout: nil)
+    def build_request(
+      method:,
+      path: nil,
+      headers: {},
+      query: {},
+      payload: nil,
+      timeout: nil,
+      auth_method: nil
+    )
       url ||= url_for_path(path)
       url = add_query_params_to_url(url, query)
-      resulting_headers = default_headers.merge(headers)
+      resulting_headers = default_headers.merge(headers).merge(auth_header(auth_method))
       { method: method, url: url, payload: payload, headers: resulting_headers, timeout: timeout }
     end
 
     # Syntactical sugar for making GET requests via the API.
     # @see #execute
-    def get(path: nil, headers: {}, query: {})
-      execute(method: :get, path: path, query: query, headers: headers)
+    def get(path: nil, headers: {}, query: {}, auth_method: nil)
+      execute(method: :get, path: path, query: query, headers: headers, auth_method: auth_method)
     end
 
     # Syntactical sugar for making POST requests via the API.
     # @see #execute
-    def post(path: nil, payload: nil, headers: {}, query: {})
-      execute(method: :post, path: path, headers: headers, query: query, payload: payload)
+    def post(path: nil, payload: nil, headers: {}, query: {}, auth_method: nil)
+      execute(
+        method: :post,
+        path: path,
+        headers: headers,
+        query: query,
+        payload: payload,
+        auth_method: auth_method
+      )
     end
 
     # Syntactical sugar for making PUT requests via the API.
     # @see #execute
-    def put(path: nil, payload:, headers: {}, query: {})
-      execute(method: :put, path: path, headers: headers, query: query, payload: payload)
+    def put(path: nil, payload:, headers: {}, query: {}, auth_method: nil)
+      execute(
+        method: :put,
+        path: path,
+        headers: headers,
+        query: query,
+        payload: payload,
+        auth_method: auth_method
+      )
     end
 
     # Syntactical sugar for making DELETE requests via the API.
     # @see #execute
-    def delete(path: nil, payload: nil, headers: {}, query: {})
-      execute(method: :delete, path: path, headers: headers, query: query, payload: payload)
+    def delete(path: nil, payload: nil, headers: {}, query: {}, auth_method: nil)
+      execute(
+        method: :delete,
+        path: path,
+        headers: headers,
+        query: query,
+        payload: payload,
+        auth_method: auth_method
+      )
     end
 
     def default_headers
@@ -216,5 +254,18 @@ module Nylas
 
       query
     end
+
+    def auth_header(auth_method)
+      authorization_string = case auth_method
+                             when AuthMethod::BEARER
+                               "Bearer #{access_token}"
+                             when AuthMethod::BASIC
+                               "Basic #{Base64.encode64("#{access_token}:")}"
+                             else
+                               "Bearer #{access_token}"
+                             end
+
+      { "Authorization" => authorization_string }
+    end
   end
 end

data/lib/nylas/job_status.rb

@@ -6,7 +6,7 @@ module Nylas
   class JobStatus
     include Model
     self.resources_path = "/job-statuses"
-    allows_operations(listable: true)
+    self.listable = true
 
     attribute :id, :string, read_only: true
     attribute :account_id, :string, read_only: true
@@ -15,7 +15,8 @@ module Nylas
     attribute :object, :string, read_only: true
     attribute :status, :string, read_only: true
     attribute :created_at, :unix_timestamp, read_only: true
-    attribute :original_data, :message, read_only: true
+    attribute :reason, :string, read_only: true
+    attribute :metadata, :hash, read_only: true
 
     # Returns the status of a job as a boolean
     # @return [Boolean] If the job was successful

data/lib/nylas/job_status_collection.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Additional methods for some of Calendar's other functionality
+  # @see https://developer.nylas.com/docs/connectivity/calendar
+  class JobStatusCollection < Collection
+    def find_model(id)
+      response = api.execute(
+        **to_be_executed.merge(
+          path: "#{resources_path}/#{id}",
+          query: view_query
+        )
+      )
+
+      object_type = response[:object]
+      return OutboxJobStatus.from_hash(response, api: api) if object_type == "message"
+
+      model.from_hash(response, api: api)
+    end
+  end
+end

data/lib/nylas/label.rb

@@ -12,6 +12,8 @@ module Nylas
     self.filterable = false
     self.updatable = true
     self.destroyable = true
+    self.id_listable = true
+    self.countable = true
 
     attribute :id, :string
     attribute :account_id, :string

data/lib/nylas/message.rb

@@ -7,7 +7,13 @@ module Nylas
     include Model
     self.raw_mime_type = "message/rfc822"
     self.resources_path = "/messages"
-    allows_operations(showable: true, listable: true, filterable: true, searchable: true, updatable: true)
+    self.listable = true
+    self.showable = true
+    self.filterable = true
+    self.updatable = true
+    self.searchable = true
+    self.id_listable = true
+    self.countable = true
     UPDATABLE_ATTRIBUTES = %i[label_ids folder_id starred unread metadata].freeze
 
     attribute :id, :string
@@ -37,6 +43,7 @@ module Nylas
     attribute :folder, :folder
     attribute :folder_id, :string
     attribute :metadata, :hash
+    attribute :reply_to_message_id, :string, read_only: true
     attribute :job_status_id, :string, read_only: true
 
     has_n_of_attribute :labels, :label, read_only: true