apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/connected_application.rb

@@ -0,0 +1,177 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Describes the connected application for a particular end user.
+  class ConnectedApplication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This field will map to the application ID that is returned from
+    # /item/applications/list, or provided to the institution in an oauth
+    # redirect.
+    # @return [String]
+    attr_accessor :application_id
+
+    # The name of the application
+    # @return [String]
+    attr_accessor :name
+
+    # A URL that links to the application logo image (will be deprecated in the
+    # future, please use logo_url).
+    # @return [String]
+    attr_accessor :logo
+
+    # A URL that links to the application logo image.
+    # @return [String]
+    attr_accessor :logo_url
+
+    # The URL for the application's website
+    # @return [String]
+    attr_accessor :application_url
+
+    # A string provided by the connected app stating why they use their
+    # respective enabled products.
+    # @return [String]
+    attr_accessor :reason_for_access
+
+    # The date this application was linked in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.
+    # @return [Date]
+    attr_accessor :created_at
+
+    # (Deprecated) A list of enums representing the data collected and products
+    # enabled for this connected application.
+    # @return [Array[ProductDataType]]
+    attr_accessor :product_data_types
+
+    # (Deprecated) A list of enums representing the data collected and products
+    # enabled for this connected application.
+    # @return [ScopesNullable]
+    attr_accessor :scopes
+
+    # Scope of required and optional account features or content from a
+    # ConnectedApplication.
+    # @return [RequestedScopes]
+    attr_accessor :requested_scopes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['application_id'] = 'application_id'
+      @_hash['name'] = 'name'
+      @_hash['logo'] = 'logo'
+      @_hash['logo_url'] = 'logo_url'
+      @_hash['application_url'] = 'application_url'
+      @_hash['reason_for_access'] = 'reason_for_access'
+      @_hash['created_at'] = 'created_at'
+      @_hash['product_data_types'] = 'product_data_types'
+      @_hash['scopes'] = 'scopes'
+      @_hash['requested_scopes'] = 'requested_scopes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scopes
+        requested_scopes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        logo
+        logo_url
+        application_url
+        reason_for_access
+      ]
+    end
+
+    def initialize(application_id:, name:, logo:, logo_url:, application_url:,
+                   reason_for_access:, created_at:, product_data_types:,
+                   scopes: SKIP, requested_scopes: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @application_id = application_id
+      @name = name
+      @logo = logo
+      @logo_url = logo_url
+      @application_url = application_url
+      @reason_for_access = reason_for_access
+      @created_at = created_at
+      @product_data_types = product_data_types
+      @scopes = scopes unless scopes == SKIP
+      @requested_scopes = requested_scopes unless requested_scopes == 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.
+      application_id =
+        hash.key?('application_id') ? hash['application_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      logo = hash.key?('logo') ? hash['logo'] : nil
+      logo_url = hash.key?('logo_url') ? hash['logo_url'] : nil
+      application_url =
+        hash.key?('application_url') ? hash['application_url'] : nil
+      reason_for_access =
+        hash.key?('reason_for_access') ? hash['reason_for_access'] : nil
+      created_at = hash.key?('created_at') ? hash['created_at'] : nil
+      product_data_types =
+        hash.key?('product_data_types') ? hash['product_data_types'] : nil
+      scopes = ScopesNullable.from_hash(hash['scopes']) if hash['scopes']
+      requested_scopes = RequestedScopes.from_hash(hash['requested_scopes']) if
+        hash['requested_scopes']
+
+      # 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.
+      ConnectedApplication.new(application_id: application_id,
+                               name: name,
+                               logo: logo,
+                               logo_url: logo_url,
+                               application_url: application_url,
+                               reason_for_access: reason_for_access,
+                               created_at: created_at,
+                               product_data_types: product_data_types,
+                               scopes: scopes,
+                               requested_scopes: requested_scopes,
+                               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} application_id: #{@application_id}, name: #{@name}, logo: #{@logo},"\
+      " logo_url: #{@logo_url}, application_url: #{@application_url}, reason_for_access:"\
+      " #{@reason_for_access}, created_at: #{@created_at}, product_data_types:"\
+      " #{@product_data_types}, scopes: #{@scopes}, requested_scopes: #{@requested_scopes},"\
+      " 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} application_id: #{@application_id.inspect}, name: #{@name.inspect}, logo:"\
+      " #{@logo.inspect}, logo_url: #{@logo_url.inspect}, application_url:"\
+      " #{@application_url.inspect}, reason_for_access: #{@reason_for_access.inspect}, created_at:"\
+      " #{@created_at.inspect}, product_data_types: #{@product_data_types.inspect}, scopes:"\
+      " #{@scopes.inspect}, requested_scopes: #{@requested_scopes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/country_code.rb

@@ -0,0 +1,56 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ISO-3166-1 alpha-2 country code standard.
+  class CountryCode
+    COUNTRY_CODE = [
+      # TODO: Write general description for US
+      US = 'US'.freeze,
+
+      # TODO: Write general description for GB
+      GB = 'GB'.freeze,
+
+      # TODO: Write general description for ES
+      ES = 'ES'.freeze,
+
+      # TODO: Write general description for NL
+      NL = 'NL'.freeze,
+
+      # TODO: Write general description for FR
+      FR = 'FR'.freeze,
+
+      # TODO: Write general description for IE
+      IE = 'IE'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = US)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'us' then US
+      when 'gb' then GB
+      when 'es' then ES
+      when 'nl' then NL
+      when 'fr' then FR
+      when 'ie' then IE
+      when 'ca' then CA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/country_code1.rb

@@ -0,0 +1,36 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ISO-3166-1 alpha-2 country code standard.
+  class CountryCode1
+    COUNTRY_CODE1 = [
+      # TODO: Write general description for US
+      US = 'US'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = US)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'us' then US
+      when 'ca' then CA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/credit.rb

@@ -0,0 +1,80 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `credit`-type accounts
+  class Credit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of account subtypes to display in Link. If not specified, all
+    # account subtypes will be shown. For a full list of valid types and
+    # subtypes, see the [Account
+    # schema](https://plaid.com/docs/api/accounts#accounts-schema).
+    # @return [Array[AccountSubtype]]
+    attr_accessor :account_subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtypes'] = 'account_subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_subtypes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes unless account_subtypes == 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_subtypes =
+        hash.key?('account_subtypes') ? hash['account_subtypes'] : 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.
+      Credit.new(account_subtypes: account_subtypes,
+                 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_subtypes: #{@account_subtypes}, 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_subtypes: #{@account_subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/credit_account.rb

@@ -0,0 +1,83 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A credit card type account. Supported products for `credit` accounts are:
+  # Balance, Transactions, Identity, and Liabilities.
+  class CreditAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bank-issued credit card
+    # @return [String]
+    attr_accessor :credit_card
+
+    # PayPal-issued credit card
+    # @return [String]
+    attr_accessor :paypal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_card'] = 'credit card'
+      @_hash['paypal'] = 'paypal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_card:, paypal:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @credit_card = credit_card
+      @paypal = paypal
+      @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.
+      credit_card = hash.key?('credit card') ? hash['credit card'] : nil
+      paypal = hash.key?('paypal') ? hash['paypal'] : 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.
+      CreditAccount.new(credit_card: credit_card,
+                        paypal: paypal,
+                        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} credit_card: #{@credit_card}, paypal: #{@paypal}, 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} credit_card: #{@credit_card.inspect}, paypal: #{@paypal.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/credit_card_liability.rb

@@ -0,0 +1,164 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing a credit card account.
+  class CreditCardLiability < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the account that this liability belongs to.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The various interest rates that apply to the account.
+    # @return [Array[Apr]]
+    attr_accessor :aprs
+
+    # true if a payment is currently overdue. Availability for this field is
+    # limited.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_overdue
+
+    # The amount of the last payment.
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # The date of the last payment. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # Availability for this field is limited.
+    # @return [Date]
+    attr_accessor :last_payment_date
+
+    # The date of the last statement. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :last_statement_issue_date
+
+    # The minimum payment due for the next billing cycle.
+    # @return [Float]
+    attr_accessor :minimum_payment_amount
+
+    # The due date for the next payment. The due date is `null` if a payment is
+    # not expected. Dates are returned in an [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :next_payment_due_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['aprs'] = 'aprs'
+      @_hash['is_overdue'] = 'is_overdue'
+      @_hash['last_payment_amount'] = 'last_payment_amount'
+      @_hash['last_payment_date'] = 'last_payment_date'
+      @_hash['last_statement_issue_date'] = 'last_statement_issue_date'
+      @_hash['minimum_payment_amount'] = 'minimum_payment_amount'
+      @_hash['next_payment_due_date'] = 'next_payment_due_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_id
+        is_overdue
+        next_payment_due_date
+      ]
+    end
+
+    def initialize(account_id:, aprs:, is_overdue:, last_payment_amount:,
+                   last_payment_date:, last_statement_issue_date:,
+                   minimum_payment_amount:, next_payment_due_date:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @aprs = aprs
+      @is_overdue = is_overdue
+      @last_payment_amount = last_payment_amount
+      @last_payment_date = last_payment_date
+      @last_statement_issue_date = last_statement_issue_date
+      @minimum_payment_amount = minimum_payment_amount
+      @next_payment_due_date = next_payment_due_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.
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      aprs = nil
+      unless hash['aprs'].nil?
+        aprs = []
+        hash['aprs'].each do |structure|
+          aprs << (Apr.from_hash(structure) if structure)
+        end
+      end
+
+      aprs = nil unless hash.key?('aprs')
+      is_overdue = hash.key?('is_overdue') ? hash['is_overdue'] : nil
+      last_payment_amount =
+        hash.key?('last_payment_amount') ? hash['last_payment_amount'] : nil
+      last_payment_date =
+        hash.key?('last_payment_date') ? hash['last_payment_date'] : nil
+      last_statement_issue_date =
+        hash.key?('last_statement_issue_date') ? hash['last_statement_issue_date'] : nil
+      minimum_payment_amount =
+        hash.key?('minimum_payment_amount') ? hash['minimum_payment_amount'] : nil
+      next_payment_due_date =
+        hash.key?('next_payment_due_date') ? hash['next_payment_due_date'] : 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.
+      CreditCardLiability.new(account_id: account_id,
+                              aprs: aprs,
+                              is_overdue: is_overdue,
+                              last_payment_amount: last_payment_amount,
+                              last_payment_date: last_payment_date,
+                              last_statement_issue_date: last_statement_issue_date,
+                              minimum_payment_amount: minimum_payment_amount,
+                              next_payment_due_date: next_payment_due_date,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, aprs: #{@aprs}, is_overdue: #{@is_overdue},"\
+      " last_payment_amount: #{@last_payment_amount}, last_payment_date: #{@last_payment_date},"\
+      " last_statement_issue_date: #{@last_statement_issue_date}, minimum_payment_amount:"\
+      " #{@minimum_payment_amount}, next_payment_due_date: #{@next_payment_due_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} account_id: #{@account_id.inspect}, aprs: #{@aprs.inspect}, is_overdue:"\
+      " #{@is_overdue.inspect}, last_payment_amount: #{@last_payment_amount.inspect},"\
+      " last_payment_date: #{@last_payment_date.inspect}, last_statement_issue_date:"\
+      " #{@last_statement_issue_date.inspect}, minimum_payment_amount:"\
+      " #{@minimum_payment_amount.inspect}, next_payment_due_date:"\
+      " #{@next_payment_due_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/credit_filter.rb

@@ -0,0 +1,78 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `credit`-type accounts
+  class CreditFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of account subtypes to display in Link. If not specified, all
+    # account subtypes will be shown. For a full list of valid types and
+    # subtypes, see the [Account
+    # schema](https://plaid.com/docs/api/accounts#accounts-schema).
+    # @return [Array[AccountSubtype]]
+    attr_accessor :account_subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtypes'] = 'account_subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes
+      @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_subtypes =
+        hash.key?('account_subtypes') ? hash['account_subtypes'] : 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.
+      CreditFilter.new(account_subtypes: account_subtypes,
+                       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_subtypes: #{@account_subtypes}, 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_subtypes: #{@account_subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end