apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/scopes.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The scopes object
+  class Scopes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [ProductAccess]
+    attr_accessor :product_access
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [Array[AccountAccess]]
+    attr_accessor :accounts
+
+    # Allow access to newly opened accounts as they are opened. If unset,
+    # defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :new_accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_access'] = 'product_access'
+      @_hash['accounts'] = 'accounts'
+      @_hash['new_accounts'] = 'new_accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_access
+        accounts
+        new_accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        new_accounts
+      ]
+    end
+
+    def initialize(product_access: SKIP, accounts: SKIP, new_accounts: true,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @product_access = product_access unless product_access == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @new_accounts = new_accounts unless new_accounts == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_access = ProductAccess.from_hash(hash['product_access']) if hash['product_access']
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountAccess.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      new_accounts = hash['new_accounts'] ||= true
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Scopes.new(product_access: product_access,
+                 accounts: accounts,
+                 new_accounts: new_accounts,
+                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_access: #{@product_access}, accounts: #{@accounts}, new_accounts:"\
+      " #{@new_accounts}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_access: #{@product_access.inspect}, accounts: #{@accounts.inspect},"\
+      " new_accounts: #{@new_accounts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/scopes_context.rb

@@ -0,0 +1,38 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An indicator for when scopes are being updated. When scopes are updated via
+  # enrollment (i.e. OAuth), the partner must send `ENROLLMENT`. When scopes are
+  # updated in a post-enrollment view, the partner must send `PORTAL`.
+  class ScopesContext
+    SCOPES_CONTEXT = [
+      # TODO: Write general description for ENROLLMENT
+      ENROLLMENT = 'ENROLLMENT'.freeze,
+
+      # TODO: Write general description for PORTAL
+      PORTAL = 'PORTAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENROLLMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enrollment' then ENROLLMENT
+      when 'portal' then PORTAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/scopes_nullable.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ScopesNullable Model.
+  class ScopesNullable < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [ProductAccess]
+    attr_accessor :product_access
+
+    # The product access being requested. Used to or disallow product access
+    # across all accounts. If unset, defaults to all products allowed.
+    # @return [Array[AccountAccess]]
+    attr_accessor :accounts
+
+    # Allow access to newly opened accounts as they are opened. If unset,
+    # defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :new_accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_access'] = 'product_access'
+      @_hash['accounts'] = 'accounts'
+      @_hash['new_accounts'] = 'new_accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_access
+        accounts
+        new_accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        new_accounts
+      ]
+    end
+
+    def initialize(product_access: SKIP, accounts: SKIP, new_accounts: true,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @product_access = product_access unless product_access == SKIP
+      @accounts = accounts unless accounts == SKIP
+      @new_accounts = new_accounts unless new_accounts == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      product_access = ProductAccess.from_hash(hash['product_access']) if hash['product_access']
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountAccess.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = SKIP unless hash.key?('accounts')
+      new_accounts = hash['new_accounts'] ||= true
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ScopesNullable.new(product_access: product_access,
+                         accounts: accounts,
+                         new_accounts: new_accounts,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_access: #{@product_access}, accounts: #{@accounts}, new_accounts:"\
+      " #{@new_accounts}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_access: #{@product_access.inspect}, accounts: #{@accounts.inspect},"\
+      " new_accounts: #{@new_accounts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/security.rb

@@ -0,0 +1,252 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Contains details about a security
+  class Security < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique, Plaid-specific identifier for the security, used to associate
+    # securities with holdings. Like all Plaid identifiers, the `security_id` is
+    # case sensitive.
+    # @return [String]
+    attr_accessor :security_id
+
+    # 12-character ISIN, a globally unique securities identifier.
+    # @return [String]
+    attr_accessor :isin
+
+    # 9-character CUSIP, an identifier assigned to North American securities.
+    # @return [String]
+    attr_accessor :cusip
+
+    # 7-character SEDOL, an identifier assigned to securities in the UK.
+    # @return [String]
+    attr_accessor :sedol
+
+    # An identifier given to the security by the institution
+    # @return [String]
+    attr_accessor :institution_security_id
+
+    # If `institution_security_id` is present, this field indicates the Plaid
+    # `institution_id` of the institution to whom the identifier belongs.
+    # @return [String]
+    attr_accessor :institution_id
+
+    # In certain cases, Plaid will provide the ID of another security whose
+    # performance resembles this security, typically when the original security
+    # has low volume, or when a private security can be modeled with a publicly
+    # traded security.
+    # @return [String]
+    attr_accessor :proxy_security_id
+
+    # A descriptive name for the security, suitable for display.
+    # @return [String]
+    attr_accessor :name
+
+    # The security’s trading symbol for publicly traded securities, and
+    # otherwise a short identifier if available.
+    # @return [String]
+    attr_accessor :ticker_symbol
+
+    # Indicates that a security is a highly liquid asset and can be treated like
+    # cash.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_cash_equivalent
+
+    # The security type of the holding. Valid security types are:
+    # `cash`: Cash, currency, and money market funds
+    # `derivative`: Options, warrants, and other derivative instruments
+    # `equity`: Domestic and foreign equities
+    # `etf`: Multi-asset exchange-traded investment funds
+    # `fixed income`: Bonds and certificates of deposit (CDs)
+    # `loan`: Loans and loan receivables.
+    # `mutual fund`: Open- and closed-end vehicles pooling funds of multiple
+    # investors.
+    # `other`: Unknown or other investment types
+    # @return [String]
+    attr_accessor :type
+
+    # Price of the security at the close of the previous trading session. `null`
+    # for non-public securities. If the security is a foreign currency or a
+    # cryptocurrency this field will be updated daily and will be priced in USD.
+    # @return [Float]
+    attr_accessor :close_price
+
+    # Date for which `close_price` is accurate. Always `null` if `close_price`
+    # is `null`.
+    # @return [Date]
+    attr_accessor :close_price_as_of
+
+    # The ISO-4217 currency code of the price given. Always `null` if
+    # `unofficial_currency_code` is non-`null`.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the security. Always `null`
+    # if `iso_currency_code` is non-`null`. Unofficial currency codes are used
+    # for currencies that do not have official ISO currency codes, such as
+    # cryptocurrencies and the currencies of certain countries.
+    # See the [currency code
+    # schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a
+    # full listing of supported `iso_currency_code`s.
+    # @return [String]
+    attr_accessor :unofficial_currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['security_id'] = 'security_id'
+      @_hash['isin'] = 'isin'
+      @_hash['cusip'] = 'cusip'
+      @_hash['sedol'] = 'sedol'
+      @_hash['institution_security_id'] = 'institution_security_id'
+      @_hash['institution_id'] = 'institution_id'
+      @_hash['proxy_security_id'] = 'proxy_security_id'
+      @_hash['name'] = 'name'
+      @_hash['ticker_symbol'] = 'ticker_symbol'
+      @_hash['is_cash_equivalent'] = 'is_cash_equivalent'
+      @_hash['type'] = 'type'
+      @_hash['close_price'] = 'close_price'
+      @_hash['close_price_as_of'] = 'close_price_as_of'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        isin
+        cusip
+        sedol
+        institution_security_id
+        institution_id
+        proxy_security_id
+        name
+        ticker_symbol
+        is_cash_equivalent
+        type
+        close_price
+        close_price_as_of
+        iso_currency_code
+        unofficial_currency_code
+      ]
+    end
+
+    def initialize(security_id:, isin:, cusip:, sedol:,
+                   institution_security_id:, institution_id:,
+                   proxy_security_id:, name:, ticker_symbol:,
+                   is_cash_equivalent:, type:, close_price:, close_price_as_of:,
+                   iso_currency_code:, unofficial_currency_code:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @security_id = security_id
+      @isin = isin
+      @cusip = cusip
+      @sedol = sedol
+      @institution_security_id = institution_security_id
+      @institution_id = institution_id
+      @proxy_security_id = proxy_security_id
+      @name = name
+      @ticker_symbol = ticker_symbol
+      @is_cash_equivalent = is_cash_equivalent
+      @type = type
+      @close_price = close_price
+      @close_price_as_of = close_price_as_of
+      @iso_currency_code = iso_currency_code
+      @unofficial_currency_code = unofficial_currency_code
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      security_id = hash.key?('security_id') ? hash['security_id'] : nil
+      isin = hash.key?('isin') ? hash['isin'] : nil
+      cusip = hash.key?('cusip') ? hash['cusip'] : nil
+      sedol = hash.key?('sedol') ? hash['sedol'] : nil
+      institution_security_id =
+        hash.key?('institution_security_id') ? hash['institution_security_id'] : nil
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_id'] : nil
+      proxy_security_id =
+        hash.key?('proxy_security_id') ? hash['proxy_security_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      ticker_symbol = hash.key?('ticker_symbol') ? hash['ticker_symbol'] : nil
+      is_cash_equivalent =
+        hash.key?('is_cash_equivalent') ? hash['is_cash_equivalent'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      close_price = hash.key?('close_price') ? hash['close_price'] : nil
+      close_price_as_of =
+        hash.key?('close_price_as_of') ? hash['close_price_as_of'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      unofficial_currency_code =
+        hash.key?('unofficial_currency_code') ? hash['unofficial_currency_code'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Security.new(security_id: security_id,
+                   isin: isin,
+                   cusip: cusip,
+                   sedol: sedol,
+                   institution_security_id: institution_security_id,
+                   institution_id: institution_id,
+                   proxy_security_id: proxy_security_id,
+                   name: name,
+                   ticker_symbol: ticker_symbol,
+                   is_cash_equivalent: is_cash_equivalent,
+                   type: type,
+                   close_price: close_price,
+                   close_price_as_of: close_price_as_of,
+                   iso_currency_code: iso_currency_code,
+                   unofficial_currency_code: unofficial_currency_code,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} security_id: #{@security_id}, isin: #{@isin}, cusip: #{@cusip}, sedol:"\
+      " #{@sedol}, institution_security_id: #{@institution_security_id}, institution_id:"\
+      " #{@institution_id}, proxy_security_id: #{@proxy_security_id}, name: #{@name},"\
+      " ticker_symbol: #{@ticker_symbol}, is_cash_equivalent: #{@is_cash_equivalent}, type:"\
+      " #{@type}, close_price: #{@close_price}, close_price_as_of: #{@close_price_as_of},"\
+      " iso_currency_code: #{@iso_currency_code}, unofficial_currency_code:"\
+      " #{@unofficial_currency_code}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} security_id: #{@security_id.inspect}, isin: #{@isin.inspect}, cusip:"\
+      " #{@cusip.inspect}, sedol: #{@sedol.inspect}, institution_security_id:"\
+      " #{@institution_security_id.inspect}, institution_id: #{@institution_id.inspect},"\
+      " proxy_security_id: #{@proxy_security_id.inspect}, name: #{@name.inspect}, ticker_symbol:"\
+      " #{@ticker_symbol.inspect}, is_cash_equivalent: #{@is_cash_equivalent.inspect}, type:"\
+      " #{@type.inspect}, close_price: #{@close_price.inspect}, close_price_as_of:"\
+      " #{@close_price_as_of.inspect}, iso_currency_code: #{@iso_currency_code.inspect},"\
+      " unofficial_currency_code: #{@unofficial_currency_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/security_override.rb

@@ -0,0 +1,131 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specify the security associated with the holding or investment transaction.
+  # When inputting custom security data to the Sandbox, Plaid will perform
+  # post-data-retrieval normalization and enrichment. These processes may cause
+  # the data returned by the Sandbox to be slightly different from the data you
+  # input. An ISO-4217 currency code and a security identifier (`ticker_symbol`,
+  # `cusip`, `isin`, or `sedol`) are required.
+  class SecurityOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 12-character ISIN, a globally unique securities identifier.
+    # @return [String]
+    attr_accessor :isin
+
+    # 9-character CUSIP, an identifier assigned to North American securities.
+    # @return [String]
+    attr_accessor :cusip
+
+    # 7-character SEDOL, an identifier assigned to securities in the UK.
+    # @return [String]
+    attr_accessor :sedol
+
+    # A descriptive name for the security, suitable for display.
+    # @return [String]
+    attr_accessor :name
+
+    # The security’s trading symbol for publicly traded securities, and
+    # otherwise a short identifier if available.
+    # @return [String]
+    attr_accessor :ticker_symbol
+
+    # Either a valid `iso_currency_code` or `unofficial_currency_code`
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['isin'] = 'isin'
+      @_hash['cusip'] = 'cusip'
+      @_hash['sedol'] = 'sedol'
+      @_hash['name'] = 'name'
+      @_hash['ticker_symbol'] = 'ticker_symbol'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        isin
+        cusip
+        sedol
+        name
+        ticker_symbol
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(isin: SKIP, cusip: SKIP, sedol: SKIP, name: SKIP,
+                   ticker_symbol: SKIP, currency: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @isin = isin unless isin == SKIP
+      @cusip = cusip unless cusip == SKIP
+      @sedol = sedol unless sedol == SKIP
+      @name = name unless name == SKIP
+      @ticker_symbol = ticker_symbol unless ticker_symbol == SKIP
+      @currency = currency unless currency == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      isin = hash.key?('isin') ? hash['isin'] : SKIP
+      cusip = hash.key?('cusip') ? hash['cusip'] : SKIP
+      sedol = hash.key?('sedol') ? hash['sedol'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      ticker_symbol = hash.key?('ticker_symbol') ? hash['ticker_symbol'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      SecurityOverride.new(isin: isin,
+                           cusip: cusip,
+                           sedol: sedol,
+                           name: name,
+                           ticker_symbol: ticker_symbol,
+                           currency: currency,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} isin: #{@isin}, cusip: #{@cusip}, sedol: #{@sedol}, name: #{@name},"\
+      " ticker_symbol: #{@ticker_symbol}, currency: #{@currency}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} isin: #{@isin.inspect}, cusip: #{@cusip.inspect}, sedol: #{@sedol.inspect},"\
+      " name: #{@name.inspect}, ticker_symbol: #{@ticker_symbol.inspect}, currency:"\
+      " #{@currency.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end