nylas 6.0.0.beta.1 → 6.0.0.beta.2

data/lib/nylas/resources/messages.rb

@@ -0,0 +1,126 @@
+# 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)] The list of messages and API Request ID.
+    def list(identifier:, query_params: nil)
+      get(
+        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:)
+      form_body, opened_files = FileUtils.build_form_request(request_body)
+
+      response = post(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/send",
+        request_body: form_body
+      )
+
+      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.
+    # @param schedule_id [String] The id of the scheduled message to stop.
+    # @return [Array(Hash, String)] The list of scheduled messages and the API Request ID.
+    def list_scheduled_messages(identifier:, schedule_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules/#{schedule_id}"
+      )
+    end
+
+    # Retrieve your scheduled messages.
+    #
+    # @param identifier [String] Grant ID or email account from which to list the scheduled messages from.
+    # @return [Array(Hash, String)] The scheduled message and the API Request ID.
+    def find_scheduled_messages(identifier:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/messages/schedules"
+      )
+    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

@@ -1,20 +1,68 @@
 # frozen_string_literal: true
 
 require_relative "resource"
-require_relative "../handler/admin_api_operations"
+require_relative "../handler/api_operations"
 
 module Nylas
-  # Redirect URIs
+  # A collection of redirect URI related API endpoints.
   class RedirectUris < Resource
-    include AdminApiOperations::Create
-    include AdminApiOperations::Update
-    include AdminApiOperations::List
-    include AdminApiOperations::Destroy
-    include AdminApiOperations::Find
-
-    # Initializes redirect URIs.
-    def initialize(sdk_instance)
-      super("applications/redirect-uris", sdk_instance)
+    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

@@ -2,10 +2,10 @@
 
 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(resource_name, sdk_instance)
-      @resource_name = resource_name
+    def initialize(sdk_instance)
       @api_key = sdk_instance.api_key
       @api_uri = sdk_instance.api_uri
       @timeout = sdk_instance.timeout

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)] The list of threads and API Request ID.
+    def list(identifier:, query_params: nil)
+      get(
+        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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "resource"
-require_relative "../handler/grants_api_operations"
+require_relative "../handler/api_operations"
 
 module Nylas
   # Module representing the possible 'trigger' values in a Webhook.
@@ -21,17 +21,65 @@ module Nylas
     MESSAGE_SEND_FAILED = "message.send_failed"
   end
 
-  # Webhooks
+  # Nylas Webhooks API
   class Webhooks < Resource
-    include GrantsApiOperations::Create
-    include GrantsApiOperations::Update
-    include GrantsApiOperations::List
-    include GrantsApiOperations::Destroy
-    include GrantsApiOperations::Find
-
-    # Initializes webhooks.
-    def initialize(parent)
-      super("webhooks", parent)
+    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
   end
 end

data/lib/nylas/utils/file_utils.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "mime/types"
+
+module Nylas
+  # A collection of file-related utilities.
+  module FileUtils
+    # 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") || []
+      message_payload = request_body.to_json
+
+      # Prepare the data to return
+      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).first.to_s
+      content_type = "application/octet-stream" if content_type.empty?
+      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 = "6.0.0.beta.1"
+  VERSION = "6.0.0.beta.2"
 end

data/lib/nylas.rb

@@ -7,7 +7,7 @@ require "rest-client"
 #   See https://github.com/sparklemotion/http-cookie/issues/27
 #   and https://github.com/sparklemotion/http-cookie/issues/6
 #
-# CookieJar uses unsafe class caching for dynamically loading cookie jars. 
+# CookieJar uses unsafe class caching for dynamically loading cookie jars.
 # If two rest-client instances are instantiated at the same time (in threads), non-deterministic
 # behaviour can occur whereby the Hash cookie jar isn't properly loaded and cached.
 # Forcing an instantiation of the jar onload will force the CookieJar to load before the system has
@@ -28,9 +28,19 @@ require_relative "nylas/config"
 require_relative "nylas/handler/http_client"
 
 require_relative "nylas/resources/applications"
+require_relative "nylas/resources/attachments"
 require_relative "nylas/resources/auth"
 require_relative "nylas/resources/calendars"
+require_relative "nylas/resources/connectors"
+require_relative "nylas/resources/credentials"
+require_relative "nylas/resources/drafts"
 require_relative "nylas/resources/events"
+require_relative "nylas/resources/folders"
 require_relative "nylas/resources/grants"
+require_relative "nylas/resources/messages"
+require_relative "nylas/resources/smart_compose"
+require_relative "nylas/resources/threads"
 require_relative "nylas/resources/redirect_uris"
 require_relative "nylas/resources/webhooks"
+
+require_relative "nylas/utils/file_utils"

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 6.0.0.beta.1
+  version: 6.0.0.beta.2
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -212,18 +232,25 @@ files:
 - lib/nylas/client.rb
 - lib/nylas/config.rb
 - lib/nylas/errors.rb
-- lib/nylas/handler/admin_api_operations.rb
 - lib/nylas/handler/api_operations.rb
-- lib/nylas/handler/grants_api_operations.rb
 - lib/nylas/handler/http_client.rb
 - lib/nylas/resources/applications.rb
+- lib/nylas/resources/attachments.rb
 - lib/nylas/resources/auth.rb
 - lib/nylas/resources/calendars.rb
+- lib/nylas/resources/connectors.rb
+- lib/nylas/resources/credentials.rb
+- lib/nylas/resources/drafts.rb
 - lib/nylas/resources/events.rb
+- lib/nylas/resources/folders.rb
 - lib/nylas/resources/grants.rb
+- lib/nylas/resources/messages.rb
 - lib/nylas/resources/redirect_uris.rb
 - lib/nylas/resources/resource.rb
+- lib/nylas/resources/smart_compose.rb
+- lib/nylas/resources/threads.rb
 - lib/nylas/resources/webhooks.rb
+- lib/nylas/utils/file_utils.rb
 - lib/nylas/version.rb
 homepage:
 licenses:

data/lib/nylas/handler/admin_api_operations.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "http_client"
-require_relative "api_operations"
-
-module Nylas
-  # Allows resources to perform CRUD operations on the Admin API endpoints without exposing the
-  # HTTP client to the end user.
-  module AdminApiOperations
-    include HttpClient
-    # Creates a Nylas object.
-    module Create
-      include ApiOperations::Post
-      # Creates a Nylas object.
-      #
-      # @param query_params [Hash, {}] Query params to pass to the request.
-      # @param request_body [Hash, nil] Request body to pass to the request.
-      # @return [Array(Hash, String)] Created Nylas object and API Request ID.
-      def create(query_params: {}, request_body: nil)
-        post(
-          path: "#{api_uri}/v3/#{resource_name}",
-          query_params: query_params,
-          request_body: request_body
-        )
-      end
-    end
-
-    # Lists Nylas objects.
-    module List
-      include ApiOperations::Get
-      # Lists Nylas objects.
-      #
-      # @param query_params [Hash, {}] Query params to pass to the request.
-      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
-      def list(query_params: {})
-        get(
-          path: "#{api_uri}/v3/#{resource_name}",
-          query_params: query_params
-        )
-      end
-    end
-
-    # Finds a Nylas object.
-    module Find
-      include ApiOperations::Get
-      # Finds a Nylas object.
-      #
-      # @param object_id [String] Object ID.
-      # @param query_params [Hash, {}] Query params to pass to the request.
-      # @return [Array(Hash, String)] Nylas object and API Request ID.
-      def find(object_id:, query_params: {})
-        get(
-          path: "#{api_uri}/v3/#{resource_name}/#{object_id}",
-          query_params: query_params
-        )
-      end
-    end
-
-    # Updates a Nylas object.
-    module Update
-      include ApiOperations::Put
-      # Updates a Nylas object.
-      #
-      # @param object_id [String] Object ID.
-      # @param query_params [Hash, {}] Query params to pass to the request.
-      # @param request_body [Hash, nil] Request body to pass to the request.
-      # @return [Array(Hash, String)] Updated Nylas object and API Request ID.
-      def update(object_id:, query_params: {}, request_body: nil)
-        put(
-          path: "#{api_uri}/v3/#{resource_name}/#{object_id}",
-          query_params: query_params,
-          request_body: request_body
-        )
-      end
-    end
-
-    # Deletes a Nylas object.
-    module Destroy
-      include ApiOperations::Delete
-      # Deletes a Nylas object.
-      #
-      # @param object_id [String] Object ID.
-      # @param query_params [Hash, {}] Query params to pass to the request.
-      # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
-      def destroy(object_id:, query_params: {})
-        _, request_id = delete(
-          path: "#{api_uri}/v3/#{resource_name}/#{object_id}",
-          query_params: query_params
-        )
-
-        [true, request_id]
-      end
-    end
-  end
-end