apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/holdings_override.rb

@@ -0,0 +1,133 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specify the holdings on the account.
+  class HoldingsOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The last price given by the institution for this security
+    # @return [Float]
+    attr_accessor :institution_price
+
+    # The date at which `institution_price` was current. Must be formatted as an
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date.
+    # @return [Date]
+    attr_accessor :institution_price_as_of
+
+    # The average original value of the holding. Multiple cost basis values for
+    # the same security purchased at different prices are not supported.
+    # @return [Float]
+    attr_accessor :cost_basis
+
+    # The total quantity of the asset held, as reported by the financial
+    # institution.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Either a valid `iso_currency_code` or `unofficial_currency_code`
+    # @return [String]
+    attr_accessor :currency
+
+    # 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.
+    # @return [SecurityOverride]
+    attr_accessor :security
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['institution_price'] = 'institution_price'
+      @_hash['institution_price_as_of'] = 'institution_price_as_of'
+      @_hash['cost_basis'] = 'cost_basis'
+      @_hash['quantity'] = 'quantity'
+      @_hash['currency'] = 'currency'
+      @_hash['security'] = 'security'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        institution_price_as_of
+        cost_basis
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institution_price:, quantity:, currency:, security:,
+                   institution_price_as_of: SKIP, cost_basis: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institution_price = institution_price
+      @institution_price_as_of = institution_price_as_of unless institution_price_as_of == SKIP
+      @cost_basis = cost_basis unless cost_basis == SKIP
+      @quantity = quantity
+      @currency = currency
+      @security = security
+      @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.
+      institution_price =
+        hash.key?('institution_price') ? hash['institution_price'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      security = SecurityOverride.from_hash(hash['security']) if hash['security']
+      institution_price_as_of =
+        hash.key?('institution_price_as_of') ? hash['institution_price_as_of'] : SKIP
+      cost_basis = hash.key?('cost_basis') ? hash['cost_basis'] : 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.
+      HoldingsOverride.new(institution_price: institution_price,
+                           quantity: quantity,
+                           currency: currency,
+                           security: security,
+                           institution_price_as_of: institution_price_as_of,
+                           cost_basis: cost_basis,
+                           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} institution_price: #{@institution_price}, institution_price_as_of:"\
+      " #{@institution_price_as_of}, cost_basis: #{@cost_basis}, quantity: #{@quantity}, currency:"\
+      " #{@currency}, security: #{@security}, 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} institution_price: #{@institution_price.inspect}, institution_price_as_of:"\
+      " #{@institution_price_as_of.inspect}, cost_basis: #{@cost_basis.inspect}, quantity:"\
+      " #{@quantity.inspect}, currency: #{@currency.inspect}, security: #{@security.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/identity_get_request.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IdentityGetRequest defines the request schema for `/identity/get`
+  class IdentityGetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your Plaid API `client_id`. The `client_id` is required and may be
+    # provided either in the `PLAID-CLIENT-ID` header or as part of a request
+    # body.
+    # @return [String]
+    attr_accessor :client_id
+
+    # Your Plaid API `secret`. The `secret` is required and may be provided
+    # either in the `PLAID-SECRET` header or as part of a request body.
+    # @return [String]
+    attr_accessor :secret
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_token
+
+    # An optional object to filter `/identity/get` results.
+    # @return [IdentityGetRequestOptions]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['secret'] = 'secret'
+      @_hash['access_token'] = 'access_token'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, client_id: SKIP, secret: SKIP, options: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id unless client_id == SKIP
+      @secret = secret unless secret == SKIP
+      @access_token = access_token
+      @options = options unless options == 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = IdentityGetRequestOptions.from_hash(hash['options']) if hash['options']
+
+      # 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.
+      IdentityGetRequest.new(access_token: access_token,
+                             client_id: client_id,
+                             secret: secret,
+                             options: options,
+                             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} client_id: #{@client_id}, secret: #{@secret}, access_token:"\
+      " #{@access_token}, options: #{@options}, 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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, access_token:"\
+      " #{@access_token.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/identity_get_request_options.rb

@@ -0,0 +1,78 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/identity/get` results.
+  class IdentityGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of `account_ids` to retrieve for the Item.
+    # Note: An error will be returned if a provided `account_id` is not
+    # associated with the Item.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'account_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == 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.
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : 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.
+      IdentityGetRequestOptions.new(account_ids: account_ids,
+                                    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} account_ids: #{@account_ids}, 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} account_ids: #{@account_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/identity_get_response.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # IdentityGetResponse defines the response schema for `/identity/get`
+  class IdentityGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The accounts for which Identity data has been requested
+    # @return [Array[AccountIdentity]]
+    attr_accessor :accounts
+
+    # Metadata about the Item.
+    # @return [Item]
+    attr_accessor :item
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts'] = 'accounts'
+      @_hash['item'] = 'item'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts:, item:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @item = item
+      @request_id = request_id
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (AccountIdentity.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = nil unless hash.key?('accounts')
+      item = Item.from_hash(hash['item']) if hash['item']
+      request_id = hash.key?('request_id') ? hash['request_id'] : 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.
+      IdentityGetResponse.new(accounts: accounts,
+                              item: item,
+                              request_id: request_id,
+                              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} accounts: #{@accounts}, item: #{@item}, request_id: #{@request_id},"\
+      " 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} accounts: #{@accounts.inspect}, item: #{@item.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/incident_update.rb

@@ -0,0 +1,106 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # IncidentUpdate Model.
+  class IncidentUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The content of the update.
+    # @return [String]
+    attr_accessor :description
+
+    # The status of the incident.
+    # @return [Status1]
+    attr_accessor :status
+
+    # The date when the update was published, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g.
+    # `"2020-10-30T15:26:48Z"`.
+    # @return [DateTime]
+    attr_accessor :updated_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['status'] = 'status'
+      @_hash['updated_date'] = 'updated_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        status
+        updated_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description: SKIP, status: SKIP, updated_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @description = description unless description == SKIP
+      @status = status unless status == SKIP
+      @updated_date = updated_date unless updated_date == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      updated_date = if hash.key?('updated_date')
+                       (DateTimeHelper.from_rfc3339(hash['updated_date']) if hash['updated_date'])
+                     else
+                       SKIP
+                     end
+
+      # 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.
+      IncidentUpdate.new(description: description,
+                         status: status,
+                         updated_date: updated_date,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_updated_date
+      DateTimeHelper.to_rfc3339(updated_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, status: #{@status}, updated_date:"\
+      " #{@updated_date}, 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} description: #{@description.inspect}, status: #{@status.inspect},"\
+      " updated_date: #{@updated_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/income_breakdown.rb

@@ -0,0 +1,106 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing a breakdown of the different income types on the
+  # paystub.
+  class IncomeBreakdown < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of income. Possible values include:
+    #   `"regular"`: regular income
+    #   `"overtime"`: overtime income
+    #   `"bonus"`: bonus income
+    # @return [Type5]
+    attr_accessor :type
+
+    # The hourly rate at which the income is paid.
+    # @return [Float]
+    attr_accessor :rate
+
+    # The number of hours logged for this income for this pay period.
+    # @return [Float]
+    attr_accessor :hours
+
+    # The total pay for this pay period.
+    # @return [Float]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['rate'] = 'rate'
+      @_hash['hours'] = 'hours'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        rate
+        hours
+        total
+      ]
+    end
+
+    def initialize(type:, rate:, hours:, total:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type
+      @rate = rate
+      @hours = hours
+      @total = total
+      @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.
+      type = hash.key?('type') ? hash['type'] : nil
+      rate = hash.key?('rate') ? hash['rate'] : nil
+      hours = hash.key?('hours') ? hash['hours'] : nil
+      total = hash.key?('total') ? hash['total'] : 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.
+      IncomeBreakdown.new(type: type,
+                          rate: rate,
+                          hours: hours,
+                          total: total,
+                          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} type: #{@type}, rate: #{@rate}, hours: #{@hours}, total: #{@total},"\
+      " 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} type: #{@type.inspect}, rate: #{@rate.inspect}, hours: #{@hours.inspect},"\
+      " total: #{@total.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end