apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/processor_token_create_response.rb

@@ -0,0 +1,87 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorTokenCreateResponse defines the response schema for
+  # `/processor/token/create` and `/processor/apex/processor_token/create`
+  class ProcessorTokenCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The `processor_token` that can then be used by the Plaid partner to make
+    # API requests
+    # @return [String]
+    attr_accessor :processor_token
+
+    # 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['processor_token'] = 'processor_token'
+      @_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(processor_token:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @processor_token = processor_token
+      @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.
+      processor_token =
+        hash.key?('processor_token') ? hash['processor_token'] : 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.
+      ProcessorTokenCreateResponse.new(processor_token: processor_token,
+                                       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} processor_token: #{@processor_token}, 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} processor_token: #{@processor_token.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/product_access.rb

@@ -0,0 +1,112 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The product access being requested. Used to or disallow product access
+  # across all accounts. If unset, defaults to all products allowed.
+  class ProductAccess < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allow access to statements. If unset, defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :statements
+
+    # Allow access to the Identity product (name, email, phone, address). If
+    # unset, defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :identity
+
+    # Allow access to account number details. If unset, defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auth
+
+    # Allow access to transaction details. If unset, defaults to `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['statements'] = 'statements'
+      @_hash['identity'] = 'identity'
+      @_hash['auth'] = 'auth'
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        statements
+        identity
+        auth
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        statements
+        identity
+        auth
+        transactions
+      ]
+    end
+
+    def initialize(statements: true, identity: true, auth: true,
+                   transactions: true, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @statements = statements unless statements == SKIP
+      @identity = identity unless identity == SKIP
+      @auth = auth unless auth == SKIP
+      @transactions = transactions unless transactions == 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.
+      statements = hash['statements'] ||= true
+      identity = hash['identity'] ||= true
+      auth = hash['auth'] ||= true
+      transactions = hash['transactions'] ||= true
+
+      # 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.
+      ProductAccess.new(statements: statements,
+                        identity: identity,
+                        auth: auth,
+                        transactions: transactions,
+                        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} statements: #{@statements}, identity: #{@identity}, auth: #{@auth},"\
+      " transactions: #{@transactions}, 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} statements: #{@statements.inspect}, identity: #{@identity.inspect}, auth:"\
+      " #{@auth.inspect}, transactions: #{@transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/product_data_type.rb

@@ -0,0 +1,40 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProductDataType.
+  class ProductDataType
+    PRODUCT_DATA_TYPE = [
+      # TODO: Write general description for ACCOUNT_BALANCE
+      ACCOUNT_BALANCE = 'ACCOUNT_BALANCE'.freeze,
+
+      # TODO: Write general description for ACCOUNT_USER_INFO
+      ACCOUNT_USER_INFO = 'ACCOUNT_USER_INFO'.freeze,
+
+      # TODO: Write general description for ACCOUNT_TRANSACTIONS
+      ACCOUNT_TRANSACTIONS = 'ACCOUNT_TRANSACTIONS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACCOUNT_BALANCE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_balance' then ACCOUNT_BALANCE
+      when 'account_user_info' then ACCOUNT_USER_INFO
+      when 'account_transactions' then ACCOUNT_TRANSACTIONS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/product_status.rb

@@ -0,0 +1,106 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # A representation of the status health of a request type. Auth requests,
+  # Balance requests, Identity requests, Investments requests, Liabilities
+  # requests, Transactions updates, Investments updates, Liabilities updates,
+  # and Item logins each have their own status object.
+  class ProductStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `HEALTHY`: the majority of requests are successful
+    # `DEGRADED`: only some requests are successful
+    # `DOWN`: all requests are failing
+    # @return [Status]
+    attr_accessor :status
+
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) formatted timestamp of the
+    # last status change for the institution.
+    # @return [DateTime]
+    attr_accessor :last_status_change
+
+    # A detailed breakdown of the institution's performance for a request type.
+    # The values for `success`, `error_plaid`, and `error_institution` sum to 1.
+    # @return [StatusBreakdown]
+    attr_accessor :breakdown
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['last_status_change'] = 'last_status_change'
+      @_hash['breakdown'] = 'breakdown'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, last_status_change:, breakdown:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status
+      @last_status_change = last_status_change
+      @breakdown = breakdown
+      @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.
+      status = hash.key?('status') ? hash['status'] : nil
+      last_status_change = if hash.key?('last_status_change')
+                             (DateTimeHelper.from_rfc3339(hash['last_status_change']) if hash['last_status_change'])
+                           end
+      breakdown = StatusBreakdown.from_hash(hash['breakdown']) if hash['breakdown']
+
+      # 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.
+      ProductStatus.new(status: status,
+                        last_status_change: last_status_change,
+                        breakdown: breakdown,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_last_status_change
+      DateTimeHelper.to_rfc3339(last_status_change)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, last_status_change: #{@last_status_change}, breakdown:"\
+      " #{@breakdown}, 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} status: #{@status.inspect}, last_status_change:"\
+      " #{@last_status_change.inspect}, breakdown: #{@breakdown.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/products.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A list of products that an institution can support. All Items must be
+  # initialized with at least one product. The Balance product is always
+  # available and does not need to be specified during initialization.
+  class Products
+    PRODUCTS = [
+      # TODO: Write general description for ASSETS
+      ASSETS = 'assets'.freeze,
+
+      # TODO: Write general description for AUTH
+      AUTH = 'auth'.freeze,
+
+      # TODO: Write general description for BALANCE
+      BALANCE = 'balance'.freeze,
+
+      # TODO: Write general description for IDENTITY
+      IDENTITY = 'identity'.freeze,
+
+      # TODO: Write general description for INVESTMENTS
+      INVESTMENTS = 'investments'.freeze,
+
+      # TODO: Write general description for LIABILITIES
+      LIABILITIES = 'liabilities'.freeze,
+
+      # TODO: Write general description for PAYMENT_INITIATION
+      PAYMENT_INITIATION = 'payment_initiation'.freeze,
+
+      # TODO: Write general description for TRANSACTIONS
+      TRANSACTIONS = 'transactions'.freeze,
+
+      # TODO: Write general description for CREDIT_DETAILS
+      CREDIT_DETAILS = 'credit_details'.freeze,
+
+      # TODO: Write general description for INCOME
+      INCOME = 'income'.freeze,
+
+      # TODO: Write general description for INCOME_VERIFICATION
+      INCOME_VERIFICATION = 'income_verification'.freeze,
+
+      # TODO: Write general description for DEPOSIT_SWITCH
+      DEPOSIT_SWITCH = 'deposit_switch'.freeze,
+
+      # TODO: Write general description for STANDING_ORDERS
+      STANDING_ORDERS = 'standing_orders'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'transfer'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ASSETS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'assets' then ASSETS
+      when 'auth' then AUTH
+      when 'balance' then BALANCE
+      when 'identity' then IDENTITY
+      when 'investments' then INVESTMENTS
+      when 'liabilities' then LIABILITIES
+      when 'payment_initiation' then PAYMENT_INITIATION
+      when 'transactions' then TRANSACTIONS
+      when 'credit_details' then CREDIT_DETAILS
+      when 'income' then INCOME
+      when 'income_verification' then INCOME_VERIFICATION
+      when 'deposit_switch' then DEPOSIT_SWITCH
+      when 'standing_orders' then STANDING_ORDERS
+      when 'transfer' then TRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/projected_income_summary_field_number.rb

@@ -0,0 +1,90 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProjectedIncomeSummaryFieldNumber Model.
+  class ProjectedIncomeSummaryFieldNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value of the field.
+    # @return [Float]
+    attr_accessor :value
+
+    # The verification status. One of the following:
+    # `"VERIFIED"`: The information was successfully verified.
+    # `"UNVERIFIED"`: The verification has not yet been performed.
+    # `"NEEDS_INFO"`: The verification was attempted but could not be completed
+    # due to missing information.
+    # "`UNABLE_TO_VERIFY`": The verification was performed and the information
+    # could not be verified.
+    # `"UNKNOWN"`: The verification status is unknown.
+    # @return [VerificationStatus]
+    attr_accessor :verification_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:, verification_status:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value
+      @verification_status = verification_status
+      @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.
+      value = hash.key?('value') ? hash['value'] : nil
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : 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.
+      ProjectedIncomeSummaryFieldNumber.new(value: value,
+                                            verification_status: verification_status,
+                                            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} value: #{@value}, verification_status: #{@verification_status},"\
+      " 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} value: #{@value.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/pslf_status.rb

@@ -0,0 +1,103 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Information about the student's eligibility in the Public Service Loan
+  # Forgiveness program. This is only returned if the institution is Fedloan
+  # (`ins_116527`).
+  class PslfStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The estimated date borrower will have completed 120 qualifying monthly
+    # payments. Returned in [ISO 8601](https://wikipedia.org/wiki/ISO_8601)
+    # format (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :estimated_eligibility_date
+
+    # The number of qualifying payments that have been made.
+    # @return [Float]
+    attr_accessor :payments_made
+
+    # The number of qualifying payments remaining.
+    # @return [Float]
+    attr_accessor :payments_remaining
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['estimated_eligibility_date'] = 'estimated_eligibility_date'
+      @_hash['payments_made'] = 'payments_made'
+      @_hash['payments_remaining'] = 'payments_remaining'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        estimated_eligibility_date
+        payments_made
+        payments_remaining
+      ]
+    end
+
+    def initialize(estimated_eligibility_date:, payments_made:,
+                   payments_remaining:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @estimated_eligibility_date = estimated_eligibility_date
+      @payments_made = payments_made
+      @payments_remaining = payments_remaining
+      @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.
+      estimated_eligibility_date =
+        hash.key?('estimated_eligibility_date') ? hash['estimated_eligibility_date'] : nil
+      payments_made = hash.key?('payments_made') ? hash['payments_made'] : nil
+      payments_remaining =
+        hash.key?('payments_remaining') ? hash['payments_remaining'] : 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.
+      PslfStatus.new(estimated_eligibility_date: estimated_eligibility_date,
+                     payments_made: payments_made,
+                     payments_remaining: payments_remaining,
+                     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} estimated_eligibility_date: #{@estimated_eligibility_date}, payments_made:"\
+      " #{@payments_made}, payments_remaining: #{@payments_remaining}, 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} estimated_eligibility_date: #{@estimated_eligibility_date.inspect},"\
+      " payments_made: #{@payments_made.inspect}, payments_remaining:"\
+      " #{@payments_remaining.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end