apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transaction_override.rb

@@ -0,0 +1,119 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Data to populate as test transaction data. If not specified, random
+  # transactions will be generated instead.
+  class TransactionOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date of the transaction, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.
+    # Transaction dates in the past or present will result in posted
+    # transactions; transaction dates in the future will result in pending
+    # transactions. Transactions in Sandbox will move from pending to posted
+    # once their transaction date has been reached.
+    # @return [Date]
+    attr_accessor :date_transacted
+
+    # The date the transaction posted, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format
+    # @return [Date]
+    attr_accessor :date_posted
+
+    # The transaction amount. Can be negative.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The transaction description.
+    # @return [String]
+    attr_accessor :description
+
+    # The ISO-4217 format currency code for the transaction.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_transacted'] = 'date_transacted'
+      @_hash['date_posted'] = 'date_posted'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_transacted:, date_posted:, amount:, description:,
+                   currency: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date_transacted = date_transacted
+      @date_posted = date_posted
+      @amount = amount
+      @description = description
+      @currency = currency unless currency == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      date_transacted =
+        hash.key?('date_transacted') ? hash['date_transacted'] : nil
+      date_posted = hash.key?('date_posted') ? hash['date_posted'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TransactionOverride.new(date_transacted: date_transacted,
+                              date_posted: date_posted,
+                              amount: amount,
+                              description: description,
+                              currency: currency,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date_transacted: #{@date_transacted}, date_posted: #{@date_posted}, amount:"\
+      " #{@amount}, description: #{@description}, currency: #{@currency}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date_transacted: #{@date_transacted.inspect}, date_posted:"\
+      " #{@date_posted.inspect}, amount: #{@amount.inspect}, description: #{@description.inspect},"\
+      " currency: #{@currency.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transaction_type.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Please use the `payment_channel` field, `transaction_type` will be
+  # deprecated in the future. `digital:` transactions that took place online.
+  # `place:` transactions that were made at a physical location. `special:`
+  # transactions that relate to banks, e.g. fees or deposits. `unresolved:`
+  # transactions that do not fit into the other three types.
+  class TransactionType
+    TRANSACTION_TYPE = [
+      # TODO: Write general description for DIGITAL
+      DIGITAL = 'digital'.freeze,
+
+      # TODO: Write general description for PLACE
+      PLACE = 'place'.freeze,
+
+      # TODO: Write general description for SPECIAL
+      SPECIAL = 'special'.freeze,
+
+      # TODO: Write general description for UNRESOLVED
+      UNRESOLVED = 'unresolved'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DIGITAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'digital' then DIGITAL
+      when 'place' then PLACE
+      when 'special' then SPECIAL
+      when 'unresolved' then UNRESOLVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/transactions_get_request.rb

@@ -0,0 +1,128 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # TransactionsGetRequest defines the request schema for `/transactions/get`
+  class TransactionsGetRequest < 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
+
+    # An optional object to be used with the request. If specified, `options`
+    # must not be `null`.
+    # @return [TransactionsGetRequestOptions]
+    attr_accessor :options
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_token
+
+    # 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 earliest date for which data should be returned. Dates should be
+    # formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The latest date for which data should be returned. Dates should be
+    # formatted as YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['options'] = 'options'
+      @_hash['access_token'] = 'access_token'
+      @_hash['secret'] = 'secret'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        options
+        secret
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, start_date:, end_date:, client_id: SKIP,
+                   options: 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
+      @options = options unless options == SKIP
+      @access_token = access_token
+      @secret = secret unless secret == SKIP
+      @start_date = start_date
+      @end_date = end_date
+      @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
+      options = TransactionsGetRequestOptions.from_hash(hash['options']) if hash['options']
+      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.
+      TransactionsGetRequest.new(access_token: access_token,
+                                 start_date: start_date,
+                                 end_date: end_date,
+                                 client_id: client_id,
+                                 options: options,
+                                 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}, options: #{@options}, access_token:"\
+      " #{@access_token}, secret: #{@secret}, start_date: #{@start_date}, end_date: #{@end_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} client_id: #{@client_id.inspect}, options: #{@options.inspect},"\
+      " access_token: #{@access_token.inspect}, secret: #{@secret.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transactions_get_request_options.rb

@@ -0,0 +1,139 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to be used with the request. If specified, `options` must
+  # not be `null`.
+  class TransactionsGetRequestOptions < 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
+
+    # The number of transactions to fetch.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The number of transactions to skip. The default value is 0.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # Include the raw unparsed transaction description from the financial
+    # institution. This field is disabled by default. If you need this
+    # information in addition to the parsed data provided, contact your Plaid
+    # Account Manager.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_original_description
+
+    # Include the `personal_finance_category` object in the response. This
+    # feature is currently in beta – to request access, contact
+    # transactions-feedback@plaid.com.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_personal_finance_category_beta
+
+    # 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['include_original_description'] = 'include_original_description'
+      @_hash['include_personal_finance_category_beta'] =
+        'include_personal_finance_category_beta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+        count
+        offset
+        include_original_description
+        include_personal_finance_category_beta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_original_description
+      ]
+    end
+
+    def initialize(account_ids: SKIP, count: 100, offset: 0,
+                   include_original_description: false,
+                   include_personal_finance_category_beta: false,
+                   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
+      unless include_original_description == SKIP
+        @include_original_description =
+          include_original_description
+      end
+      unless include_personal_finance_category_beta == SKIP
+        @include_personal_finance_category_beta =
+          include_personal_finance_category_beta
+      end
+      @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
+      include_original_description =
+        hash['include_original_description'] ||= false
+      include_personal_finance_category_beta =
+        hash['include_personal_finance_category_beta'] ||= false
+
+      # 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.
+      TransactionsGetRequestOptions.new(account_ids: account_ids,
+                                        count: count,
+                                        offset: offset,
+                                        include_original_description: include_original_description,
+                                        include_personal_finance_category_beta: include_personal_finance_category_beta,
+                                        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},"\
+      " include_original_description: #{@include_original_description},"\
+      " include_personal_finance_category_beta: #{@include_personal_finance_category_beta},"\
+      " 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}, include_original_description:"\
+      " #{@include_original_description.inspect}, include_personal_finance_category_beta:"\
+      " #{@include_personal_finance_category_beta.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transactions_get_response.rb

@@ -0,0 +1,138 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # TransactionsGetResponse defines the response schema for `/transactions/get`
+  class TransactionsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array containing the `accounts` associated with the Item for which
+    # transactions are being returned. Each transaction can be mapped to its
+    # corresponding account via the `account_id` field.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # An array containing transactions from the account. Transactions are
+    # returned in reverse chronological order, with the most recent at the
+    # beginning of the array. The maximum number of transactions returned is
+    # determined by the `count` parameter.
+    # @return [Array[Transaction]]
+    attr_accessor :transactions
+
+    # The total number of transactions available within the date range
+    # specified. If `total_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_transactions
+
+    # 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['transactions'] = 'transactions'
+      @_hash['total_transactions'] = 'total_transactions'
+      @_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:, transactions:, total_transactions:, item:,
+                   request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @transactions = transactions
+      @total_transactions = total_transactions
+      @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
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (Transaction.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = nil unless hash.key?('transactions')
+      total_transactions =
+        hash.key?('total_transactions') ? hash['total_transactions'] : nil
+      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.
+      TransactionsGetResponse.new(accounts: accounts,
+                                  transactions: transactions,
+                                  total_transactions: total_transactions,
+                                  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}, transactions: #{@transactions}, total_transactions:"\
+      " #{@total_transactions}, 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}, transactions: #{@transactions.inspect},"\
+      " total_transactions: #{@total_transactions.inspect}, item: #{@item.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transactions_refresh_request.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # TransactionsRefreshRequest defines the request schema for
+  # `/transactions/refresh`
+  class TransactionsRefreshRequest < 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
+
+    # The access token associated with the Item data is being requested for.
+    # @return [String]
+    attr_accessor :access_token
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_id'] = 'client_id'
+      @_hash['access_token'] = 'access_token'
+      @_hash['secret'] = 'secret'
+      @_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
+      @access_token = access_token
+      @secret = secret unless secret == 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
+
+      # 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.
+      TransactionsRefreshRequest.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}, access_token: #{@access_token}, secret:"\
+      " #{@secret}, 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}, access_token: #{@access_token.inspect},"\
+      " secret: #{@secret.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end