nylas 5.17.0 → 6.0.3

data/lib/nylas/resources/messages.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "smart_compose"
+require_relative "../handler/api_operations"
+require_relative "../utils/file_utils"
+
+module Nylas
+  # Nylas Messages API
+  class Messages < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    attr_reader :smart_compose
+
+    # Initializes the messages resource.
+    # @param sdk_instance [Nylas::API] The API instance to which the resource is bound.
+    def initialize(sdk_instance)
+      super(sdk_instance)
+      @smart_compose = SmartCompose.new(sdk_instance)
+    end
+
+    # Return all messages.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param query_params [Hash, nil] Query params to pass to the request.
+    # @return [Array(Array(Hash), String, String)] The list of messages, API Request ID, and next cursor.
+    def list(identifier:, query_params: nil)
+      get_list(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages",
+        query_params: query_params
+      )
+    end
+
+    # Return a message.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param message_id [String] The id of the message to return.
+    # @return [Array(Hash, String)] The message and API request ID.
+    def find(identifier:, message_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/#{message_id}"
+      )
+    end
+
+    # Update a message.
+    #
+    # @param identifier [String] Grant ID or email account in which to update an object.
+    # @param message_id [String] The id of the message to update.
+    # @param request_body [Hash] The values to update the message with
+    # @return [Array(Hash, String)] The updated message and API Request ID.
+    def update(identifier:, message_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/#{message_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a message.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete an object.
+    # @param message_id [String] The id of the message to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(identifier:, message_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/#{message_id}"
+      )
+
+      [true, request_id]
+    end
+
+    # Send a message.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete an object.
+    # @param request_body [Hash] The values to create the message with.
+    #   If you're attaching files, you must pass an array of [File] objects, or
+    #   you can use {FileUtils::attach_file_request_builder} to build each object attach.
+    # @return [Array(Hash, String)] The sent message and the API Request ID.
+    def send(identifier:, request_body:)
+      payload = request_body
+      opened_files = []
+
+      # Use form data only if the attachment size is greater than 3mb
+      attachments = request_body[:attachments] || request_body["attachments"] || []
+      attachment_size = attachments&.sum { |attachment| attachment[:size] || 0 } || 0
+
+      if attachment_size >= FileUtils::FORM_DATA_ATTACHMENT_SIZE
+        payload, opened_files = FileUtils.build_form_request(request_body)
+      end
+
+      response = post(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/send",
+        request_body: payload
+      )
+
+      opened_files.each(&:close)
+
+      response
+    end
+
+    # Retrieve your scheduled messages.
+    #
+    # @param identifier [String] Grant ID or email account from which to find the scheduled message from.
+    # @return [Array(Array(Hash), String)] The list of scheduled messages and the API Request ID.
+    def list_scheduled_messages(identifier:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules"
+      )
+    end
+
+    # Retrieve your scheduled messages.
+    #
+    # @param identifier [String] Grant ID or email account from which to list the scheduled messages from.
+    # @param schedule_id [String] The id of the scheduled message to stop.
+    # @return [Array(Hash, String)] The scheduled message and the API Request ID.
+    def find_scheduled_messages(identifier:, schedule_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules/#{schedule_id}"
+      )
+    end
+
+    # Stop a scheduled message.
+    #
+    # @param identifier [String] Grant ID or email account from which to list the scheduled messages from.
+    # @param schedule_id [String] The id of the scheduled message to stop..
+    # @return [Array(Hash, String)] The scheduled message and the API Request ID.
+    def stop_scheduled_messages(identifier:, schedule_id:)
+      delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules/#{schedule_id}"
+      )
+    end
+  end
+end

data/lib/nylas/resources/redirect_uris.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # A collection of redirect URI related API endpoints.
+  class RedirectUris < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all redirect uris.
+    #
+    # @return [Array(Array(Hash), String)] The list of redirect uris and API Request ID.
+    def list
+      get(
+        path: "#{api_uri}/v3/applications/redirect-uris"
+      )
+    end
+
+    # Return a redirect uri.
+    #
+    # @param redirect_uri_id [String] The id of the redirect uri to return.
+    # @return [Array(Hash, String)] The redirect uri and API request ID.
+    def find(redirect_uri_id:)
+      get(
+        path: "#{api_uri}/v3/applications/redirect-uris/#{redirect_uri_id}"
+      )
+    end
+
+    # Create a redirect uri.
+    #
+    # @param request_body [Hash] The values to create the redirect uri with.
+    # @return [Array(Hash, String)] The created redirect uri and API Request ID.
+    def create(request_body:)
+      post(
+        path: "#{api_uri}/v3/applications/redirect-uris",
+        request_body: request_body
+      )
+    end
+
+    # Update a redirect uri.
+    #
+    # @param redirect_uri_id [String] The id of the redirect uri to update.
+    # @param request_body [Hash] The values to update the redirect uri with
+    # @return [Array(Hash, String)] The updated redirect uri and API Request ID.
+    def update(redirect_uri_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/applications/redirect-uris/#{redirect_uri_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a redirect uri.
+    #
+    # @param redirect_uri_id [String] The id of the redirect uri to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(redirect_uri_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/applications/redirect-uris/#{redirect_uri_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/resource.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nylas
+  # NOTE: BaseResource is the base class for all Nylas API resources.
+  # Used by all Nylas API resources
+  class Resource
+    # Initializes a resource.
+    def initialize(sdk_instance)
+      @api_key = sdk_instance.api_key
+      @api_uri = sdk_instance.api_uri
+      @timeout = sdk_instance.timeout
+    end
+
+    private
+
+    attr_reader :resource_name, :api_key, :api_uri, :timeout
+  end
+end

data/lib/nylas/resources/smart_compose.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Smart Compose API
+  class SmartCompose < Resource
+    include ApiOperations::Post
+
+    # Compose a message.
+    #
+    # @param identifier [String] Grant ID or email account to generate a message suggestion for.
+    # @param request_body [Hash] The prompt that smart compose will use to generate a message suggestion.
+    # @return [Array(Hash, String)] The generated message and API Request ID.
+    def compose_message(identifier:, request_body:)
+      post(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/smart-compose",
+        request_body: request_body
+      )
+    end
+
+    # Compose a message reply.
+    #
+    # @param identifier [String] Grant ID or email account to generate a message suggestion for.
+    # @param message_id [String] The id of the message to reply to.
+    # @param request_body [Hash] The prompt that smart compose will use to generate a message reply.
+    # @return [Array(Hash, String)] The generated message reply and API Request ID.
+    def compose_message_reply(identifier:, message_id:, request_body:)
+      post(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/#{message_id}/smart-compose",
+        request_body: request_body
+      )
+    end
+  end
+end

data/lib/nylas/resources/threads.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Threads API
+  class Threads < Resource
+    include ApiOperations::Get
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all threads.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param query_params [Hash] Query params to pass to the request.
+    # @return [Array(Array(Hash), String, String)] The list of threads, API Request ID, and next cursor.
+    def list(identifier:, query_params: nil)
+      get_list(
+        path: "#{api_uri}/v3/grants/#{identifier}/threads",
+        query_params: query_params
+      )
+    end
+
+    # Return an thread.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param thread_id [String] The id of the thread to return.
+    # @return [Array(Hash, String)] The thread and API request ID.
+    def find(identifier:, thread_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/threads/#{thread_id}"
+      )
+    end
+
+    # Update an thread.
+    #
+    # @param identifier [String] Grant ID or email account in which to update the thread.
+    # @param thread_id [String] The id of the thread to update.
+    # @param request_body [Hash] The values to update the thread with
+    # @return [Array(Hash, String)] The updated thread and API Request ID.
+    def update(identifier:, thread_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/grants/#{identifier}/threads/#{thread_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete an thread.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete the thread.
+    # @param thread_id [String] The id of the thread to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(identifier:, thread_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/threads/#{thread_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/webhooks.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Module representing the possible 'trigger' values in a Webhook.
+  # @see https://developer.nylas.com/docs/api#post/a/client_id/webhooks
+  module WebhookTrigger
+    CALENDAR_CREATED = "calendar.created"
+    CALENDAR_UPDATED = "calendar.updated"
+    CALENDAR_DELETED = "calendar.deleted"
+    EVENT_CREATED = "event.created"
+    EVENT_UPDATED = "event.updated"
+    EVENT_DELETED = "event.deleted"
+    GRANT_CREATED = "grant.created"
+    GRANT_UPDATED = "grant.updated"
+    GRANT_DELETED = "grant.deleted"
+    GRANT_EXPIRED = "grant.expired"
+    MESSAGE_SEND_SUCCESS = "message.send_success"
+    MESSAGE_SEND_FAILED = "message.send_failed"
+    MESSAGE_OPENED = "message.opened"
+    MESSAGE_LINK_CLICKED = "message.link_clicked"
+    THREAD_REPLIED = "thread.replied"
+  end
+
+  # Nylas Webhooks API
+  class Webhooks < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all webhooks.
+    #
+    # @return [Array(Array(Hash), String)] The list of webhooks and API Request ID.
+    def list
+      get(
+        path: "#{api_uri}/v3/webhooks"
+      )
+    end
+
+    # Return a webhook.
+    #
+    # @param webhook_id [String] The id of the webhook to return.
+    # @return [Array(Hash, String)] The webhook and API request ID.
+    def find(webhook_id:)
+      get(
+        path: "#{api_uri}/v3/webhooks/#{webhook_id}"
+      )
+    end
+
+    # Create a webhook.
+    #
+    # @param request_body [Hash] The values to create the webhook with.
+    # @return [Array(Hash, String)] The created webhook and API Request ID.
+    def create(request_body:)
+      post(
+        path: "#{api_uri}/v3/webhooks",
+        request_body: request_body
+      )
+    end
+
+    # Update a webhook.
+    #
+    # @param webhook_id [String] The id of the webhook to update.
+    # @param request_body [Hash] The values to update the webhook with
+    # @return [Array(Hash, String)] The updated webhook and API Request ID.
+    def update(webhook_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/webhooks/#{webhook_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a webhook.
+    #
+    # @param webhook_id [String] The id of the webhook to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(webhook_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/webhooks/#{webhook_id}"
+      )
+
+      [true, request_id]
+    end
+
+    # Update the webhook secret value for a destination.
+    # @param webhook_id [String] The ID of the webhook destination to update.
+    # @return [Array(Hash, String)] The updated webhook destination and API Request ID.
+    def rotate_secret(webhook_id:)
+      post(
+        path: "#{api_uri}/v3/webhooks/rotate-secret/#{webhook_id}",
+        request_body: {}
+      )
+    end
+
+    # Get the current list of IP addresses that Nylas sends webhooks from
+    # @return [Array(Hash, String)] List of IP addresses that Nylas sends webhooks from and API Request ID.
+    def ip_addresses
+      get(
+        path: "#{api_uri}/v3/webhooks/ip-addresses"
+      )
+    end
+
+    # Extract the challenge parameter from a URL
+    # @param url [String] The URL sent by Nylas containing the challenge parameter
+    # @return [String] The challenge parameter
+    def self.extract_challenge_parameter(url)
+      url_object = URI.parse(url)
+      query = CGI.parse(url_object.query || "")
+
+      challenge_parameter = query["challenge"]
+      if challenge_parameter.nil? || challenge_parameter.empty? || challenge_parameter.first.nil?
+        raise "Invalid URL or no challenge parameter found."
+      end
+
+      challenge_parameter.first
+    end
+  end
+end

data/lib/nylas/utils/file_utils.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "mime/types"
+
+module Nylas
+  # A collection of file-related utilities.
+  module FileUtils
+    # The maximum size of an attachment that can be sent using json
+    FORM_DATA_ATTACHMENT_SIZE = 3 * 1024 * 1024
+
+    # Build a form request for the API.
+    # @param request_body The values to create the message with.
+    # @return The form data to send to the API and the opened files.
+    # @!visibility private
+    def self.build_form_request(request_body)
+      attachments = request_body.delete(:attachments) || request_body.delete("attachments") || []
+
+      # RestClient will not send a multipart request if there are no attachments
+      # so we need to return the message payload to be used as a json payload
+      return [request_body, []] if attachments.empty?
+
+      # Prepare the data to return
+      message_payload = request_body.to_json
+
+      form_data = {}
+      opened_files = []
+
+      attachments.each_with_index do |attachment, index|
+        file = attachment[:content] || attachment["content"]
+        form_data.merge!({ "file#{index}" => file })
+        opened_files << file
+      end
+
+      form_data.merge!({ "multipart" => true, "message" => message_payload })
+
+      [form_data, opened_files]
+    end
+
+    # Build the request to attach a file to a message/draft object.
+    # @param file_path [String] The path to the file to attach.
+    # @return [Hash] The request that will attach the file to the message/draft
+    def self.attach_file_request_builder(file_path)
+      filename = File.basename(file_path)
+      content_type = MIME::Types.type_for(file_path)
+      content_type = if !content_type.nil? && !content_type.empty?
+                       content_type.first.to_s
+                     else
+                       "application/octet-stream"
+                     end
+      size = File.size(file_path)
+      content = File.new(file_path, "rb")
+
+      {
+        filename: filename,
+        content_type: content_type,
+        size: size,
+        content: content
+      }
+    end
+  end
+end

data/lib/nylas/version.rb

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