apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/accounts_balance_get_request.rb

@@ -0,0 +1,108 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountsBalanceGetRequest defines the request schema for
+  # `/accounts/balance/get`
+  class AccountsBalanceGetRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # 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 filter `/accounts/balance/get` results.
+    # @return [AccountsBalanceGetRequestOptions]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['secret'] = 'secret'
+      @_hash['client_id'] = 'client_id'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        secret
+        client_id
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, secret: SKIP, client_id: SKIP, options: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_token = access_token
+      @secret = secret unless secret == SKIP
+      @client_id = client_id unless client_id == SKIP
+      @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
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      options = AccountsBalanceGetRequestOptions.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.
+      AccountsBalanceGetRequest.new(access_token: access_token,
+                                    secret: secret,
+                                    client_id: client_id,
+                                    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} access_token: #{@access_token}, secret: #{@secret}, client_id:"\
+      " #{@client_id}, 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} access_token: #{@access_token.inspect}, secret: #{@secret.inspect},"\
+      " client_id: #{@client_id.inspect}, options: #{@options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/accounts_balance_get_request_options.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # An optional object to filter `/accounts/balance/get` results.
+  class AccountsBalanceGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of `account_ids` to retrieve for the Item. The default value is
+    # `null`.
+    # Note: An error will be returned if a provided `account_id` is not
+    # associated with the Item.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (`YYYY-MM-DDTHH:mm:ssZ`) indicating the oldest acceptable balance when
+    # making a request to `/accounts/balance/get`.
+    # If the balance that is pulled for `ins_128026` (Capital One) is older than
+    # the given timestamp, an `INVALID_REQUEST` error with the code of
+    # `LAST_UPDATED_DATETIME_OUT_OF_RANGE` will be returned with the most recent
+    # timestamp for the requested account contained in the response.
+    # This field is only used when the institution is `ins_128026` (Capital
+    # One), in which case a value must be provided or an `INVALID_REQUEST` error
+    # with the code of `INVALID_FIELD` will be returned. For all other
+    # institutions, this field is ignored.
+    # @return [DateTime]
+    attr_accessor :min_last_updated_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'account_ids'
+      @_hash['min_last_updated_datetime'] = 'min_last_updated_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+        min_last_updated_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, min_last_updated_datetime: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == SKIP
+      unless min_last_updated_datetime == SKIP
+        @min_last_updated_datetime =
+          min_last_updated_datetime
+      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
+      min_last_updated_datetime = if hash.key?('min_last_updated_datetime')
+                                    (DateTimeHelper.from_rfc3339(hash['min_last_updated_datetime']) if hash['min_last_updated_datetime'])
+                                  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.
+      AccountsBalanceGetRequestOptions.new(account_ids: account_ids,
+                                           min_last_updated_datetime: min_last_updated_datetime,
+                                           additional_properties: additional_properties)
+    end
+
+    def to_custom_min_last_updated_datetime
+      DateTimeHelper.to_rfc3339(min_last_updated_datetime)
+    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}, min_last_updated_datetime:"\
+      " #{@min_last_updated_datetime}, 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}, min_last_updated_datetime:"\
+      " #{@min_last_updated_datetime.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/accounts_get_request.rb

@@ -0,0 +1,107 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountsGetRequest defines the request schema for `/accounts/get`
+  class AccountsGetRequest < 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 `/accounts/get` results.
+    # @return [AccountsGetRequestOptions]
+    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 = AccountsGetRequestOptions.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.
+      AccountsGetRequest.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/accounts_get_request_options.rb

@@ -0,0 +1,76 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An optional object to filter `/accounts/get` results.
+  class AccountsGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of `account_ids` to retrieve for the Account.
+    # @return [Array[String]]
+    attr_accessor :account_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_ids'] = 'account_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_ids: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_ids = account_ids unless account_ids == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_ids = hash.key?('account_ids') ? hash['account_ids'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountsGetRequestOptions.new(account_ids: account_ids,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_ids: #{@account_ids}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_ids: #{@account_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/accounts_get_response.rb

@@ -0,0 +1,104 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountsGetResponse defines the response schema for `/accounts/get` and
+  # `/accounts/balance/get`.
+  class AccountsGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of financial institution accounts associated with the Item.
+    # If `/accounts/balance/get` was called, each account will include real-time
+    # balance information.
+    # @return [Array[Account]]
+    attr_accessor :accounts
+
+    # Metadata about the Item.
+    # @return [Item]
+    attr_accessor :item
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accounts'] = 'accounts'
+      @_hash['item'] = 'item'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accounts:, item:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @accounts = accounts
+      @item = item
+      @request_id = request_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      accounts = nil
+      unless hash['accounts'].nil?
+        accounts = []
+        hash['accounts'].each do |structure|
+          accounts << (Account.from_hash(structure) if structure)
+        end
+      end
+
+      accounts = nil unless hash.key?('accounts')
+      item = Item.from_hash(hash['item']) if hash['item']
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountsGetResponse.new(accounts: accounts,
+                              item: item,
+                              request_id: request_id,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accounts: #{@accounts}, item: #{@item}, request_id: #{@request_id},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} accounts: #{@accounts.inspect}, item: #{@item.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/ach_class.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Specifies the use case of the transfer.  Required for transfers on an ACH
+  # network. `"arc"` - Accounts Receivable Entry `"cbr`" - Cross Border Entry
+  # `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate
+  # bank accounts `"cie"` - Customer Initiated Entry `"cor"` - Automated
+  # Notification of Change `"ctx"` - Corporate Trade Exchange `"iat"` -
+  # International `"mte"` - Machine Transfer Entry `"pbr"` - Cross Border Entry
+  # `"pop"` - Point-of-Purchase Entry `"pos"` - Point-of-Sale Entry `"ppd"` -
+  # Prearranged Payment or Deposit - the transfer is part of a pre-existing
+  # relationship with a consumer, eg. bill payment `"rck"` - Re-presented Check
+  # Entry `"tel"` - Telephone-Initiated Entry `"web"` - Internet-Initiated Entry
+  # - debits from a consumer’s account where their authorization is obtained
+  # over the Internet
+  class AchClass
+    ACH_CLASS = [
+      # TODO: Write general description for ARC
+      ARC = 'arc'.freeze,
+
+      # TODO: Write general description for CBR
+      CBR = 'cbr'.freeze,
+
+      # TODO: Write general description for CCD
+      CCD = 'ccd'.freeze,
+
+      # TODO: Write general description for CIE
+      CIE = 'cie'.freeze,
+
+      # TODO: Write general description for COR
+      COR = 'cor'.freeze,
+
+      # TODO: Write general description for CTX
+      CTX = 'ctx'.freeze,
+
+      # TODO: Write general description for IAT
+      IAT = 'iat'.freeze,
+
+      # TODO: Write general description for MTE
+      MTE = 'mte'.freeze,
+
+      # TODO: Write general description for PBR
+      PBR = 'pbr'.freeze,
+
+      # TODO: Write general description for POP
+      POP = 'pop'.freeze,
+
+      # TODO: Write general description for POS
+      POS = 'pos'.freeze,
+
+      # TODO: Write general description for PPD
+      PPD = 'ppd'.freeze,
+
+      # TODO: Write general description for RCK
+      RCK = 'rck'.freeze,
+
+      # TODO: Write general description for TEL
+      TEL = 'tel'.freeze,
+
+      # TODO: Write general description for WEB
+      WEB = 'web'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ARC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'arc' then ARC
+      when 'cbr' then CBR
+      when 'ccd' then CCD
+      when 'cie' then CIE
+      when 'cor' then COR
+      when 'ctx' then CTX
+      when 'iat' then IAT
+      when 'mte' then MTE
+      when 'pbr' then PBR
+      when 'pop' then POP
+      when 'pos' then POS
+      when 'ppd' then PPD
+      when 'rck' then RCK
+      when 'tel' then TEL
+      when 'web' then WEB
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/address.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A physical mailing address.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Data about the components comprising an address.
+    # @return [AddressData]
+    attr_accessor :data
+
+    # When `true`, identifies the address as the primary address on an account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, primary: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @primary = primary unless primary == 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.
+      data = AddressData.from_hash(hash['data']) if hash['data']
+      primary = hash.key?('primary') ? hash['primary'] : 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.
+      Address.new(data: data,
+                  primary: primary,
+                  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} data: #{@data}, primary: #{@primary}, 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} data: #{@data.inspect}, primary: #{@primary.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end