apimatic-plaid-sdk 0.0.1

data/lib/plaid/configuration.rb

@@ -0,0 +1,198 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Production
+    # ENVIRONMENT2: Development
+    # ENVIRONMENT3: Sandbox
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze,
+      ENVIRONMENT3 = 'environment3'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'environment2' then ENVIRONMENT2
+      when 'environment3' then ENVIRONMENT3
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :plaid_client_id_credentials,
+                :plaid_secret_credentials, :plaid_version_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      plaid_client_id_credentials: nil, plaid_secret_credentials: nil,
+      plaid_version_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding Custom Header Signature credentials
+      @plaid_client_id_credentials = plaid_client_id_credentials
+
+      # The object holding Custom Header Signature credentials
+      @plaid_secret_credentials = plaid_secret_credentials
+
+      # The object holding Custom Header Signature credentials
+      @plaid_version_credentials = plaid_version_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, plaid_client_id_credentials: nil,
+                   plaid_secret_credentials: nil,
+                   plaid_version_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      plaid_client_id_credentials ||= self.plaid_client_id_credentials
+      plaid_secret_credentials ||= self.plaid_secret_credentials
+      plaid_version_credentials ||= self.plaid_version_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        plaid_client_id_credentials: plaid_client_id_credentials,
+        plaid_secret_credentials: plaid_secret_credentials,
+        plaid_version_credentials: plaid_version_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://production.plaid.com'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://development.plaid.com'
+      },
+      Environment::ENVIRONMENT3 => {
+        Server::DEFAULT => 'https://sandbox.plaid.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      plaid_client_id_credentials = PlaidClientIdCredentials.from_env
+      plaid_secret_credentials = PlaidSecretCredentials.from_env
+      plaid_version_credentials = PlaidVersionCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        plaid_client_id_credentials: plaid_client_id_credentials,
+        plaid_secret_credentials: plaid_secret_credentials,
+        plaid_version_credentials: plaid_version_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/plaid/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/plaid/exceptions/error_error_exception.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # We use standard HTTP response codes for success and failure notifications,
+  # and our errors are further classified by `error_type`. In general, 200 HTTP
+  # codes correspond to success, 40X codes are for developer- or user-related
+  # failures, and 50X codes are for Plaid-related issues.  Error fields will be
+  # `null` if no error has occurred.
+  class ErrorErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A broad categorization of the error. Safe for programatic use.
+    # @return [ErrorType]
+    attr_accessor :error_type
+
+    # The particular error code. Safe for programmatic use.
+    # @return [String]
+    attr_accessor :error_code
+
+    # A developer-friendly representation of the error code. This may change
+    # over time and is not safe for programmatic use.
+    # @return [String]
+    attr_accessor :error_message
+
+    # A user-friendly representation of the error code. `null` if the error is
+    # not related to user action.
+    # This may change over time and is not safe for programmatic use.
+    # @return [String]
+    attr_accessor :display_message
+
+    # A unique ID identifying the request, to be used for troubleshooting
+    # purposes. This field will be omitted in errors provided by webhooks.
+    # @return [String]
+    attr_accessor :request_id
+
+    # In the Assets product, a request can pertain to more than one Item. If an
+    # error is returned for such a request, `causes` will return an array of
+    # errors containing a breakdown of these errors on the individual Item
+    # level, if any can be identified.
+    # `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`.
+    # @return [Array[Object]]
+    attr_accessor :causes
+
+    # The HTTP status code associated with the error. This will only be returned
+    # in the response body when the error information is provided via a webhook.
+    # @return [Float]
+    attr_accessor :status
+
+    # The URL of a Plaid documentation page with more information about the
+    # error
+    # @return [String]
+    attr_accessor :documentation_url
+
+    # Suggested steps for resolving the error
+    # @return [String]
+    attr_accessor :suggested_action
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_type = hash.key?('error_type') ? hash['error_type'] : nil
+      @error_code = hash.key?('error_code') ? hash['error_code'] : nil
+      @error_message = hash.key?('error_message') ? hash['error_message'] : nil
+      @display_message =
+        hash.key?('display_message') ? hash['display_message'] : nil
+      @request_id = hash.key?('request_id') ? hash['request_id'] : SKIP
+      @causes = hash.key?('causes') ? hash['causes'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @documentation_url =
+        hash.key?('documentation_url') ? hash['documentation_url'] : SKIP
+      @suggested_action =
+        hash.key?('suggested_action') ? hash['suggested_action'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_type: #{@error_type}, error_code: #{@error_code}, error_message:"\
+      " #{@error_message}, display_message: #{@display_message}, request_id: #{@request_id},"\
+      " causes: #{@causes}, status: #{@status}, documentation_url: #{@documentation_url},"\
+      " suggested_action: #{@suggested_action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_type: #{@error_type.inspect}, error_code: #{@error_code.inspect},"\
+      " error_message: #{@error_message.inspect}, display_message: #{@display_message.inspect},"\
+      " request_id: #{@request_id.inspect}, causes: #{@causes.inspect}, status:"\
+      " #{@status.inspect}, documentation_url: #{@documentation_url.inspect}, suggested_action:"\
+      " #{@suggested_action.inspect}>"
+    end
+  end
+end

data/lib/plaid/http/api_response.rb

@@ -0,0 +1,19 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/plaid/http/auth/plaid_client_id.rb

@@ -0,0 +1,52 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Utility class for custom header authorization.
+  class PlaidClientId < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PlaidClientId: plaid_client_id is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(plaid_client_id_credentials)
+      auth_params = {}
+      auth_params['PLAID-CLIENT-ID'] = plaid_client_id_credentials.plaid_client_id unless
+        plaid_client_id_credentials.nil? || plaid_client_id_credentials.plaid_client_id.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PlaidClientIdCredentials.
+  # Data class for PlaidClientIdCredentials.
+  class PlaidClientIdCredentials
+    attr_reader :plaid_client_id
+
+    def initialize(plaid_client_id:)
+      raise ArgumentError, 'plaid_client_id cannot be nil' if plaid_client_id.nil?
+
+      @plaid_client_id = plaid_client_id
+    end
+
+    def self.from_env
+      plaid_client_id = ENV['PLAID_CLIENT_ID_PLAID_CLIENT_ID']
+      all_nil = [
+        plaid_client_id
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(plaid_client_id: plaid_client_id)
+    end
+
+    def clone_with(plaid_client_id: nil)
+      plaid_client_id ||= self.plaid_client_id
+
+      PlaidClientIdCredentials.new(plaid_client_id: plaid_client_id)
+    end
+  end
+end

data/lib/plaid/http/auth/plaid_secret.rb

@@ -0,0 +1,52 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Utility class for custom header authorization.
+  class PlaidSecret < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PlaidSecret: plaid_secret is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(plaid_secret_credentials)
+      auth_params = {}
+      auth_params['PLAID-SECRET'] = plaid_secret_credentials.plaid_secret unless
+        plaid_secret_credentials.nil? || plaid_secret_credentials.plaid_secret.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PlaidSecretCredentials.
+  # Data class for PlaidSecretCredentials.
+  class PlaidSecretCredentials
+    attr_reader :plaid_secret
+
+    def initialize(plaid_secret:)
+      raise ArgumentError, 'plaid_secret cannot be nil' if plaid_secret.nil?
+
+      @plaid_secret = plaid_secret
+    end
+
+    def self.from_env
+      plaid_secret = ENV['PLAID_SECRET_PLAID_SECRET']
+      all_nil = [
+        plaid_secret
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(plaid_secret: plaid_secret)
+    end
+
+    def clone_with(plaid_secret: nil)
+      plaid_secret ||= self.plaid_secret
+
+      PlaidSecretCredentials.new(plaid_secret: plaid_secret)
+    end
+  end
+end

data/lib/plaid/http/auth/plaid_version.rb

@@ -0,0 +1,52 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Utility class for custom header authorization.
+  class PlaidVersion < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PlaidVersion: plaid_version is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(plaid_version_credentials)
+      auth_params = {}
+      auth_params['Plaid-Version'] = plaid_version_credentials.plaid_version unless
+        plaid_version_credentials.nil? || plaid_version_credentials.plaid_version.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for PlaidVersionCredentials.
+  # Data class for PlaidVersionCredentials.
+  class PlaidVersionCredentials
+    attr_reader :plaid_version
+
+    def initialize(plaid_version:)
+      raise ArgumentError, 'plaid_version cannot be nil' if plaid_version.nil?
+
+      @plaid_version = plaid_version
+    end
+
+    def self.from_env
+      plaid_version = ENV['PLAID_VERSION_PLAID_VERSION']
+      all_nil = [
+        plaid_version
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(plaid_version: plaid_version)
+    end
+
+    def clone_with(plaid_version: nil)
+      plaid_version ||= self.plaid_version
+
+      PlaidVersionCredentials.new(plaid_version: plaid_version)
+    end
+  end
+end

data/lib/plaid/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/plaid/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/plaid/http/http_request.rb

@@ -0,0 +1,10 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/plaid/http/http_response.rb

@@ -0,0 +1,10 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/plaid/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end