nylas 5.5.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23edacaacec01d7cfd4c182647c30287d27b6ef790ec4abb7a83f98afa17782a
-  data.tar.gz: 3303d603caaf9a5be367fd5983f5350a61460575ddd7978c475c7eaf8be88727
+  metadata.gz: 0bcbd7a865f3b26271776f6e5358647e8e8d9d92d29b9e33f1e942bb0153ea80
+  data.tar.gz: 8a16ead2bc3cccb8f29dcdcf97cbb128722f0f68acf843a96788426c440fbe6c
 SHA512:
-  metadata.gz: af4b7703eb190cbebcc2dac2777ea8cc3a9dbc77dc07604ffd11b3d5aaf4b8085afe60512cca8698bae58f1729c6adee6dd3fe03ae68bb0139ce0c0f208f91cb
-  data.tar.gz: f2060e79d3fe69ba18cb7fc35647504b4f5c66c0ba7c8e41d861b058991e109c5c2a0ec3c1a505eb9ec11d45c8ee9f359f988ade593685af5bf6a157b1029833
+  metadata.gz: 2678a4be307e3870b12d605f5cac42878a884ac97e562ce9cb372d2db54135d9f12ebec4422910efff329e81f4beffa59fe485192f8974832a8d8957cf622431
+  data.tar.gz: 8f77887a487ee85104aae6557bbdf6a39f2fd96bd5fc5265f68e7923655fed39eb2269d9a59d6fc0209ead37cc3cc8b272fbe496ad08e027e64f2c5ab841ed6e

data/lib/nylas/account.rb

@@ -7,15 +7,17 @@ module Nylas
     include Model
     self.listable = true
     self.showable = true
+    self.updatable = true
 
-    attribute :id, :string
-    attribute :account_id, :string
-    attribute :billing_state, :string
-    attribute :sync_state, :string
-    attribute :provider, :string
+    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 :email, :string
-    attribute :trial, :boolean
+    attribute :email, :string, read_only: true
+    attribute :trial, :boolean, read_only: true
+    attribute :metadata, :hash
 
     def upgrade
       response = execute(method: :post, path: "#{resource_path}/upgrade")

data/lib/nylas/api.rb

@@ -48,7 +48,11 @@ module Nylas
       "#{api_server}/oauth/authorize?#{URI.encode_www_form(params)}"
     end
 
-    def exchange_code_for_token(code)
+    # Exchanges an authorization code for an access token
+    # @param code [String] The authorization code to exchange
+    # @param return_full_response [Boolean] If true, returns the full response body instead of just the token
+    # @return [String | Hash] Returns just the access token as a string, or the full response as a hash
+    def exchange_code_for_token(code, return_full_response: false)
       data = {
         "client_id" => app_id,
         "client_secret" => client.app_secret,
@@ -56,8 +60,8 @@ module Nylas
         "code" => code
       }
 
-      response_json = execute(method: :post, path: "/oauth/token", payload: data)
-      response_json[:access_token]
+      response = execute(method: :post, path: "/oauth/token", payload: data)
+      return_full_response ? response : response[:access_token]
     end
 
     # @return [Collection<Contact>] A queryable collection of Contacts
@@ -81,7 +85,7 @@ module Nylas
       @accounts ||= Collection.new(model: Account, api: as(client.app_secret))
     end
 
-    # @return [Collection<Calendar>] A queryable collection of {Calendar}s
+    # @return [CalendarCollection<Calendar>] A queryable collection of {Calendar}s
     def calendars
       @calendars ||= CalendarCollection.new(model: Calendar, api: self)
     end
@@ -96,7 +100,7 @@ module Nylas
       @drafts ||= Collection.new(model: Draft, api: self)
     end
 
-    # @return [Collection<Event>] A queryable collection of {Event}s
+    # @return [EventCollection<Event>] A queryable collection of {Event}s
     def events
       @events ||= EventCollection.new(model: Event, api: self)
     end
@@ -126,12 +130,12 @@ module Nylas
       @room_resources ||= Collection.new(model: RoomResource, api: self)
     end
 
-    # @return[Collection<Scheduler>] A queryable collection of {Scheduler} objects
+    # @return[SchedulerCollection<Scheduler>] A queryable collection of {Scheduler} objects
     def scheduler
       # Make a deep copy of the API as the scheduler API uses a different base URL
       scheduler_api = Marshal.load(Marshal.dump(self))
       scheduler_api.client.api_server = "https://api.schedule.nylas.com"
-      @scheduler ||= Collection.new(model: Scheduler, api: scheduler_api)
+      @scheduler ||= SchedulerCollection.new(model: Scheduler, api: scheduler_api)
     end
 
     # @return[Neural] A {Neural} object that provides

data/lib/nylas/calendar.rb

@@ -6,7 +6,8 @@ module Nylas
   class Calendar
     include Model
     self.resources_path = "/calendars"
-    allows_operations(listable: true, filterable: true, showable: true)
+    allows_operations(creatable: true, listable: true, filterable: true, showable: true, updatable: true,
+                      destroyable: true)
 
     attribute :id, :string
     attribute :account_id, :string
@@ -20,6 +21,7 @@ module Nylas
     attribute :timezone, :string
 
     attribute :read_only, :boolean
+    attribute :metadata, :hash
 
     def read_only?
       read_only == true

data/lib/nylas/draft.rb

@@ -75,14 +75,14 @@ module Nylas
       execute(method: :delete, path: resource_path, payload: attributes.serialize_for_api(keys: [:version]))
     end
 
-    private
-
-    def save_call
+    def save
       extract_file_ids!
 
       super
     end
 
+    private
+
     def extract_file_ids!
       files = self.files || []
 

data/lib/nylas/event.rb

@@ -29,6 +29,7 @@ module Nylas
     attribute :when, :when
     attribute :metadata, :hash
     attribute :conferencing, :event_conferencing
+    has_n_of_attribute :notifications, :event_notification
     attribute :original_start_time, :unix_timestamp
 
     attr_accessor :notify_participants

data/lib/nylas/event_notification.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the Event Notification object
+  # @see https://developer.nylas.com/docs/connectivity/calendar/event-notifications
+  class EventNotification
+    include Model::Attributable
+
+    attribute :type, :string
+    attribute :minutes_before_event, :integer
+    attribute :url, :string
+    attribute :payload, :string
+    attribute :subject, :string
+    attribute :body, :string
+    attribute :message, :string
+  end
+end

data/lib/nylas/message.rb

@@ -8,7 +8,7 @@ module Nylas
     self.raw_mime_type = "message/rfc822"
     self.resources_path = "/messages"
     allows_operations(showable: true, listable: true, filterable: true, searchable: true, updatable: true)
-    UPDATABLE_ATTRIBUTES = %i[label_ids folder_id starred unread].freeze
+    UPDATABLE_ATTRIBUTES = %i[label_ids folder_id starred unread metadata].freeze
 
     attribute :id, :string
     attribute :object, :string
@@ -36,6 +36,7 @@ module Nylas
     has_n_of_attribute :files, :file
     attribute :folder, :folder
     attribute :folder_id, :string
+    attribute :metadata, :hash
 
     has_n_of_attribute :labels, :label, read_only: true
     has_n_of_attribute :label_ids, :string
@@ -72,14 +73,10 @@ module Nylas
       self
     end
 
-    def save_call
+    def save
       handle_folder
 
-      execute(
-        method: :put,
-        payload: attributes.serialize_for_api,
-        path: resource_path
-      )
+      super
     end
 
     def handle_folder

data/lib/nylas/model.rb

@@ -28,7 +28,7 @@ module Nylas
       result = if persisted?
                  raise ModelNotUpdatableError, self unless updatable?
 
-                 save_call
+                 update_call(attributes.serialize_for_api)
                else
                  create
                end
@@ -120,14 +120,6 @@ module Nylas
 
     private
 
-    def save_call
-      execute(
-        method: :put,
-        payload: attributes.serialize_for_api,
-        path: resource_path
-      )
-    end
-
     def update_call(payload)
       result = execute(
         method: :put,

data/lib/nylas/scheduler_booking_confirmation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nylas
+  # 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/scheduler_booking_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nylas
+  # 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

data/lib/nylas/scheduler_collection.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Additional methods for some of Scheduler's other functionality
+  # @see https://developer.nylas.com/docs/api/scheduler#overview
+  class SchedulerCollection < Collection
+    # Retrieve Google availability
+    # @return [Hash] Returns the availability
+    def get_google_availability
+      execute_provider_availability("google")
+    end
+
+    # Retrieve Office 365 availability
+    # @return [Hash] Returns the availability
+    def get_office_365_availability
+      execute_provider_availability("o365")
+    end
+
+    # Retrieve public config for a scheduling page
+    # @param slug [String] The Scheduler page slug
+    # @return [Scheduler] Returns the Scheduler object representing the page configuration
+    def get_page_slug(slug)
+      page_response = api.execute(
+        method: :get,
+        path: "/schedule/#{slug}/info"
+      )
+
+      Scheduler.new(**page_response.merge(api: api))
+    end
+
+    # Retrieve available time slots
+    # @param slug [String] The Scheduler page slug
+    # @return [Array<SchedulerTimeSlot>] Returns the list of available timeslots
+    def get_available_time_slots(slug)
+      response = api.execute(
+        method: :get,
+        path: "/schedule/#{slug}/timeslots"
+      )
+
+      timeslots = []
+      response.each do |available_slot|
+        timeslots.push(SchedulerTimeSlot.new(**available_slot.merge(api: api)))
+      end
+      timeslots
+    end
+
+    # Book a time slot
+    # @param slug [String] The Scheduler page slug
+    # @param timeslot [SchedulerBookingRequest] The time slot booking request
+    # @return [SchedulerBookingConfirmation] Returns the booking confirmation
+    def book_time_slot(slug, timeslot)
+      payload = timeslot.to_h
+      # The booking endpoint requires additional_values and additional_emails
+      # to exist regardless if they are empty or not
+      payload[:additional_values] = {} unless payload[:additional_values]
+      payload[:additional_emails] = [] unless payload[:additional_emails]
+      booking_response = api.execute(
+        method: :post,
+        path: "/schedule/#{slug}/timeslots",
+        payload: JSON.dump(payload)
+      )
+
+      SchedulerBookingConfirmation.new(**booking_response.merge(api: api))
+    end
+
+    # Cancel a booking
+    # @param slug [String] The Scheduler page slug
+    # @param edit_hash [String] The token used for editing the booked time slot
+    # @param reason [String] The reason for cancelling the booking
+    # @return [Hash] Returns a hash of a boolean representing success of cancellation
+    def cancel_booking(slug, edit_hash, reason)
+      api.execute(
+        method: :post,
+        path: "/schedule/#{slug}/#{edit_hash}/cancel",
+        payload: JSON.dump(reason: reason)
+      )
+    end
+
+    # Confirm a booking
+    # @param slug [String] The Scheduler page slug
+    # @param edit_hash [String] The token used for editing the booked time slot
+    # @return [SchedulerBookingConfirmation] Returns the confirmed booking confirmation
+    def confirm_booking(slug, edit_hash)
+      booking_response = api.execute(
+        method: :post,
+        path: "/schedule/#{slug}/#{edit_hash}/confirm",
+        payload: {}
+      )
+
+      SchedulerBookingConfirmation.new(**booking_response.merge(api: api))
+    end
+
+    private
+
+    # Retrieve provider availability
+    # @return [Hash] Returns the availability
+    def execute_provider_availability(provider)
+      api.execute(
+        method: :get,
+        path: "/schedule/availability/#{provider}"
+      )
+    end
+  end
+end

data/lib/nylas/scheduler_time_slot.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Structure to represent the time slot object from the Scheduler API
+  class SchedulerTimeSlot
+    include Model::Attributable
+    attribute :account_id, :string
+    attribute :calendar_id, :string
+    attribute :host_name, :string
+    attribute :start, :unix_timestamp
+    attribute :end, :unix_timestamp
+    has_n_of_attribute :emails, :string
+  end
+end

data/lib/nylas/version.rb

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

data/lib/nylas.rb

@@ -56,6 +56,7 @@ require_relative "nylas/open_hours"
 require_relative "nylas/event_conferencing"
 require_relative "nylas/event_conferencing_details"
 require_relative "nylas/event_conferencing_autocreate"
+require_relative "nylas/event_notification"
 require_relative "nylas/component"
 
 # Custom collection types
@@ -65,6 +66,7 @@ require_relative "nylas/deltas_collection"
 require_relative "nylas/free_busy_collection"
 require_relative "nylas/calendar_collection"
 require_relative "nylas/component_collection"
+require_relative "nylas/scheduler_collection"
 
 # Models supported by the API
 require_relative "nylas/account"
@@ -96,6 +98,9 @@ require_relative "nylas/neural_signature_extraction"
 require_relative "nylas/neural_message_options"
 require_relative "nylas/categorize"
 require_relative "nylas/scheduler_config"
+require_relative "nylas/scheduler_time_slot"
+require_relative "nylas/scheduler_booking_request"
+require_relative "nylas/scheduler_booking_confirmation"
 
 require_relative "nylas/native_authentication"
 
@@ -135,10 +140,12 @@ module Nylas
   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)
+  Types.registry[:event_notification] = Types::ModelType.new(model: EventNotification)
   Types.registry[:neural] = Types::ModelType.new(model: Neural)
   Types.registry[:categorize] = Types::ModelType.new(model: Categorize)
   Types.registry[:neural_signature_contact] = Types::ModelType.new(model: NeuralSignatureContact)
   Types.registry[:neural_contact_link] = Types::ModelType.new(model: NeuralContactLink)
   Types.registry[:neural_contact_name] = Types::ModelType.new(model: NeuralContactName)
   Types.registry[:scheduler_config] = Types::ModelType.new(model: SchedulerConfig)
+  Types.registry[:scheduler_time_slot] = Types::ModelType.new(model: SchedulerTimeSlot)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-28 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -290,6 +290,7 @@ files:
 - lib/nylas/event_conferencing.rb
 - lib/nylas/event_conferencing_autocreate.rb
 - lib/nylas/event_conferencing_details.rb
+- lib/nylas/event_notification.rb
 - lib/nylas/file.rb
 - lib/nylas/filter_attributes.rb
 - lib/nylas/folder.rb
@@ -331,7 +332,11 @@ files:
 - lib/nylas/room_resource.rb
 - lib/nylas/rsvp.rb
 - lib/nylas/scheduler.rb
+- lib/nylas/scheduler_booking_confirmation.rb
+- lib/nylas/scheduler_booking_request.rb
+- lib/nylas/scheduler_collection.rb
 - lib/nylas/scheduler_config.rb
+- lib/nylas/scheduler_time_slot.rb
 - lib/nylas/search_collection.rb
 - lib/nylas/thread.rb
 - lib/nylas/time_slot.rb