nylas 5.7.0 → 5.12.1

data/lib/nylas/model.rb

@@ -20,8 +20,8 @@ module Nylas
       model.extend(ClassMethods)
       model.extend(Forwardable)
       model.def_delegators :model_class, :creatable?, :filterable?, :listable?, :searchable?, :showable?,
-                           :updatable?, :destroyable?
-      model.allows_operations
+                           :updatable?, :destroyable?, :id_listable?, :countable?
+      model.init_operations
     end
 
     def save
@@ -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?
 
@@ -137,19 +141,19 @@ module Nylas
     # Allows you to narrow in exactly what kind of model you're working with
     module ClassMethods
       attr_accessor :raw_mime_type, :creatable, :showable, :filterable, :searchable, :listable, :updatable,
-                    :destroyable
-      attr_writer :resources_path
-
-      def allows_operations(creatable: false, showable: false, listable: false, filterable: false,
-                            searchable: false, updatable: false, destroyable: false)
-
-        self.creatable ||= creatable
-        self.showable ||= showable
-        self.listable ||= listable
-        self.filterable ||= filterable
-        self.searchable ||= searchable
-        self.updatable ||= updatable
-        self.destroyable ||= destroyable
+                    :destroyable, :id_listable, :countable
+      attr_writer :resources_path, :auth_method
+
+      def init_operations
+        self.creatable = false
+        self.showable = false
+        self.listable = false
+        self.filterable = false
+        self.searchable = false
+        self.updatable = false
+        self.destroyable = false
+        self.id_listable = false
+        self.countable = false
       end
 
       def creatable?
@@ -180,10 +184,22 @@ module Nylas
         destroyable
       end
 
+      def id_listable?
+        id_listable
+      end
+
+      def countable?
+        countable
+      end
+
       def resources_path(*)
         @resources_path
       end
 
+      def auth_method(*)
+        @auth_method || HttpClient::AuthMethod::BEARER
+      end
+
       def exposable_as_raw?
         !raw_mime_type.nil?
       end

data/lib/nylas/neural_categorizer.rb

@@ -6,7 +6,7 @@ module Nylas
   class NeuralCategorizer < Message
     include Model
     self.resources_path = "/neural/categorize"
-    allows_operations(listable: true)
+    self.listable = true
 
     attribute :categorizer, :categorize
     # Overrides Message's label attribute as currently categorize returns

data/lib/nylas/neural_clean_conversation.rb

@@ -6,7 +6,7 @@ module Nylas
   class NeuralCleanConversation < Message
     include Model
     self.resources_path = "/neural/conversation"
-    allows_operations(listable: true)
+    self.listable = true
     IMAGE_REGEX = /[(']cid:(.*?)[)']/.freeze
 
     attribute :conversation, :string

data/lib/nylas/neural_ocr.rb

@@ -6,7 +6,7 @@ module Nylas
   class NeuralOcr < File
     include Model
     self.resources_path = "/neural/ocr"
-    allows_operations(listable: true)
+    self.listable = true
 
     has_n_of_attribute :ocr, :string
     attribute :processed_pages, :integer

data/lib/nylas/neural_sentiment_analysis.rb

@@ -6,7 +6,7 @@ module Nylas
   class NeuralSentimentAnalysis
     include Model
     self.resources_path = "/neural/sentiment"
-    allows_operations(listable: true)
+    self.listable = true
 
     attribute :account_id, :string
     attribute :sentiment, :string

data/lib/nylas/new_message.rb

@@ -26,8 +26,14 @@ module Nylas
 
     attribute :tracking, :message_tracking
 
+    # Sends the new message
+    # @return [Message] The sent message
+    # @raise [RuntimeError] if the API response data was not a hash
     def send!
-      Message.new(**api.execute(method: :post, path: "/send", payload: to_json).merge(api: api))
+      message_data = api.execute(method: :post, path: "/send", payload: to_json)
+      raise "Unexpected response from the server, data received not a Message" unless message_data.is_a?(Hash)
+
+      Message.from_hash(message_data, api: api)
     end
   end
 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/participant.rb

@@ -6,6 +6,7 @@ module Nylas
     include Model::Attributable
     attribute :name, :string
     attribute :email, :string
+    attribute :phone_number, :string
     attribute :comment, :string
     attribute :status, :string, read_only: true
   end

data/lib/nylas/room_resource.rb

@@ -6,7 +6,7 @@ module Nylas
   class RoomResource
     include Model
     self.resources_path = "/resources"
-    allows_operations(listable: true)
+    self.listable = true
 
     attribute :object, :string, read_only: true
     attribute :email, :string, read_only: true

data/lib/nylas/rsvp.rb

@@ -5,7 +5,7 @@ module Nylas
   # @see https://docs.nylas.com/reference#rsvping-to-invitations
   class Rsvp
     include Model
-    allows_operations(creatable: true)
+    self.creatable = true
 
     attribute :account_id, :string
     attribute :event_id, :string

data/lib/nylas/scheduler.rb

@@ -6,8 +6,12 @@ module Nylas
   class Scheduler
     include Model
     self.resources_path = "/manage/pages"
-    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
 
     attribute :id, :integer, read_only: true
     attribute :app_client_id, :string

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/thread.rb

@@ -5,7 +5,12 @@ module Nylas
   # @see https://docs.nylas.com/reference#threads
   class Thread
     include Model
-    allows_operations(searchable: true, filterable: true, listable: true, updatable: true)
+    self.searchable = true
+    self.listable = true
+    self.filterable = true
+    self.updatable = true
+    self.id_listable = true
+    self.countable = true
 
     self.resources_path = "/threads"
 

data/lib/nylas/time_slot.rb

@@ -10,5 +10,7 @@ module Nylas
     attribute :status, :string
     attribute :start_time, :unix_timestamp
     attribute :end_time, :unix_timestamp
+    attribute :capacity, :time_slot_capacity
+    has_n_of_attribute :emails, :string
   end
 end

data/lib/nylas/time_slot_capacity.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Capacity values for a timeslot
+  # @see https://docs.nylas.com/reference#calendars-free-busy
+  class TimeSlotCapacity
+    include Model::Attributable
+
+    attribute :event_id, :string
+    attribute :current_capacity, :integer
+    attribute :max_capacity, :integer
+  end
+end

data/lib/nylas/version.rb

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

data/lib/nylas/webhook.rb

@@ -1,21 +1,98 @@
 # frozen_string_literal: true
 
+module WebhookState
+  # Module representing the possible 'state' values in a Webhook
+  # @see https://developer.nylas.com/docs/api#post/a/client_id/webhooks
+
+  ACTIVE = "active"
+  INACTIVE = "inactive"
+end
+
+module WebhookTrigger
+  # Module representing the possible 'trigger' values in a Webhook
+  # @see https://developer.nylas.com/docs/api#post/a/client_id/webhooks
+
+  ACCOUNT_CONNECTED = "account.connected"
+  ACCOUNT_RUNNING = "account.running"
+  ACCOUNT_STOPPED = "account.stopped"
+  ACCOUNT_INVALID = "account.invalid"
+  ACCOUNT_SYNC_ERROR = "account.sync_error"
+  MESSAGE_CREATED = "message.created"
+  MESSAGE_OPENED = "message.opened"
+  MESSAGE_LINK_CLICKED = "message.link_created"
+  MESSAGE_UPDATED = "message.updated"
+  MESSAGE_BOUNCED = "message.bounced"
+  THREAD_REPLIED = "thread.replied"
+  CONTACT_CREATED = "contact.created"
+  CONTACT_UPDATED = "contact.updated"
+  CONTACT_DELETED = "contact.deleted"
+  CALENDAR_CREATED = "calendar.created"
+  CALENDAR_UPDATED = "calendar.updated"
+  CALENDAR_DELETED = "calendar.deleted"
+  EVENT_CREATED = "event.created"
+  EVENT_UPDATED = "event.updated"
+  EVENT_DELETED = "event.deleted"
+  JOB_SUCCESSFUL = "job.successful"
+  JOB_FAILED = "job.failed"
+end
+
 module Nylas
   # Represents a webhook attached to your application.
   # @see https://docs.nylas.com/reference#webhooks
   class Webhook
     include Model
-    allows_operations(listable: true, showable: true)
-    attribute :id, :string
-    attribute :application_id, :string
+    self.creatable = true
+    self.listable = true
+    self.showable = true
+    self.updatable = true
+    self.destroyable = true
+    self.auth_method = HttpClient::AuthMethod::BASIC
+    attribute :id, :string, read_only: true
+    attribute :application_id, :string, read_only: true
 
     attribute :callback_url, :string
     attribute :state, :string
-    attribute :version, :string
+    attribute :version, :string, read_only: true
     has_n_of_attribute :triggers, :string
 
+    STATE = [:inactive].freeze
+
+    def save
+      result = if persisted?
+                 update_call(update_payload)
+               else
+                 create
+               end
+
+      attributes.merge(result)
+    end
+
+    def save_all_attributes
+      save
+    end
+
+    def update(**data)
+      raise ArgumentError, "Only 'state' is allowed to be updated" if data.length > 1 || !data.key?(:state)
+
+      attributes.merge(**data)
+      payload = JSON.dump(data)
+      update_call(payload)
+
+      true
+    end
+
+    def update_all_attributes(**data)
+      update(**data)
+    end
+
     def self.resources_path(api:)
       "/a/#{api.app_id}/webhooks"
     end
+
+    private
+
+    def update_payload
+      JSON.dump({ state: state })
+    end
   end
 end

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"
 
@@ -52,6 +54,7 @@ require_relative "nylas/nylas_date"
 require_relative "nylas/when"
 require_relative "nylas/free_busy"
 require_relative "nylas/time_slot"
+require_relative "nylas/time_slot_capacity"
 require_relative "nylas/open_hours"
 require_relative "nylas/event_conferencing"
 require_relative "nylas/event_conferencing_details"
@@ -67,6 +70,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 +92,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 +115,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
@@ -140,6 +145,7 @@ module Nylas
   Types.registry[:contact_group] = Types::ModelType.new(model: ContactGroup)
   Types.registry[:when] = Types::ModelType.new(model: When)
   Types.registry[:time_slot] = Types::ModelType.new(model: TimeSlot)
+  Types.registry[:time_slot_capacity] = Types::ModelType.new(model: TimeSlotCapacity)
   Types.registry[:event_conferencing] = Types::ModelType.new(model: EventConferencing)
   Types.registry[:event_conferencing_details] = Types::ModelType.new(model: EventConferencingDetails)
   Types.registry[:event_conferencing_autocreate] = Types::ModelType.new(model: EventConferencingAutocreate)
@@ -152,4 +158,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.7.0
+  version: 5.12.1
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-08-12 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,8 +344,10 @@ 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/time_slot_capacity.rb
 - lib/nylas/timespan.rb
 - lib/nylas/token_info.rb
 - lib/nylas/types.rb
@@ -374,7 +380,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Gem for interacting with the Nylas API