nylas 5.17.0 → 6.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0660c04f6656d846a55819153819877b599ed5342d8f2ea9c18a7b19e0799ec3
-  data.tar.gz: bf1bd6d4382a6705a5146ff86202436512cf0fc5c68817c77a932e846c3150cf
+  metadata.gz: 8695c7d105dd1621576a1cc5dfa3bd2d7ff482d171763bf9273a3797cc320675
+  data.tar.gz: 88bda22c310af6c54061db72b6c19a5c4f8abed1e8e6a8518f4a4585d1ea6c38
 SHA512:
-  metadata.gz: 076702b69e4ea6a7ef882f3ac65490d54c90bae69cdc8f940aab62a4d29997627d7936b3426158e10935f1aecfad517e17b2d3c5502aa26a636e48319c492fcd
-  data.tar.gz: 1d7fd956e5676c2b418ed2d0d79ecfd9cf3b6a961f8768ee0dd97952f0ea043810e90499063b1940efc055506a79187f78d4daf04fe386dfbdf64141bd1d9262
+  metadata.gz: cc213a177a26c78864c48e678f6ff2d01cf9a3f29305cb2169b192018a531f3b5d106dab1fdfd350b323e1bbb69c4069ed13ec8ff5319742805c559077d52ac5
+  data.tar.gz: 2d51f8063938e335b00d9331f1beb9fb7c317c0af0954544c8ed40e3e4e14341452cdcf9be98a61ac4f9aae24d98eb0661434aea622a495fbd7f531d1293ec5c

data/lib/nylas/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "resources/calendars"
+require_relative "resources/events"
+require_relative "resources/auth"
+require_relative "resources/webhooks"
+require_relative "resources/applications"
+
+module Nylas
+  # Methods to retrieve data from the Nylas API as Ruby objects.
+  class Client
+    attr_reader :api_key, :api_uri, :timeout
+
+    # Initializes a client session.
+    #
+    # @param api_key [Hash, nil] API key to use for the client session.
+    # @param api_uri [Hash] Client session's host.
+    # @param timeout [Hash, nil] Timeout value to use for the client session.
+    def initialize(api_key: nil,
+                   api_uri: Config::DEFAULT_REGION_URL,
+                   timeout: nil)
+      @api_key = api_key
+      @api_uri = api_uri
+      @timeout = timeout
+    end
+
+    # The application resources for your Nylas application.
+    #
+    # @return [Nylas::Applications] Application resources for your Nylas application.
+    def applications
+      Applications.new(self)
+    end
+
+    # The calendar resources for your Nylas application.
+    #
+    # @return [Nylas::Calendars] Calendar resources for your Nylas application.
+    def calendars
+      Calendars.new(self)
+    end
+
+    # The event resources for your Nylas application.
+    #
+    # @return [Nylas::Events] Event resources for your Nylas application
+    def events
+      Events.new(self)
+    end
+
+    # The auth resources for your Nylas application.
+    #
+    # @return [Nylas::Auth] Auth resources for your Nylas application.
+    def auth
+      Auth.new(self)
+    end
+
+    # The webhook resources for your Nylas application.
+    #
+    # @return [Nylas::Webhooks] Webhook resources for your Nylas application.
+    def webhooks
+      Webhooks.new(self)
+    end
+  end
+end

data/lib/nylas/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Configuration options for the Nylas Ruby SDK.
+  module Config
+    # The configuration options for supported regions.
+    REGION_CONFIG = {
+      us: {
+        nylas_api_url: "https://api.us.nylas.com"
+      },
+      eu: {
+        nylas_api_url: "https://api.eu.nylas.com"
+      }
+    }.freeze
+
+    # The default API endpoint for the Nylas API.
+    DEFAULT_REGION_URL = REGION_CONFIG[:us][:nylas_api_url]
+  end
+end

data/lib/nylas/errors.rb

@@ -3,109 +3,61 @@
 module Nylas
   Error = Class.new(::StandardError)
 
-  class ModelActionError < Error; end
-  class ModelNotFilterableError < ModelActionError; end
-  class ModelNotCreatableError < ModelActionError; end
-  class ModelNotShowableError < ModelActionError; end
-  class ModelNotAvailableAsRawError < ModelActionError; end
-  class ModelNotListableError < ModelActionError; end
-  class ModelNotFilterableError < ModelActionError; end
-  class ModelNotSearchableError < ModelActionError; end
-  class ModelNotUpdatableError < ModelActionError; end
-  class ModelNotDestroyableError < ModelActionError; end
-
   class JsonParseError < Error; end
 
-  # Raised when attempting to set a field that is not on a model with mass assignment
-  class ModelMissingFieldError < ModelActionError
-    def initialize(field, model)
-      super("#{field} is not a valid attribute for #{model.class.name}")
-    end
-  end
-
-  # Indicates that a given method needs an access token to work.
-  class NoAuthToken < Error
-    def initialize(method_name)
-      super "No access token was provided and the #{method_name} method requires one"
-    end
-  end
-
-  UnexpectedAccountAction = Class.new(Error)
-  UnexpectedResponse = Class.new(Error)
-
-  # Base class to inflate the standard errors returned from the Nylas API
-  class APIError < Error
-    attr_accessor :type
-    attr_accessor :message
-    attr_accessor :server_error
-
-    def initialize(type, message, server_error = nil)
+  # Base class to inflate the standard errors returned from the Nylas API.
+  class NylasApiError < Error
+    attr_accessor :type, :request_id, :provider_error, :status_code
+
+    # Initializes an error and assigns the given attributes to it.
+    #
+    # @param type [Hash] Error type.
+    # @param message [String] Error message.
+    # @param status_code [Hash] Error status code.
+    # @param provider_error [String, nil] Provider error.
+    # @param request_id [Hash, nil] The ID of the request.
+    def initialize(type, message, status_code, provider_error = nil, request_id = nil)
       super(message)
       self.type = type
-      self.message = message
-      self.server_error = server_error
+      self.status_code = status_code
+      self.provider_error = provider_error
+      self.request_id = request_id
     end
 
-    def self.parse_error_response(response)
+    # Parses the error response.
+    #
+    # @param response [Hash] Response from the Nylas API.
+    # @param status_code [String] Error status code.
+    def self.parse_error_response(response, status_code)
       new(
         response["type"],
         response["message"],
-        response["server_error"]
+        status_code,
+        response["provider_error"]
       )
     end
   end
 
-  # Error class representing a 429 error response, with details on the rate limit
-  class RateLimitError < APIError
-    attr_accessor :rate_limit
-    attr_accessor :rate_limit_reset
-
-    RATE_LIMIT_LIMIT_HEADER = "x_ratelimit_limit"
-    RATE_LIMIT_RESET_HEADER = "x_ratelimit_reset"
-
-    def initialize(type, message, server_error = nil, rate_limit = nil, rate_limit_reset = nil)
-      super(type, message, server_error)
-      self.rate_limit = rate_limit
-      self.rate_limit_reset = rate_limit_reset
+  # Base class to inflate the standard errors returned from the Nylas OAuth integration.
+  class NylasOAuthError < Error
+    attr_accessor :error, :error_description, :error_uri, :error_code, :status_code
+
+    # Initializes an error and assigns the given attributes to it.
+    #
+    # @param error [Hash] Error type.
+    # @param error_description [String] Description of the error.
+    # @param error_uri [Hash] Error URI.
+    # @param error_code [Hash] Error code.
+    # @param status_code [Hash] Error status code.
+    def initialize(error, error_description, error_uri, error_code, status_code)
+      super(error_description)
+      self.error = error
+      self.error_description = error_description
+      self.error_uri = error_uri
+      self.error_code = error_code
+      self.status_code = status_code
     end
-
-    def self.parse_error_response(response)
-      rate_limit, rate_limit_rest = extract_rate_limit_details(response)
-
-      new(
-        response["type"],
-        response["message"],
-        response["server_error"],
-        rate_limit,
-        rate_limit_rest
-      )
-    end
-
-    def self.extract_rate_limit_details(response)
-      return nil, nil unless response.respond_to?(:headers)
-
-      rate_limit = response.headers[RATE_LIMIT_LIMIT_HEADER.to_sym].to_i
-      rate_limit_rest = response.headers[RATE_LIMIT_RESET_HEADER.to_sym].to_i
-
-      [rate_limit, rate_limit_rest]
-    end
-
-    private_class_method :extract_rate_limit_details
   end
 
-  AccessDenied = Class.new(APIError)
-  ResourceNotFound = Class.new(APIError)
-  MethodNotAllowed = Class.new(APIError)
-  InvalidRequest = Class.new(APIError)
-  UnauthorizedRequest = Class.new(APIError)
-  ResourceRemoved = Class.new(APIError)
-  TeapotError = Class.new(APIError)
-  RequestTimedOut = Class.new(APIError)
-  MessageRejected = Class.new(APIError)
-  SendingQuotaExceeded = Class.new(RateLimitError)
-  ServiceUnavailable = Class.new(APIError)
-  BadGateway = Class.new(APIError)
-  InternalError = Class.new(APIError)
-  EndpointNotYetImplemented = Class.new(APIError)
-  MailProviderError = Class.new(APIError)
+  HTTP_SUCCESS_CODES = [200, 201, 202, 302].freeze
 end

data/lib/nylas/handler/admin_api_operations.rb

@@ -0,0 +1,95 @@
+# 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

data/lib/nylas/handler/api_operations.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Nylas
+  # Allows resources to perform API operations on the Nylas API endpoints without exposing the HTTP
+  # client to the end user.
+  module ApiOperations
+    # Performs a GET call to the Nylas API.
+    module Get
+      protected
+
+      include HttpClient
+      # Performs a GET call to the Nylas API.
+      #
+      # @param path [String] Destination path for the call.
+      # @param query_params [Hash, {}] Query params to pass to the call.
+      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
+      def get(path:, query_params: {})
+        response = execute(
+          method: :get,
+          path: path,
+          query: query_params,
+          payload: nil,
+          api_key: api_key,
+          timeout: timeout
+        )
+
+        [response[:data], response[:request_id]]
+      end
+    end
+
+    # Performs a POST call to the Nylas API.
+    module Post
+      protected
+
+      include HttpClient
+      # Performs a POST call to the Nylas API.
+      #
+      # @param path [String] Destination path for the call.
+      # @param query_params [Hash, {}] Query params to pass to the call.
+      # @param request_body [String, Hash, nil] Request body to pass to the call.
+      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
+      def post(path:, query_params: {}, request_body: nil, headers: {})
+        response = execute(
+          method: :post,
+          path: path,
+          query: query_params,
+          payload: request_body,
+          headers: headers,
+          api_key: api_key,
+          timeout: timeout
+        )
+
+        [response[:data], response[:request_id]]
+      end
+    end
+
+    # Performs a PUT call to the Nylas API.
+    module Put
+      protected
+
+      include HttpClient
+      # Performs a PUT call to the Nylas API.
+      #
+      # @param path [String] Destination path for the call.
+      # @param query_params [Hash, {}] Query params to pass to the call.
+      # @param request_body [String, Hash, nil] Request body to pass to the call.
+      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
+      def put(path:, query_params: {}, request_body: nil, headers: {})
+        response = execute(
+          method: :put,
+          path: path,
+          query: query_params,
+          payload: request_body,
+          headers: headers,
+          api_key: api_key,
+          timeout: timeout
+        )
+
+        [response[:data], response[:request_id]]
+      end
+    end
+
+    # Performs a PATCH call to the Nylas API.
+    module Patch
+      protected
+
+      include HttpClient
+      # Performs a PATCH call to the Nylas API.
+      #
+      # @param path [String] Destination path for the call.
+      # @param query_params [Hash, {}] Query params to pass to the call.
+      # @param request_body [String, Hash, nil] Request body to pass to the call.
+      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
+      def patch(path:, query_params: {}, request_body: nil, headers: {})
+        response = execute(
+          method: :patch,
+          path: path,
+          query: query_params,
+          payload: request_body,
+          headers: headers,
+          api_key: api_key,
+          timeout: timeout
+        )
+
+        [response[:data], response[:request_id]]
+      end
+    end
+
+    # Performs a DELETE call to the Nylas API.
+    module Delete
+      protected
+
+      include HttpClient
+      # Performs a DELETE call to the Nylas API.
+      #
+      # @param path [String] Destination path for the call.
+      # @param query_params [Hash, {}] Query params to pass to the call.
+      # @param headers [Hash, {}] Additional HTTP headers to include in the payload.
+      # @return [Array(Hash, String)] List of Nylas objects and API Request ID.
+      def delete(path:, query_params: {}, headers: {})
+        response = execute(
+          method: :delete,
+          path: path,
+          query: query_params,
+          headers: headers,
+          payload: nil,
+          api_key: api_key,
+          timeout: timeout
+        )
+
+        [response[:data], response[:request_id]]
+      end
+    end
+  end
+end

data/lib/nylas/handler/grants_api_operations.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative "http_client"
+require_relative "api_operations"
+
+module Nylas
+  # Allows resources to perform CRUD operations on the Grants API endpoints without exposing the
+  # HTTP client to the end user.
+  module GrantsApiOperations
+    # Creates a Nylas object.
+    module Create
+      include ApiOperations::Post
+      # Creates a Nylas object.
+      #
+      # @param identifier [String] Grant ID or email account in which to create the 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(identifier:, query_params: {}, request_body: nil)
+        post(
+          path: "#{api_uri}/v3/grants/#{identifier}/#{resource_name}",
+          query_params: query_params,
+          request_body: request_body
+        )
+      end
+    end
+
+    # Lists Nylas objects.
+    module List
+      include ApiOperations::Get
+      # Lists Nylas objects.
+      #
+      # @param identifier [String] Grant ID or email account to query.
+      # @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(identifier:, query_params: {})
+        get(
+          path: "#{api_uri}/v3/grants/#{identifier}/#{resource_name}",
+          query_params: query_params
+        )
+      end
+    end
+
+    # Finds a Nylas object.
+    module Find
+      include ApiOperations::Get
+      # Finds a Nylas object.
+      #
+      # @param identifier [String] Grant ID or email account to query.
+      # @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(identifier:, object_id:, query_params: {})
+        get(
+          path: "#{api_uri}/v3/grants/#{identifier}/#{resource_name}/#{object_id}",
+          query_params: query_params
+        )
+      end
+    end
+
+    # Updates a Nylas object.
+    module Update
+      include ApiOperations::Put
+      # Updates a Nylas object.
+      #
+      # @param identifier [String] Grant ID or email account in which to update an 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(identifier:, object_id:, query_params: {}, request_body: nil)
+        put(
+          path: "#{api_uri}/v3/grants/#{identifier}/#{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 identifier [String] Grant ID or email account from which to delete an 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(identifier:, object_id:, query_params: {})
+        _, request_id = delete(
+          path: "#{api_uri}/v3/grants/#{identifier}/#{resource_name}/#{object_id}",
+          query_params: query_params
+        )
+
+        [true, request_id]
+      end
+    end
+  end
+end