apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/application.rb

@@ -0,0 +1,131 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Metadata about the application
+  class Application < 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
+
+    # 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
+
+    # 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
+
+    # 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['created_at'] = 'created_at'
+      @_hash['logo_url'] = 'logo_url'
+      @_hash['application_url'] = 'application_url'
+      @_hash['reason_for_access'] = 'reason_for_access'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        logo_url
+        application_url
+        reason_for_access
+      ]
+    end
+
+    def initialize(application_id:, name:, created_at:, logo_url:,
+                   application_url:, reason_for_access:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @application_id = application_id
+      @name = name
+      @created_at = created_at
+      @logo_url = logo_url
+      @application_url = application_url
+      @reason_for_access = reason_for_access
+      @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
+      created_at = hash.key?('created_at') ? hash['created_at'] : 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
+
+      # 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.
+      Application.new(application_id: application_id,
+                      name: name,
+                      created_at: created_at,
+                      logo_url: logo_url,
+                      application_url: application_url,
+                      reason_for_access: reason_for_access,
+                      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}, created_at:"\
+      " #{@created_at}, logo_url: #{@logo_url}, application_url: #{@application_url},"\
+      " reason_for_access: #{@reason_for_access}, 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},"\
+      " created_at: #{@created_at.inspect}, logo_url: #{@logo_url.inspect}, application_url:"\
+      " #{@application_url.inspect}, reason_for_access: #{@reason_for_access.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/application_get_request.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ApplicationGetResponse defines the schema for `/application/get`
+  class ApplicationGetRequest < 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
+
+    # 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
+
+    # 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['application_id'] = 'application_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_id:, secret:, application_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_id = client_id
+      @secret = secret
+      @application_id = application_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.
+      client_id = hash.key?('client_id') ? hash['client_id'] : nil
+      secret = hash.key?('secret') ? hash['secret'] : nil
+      application_id =
+        hash.key?('application_id') ? hash['application_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.
+      ApplicationGetRequest.new(client_id: client_id,
+                                secret: secret,
+                                application_id: application_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} client_id: #{@client_id}, secret: #{@secret}, application_id:"\
+      " #{@application_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
+      " application_id: #{@application_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/application_get_response.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The request ID associated with this call.
+  class ApplicationGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # Metadata about the application
+    # @return [Application]
+    attr_accessor :application
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'request_id'
+      @_hash['application'] = 'application'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id:, application:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_id = request_id
+      @application = application
+      @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.
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      application = Application.from_hash(hash['application']) if hash['application']
+
+      # 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.
+      ApplicationGetResponse.new(request_id: request_id,
+                                 application: application,
+                                 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} request_id: #{@request_id}, application: #{@application},"\
+      " 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} request_id: #{@request_id.inspect}, application: #{@application.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/apr.rb

@@ -0,0 +1,109 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Information about the APR on the account.
+  class Apr < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Annual Percentage Rate applied.
+    # @return [Float]
+    attr_accessor :apr_percentage
+
+    # The type of balance to which the APR applies.
+    # @return [AprType]
+    attr_accessor :apr_type
+
+    # Amount of money that is subjected to the APR if a balance was carried
+    # beyond payment due date. How it is calculated can vary by card issuer. It
+    # is often calculated as an average daily balance.
+    # @return [Float]
+    attr_accessor :balance_subject_to_apr
+
+    # Amount of money charged due to interest from last statement.
+    # @return [Float]
+    attr_accessor :interest_charge_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['apr_percentage'] = 'apr_percentage'
+      @_hash['apr_type'] = 'apr_type'
+      @_hash['balance_subject_to_apr'] = 'balance_subject_to_apr'
+      @_hash['interest_charge_amount'] = 'interest_charge_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        balance_subject_to_apr
+        interest_charge_amount
+      ]
+    end
+
+    def initialize(apr_percentage:, apr_type:, balance_subject_to_apr:,
+                   interest_charge_amount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @apr_percentage = apr_percentage
+      @apr_type = apr_type
+      @balance_subject_to_apr = balance_subject_to_apr
+      @interest_charge_amount = interest_charge_amount
+      @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.
+      apr_percentage =
+        hash.key?('apr_percentage') ? hash['apr_percentage'] : nil
+      apr_type = hash.key?('apr_type') ? hash['apr_type'] : nil
+      balance_subject_to_apr =
+        hash.key?('balance_subject_to_apr') ? hash['balance_subject_to_apr'] : nil
+      interest_charge_amount =
+        hash.key?('interest_charge_amount') ? hash['interest_charge_amount'] : 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.
+      Apr.new(apr_percentage: apr_percentage,
+              apr_type: apr_type,
+              balance_subject_to_apr: balance_subject_to_apr,
+              interest_charge_amount: interest_charge_amount,
+              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} apr_percentage: #{@apr_percentage}, apr_type: #{@apr_type},"\
+      " balance_subject_to_apr: #{@balance_subject_to_apr}, interest_charge_amount:"\
+      " #{@interest_charge_amount}, 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} apr_percentage: #{@apr_percentage.inspect}, apr_type: #{@apr_type.inspect},"\
+      " balance_subject_to_apr: #{@balance_subject_to_apr.inspect}, interest_charge_amount:"\
+      " #{@interest_charge_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/apr_type.rb

@@ -0,0 +1,44 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of balance to which the APR applies.
+  class AprType
+    APR_TYPE = [
+      # TODO: Write general description for BALANCE_TRANSFER_APR
+      BALANCE_TRANSFER_APR = 'balance_transfer_apr'.freeze,
+
+      # TODO: Write general description for CASH_APR
+      CASH_APR = 'cash_apr'.freeze,
+
+      # TODO: Write general description for PURCHASE_APR
+      PURCHASE_APR = 'purchase_apr'.freeze,
+
+      # TODO: Write general description for SPECIAL
+      SPECIAL = 'special'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BALANCE_TRANSFER_APR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'balance_transfer_apr' then BALANCE_TRANSFER_APR
+      when 'cash_apr' then CASH_APR
+      when 'purchase_apr' then PURCHASE_APR
+      when 'special' then SPECIAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/asset_report.rb

@@ -0,0 +1,145 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # An object representing an Asset Report
+  class AssetReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique ID identifying an Asset Report. Like all Plaid identifiers, this
+    # ID is case sensitive.
+    # @return [String]
+    attr_accessor :asset_report_id
+
+    # An identifier you determine and submit for the Asset Report.
+    # @return [String]
+    attr_accessor :client_report_id
+
+    # The date and time when the Asset Report was created, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g.
+    # "2018-04-12T03:32:11Z").
+    # @return [DateTime]
+    attr_accessor :date_generated
+
+    # The duration of transaction history you requested
+    # @return [Float]
+    attr_accessor :days_requested
+
+    # The user object allows you to provide additional information about the
+    # user to be appended to the Asset Report. All fields are optional. The
+    # `first_name`, `last_name`, and `ssn` fields are required if you would like
+    # the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
+    # @return [AssetReportUser]
+    attr_accessor :user
+
+    # Data returned by Plaid about each of the Items included in the Asset
+    # Report.
+    # @return [Array[AssetReportItem]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_report_id'] = 'asset_report_id'
+      @_hash['client_report_id'] = 'client_report_id'
+      @_hash['date_generated'] = 'date_generated'
+      @_hash['days_requested'] = 'days_requested'
+      @_hash['user'] = 'user'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_report_id:, client_report_id:, date_generated:,
+                   days_requested:, user:, items:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_report_id = asset_report_id
+      @client_report_id = client_report_id
+      @date_generated = date_generated
+      @days_requested = days_requested
+      @user = user
+      @items = items
+      @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.
+      asset_report_id =
+        hash.key?('asset_report_id') ? hash['asset_report_id'] : nil
+      client_report_id =
+        hash.key?('client_report_id') ? hash['client_report_id'] : nil
+      date_generated = if hash.key?('date_generated')
+                         (DateTimeHelper.from_rfc3339(hash['date_generated']) if hash['date_generated'])
+                       end
+      days_requested =
+        hash.key?('days_requested') ? hash['days_requested'] : nil
+      user = AssetReportUser.from_hash(hash['user']) if hash['user']
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (AssetReportItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # 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.
+      AssetReport.new(asset_report_id: asset_report_id,
+                      client_report_id: client_report_id,
+                      date_generated: date_generated,
+                      days_requested: days_requested,
+                      user: user,
+                      items: items,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_date_generated
+      DateTimeHelper.to_rfc3339(date_generated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} asset_report_id: #{@asset_report_id}, client_report_id:"\
+      " #{@client_report_id}, date_generated: #{@date_generated}, days_requested:"\
+      " #{@days_requested}, user: #{@user}, items: #{@items}, 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} asset_report_id: #{@asset_report_id.inspect}, client_report_id:"\
+      " #{@client_report_id.inspect}, date_generated: #{@date_generated.inspect}, days_requested:"\
+      " #{@days_requested.inspect}, user: #{@user.inspect}, items: #{@items.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end