nylas_v2 5.14.2

data/lib/nylas_v2/neural_signature_contact.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the Neural API's Signature Extraction Contact object
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#parse-signature-response
+  class NeuralSignatureContact
+    include Model::Attributable
+    has_n_of_attribute :job_titles, :string
+    has_n_of_attribute :links, :neural_contact_link
+    has_n_of_attribute :phone_numbers, :string
+    has_n_of_attribute :emails, :string
+    has_n_of_attribute :names, :neural_contact_name
+
+    attr_accessor :api
+
+    # Creates a Nylas contact object compatible with the contact endpoints.
+    # Please note if multiple names or multiple job titles were parsed only
+    # the first set are used.
+    def to_contact_object
+      contact = merge_multiple_hashes([convert_names, convert_emails, convert_phone_numbers, convert_links])
+      contact[:job_title] = job_titles[0] unless job_titles.nil?
+      Contact.new(**contact.merge(api: api))
+    end
+
+    private
+
+    def convert_names
+      return {} if names.empty?
+
+      contact = {}
+      contact[:given_name] = names[0].first_name if names[0].first_name
+      contact[:surname] = names[0].last_name if names[0].last_name
+      contact
+    end
+
+    def convert_emails
+      return {} if emails.empty?
+
+      contact = {}
+      contact[:emails] = []
+      emails.each do |e|
+        contact[:emails].push(type: "personal", email: e)
+      end
+      contact
+    end
+
+    def convert_phone_numbers
+      return {} if phone_numbers.empty?
+
+      contact = {}
+      contact[:phone_numbers] = []
+      phone_numbers.each do |number|
+        contact[:phone_numbers].push(type: "mobile", number: number)
+      end
+      contact
+    end
+
+    def convert_links
+      return {} if links.empty?
+
+      contact = {}
+      contact[:web_pages] = []
+      links.each do |link|
+        type = "homepage"
+        type = link.description unless link.description.empty?
+        contact[:web_pages].push(type: type, url: link.url)
+      end
+      contact
+    end
+
+    # For Ruby 2.5 support as it doesn't support multiple hashes to merge at once
+    def merge_multiple_hashes(hashes_to_merge)
+      hash = {}
+      hashes_to_merge.each do |new_hash|
+        hash = hash.merge(new_hash)
+      end
+
+      hash
+    end
+  end
+end

data/lib/nylas_v2/neural_signature_extraction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent a the Signature Extraction Schema.
+  # @see https://developer.nylas.com/docs/intelligence/signature-extraction/#signature-feedback-response
+  class NeuralSignatureExtraction < Message
+    include Model
+    self.resources_path = "/neural/signature"
+
+    attribute :signature, :string
+    attribute :model_version, :string
+    attribute :contacts, :neural_signature_contact
+
+    inherit_attributes
+
+    transfer :api, to: %i[contacts]
+  end
+end

data/lib/nylas_v2/new_message.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Data structure for sending a message via the Nylas API
+  class NewMessage
+    include Model
+    self.creatable = false
+    self.showable = false
+    self.listable = false
+    self.filterable = false
+    self.updatable = false
+    self.destroyable = false
+
+    has_n_of_attribute :to, :email_address
+    has_n_of_attribute :from, :email_address
+    has_n_of_attribute :cc, :email_address
+    has_n_of_attribute :bcc, :email_address
+    has_n_of_attribute :reply_to, :email_address
+
+    attribute :subject, :string
+    attribute :body, :string
+    attribute :reply_to_message_id, :string
+    attribute :metadata, :hash
+
+    has_n_of_attribute :file_ids, :string
+
+    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_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_v2/nylas_date.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent Nylas's more complex Date Schema
+  # @see https://docs.nylas.com/reference#contactsid
+  class NylasDate
+    extend Forwardable
+    def_delegators :date, :===, :==, :<=>, :eql?, :equal?
+
+    include Model::Attributable
+    attribute :object, :string
+    attribute :date, :date
+  end
+
+  # Serializes, Deserializes between {NylasDate} objects and a {Hash}
+  class NylasDateType < Types::ModelType
+    def initialize
+      super(model: NylasDate)
+    end
+
+    def cast(value)
+      value.is_a?(String) ? super({ object: "date", date: value }) : super
+    end
+  end
+end

data/lib/nylas_v2/open_hours.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Additional times email accounts are available
+  # @see https://developer.nylas.com/docs/api/#post/calendars/availability
+  class OpenHours
+    include Model::Attributable
+
+    attribute :timezone, :string
+    attribute :start, :string
+    attribute :end, :string
+    has_n_of_attribute :emails, :string
+    has_n_of_attribute :days, :integer
+  end
+end

data/lib/nylas_v2/outbox.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # 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_v2/outbox_job_status.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # 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_v2/outbox_message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # 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_v2/participant.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the Participant
+  class Participant
+    include Model::Attributable
+    attribute :name, :string
+    attribute :email, :string
+    attribute :phone_number, :string
+    attribute :comment, :string
+    attribute :status, :string, read_only: true
+  end
+end

data/lib/nylas_v2/phone_number.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the Phone Number Schema
+  # @see https://docs.nylas.com/reference#contactsid
+  class PhoneNumber
+    include Model::Attributable
+    attribute :type, :string
+    attribute :number, :string
+  end
+end

data/lib/nylas_v2/physical_address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the Physical Address schema
+  # @see https://docs.nylas.com/reference#contactsid
+  class PhysicalAddress
+    include Model::Attributable
+    attribute :format, :string
+    attribute :type, :string
+    attribute :street_address, :string
+    attribute :postal_code, :string
+    attribute :state, :string
+    attribute :city, :string
+    attribute :country, :string
+    attribute :secondary_address, :string
+  end
+end

data/lib/nylas_v2/raw_message.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Allows sending of email with nylas from an rfc822 compatible string
+  class RawMessage
+    attr_accessor :api, :mime_compatible_string
+
+    def initialize(mime_compatible_string, api:)
+      self.api = api
+      self.mime_compatible_string = mime_compatible_string
+    end
+
+    def send!
+      Message.new(**api.execute(
+        method: :post,
+        path: "/send",
+        payload: mime_compatible_string,
+        headers: HEADERS
+      ).merge(api: api))
+    end
+
+    HEADERS = { "Content-type" => "message/rfc822" }.freeze
+    private_constant :HEADERS
+  end
+end

data/lib/nylas_v2/recurrence.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Representation of a Recurrence object
+  # @see https://docs.nylas.com/reference#section-recurrence
+  class Recurrence
+    include Model::Attributable
+    has_n_of_attribute :rrule, :string
+    attribute :timezone, :string
+  end
+end

data/lib/nylas_v2/registry.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Used to create a hash-like structure which defaults to raising an exception in the event the key to
+  # retrieve does not exist.
+  class Registry
+    # Used to indicate an attempt to retrieve something not yet registered in a registry
+    # Includes the list of keys in the registry for debug purposes.
+    class MissingKeyError < Error
+      attr_accessor :key
+
+      def initialize(key, keys)
+        super("key #{key} not in #{keys}")
+        self.key = key
+      end
+    end
+    attr_accessor :registry_data
+
+    extend Forwardable
+    def_delegators :registry_data, :keys, :each, :reduce, :key?
+
+    def initialize(initial_data = {})
+      self.registry_data = initial_data.each.each_with_object({}) do |(key, value), registry|
+        registry[key] = value
+      end
+    end
+
+    def [](key)
+      registry_data.fetch(key)
+    rescue KeyError
+      raise MissingKeyError.new(key, keys)
+    end
+
+    def []=(key, value)
+      registry_data[key] = value
+    end
+
+    def to_h
+      registry_data
+    end
+  end
+end

data/lib/nylas_v2/room_resource.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Ruby representation of a Nylas Room Resource object
+  # @see https://developer.nylas.com/docs/api/#tag--Room-Resources
+  class RoomResource
+    include Model
+    self.resources_path = "/resources"
+    self.listable = true
+
+    attribute :object, :string, read_only: true
+    attribute :email, :string, read_only: true
+    attribute :name, :string, read_only: true
+    attribute :capacity, :string, read_only: true
+    attribute :building, :string, read_only: true
+    attribute :floor_name, :string, read_only: true
+    attribute :floor_number, :string, read_only: true
+  end
+end

data/lib/nylas_v2/rsvp.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Allows RSVPing to a particular event
+  # @see https://docs.nylas.com/reference#rsvping-to-invitations
+  class Rsvp
+    include Model
+    self.creatable = true
+
+    attribute :account_id, :string
+    attribute :event_id, :string
+    attribute :status, :string
+    attr_accessor :notify_participants
+
+    def save
+      api.execute(
+        method: :post,
+        path: "/send-rsvp",
+        payload: attributes.serialize_for_api,
+        query: { notify_participants: notify_participants }
+      )
+    end
+  end
+end

data/lib/nylas_v2/scheduler.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Ruby representation of a the Nylas Scheduler API
+  # @see https://developer.nylas.com/docs/api/scheduler/#overview
+  class Scheduler
+    include Model
+    self.resources_path = "/manage/pages"
+    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
+    attribute :app_organization_id, :integer
+    attribute :config, :scheduler_config
+    attribute :edit_token, :string
+    attribute :name, :string
+    attribute :slug, :string
+    attribute :created_at, :date
+    attribute :modified_at, :date
+
+    has_n_of_attribute :access_tokens, :string
+
+    def get_available_calendars
+      raise ArgumentError, "Cannot get calendars for a page without an ID." if id.nil?
+
+      api.execute(
+        method: :get,
+        path: "/manage/pages/#{id}/calendars"
+      )
+    end
+
+    def upload_image(content_type:, object_name:)
+      raise ArgumentError, "Cannot upload an image to a page without an ID." if id.nil?
+
+      payload = {
+        contentType: content_type,
+        objectName: object_name
+      }
+      api.execute(
+        method: :put,
+        path: "/manage/pages/#{id}/upload-image",
+        payload: JSON.dump(payload)
+      )
+    end
+  end
+end

data/lib/nylas_v2/scheduler_booking_confirmation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the booking response returned from the Scheduler API
+  class SchedulerBookingConfirmation
+    include Model::Attributable
+    attribute :id, :integer
+    attribute :account_id, :string
+    attribute :calendar_event_id, :string
+    attribute :calendar_id, :string
+    attribute :edit_hash, :string
+    attribute :location, :string
+    attribute :title, :string
+    attribute :recipient_email, :string
+    attribute :recipient_locale, :string
+    attribute :recipient_name, :string
+    attribute :recipient_tz, :string
+    attribute :additional_field_values, :hash
+    attribute :is_confirmed, :boolean
+    attribute :start_time, :unix_timestamp
+    attribute :end_time, :unix_timestamp
+    has_n_of_attribute :additional_emails, :string
+  end
+end

data/lib/nylas_v2/scheduler_booking_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module NylasV2
+  # Structure to represent the booking request used for the Scheduler API
+  class SchedulerBookingRequest
+    include Model::Attributable
+    attribute :additional_values, :hash
+    attribute :email, :string
+    attribute :locale, :string
+    attribute :name, :string
+    attribute :page_hostname, :string
+    attribute :replaces_booking_hash, :string
+    attribute :timezone, :string
+    attribute :slot, :scheduler_time_slot
+    has_n_of_attribute :additional_emails, :string
+  end
+end