nylas 5.17.0 → 6.0.0.beta.2

data/lib/nylas/resources/connectors.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Connectors API
+  class Connectors < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Access the Credentials API
+    attr_reader :credentials
+
+    # Initializes Connectors.
+    def initialize(sdk_instance)
+      super(sdk_instance)
+
+      @credentials = Credentials.new(sdk_instance)
+    end
+
+    # Return all connectors.
+    #
+    # @param query_params [Hash, nil] Query params to pass to the request.
+    # @return [Array(Array(Hash), String)] The list of connectors and API Request ID.
+    def list(query_params: nil)
+      get(
+        path: "#{api_uri}/v3/connectors",
+        query_params: query_params
+      )
+    end
+
+    # Return a connector.
+    #
+    # @param provider [String] The provider associated to the connector to retrieve.
+    # @return [Array(Hash, String)] The connector and API request ID.
+    def find(provider:)
+      get(
+        path: "#{api_uri}/v3/connectors/#{provider}"
+      )
+    end
+
+    # Create a connector.
+    #
+    # @param request_body [Hash] The values to create the connector with.
+    # @return [Array(Hash, String)] The created connector and API Request ID.
+    def create(request_body:)
+      post(
+        path: "#{api_uri}/v3/connectors",
+        request_body: request_body
+      )
+    end
+
+    # Update a connector.
+    #
+    # @param provider [String] The provider associated to the connector to update.
+    # @param request_body [Hash] The values to update the connector with
+    # @return [Array(Hash, String)] The updated connector and API Request ID.
+    def update(provider:, request_body:)
+      put(
+        path: "#{api_uri}/v3/connectors/#{provider}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a connector.
+    #
+    # @param provider [String] The provider associated to the connector to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(provider:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/connectors/#{provider}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/credentials.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Connectors API
+  class Credentials < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all credentials.
+    #
+    # @param provider [String] The provider associated to the credential to list from
+    # @param query_params [Hash, nil] Query params to pass to the request.
+    # @return [Array(Array(Hash), String)] The list of credentials and API Request ID.
+    def list(provider:, query_params: nil)
+      get(
+        path: "#{api_uri}/v3/connectors/#{provider}/creds",
+        query_params: query_params
+      )
+    end
+
+    # Return a connector.
+    #
+    # @param provider [String] The provider associated to the connector to retrieve.
+    # @param credential_id [String] The id of the credentials to retrieve.
+    # @return [Array(Hash, String)] The connector and API request ID.
+    def find(provider:, credential_id:)
+      get(
+        path: "#{api_uri}/v3/connectors/#{provider}/creds/#{credential_id}"
+      )
+    end
+
+    # Create a connector.
+    #
+    # @param provider [String] The provider associated to the credential being created
+    # @param request_body [Hash] The values to create the connector with.
+    # @return [Array(Hash, String)] The created connector and API Request ID.
+    def create(provider:, request_body:)
+      post(
+        path: "#{api_uri}/v3/connectors/#{provider}/creds",
+        request_body: request_body
+      )
+    end
+
+    # Update a connector.
+    #
+    # @param provider [String] The provider associated to the connector to update from.
+    # @param credential_id [String] The id of the credentials to update.
+    # @param request_body [Hash] The values to update the connector with
+    # @return [Array(Hash, String)] The updated connector and API Request ID.
+    def update(provider:, credential_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/connectors/#{provider}/creds/#{credential_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a connector.
+    #
+    # @param provider [String] The provider associated to the connector to delete.
+    # @param credential_id [String] The id of the credentials to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(provider:, credential_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/connectors/#{provider}/creds/#{credential_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/drafts.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+require_relative "../utils/file_utils"
+
+module Nylas
+  # Nylas Drafts API
+  class Drafts < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all drafts.
+    #
+    # @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 drafts and API Request ID.
+    def list(identifier:, query_params: nil)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/drafts",
+        query_params: query_params
+      )
+    end
+
+    # Return an draft.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param draft_id [String] The id of the draft to return.
+    # @return [Array(Hash, String)] The draft and API request ID.
+    def find(identifier:, draft_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/drafts/#{draft_id}"
+      )
+    end
+
+    # Create an draft.
+    #
+    # @param identifier [String] Grant ID or email account in which to create the draft.
+    # @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 created draft and API Request ID.
+    def create(identifier:, request_body:)
+      form_body, opened_files = FileUtils.build_form_request(request_body)
+      response = post(
+        path: "#{api_uri}/v3/grants/#{identifier}/drafts",
+        request_body: form_body
+      )
+
+      opened_files.each(&:close)
+
+      response
+    end
+
+    # Update an draft.
+    #
+    # @param identifier [String] Grant ID or email account in which to update the draft.
+    # @param draft_id [String] The id of the draft to update.
+    # @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 updated draft and API Request ID.
+    def update(identifier:, draft_id:, request_body:)
+      form_body, opened_files = FileUtils.build_form_request(request_body)
+
+      response = put(
+        path: "#{api_uri}/v3/grants/#{identifier}/drafts/#{draft_id}",
+        request_body: form_body
+      )
+
+      opened_files.each(&:close)
+
+      response
+    end
+
+    # Delete an draft.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete an object.
+    # @param draft_id [String] The id of the draft to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(identifier:, draft_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/drafts/#{draft_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/events.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Events API
+  class Events < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all events.
+    #
+    # @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 events and API Request ID.
+    def list(identifier:, query_params:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/events",
+        query_params: query_params
+      )
+    end
+
+    # Return an event.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param event_id [String] The id of the event to return.
+    # @param query_params [Hash] The query parameters to include in the request
+    # @return [Array(Hash, String)] The event and API request ID.
+    def find(identifier:, event_id:, query_params:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/events/#{event_id}",
+        query_params: query_params
+      )
+    end
+
+    # Create an event.
+    #
+    # @param identifier [String] Grant ID or email account in which to create the object.
+    # @param request_body [Hash] The values to create the event with.
+    # @param query_params [Hash] The query parameters to include in the request.
+    # @return [Array(Hash, String)] The created event and API Request ID.
+    def create(identifier:, request_body:, query_params:)
+      post(
+        path: "#{api_uri}/v3/grants/#{identifier}/events",
+        query_params: query_params,
+        request_body: request_body
+      )
+    end
+
+    # Update an event.
+    #
+    # @param identifier [String] Grant ID or email account in which to update an object.
+    # @param event_id [String] The id of the event to update.
+    # @param request_body [Hash] The values to update the event with
+    # @param query_params [Hash] The query parameters to include in the request
+    # @return [Array(Hash, String)] The updated event and API Request ID.
+    def update(identifier:, event_id:, request_body:, query_params:)
+      put(
+        path: "#{api_uri}/v3/grants/#{identifier}/events/#{event_id}",
+        query_params: query_params,
+        request_body: request_body
+      )
+    end
+
+    # Delete an event.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete an object.
+    # @param event_id [String] The id of the event to delete.
+    # @param query_params [Hash] The query parameters to include in the request
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(identifier:, event_id:, query_params:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/events/#{event_id}",
+        query_params: query_params
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/folders.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Nylas Folder API
+  class Folders < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all folders.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @return [Array(Array(Hash), String)] The list of folders and API Request ID.
+    def list(identifier:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/folders"
+      )
+    end
+
+    # Return a folder.
+    #
+    # @param identifier [String] Grant ID or email account to query.
+    # @param folder_id [String] The id of the folder to return.
+    # @return [Array(Hash, String)] The folder and API request ID.
+    def find(identifier:, folder_id:)
+      get(
+        path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}"
+      )
+    end
+
+    # Create a folder.
+    #
+    # @param identifier [String] Grant ID or email account in which to create the object.
+    # @param request_body [Hash] The values to create the folder with.
+    # @return [Array(Hash, String)] The created folder and API Request ID.
+    def create(identifier:, request_body:)
+      post(
+        path: "#{api_uri}/v3/grants/#{identifier}/folders",
+        request_body: request_body
+      )
+    end
+
+    # Update a folder.
+    #
+    # @param identifier [String] Grant ID or email account in which to update an object.
+    # @param folder_id [String] The id of the folder to update.
+    # @param request_body [Hash] The values to update the folder with
+    # @return [Array(Hash, String)] The updated folder and API Request ID.
+    def update(identifier:, folder_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a folder.
+    #
+    # @param identifier [String] Grant ID or email account from which to delete an object.
+    # @param folder_id [String] The id of the folder to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(identifier:, folder_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grants/#{identifier}/folders/#{folder_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

data/lib/nylas/resources/grants.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "resource"
+require_relative "../handler/api_operations"
+
+module Nylas
+  # Grants
+  class Grants < Resource
+    include ApiOperations::Get
+    include ApiOperations::Post
+    include ApiOperations::Put
+    include ApiOperations::Delete
+
+    # Return all grants.
+    #
+    # @param query_params [Hash, nil] Query params to pass to the request.
+    # @return [Array(Array(Hash), String)] The list of grants and API Request ID.
+    def list(query_params: nil)
+      get(
+        path: "#{api_uri}/v3/grant",
+        query_params: query_params
+      )
+    end
+
+    # Return a grant.
+    #
+    # @param grant_id [String] The id of the grant to return.
+    # @return [Array(Hash, String)] The grant and API request ID.
+    def find(grant_id:)
+      get(
+        path: "#{api_uri}/v3/grant/#{grant_id}"
+      )
+    end
+
+    # Create a Grant via Custom Authentication.
+    #
+    # @param request_body [Hash] The values to create the Grant with.
+    # @return [Array(Hash, String)] Created grant and API Request ID.
+    def create(request_body)
+      post(
+        path: "#{api_uri}/v3/#{resource_name}/custom",
+        request_body: request_body
+      )
+    end
+
+    # Update a grant.
+    #
+    # @param grant_id [String] The id of the grant to update.
+    # @param request_body [Hash] The values to update the grant with
+    # @return [Array(Hash, String)] The updated grant and API Request ID.
+    def update(grant_id:, request_body:)
+      put(
+        path: "#{api_uri}/v3/grant/#{grant_id}",
+        request_body: request_body
+      )
+    end
+
+    # Delete a grant.
+    #
+    # @param grant_id [String] The id of the grant to delete.
+    # @return [Array(TrueClass, String)] True and the API Request ID for the delete operation.
+    def destroy(grant_id:)
+      _, request_id = delete(
+        path: "#{api_uri}/v3/grant/#{grant_id}"
+      )
+
+      [true, request_id]
+    end
+  end
+end

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

@@ -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