apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/investments_transactions_get_request_options.rb

@@ -0,0 +1,96 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/investments/transactions/get` results. If
+  # provided, must be non-`null`.
+  class InvestmentsTransactionsGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of `account_ids` to retrieve for the Item.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # The number of transactions to fetch.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The number of transactions to skip when fetching transaction history
+    # @return [Integer]
+    attr_accessor :offset
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'account_ids'
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+        count
+        offset
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, count: 100, offset: 0,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == SKIP
+      @count = count unless count == SKIP
+      @offset = offset unless offset == 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
+      count = hash['count'] ||= 100
+      offset = hash['offset'] ||= 0
+
+      # 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.
+      InvestmentsTransactionsGetRequestOptions.new(account_ids: account_ids,
+                                                   count: count,
+                                                   offset: offset,
+                                                   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}, count: #{@count}, offset: #{@offset},"\
+      " 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}, count: #{@count.inspect}, offset:"\
+      " #{@offset.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/investments_transactions_get_response.rb

@@ -0,0 +1,156 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # InvestmentsTransactionsGetResponse defines the response schema for
+  # `/investments/transactions/get`
+  class InvestmentsTransactionsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata about the Item.
+    # @return [Item]
+    attr_accessor :item
+
+    # The accounts for which transaction history is being fetched.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # All securities for which there is a corresponding transaction being
+    # fetched.
+    # @return [Array[Security]]
+    attr_accessor :securities
+
+    # The transactions being fetched
+    # @return [Array[InvestmentTransaction]]
+    attr_accessor :investment_transactions
+
+    # The total number of transactions available within the date range
+    # specified. If `total_investment_transactions` is larger than the size of
+    # the `transactions` array, more transactions are available and can be
+    # fetched via manipulating the `offset` parameter.'
+    # @return [Integer]
+    attr_accessor :total_investment_transactions
+
+    # 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['item'] = 'item'
+      @_hash['accounts'] = 'accounts'
+      @_hash['securities'] = 'securities'
+      @_hash['investment_transactions'] = 'investment_transactions'
+      @_hash['total_investment_transactions'] =
+        'total_investment_transactions'
+      @_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(item:, accounts:, securities:, investment_transactions:,
+                   total_investment_transactions:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @item = item
+      @accounts = accounts
+      @securities = securities
+      @investment_transactions = investment_transactions
+      @total_investment_transactions = total_investment_transactions
+      @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.
+      item = Item.from_hash(hash['item']) if hash['item']
+      # 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
+      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')
+      # Parameter is an array, so we need to iterate through it
+      investment_transactions = nil
+      unless hash['investment_transactions'].nil?
+        investment_transactions = []
+        hash['investment_transactions'].each do |structure|
+          investment_transactions << (InvestmentTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      investment_transactions = nil unless hash.key?('investment_transactions')
+      total_investment_transactions =
+        hash.key?('total_investment_transactions') ? hash['total_investment_transactions'] : nil
+      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.
+      InvestmentsTransactionsGetResponse.new(item: item,
+                                             accounts: accounts,
+                                             securities: securities,
+                                             investment_transactions: investment_transactions,
+                                             total_investment_transactions: total_investment_transactions,
+                                             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} item: #{@item}, accounts: #{@accounts}, securities: #{@securities},"\
+      " investment_transactions: #{@investment_transactions}, total_investment_transactions:"\
+      " #{@total_investment_transactions}, 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} item: #{@item.inspect}, accounts: #{@accounts.inspect}, securities:"\
+      " #{@securities.inspect}, investment_transactions: #{@investment_transactions.inspect},"\
+      " total_investment_transactions: #{@total_investment_transactions.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/investments_transactions_override.rb

@@ -0,0 +1,151 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specify the list of investments transactions on the account.
+  class InvestmentsTransactionsOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Posting date for the transaction. Must be formatted as an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) date.
+    # @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. Must be
+    # positive if the type is a buy and negative if the type is a sell.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # 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
+
+    # The type of the investment transaction. Possible values are:
+    # `buy`: Buying an investment
+    # `sell`: Selling an investment
+    # `cash`: Activity that modifies a cash position
+    # `fee`: A fee on the account
+    # `transfer`: Activity that modifies a position, but not through buy/sell
+    # activity e.g. options exercise, portfolio transfer
+    # @return [String]
+    attr_accessor :type
+
+    # 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['date'] = 'date'
+      @_hash['name'] = 'name'
+      @_hash['quantity'] = 'quantity'
+      @_hash['price'] = 'price'
+      @_hash['fees'] = 'fees'
+      @_hash['type'] = 'type'
+      @_hash['currency'] = 'currency'
+      @_hash['security'] = 'security'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fees
+        security
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date:, name:, quantity:, price:, type:, currency:,
+                   fees: SKIP, security: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date
+      @name = name
+      @quantity = quantity
+      @price = price
+      @fees = fees unless fees == SKIP
+      @type = type
+      @currency = currency
+      @security = security unless security == 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.
+      date = hash.key?('date') ? hash['date'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      fees = hash.key?('fees') ? hash['fees'] : SKIP
+      security = SecurityOverride.from_hash(hash['security']) if hash['security']
+
+      # 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.
+      InvestmentsTransactionsOverride.new(date: date,
+                                          name: name,
+                                          quantity: quantity,
+                                          price: price,
+                                          type: type,
+                                          currency: currency,
+                                          fees: fees,
+                                          security: security,
+                                          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}, name: #{@name}, quantity: #{@quantity}, price: #{@price},"\
+      " fees: #{@fees}, type: #{@type}, 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} date: #{@date.inspect}, name: #{@name.inspect}, quantity:"\
+      " #{@quantity.inspect}, price: #{@price.inspect}, fees: #{@fees.inspect}, type:"\
+      " #{@type.inspect}, currency: #{@currency.inspect}, security: #{@security.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/item.rb

@@ -0,0 +1,173 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Metadata about the Item.
+  class Item < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Plaid Item ID. The `item_id` is always unique; linking the same
+    # account at the same institution twice will result in two Items with
+    # different `item_id` values. Like all Plaid identifiers, the `item_id` is
+    # case-sensitive.
+    # @return [String]
+    attr_accessor :item_id
+
+    # The Plaid Institution ID associated with the Item. Field is `null` for
+    # Items created via Same Day Micro-deposits.
+    # @return [String]
+    attr_accessor :institution_id
+
+    # The URL registered to receive webhooks for the Item.
+    # @return [String]
+    attr_accessor :webhook
+
+    # 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
+
+    # A list of products available for the Item that have not yet been accessed.
+    # @return [Array[Products]]
+    attr_accessor :available_products
+
+    # A list of products that have been billed for the Item. Note -
+    # `billed_products` is populated in all environments but only requests in
+    # Production are billed.
+    # @return [Array[Products]]
+    attr_accessor :billed_products
+
+    # The RFC 3339 timestamp after which the consent provided by the end user
+    # will expire. Upon consent expiration, the item will enter the
+    # `ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED`
+    # error and maintain continuous consent, the end user can reauthenticate via
+    # Link’s update mode in advance of the consent expiration time.
+    # Note - This is only relevant for certain OAuth-based institutions. For all
+    # other institutions, this field will be null.
+    # @return [DateTime]
+    attr_accessor :consent_expiration_time
+
+    # Indicates whether an Item requires user interaction to be updated, which
+    # can be the case for Items with some forms of two-factor authentication.
+    # `background` - Item can be updated in the background
+    # `user_present_required` - Item requires user interaction to be updated
+    # @return [UpdateType]
+    attr_accessor :update_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_id'] = 'item_id'
+      @_hash['institution_id'] = 'institution_id'
+      @_hash['webhook'] = 'webhook'
+      @_hash['error'] = 'error'
+      @_hash['available_products'] = 'available_products'
+      @_hash['billed_products'] = 'billed_products'
+      @_hash['consent_expiration_time'] = 'consent_expiration_time'
+      @_hash['update_type'] = 'update_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        institution_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        institution_id
+        webhook
+        consent_expiration_time
+      ]
+    end
+
+    def initialize(item_id:, webhook:, error:, available_products:,
+                   billed_products:, consent_expiration_time:, update_type:,
+                   institution_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @item_id = item_id
+      @institution_id = institution_id unless institution_id == SKIP
+      @webhook = webhook
+      @error = error
+      @available_products = available_products
+      @billed_products = billed_products
+      @consent_expiration_time = consent_expiration_time
+      @update_type = update_type
+      @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.
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      webhook = hash.key?('webhook') ? hash['webhook'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+      available_products =
+        hash.key?('available_products') ? hash['available_products'] : nil
+      billed_products =
+        hash.key?('billed_products') ? hash['billed_products'] : nil
+      consent_expiration_time = if hash.key?('consent_expiration_time')
+                                  (DateTimeHelper.from_rfc3339(hash['consent_expiration_time']) if hash['consent_expiration_time'])
+                                end
+      update_type = hash.key?('update_type') ? hash['update_type'] : nil
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_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.
+      Item.new(item_id: item_id,
+               webhook: webhook,
+               error: error,
+               available_products: available_products,
+               billed_products: billed_products,
+               consent_expiration_time: consent_expiration_time,
+               update_type: update_type,
+               institution_id: institution_id,
+               additional_properties: additional_properties)
+    end
+
+    def to_custom_consent_expiration_time
+      DateTimeHelper.to_rfc3339(consent_expiration_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_id: #{@item_id}, institution_id: #{@institution_id}, webhook:"\
+      " #{@webhook}, error: #{@error}, available_products: #{@available_products},"\
+      " billed_products: #{@billed_products}, consent_expiration_time:"\
+      " #{@consent_expiration_time}, update_type: #{@update_type}, 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} item_id: #{@item_id.inspect}, institution_id: #{@institution_id.inspect},"\
+      " webhook: #{@webhook.inspect}, error: #{@error.inspect}, available_products:"\
+      " #{@available_products.inspect}, billed_products: #{@billed_products.inspect},"\
+      " consent_expiration_time: #{@consent_expiration_time.inspect}, update_type:"\
+      " #{@update_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/item_access_token_invalidate_request.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ItemAccessTokenInvalidateRequest defines the request schema for
+  # `/item/access_token/invalidate`
+  class ItemAccessTokenInvalidateRequest < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, client_id: SKIP, secret: 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
+      @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
+
+      # 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.
+      ItemAccessTokenInvalidateRequest.new(access_token: access_token,
+                                           client_id: client_id,
+                                           secret: secret,
+                                           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}, 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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end