apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/health_incident.rb

@@ -0,0 +1,130 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # HealthIncident Model.
+  class HealthIncident < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The start date of the incident, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g.
+    # `"2020-10-30T15:26:48Z"`.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the incident, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g.
+    # `"2020-10-30T15:26:48Z"`.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The title of the incident
+    # @return [String]
+    attr_accessor :title
+
+    # Updates on the health incident.
+    # @return [Array[IncidentUpdate]]
+    attr_accessor :incident_updates
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['title'] = 'title'
+      @_hash['incident_updates'] = 'incident_updates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date:, title:, incident_updates:, end_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date
+      @end_date = end_date unless end_date == SKIP
+      @title = title
+      @incident_updates = incident_updates
+      @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.
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      title = hash.key?('title') ? hash['title'] : nil
+      # Parameter is an array, so we need to iterate through it
+      incident_updates = nil
+      unless hash['incident_updates'].nil?
+        incident_updates = []
+        hash['incident_updates'].each do |structure|
+          incident_updates << (IncidentUpdate.from_hash(structure) if structure)
+        end
+      end
+
+      incident_updates = nil unless hash.key?('incident_updates')
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_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.
+      HealthIncident.new(start_date: start_date,
+                         title: title,
+                         incident_updates: incident_updates,
+                         end_date: end_date,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, title: #{@title},"\
+      " incident_updates: #{@incident_updates}, 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} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect}, title:"\
+      " #{@title.inspect}, incident_updates: #{@incident_updates.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/historical_balance.rb

@@ -0,0 +1,118 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing a balance held by an account in the past
+  class HistoricalBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date of the calculated historical balance, in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)
+    # @return [Date]
+    attr_accessor :date
+
+    # The total amount of funds in the account, calculated from the `current`
+    # balance in the `balance` object by subtracting inflows and adding back
+    # outflows according to the posted date of each transaction.
+    # If the account has any pending transactions, historical balance amounts on
+    # or after the date of the earliest pending transaction may differ if
+    # retrieved in subsequent Asset Reports as a result of those pending
+    # transactions posting.
+    # @return [Float]
+    attr_accessor :current
+
+    # The ISO-4217 currency code of the balance. Always `null` if
+    # `unofficial_currency_code` is non-`null`.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the balance. Always `null` if
+    # `iso_currency_code` is non-`null`.
+    # 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['date'] = 'date'
+      @_hash['current'] = 'current'
+      @_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[
+        iso_currency_code
+        unofficial_currency_code
+      ]
+    end
+
+    def initialize(date:, current:, iso_currency_code:,
+                   unofficial_currency_code:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date
+      @current = current
+      @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.
+      date = hash.key?('date') ? hash['date'] : nil
+      current = hash.key?('current') ? hash['current'] : 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.
+      HistoricalBalance.new(date: date,
+                            current: current,
+                            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} date: #{@date}, current: #{@current}, 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} date: #{@date.inspect}, current: #{@current.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/historical_update_webhook.rb

@@ -0,0 +1,124 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when an Item's historical transaction pull is completed and Plaid has
+  # prepared as much historical transaction data as possible for the Item. Once
+  # this webhook has been fired, transaction data beyond the most recent 30 days
+  # can be fetched for the Item. If [Account Select
+  # v2](https://plaid.com/docs/link/customization/#account-select) is enabled,
+  # this webhook will also be fired if account selections for the Item are
+  # updated, with `num_transactions` set to the number of net new transactions
+  # pulled after the account selection update.
+  class HistoricalUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `TRANSACTIONS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `HISTORICAL_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # 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.
+    # @return [Error]
+    attr_accessor :error
+
+    # The number of new, unfetched transactions available
+    # @return [Float]
+    attr_accessor :new_transactions
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['error'] = 'error'
+      @_hash['new_transactions'] = 'new_transactions'
+      @_hash['item_id'] = 'item_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, new_transactions:, item_id:,
+                   error: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @error = error unless error == SKIP
+      @new_transactions = new_transactions
+      @item_id = item_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      new_transactions =
+        hash.key?('new_transactions') ? hash['new_transactions'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      HistoricalUpdateWebhook.new(webhook_type: webhook_type,
+                                  webhook_code: webhook_code,
+                                  new_transactions: new_transactions,
+                                  item_id: item_id,
+                                  error: error,
+                                  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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, error:"\
+      " #{@error}, new_transactions: #{@new_transactions}, item_id: #{@item_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, error: #{@error.inspect}, new_transactions:"\
+      " #{@new_transactions.inspect}, item_id: #{@item_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/holding.rb

@@ -0,0 +1,169 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A securities holding at an institution.
+  class Holding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Plaid `account_id` associated with the holding.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The Plaid `security_id` associated with the holding.
+    # @return [String]
+    attr_accessor :security_id
+
+    # The last price given by the institution for this security.
+    # @return [Float]
+    attr_accessor :institution_price
+
+    # The date at which `institution_price` was current.
+    # @return [Date]
+    attr_accessor :institution_price_as_of
+
+    # The value of the holding, as reported by the institution.
+    # @return [Float]
+    attr_accessor :institution_value
+
+    # The cost basis of the holding.
+    # @return [Float]
+    attr_accessor :cost_basis
+
+    # The total quantity of the asset held, as reported by the financial
+    # institution. If the security is an option, `quantity` will reflect the
+    # total number of options (typically the number of contracts multiplied by
+    # 100), not the number of contracts.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The ISO-4217 currency code of the holding. Always `null` if
+    # `unofficial_currency_code` is non-`null`.
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The unofficial currency code associated with the holding. 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['account_id'] = 'account_id'
+      @_hash['security_id'] = 'security_id'
+      @_hash['institution_price'] = 'institution_price'
+      @_hash['institution_price_as_of'] = 'institution_price_as_of'
+      @_hash['institution_value'] = 'institution_value'
+      @_hash['cost_basis'] = 'cost_basis'
+      @_hash['quantity'] = 'quantity'
+      @_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[
+        institution_price_as_of
+        cost_basis
+        iso_currency_code
+        unofficial_currency_code
+      ]
+    end
+
+    def initialize(account_id:, security_id:, institution_price:,
+                   institution_price_as_of:, institution_value:, cost_basis:,
+                   quantity:, iso_currency_code:, unofficial_currency_code:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @security_id = security_id
+      @institution_price = institution_price
+      @institution_price_as_of = institution_price_as_of
+      @institution_value = institution_value
+      @cost_basis = cost_basis
+      @quantity = quantity
+      @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.
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      security_id = hash.key?('security_id') ? hash['security_id'] : nil
+      institution_price =
+        hash.key?('institution_price') ? hash['institution_price'] : nil
+      institution_price_as_of =
+        hash.key?('institution_price_as_of') ? hash['institution_price_as_of'] : nil
+      institution_value =
+        hash.key?('institution_value') ? hash['institution_value'] : nil
+      cost_basis = hash.key?('cost_basis') ? hash['cost_basis'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : 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.
+      Holding.new(account_id: account_id,
+                  security_id: security_id,
+                  institution_price: institution_price,
+                  institution_price_as_of: institution_price_as_of,
+                  institution_value: institution_value,
+                  cost_basis: cost_basis,
+                  quantity: quantity,
+                  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} account_id: #{@account_id}, security_id: #{@security_id},"\
+      " institution_price: #{@institution_price}, institution_price_as_of:"\
+      " #{@institution_price_as_of}, institution_value: #{@institution_value}, cost_basis:"\
+      " #{@cost_basis}, quantity: #{@quantity}, 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} account_id: #{@account_id.inspect}, security_id: #{@security_id.inspect},"\
+      " institution_price: #{@institution_price.inspect}, institution_price_as_of:"\
+      " #{@institution_price_as_of.inspect}, institution_value: #{@institution_value.inspect},"\
+      " cost_basis: #{@cost_basis.inspect}, quantity: #{@quantity.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/holdings_default_update_webhook.rb

@@ -0,0 +1,129 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when new or updated holdings have been detected on an investment
+  # account. The webhook typically fires once per day, after market close, in
+  # response to any newly added holdings or price changes to existing holdings.
+  class HoldingsDefaultUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `HOLDINGS`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `DEFAULT_UPDATE`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # 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.
+    # @return [Error]
+    attr_accessor :error
+
+    # The number of new holdings reported since the last time this webhook was
+    # fired.
+    # @return [Float]
+    attr_accessor :new_holdings
+
+    # The number of updated holdings reported since the last time this webhook
+    # was fired.
+    # @return [Float]
+    attr_accessor :updated_holdings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['item_id'] = 'item_id'
+      @_hash['error'] = 'error'
+      @_hash['new_holdings'] = 'new_holdings'
+      @_hash['updated_holdings'] = 'updated_holdings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, item_id:, new_holdings:,
+                   updated_holdings:, error: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @item_id = item_id
+      @error = error unless error == SKIP
+      @new_holdings = new_holdings
+      @updated_holdings = updated_holdings
+      @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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      new_holdings = hash.key?('new_holdings') ? hash['new_holdings'] : nil
+      updated_holdings =
+        hash.key?('updated_holdings') ? hash['updated_holdings'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      HoldingsDefaultUpdateWebhook.new(webhook_type: webhook_type,
+                                       webhook_code: webhook_code,
+                                       item_id: item_id,
+                                       new_holdings: new_holdings,
+                                       updated_holdings: updated_holdings,
+                                       error: error,
+                                       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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, item_id:"\
+      " #{@item_id}, error: #{@error}, new_holdings: #{@new_holdings}, updated_holdings:"\
+      " #{@updated_holdings}, 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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, item_id: #{@item_id.inspect}, error: #{@error.inspect},"\
+      " new_holdings: #{@new_holdings.inspect}, updated_holdings: #{@updated_holdings.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end