nylas 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cf10f2710c3235c9230e3b86d41282e527c91f00771fd639609afa1ee2a81e9
-  data.tar.gz: 69569f23b2d53e00453171fb16d72e20ee6c91612e63af2de693b0e2bd6100aa
+  metadata.gz: b390b7c22a3dfcc7a4eed1db3966295d71a5f8928efd4b81bedbabd0c7bac0dc
+  data.tar.gz: d27e92177ddf12626917c2b20334bc74bcc703f04d5d68721375429aa4ce06fe
 SHA512:
-  metadata.gz: 7751effbad21dd7118415731e2cc96c370c2fbc53c39b7d536cc24ead935ea6ce86bbf4919ae6f530b45c1e4bdc0e420ee26ddb4438fd27a39ade73999bf059b
-  data.tar.gz: 85f42e07ef66b54180fbebd61f9808013675b2d459f23ce2cc1f347b9682f0dcfc92a7999536e1725cbba1ff41f18fff96b827d0eb44de25adcff72f0298b154
+  metadata.gz: c0d5c385aa98002eceed26178f6d63e60950344fd48cd229c2c32fd4b3998c837db894ca2fd883da8886f4dd91ee8fef01b07885f7e3941ef5b17d8bb4c2afe6
+  data.tar.gz: 86d6663b12da809962c28d6284ee5a22c90951ac9055bbadce90a347a55061ac1c67ff1feeb7e22b711d2311f24df2d0928e858be3ca03074e9e109022199b62

data/lib/nylas/account.rb

@@ -9,12 +9,14 @@ module Nylas
     self.showable = true
     self.updatable = true
     self.destroyable = 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

@@ -132,7 +132,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 +148,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 +168,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 +183,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 +194,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/collection.rb

@@ -139,7 +139,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

@@ -6,6 +6,7 @@ module Nylas
     include Model
     allows_operations(creatable: true, listable: true, filterable: true, showable: true, updatable: true,
                       destroyable: true)
+    self.auth_method = HttpClient::AuthMethod::BASIC
 
     attribute :id, :string, read_only: true
     attribute :account_id, :string

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
+    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

@@ -15,7 +15,7 @@ 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
 
     # 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/model.rb

@@ -39,8 +39,8 @@ module Nylas
       !id.nil?
     end
 
-    def execute(method:, payload: nil, path:, query: {})
-      api.execute(method: method, payload: payload, path: path, query: query)
+    def execute(method:, payload: nil, path:, query: {}, auth_method: self.auth_method)
+      api.execute(method: method, payload: payload, path: path, query: query, auth_method: auth_method)
     end
 
     def create
@@ -107,6 +107,10 @@ module Nylas
       self.class.resources_path(api: api)
     end
 
+    def auth_method
+      self.class.auth_method(api: api)
+    end
+
     def destroy
       raise ModelNotDestroyableError, self unless destroyable?
 
@@ -138,7 +142,7 @@ module Nylas
     module ClassMethods
       attr_accessor :raw_mime_type, :creatable, :showable, :filterable, :searchable, :listable, :updatable,
                     :destroyable
-      attr_writer :resources_path
+      attr_writer :resources_path, :auth_method
 
       def allows_operations(creatable: false, showable: false, listable: false, filterable: false,
                             searchable: false, updatable: false, destroyable: false)
@@ -184,6 +188,10 @@ module Nylas
         @resources_path
       end
 
+      def auth_method(*)
+        @auth_method || HttpClient::AuthMethod::BEARER
+      end
+
       def exposable_as_raw?
         !raw_mime_type.nil?
       end

data/lib/nylas/outbox.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Methods for Outbox functionality
+  # @see https://developer.nylas.com/docs/api/#tag--Outbox
+  class Outbox
+    attr_accessor :api
+
+    def initialize(api:)
+      self.api = api
+    end
+
+    def outbox_path
+      @outbox_path ||= "/v2/outbox"
+    end
+
+    # rubocop:disable Layout/LineLength
+    # Send a message via Outbox
+    # @param draft [Draft, OutboxMessage] The message to send
+    # @param send_at [Numeric] The date and time to send the message. If not set, Outbox will send this message immediately.
+    # @param retry_limit_datetime [Numeric] The date and time to stop retry attempts for a message. If not set, it defaults to 24 hours after send_at.
+    # @return [OutboxJobStatus] The outbox job status status and message data
+    # rubocop:enable Layout/LineLength
+    def send(draft, send_at: nil, retry_limit_datetime: nil)
+      message = draft.to_h(enforce_read_only: true)
+      message.merge!(validate_set_date_time(send_at, retry_limit_datetime))
+      outbox_response = api.execute(
+        method: :post,
+        path: outbox_path,
+        payload: JSON.dump(message)
+      )
+
+      OutboxJobStatus.new(**outbox_response)
+    end
+
+    # rubocop:disable Layout/LineLength
+    # Update a scheduled Outbox message
+    # @param job_status_id [String] The ID of the outbox job status
+    # @param message [Draft, OutboxMessage] The message object with updated values
+    # @param send_at [Numeric] The date and time to send the message. If not set, Outbox will send this message immediately.
+    # @param retry_limit_datetime [Numeric] The date and time to stop retry attempts for a message. If not set, it defaults to 24 hours after send_at.
+    # @return [OutboxJobStatus] The updated outbox job status status and message data
+    # rubocop:enable Layout/LineLength
+    def update(job_status_id, message: nil, send_at: nil, retry_limit_datetime: nil)
+      payload = {}
+      payload.merge!(message.to_h(enforce_read_only: true)) if message
+      payload.merge!(validate_set_date_time(send_at, retry_limit_datetime))
+      outbox_response = api.execute(
+        method: :patch,
+        path: "#{outbox_path}/#{job_status_id}",
+        payload: JSON.dump(payload)
+      )
+
+      OutboxJobStatus.new(**outbox_response)
+    end
+
+    # Delete a scheduled Outbox message
+    # @param job_status_id [String] The ID of the outbox job status to delete
+    # @return [void]
+    def delete(job_status_id)
+      api.execute(
+        method: :delete,
+        path: "#{outbox_path}/#{job_status_id}"
+      )
+    end
+
+    # SendGrid - Check Authentication and Verification Status
+    # @return [SendGridVerifiedStatus] The SendGrid Authentication and Verification Status
+    def send_grid_verification_status
+      response = api.execute(
+        method: :get,
+        path: "#{outbox_path}/onboard/verified_status"
+      )
+
+      raise "Verification status not present in response" if response.key?("results")
+
+      SendGridVerifiedStatus.new(**response[:results])
+    end
+
+    # SendGrid -  Delete SendGrid Subuser and UAS Grant
+    # @param email [String] Email address for SendGrid subuser to delete
+    # @return [void]
+    def delete_send_grid_sub_user(email)
+      api.execute(
+        method: :delete,
+        path: "#{outbox_path}/onboard/subuser",
+        payload: JSON.dump({ email: email })
+      )
+    end
+
+    private
+
+    def validate_set_date_time(send_at, retry_limit_datetime)
+      hash = {}
+      hash[:send_at] = validate_send_at(send_at) if send_at
+      if retry_limit_datetime
+        hash[:retry_limit_datetime] = validate_retry_limit_datetime(send_at, retry_limit_datetime)
+      end
+
+      hash
+    end
+
+    def validate_send_at(send_at)
+      return send_at unless send_at != 0 && (send_at < Time.now.to_i)
+
+      raise ArgumentError, "Cannot set message to be sent at a time before the current time."
+    end
+
+    def validate_retry_limit_datetime(send_at, retry_limit_datetime)
+      valid_send_at = send_at && send_at != 0 ? send_at : Time.now.to_i
+      return retry_limit_datetime unless retry_limit_datetime != 0 && (retry_limit_datetime < valid_send_at)
+
+      raise ArgumentError, "Cannot set message to stop retrying before time to send at."
+    end
+  end
+end

data/lib/nylas/outbox_job_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Ruby representation of a Nylas Outbox Job Status object
+  # @see https://developer.nylas.com/docs/api/#post/v2/outbox
+  class OutboxJobStatus < JobStatus
+    include Model
+
+    attribute :send_at, :unix_timestamp
+    attribute :original_send_at, :unix_timestamp
+    attribute :message_id, :string
+    attribute :thread_id, :string
+    attribute :original_data, :outbox_message
+
+    transfer :api, to: %i[original_data]
+
+    inherit_attributes
+  end
+end

data/lib/nylas/outbox_message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Ruby representation of a Nylas Outbox Message object
+  # @see https://developer.nylas.com/docs/api/#post/v2/outbox
+  class OutboxMessage < Draft
+    include Model
+
+    attribute :send_at, :unix_timestamp
+    attribute :retry_limit_datetime, :unix_timestamp
+    attribute :original_send_at, :unix_timestamp, read_only: true
+
+    transfer :api, to: %i[events files folder labels]
+
+    inherit_attributes
+  end
+end

data/lib/nylas/send_grid_verified_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Ruby representation of a Nylas Send Grid verified status object
+  # @see https://docs.nylas.com/reference#drafts
+  class SendGridVerifiedStatus
+    include Model::Attributable
+
+    attribute :domain_verified, :boolean
+    attribute :sender_verified, :boolean
+  end
+end

data/lib/nylas/version.rb

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

data/lib/nylas/webhook.rb

@@ -43,6 +43,7 @@ module Nylas
     include Model
     allows_operations(creatable: true, listable: true, showable: true, updatable: true,
                       destroyable: true)
+    self.auth_method = HttpClient::AuthMethod::BASIC
     attribute :id, :string, read_only: true
     attribute :application_id, :string, read_only: true
 

data/lib/nylas.rb

@@ -29,6 +29,8 @@ require_relative "nylas/registry"
 require_relative "nylas/types"
 require_relative "nylas/constraints"
 
+require_relative "nylas/http_client"
+require_relative "nylas/api"
 require_relative "nylas/collection"
 require_relative "nylas/model"
 
@@ -67,6 +69,8 @@ require_relative "nylas/free_busy_collection"
 require_relative "nylas/calendar_collection"
 require_relative "nylas/component_collection"
 require_relative "nylas/scheduler_collection"
+require_relative "nylas/job_status_collection"
+require_relative "nylas/outbox"
 
 # Models supported by the API
 require_relative "nylas/account"
@@ -87,6 +91,9 @@ require_relative "nylas/scheduler"
 require_relative "nylas/job_status"
 require_relative "nylas/token_info"
 require_relative "nylas/application_details"
+require_relative "nylas/outbox_message"
+require_relative "nylas/outbox_job_status"
+require_relative "nylas/send_grid_verified_status"
 
 # Neural specific types
 require_relative "nylas/neural"
@@ -107,9 +114,6 @@ require_relative "nylas/scheduler_booking_confirmation"
 
 require_relative "nylas/native_authentication"
 
-require_relative "nylas/http_client"
-require_relative "nylas/api"
-
 require_relative "nylas/filter_attributes"
 # an SDK for interacting with the Nylas API
 # @see https://docs.nylas.com/reference
@@ -152,4 +156,5 @@ module Nylas
   Types.registry[:scheduler_config] = Types::ModelType.new(model: SchedulerConfig)
   Types.registry[:scheduler_time_slot] = Types::ModelType.new(model: SchedulerTimeSlot)
   Types.registry[:job_status] = Types::ModelType.new(model: JobStatus)
+  Types.registry[:outbox_message] = Types::ModelType.new(model: OutboxMessage)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 5.8.0
+  version: 5.9.0
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -300,6 +300,7 @@ files:
 - lib/nylas/http_client.rb
 - lib/nylas/im_address.rb
 - lib/nylas/job_status.rb
+- lib/nylas/job_status_collection.rb
 - lib/nylas/label.rb
 - lib/nylas/logging.rb
 - lib/nylas/message.rb
@@ -325,6 +326,9 @@ files:
 - lib/nylas/new_message.rb
 - lib/nylas/nylas_date.rb
 - lib/nylas/open_hours.rb
+- lib/nylas/outbox.rb
+- lib/nylas/outbox_job_status.rb
+- lib/nylas/outbox_message.rb
 - lib/nylas/participant.rb
 - lib/nylas/phone_number.rb
 - lib/nylas/physical_address.rb
@@ -340,6 +344,7 @@ files:
 - lib/nylas/scheduler_config.rb
 - lib/nylas/scheduler_time_slot.rb
 - lib/nylas/search_collection.rb
+- lib/nylas/send_grid_verified_status.rb
 - lib/nylas/thread.rb
 - lib/nylas/time_slot.rb
 - lib/nylas/timespan.rb