apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/investment_transaction.rb

@@ -0,0 +1,231 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A transaction within an investment account.
+  class InvestmentTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the Investment transaction, unique across all Plaid
+    # transactions. Like all Plaid identifiers, the `investment_transaction_id`
+    # is case sensitive.
+    # @return [String]
+    attr_accessor :investment_transaction_id
+
+    # A legacy field formerly used internally by Plaid to identify certain
+    # canceled transactions.
+    # @return [String]
+    attr_accessor :cancel_transaction_id
+
+    # The `account_id` of the account against which this transaction posted.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The `security_id` to which this transaction is related.
+    # @return [String]
+    attr_accessor :security_id
+
+    # The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the
+    # transaction, or transacted date for pending transactions.
+    # @return [Date]
+    attr_accessor :date
+
+    # The institution’s description of the transaction.
+    # @return [String]
+    attr_accessor :name
+
+    # The number of units of the security involved in this transaction.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The complete value of the transaction. Positive values when cash is
+    # debited, e.g. purchases of stock; negative values when cash is credited,
+    # e.g. sales of stock. Treatment remains the same for cash-only movements
+    # unassociated with securities.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The price of the security at which this transaction occurred.
+    # @return [Float]
+    attr_accessor :price
+
+    # The combined value of all fees applied to this transaction
+    # @return [Float]
+    attr_accessor :fees
+
+    # Value is one of the following:
+    # `buy`: Buying an investment
+    # `sell`: Selling an investment
+    # `cancel`: A cancellation of a pending transaction
+    # `cash`: Activity that modifies a cash position
+    # `fee`: A fee on the account
+    # `transfer`: Activity which modifies a position, but not through buy/sell
+    # activity e.g. options exercise, portfolio transfer
+    # For descriptions of possible transaction types and subtypes, see the
+    # [Investment transaction types
+    # schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-
+    # schema).
+    # @return [Type4]
+    attr_accessor :type
+
+    # For descriptions of possible transaction types and subtypes, see the
+    # [Investment transaction types
+    # schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-
+    # schema).
+    # @return [Subtype]
+    attr_accessor :subtype
+
+    # The ISO-4217 currency code of the transaction. 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['investment_transaction_id'] = 'investment_transaction_id'
+      @_hash['cancel_transaction_id'] = 'cancel_transaction_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash['security_id'] = 'security_id'
+      @_hash['date'] = 'date'
+      @_hash['name'] = 'name'
+      @_hash['quantity'] = 'quantity'
+      @_hash['amount'] = 'amount'
+      @_hash['price'] = 'price'
+      @_hash['fees'] = 'fees'
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancel_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        cancel_transaction_id
+        security_id
+        fees
+        iso_currency_code
+        unofficial_currency_code
+      ]
+    end
+
+    def initialize(investment_transaction_id:, account_id:, security_id:, date:,
+                   name:, quantity:, amount:, price:, fees:, type:, subtype:,
+                   iso_currency_code:, unofficial_currency_code:,
+                   cancel_transaction_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @investment_transaction_id = investment_transaction_id
+      @cancel_transaction_id = cancel_transaction_id unless cancel_transaction_id == SKIP
+      @account_id = account_id
+      @security_id = security_id
+      @date = date
+      @name = name
+      @quantity = quantity
+      @amount = amount
+      @price = price
+      @fees = fees
+      @type = type
+      @subtype = subtype
+      @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.
+      investment_transaction_id =
+        hash.key?('investment_transaction_id') ? hash['investment_transaction_id'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      security_id = hash.key?('security_id') ? hash['security_id'] : nil
+      date = hash.key?('date') ? hash['date'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      fees = hash.key?('fees') ? hash['fees'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      subtype = hash.key?('subtype') ? hash['subtype'] : 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
+      cancel_transaction_id =
+        hash.key?('cancel_transaction_id') ? hash['cancel_transaction_id'] : 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.
+      InvestmentTransaction.new(investment_transaction_id: investment_transaction_id,
+                                account_id: account_id,
+                                security_id: security_id,
+                                date: date,
+                                name: name,
+                                quantity: quantity,
+                                amount: amount,
+                                price: price,
+                                fees: fees,
+                                type: type,
+                                subtype: subtype,
+                                iso_currency_code: iso_currency_code,
+                                unofficial_currency_code: unofficial_currency_code,
+                                cancel_transaction_id: cancel_transaction_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} investment_transaction_id: #{@investment_transaction_id},"\
+      " cancel_transaction_id: #{@cancel_transaction_id}, account_id: #{@account_id}, security_id:"\
+      " #{@security_id}, date: #{@date}, name: #{@name}, quantity: #{@quantity}, amount:"\
+      " #{@amount}, price: #{@price}, fees: #{@fees}, type: #{@type}, subtype: #{@subtype},"\
+      " 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} investment_transaction_id: #{@investment_transaction_id.inspect},"\
+      " cancel_transaction_id: #{@cancel_transaction_id.inspect}, account_id:"\
+      " #{@account_id.inspect}, security_id: #{@security_id.inspect}, date: #{@date.inspect},"\
+      " name: #{@name.inspect}, quantity: #{@quantity.inspect}, amount: #{@amount.inspect}, price:"\
+      " #{@price.inspect}, fees: #{@fees.inspect}, type: #{@type.inspect}, subtype:"\
+      " #{@subtype.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/investments_holdings_get_request.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InvestmentsHoldingsGetRequest defines the request schema for
+  # `/investments/holdings/get`
+  class InvestmentsHoldingsGetRequest < 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 `/investments/holdings/get` results. If
+    # provided, must not be `null`.
+    # @return [InvestmentHoldingsGetRequestOptions]
+    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 = InvestmentHoldingsGetRequestOptions.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.
+      InvestmentsHoldingsGetRequest.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/investments_holdings_get_response.rb

@@ -0,0 +1,142 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InvestmentsHoldingsGetResponse defines the response schema for
+  # `/investments/holdings/get`
+  class InvestmentsHoldingsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The accounts associated with the Item
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # The holdings belonging to investment accounts associated with the Item.
+    # Details of the securities in the holdings are provided in the `securities`
+    # field.
+    # @return [Array[Holding]]
+    attr_accessor :holdings
+
+    # Objects describing the securities held in the accounts associated with the
+    # Item.
+    # @return [Array[Security]]
+    attr_accessor :securities
+
+    # 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['holdings'] = 'holdings'
+      @_hash['securities'] = 'securities'
+      @_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:, holdings:, securities:, item:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @holdings = holdings
+      @securities = securities
+      @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 << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = nil unless hash.key?('accounts')
+      # Parameter is an array, so we need to iterate through it
+      holdings = nil
+      unless hash['holdings'].nil?
+        holdings = []
+        hash['holdings'].each do |structure|
+          holdings << (Holding.from_hash(structure) if structure)
+        end
+      end
+
+      holdings = nil unless hash.key?('holdings')
+      # Parameter is an array, so we need to iterate through it
+      securities = nil
+      unless hash['securities'].nil?
+        securities = []
+        hash['securities'].each do |structure|
+          securities << (Security.from_hash(structure) if structure)
+        end
+      end
+
+      securities = nil unless hash.key?('securities')
+      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.
+      InvestmentsHoldingsGetResponse.new(accounts: accounts,
+                                         holdings: holdings,
+                                         securities: securities,
+                                         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}, holdings: #{@holdings}, securities: #{@securities},"\
+      " 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}, holdings: #{@holdings.inspect}, securities:"\
+      " #{@securities.inspect}, item: #{@item.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/investments_transactions_get_request.rb

@@ -0,0 +1,130 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InvestmentsTransactionsGetRequest defines the request schema for
+  # `/investments/transactions/get`
+  class InvestmentsTransactionsGetRequest < 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
+
+    # The earliest date for which to fetch transaction history. Dates should be
+    # formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The most recent date for which to fetch transaction history. Dates should
+    # be formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # An optional object to filter `/investments/transactions/get` results. If
+    # provided, must be non-`null`.
+    # @return [InvestmentsTransactionsGetRequestOptions]
+    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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_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:, start_date:, end_date:, 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
+      @start_date = start_date
+      @end_date = end_date
+      @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
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = InvestmentsTransactionsGetRequestOptions.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.
+      InvestmentsTransactionsGetRequest.new(access_token: access_token,
+                                            start_date: start_date,
+                                            end_date: end_date,
+                                            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}, start_date: #{@start_date}, end_date: #{@end_date}, 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}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end