apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/user_custom_password.rb

@@ -0,0 +1,166 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Custom test accounts are configured with a JSON configuration object
+  # formulated according to the schema below. All fields are optional. Sending
+  # an empty object as a configuration will result in an account configured with
+  # random balances and transaction history.
+  class UserCustomPassword < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version of the password schema to use, possible values are 1 or 2. The
+    # default value is 2. You should only specify 1 if you know it is necessary
+    # for your test suite.
+    # @return [String]
+    attr_accessor :version
+
+    # A seed, in the form of a string, that will be used to randomly generate
+    # account and transaction data, if this data is not specified using the
+    # `override_accounts` argument. If no seed is specified, the randomly
+    # generated data will be different each time.
+    # Note that transactions data is generated relative to the Item's creation
+    # date. Different Items created on different dates with the same seed for
+    # transactions data will have different dates for the transactions. The
+    # number of days between each transaction and the Item creation will remain
+    # constant. For example, an Item created on December 15 might show a
+    # transaction on December 14. An Item created on December 20, using the same
+    # seed, would show that same transaction occurring on December 19.
+    # @return [String]
+    attr_accessor :seed
+
+    # An array of account overrides to configure the accounts for the Item. By
+    # default, if no override is specified, transactions and account data will
+    # be randomly generated based on the account type and subtype, and other
+    # products will have fixed or empty data.
+    # @return [Array[OverrideAccounts]]
+    attr_accessor :override_accounts
+
+    # Specifies the multi-factor authentication settings to use with this test
+    # account
+    # @return [Mfa]
+    attr_accessor :mfa
+
+    # You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by
+    # using the recaptcha field. Possible values are `good` or `bad`. A value of
+    # `good` will result in successful Item creation and `bad` will result in a
+    # `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require
+    # the reCAPTCHA to be manually solved within Plaid Link.
+    # @return [String]
+    attr_accessor :recaptcha
+
+    # An error code to force on Item creation. Possible values are:
+    # `"INSTITUTION_NOT_RESPONDING"`
+    # `"INSTITUTION_NO_LONGER_SUPPORTED"`
+    # `"INVALID_CREDENTIALS"`
+    # `"INVALID_MFA"`
+    # `"ITEM_LOCKED"`
+    # `"ITEM_LOGIN_REQUIRED"`
+    # `"ITEM_NOT_SUPPORTED"`
+    # `"INVALID_LINK_TOKEN"`
+    # `"MFA_NOT_SUPPORTED"`
+    # `"NO_ACCOUNTS"`
+    # `"PLAID_ERROR"`
+    # `"PRODUCTS_NOT_SUPPORTED"`
+    # `"USER_SETUP_REQUIRED"`
+    # @return [String]
+    attr_accessor :force_error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version'] = 'version'
+      @_hash['seed'] = 'seed'
+      @_hash['override_accounts'] = 'override_accounts'
+      @_hash['mfa'] = 'mfa'
+      @_hash['recaptcha'] = 'recaptcha'
+      @_hash['force_error'] = 'force_error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        version
+      ]
+    end
+
+    def initialize(seed:, override_accounts:, mfa:, recaptcha:, force_error:,
+                   version: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @version = version unless version == SKIP
+      @seed = seed
+      @override_accounts = override_accounts
+      @mfa = mfa
+      @recaptcha = recaptcha
+      @force_error = force_error
+      @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.
+      seed = hash.key?('seed') ? hash['seed'] : nil
+      # Parameter is an array, so we need to iterate through it
+      override_accounts = nil
+      unless hash['override_accounts'].nil?
+        override_accounts = []
+        hash['override_accounts'].each do |structure|
+          override_accounts << (OverrideAccounts.from_hash(structure) if structure)
+        end
+      end
+
+      override_accounts = nil unless hash.key?('override_accounts')
+      mfa = Mfa.from_hash(hash['mfa']) if hash['mfa']
+      recaptcha = hash.key?('recaptcha') ? hash['recaptcha'] : nil
+      force_error = hash.key?('force_error') ? hash['force_error'] : nil
+      version = hash.key?('version') ? hash['version'] : 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.
+      UserCustomPassword.new(seed: seed,
+                             override_accounts: override_accounts,
+                             mfa: mfa,
+                             recaptcha: recaptcha,
+                             force_error: force_error,
+                             version: version,
+                             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} version: #{@version}, seed: #{@seed}, override_accounts:"\
+      " #{@override_accounts}, mfa: #{@mfa}, recaptcha: #{@recaptcha}, force_error:"\
+      " #{@force_error}, 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} version: #{@version.inspect}, seed: #{@seed.inspect}, override_accounts:"\
+      " #{@override_accounts.inspect}, mfa: #{@mfa.inspect}, recaptcha: #{@recaptcha.inspect},"\
+      " force_error: #{@force_error.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/user_permission_revoked_webhook.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The `USER_PERMISSION_REVOKED` webhook is fired to when an end user has used
+  # the [my.plaid.com portal](https://my.plaid.com) to revoke the permission
+  # that they previously granted to access an Item. Once access to an Item has
+  # been revoked, it cannot be restored. If the user subsequently returns to
+  # your application, a new Item must be created for the user.
+  class UserPermissionRevokedWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `ITEM`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `USER_PERMISSION_REVOKED`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # We use standard HTTP response codes for success and failure notifications,
+    # and our errors are further classified by `error_type`. In general, 200
+    # HTTP codes correspond to success, 40X codes are for developer- or
+    # user-related failures, and 50X codes are for Plaid-related issues.  Error
+    # fields will be `null` if no error has occurred.
+    # @return [Error]
+    attr_accessor :error
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['item_id'] = 'item_id'
+      @_hash['error'] = 'error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, item_id:, error: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @item_id = item_id
+      @error = error unless error == 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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      error = Error.from_hash(hash['error']) if hash['error']
+
+      # 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.
+      UserPermissionRevokedWebhook.new(webhook_type: webhook_type,
+                                       webhook_code: webhook_code,
+                                       item_id: item_id,
+                                       error: error,
+                                       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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, item_id:"\
+      " #{@item_id}, error: #{@error}, 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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, item_id: #{@item_id.inspect}, error: #{@error.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/value.rb

@@ -0,0 +1,52 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The frequency of the pay period.
+  class Value
+    VALUE = [
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'semimonthly'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'biweekly'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze,
+
+      # TODO: Write general description for NULL
+      NULL = 'null'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MONTHLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'monthly' then MONTHLY
+      when 'semimonthly' then SEMIMONTHLY
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'unknown' then UNKNOWN
+      when 'null' then NULL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/verification_expired_webhook.rb

@@ -0,0 +1,102 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when an Item was not verified via automated micro-deposits after ten
+  # days since the automated micro-deposit was made.
+  class VerificationExpiredWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `AUTH`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `VERIFICATION_EXPIRED`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The `item_id` of the Item associated with this webhook, warning, or error
+    # @return [String]
+    attr_accessor :item_id
+
+    # The `account_id` of the account associated with the webhook
+    # @return [String]
+    attr_accessor :account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['webhook_type'] = 'webhook_type'
+      @_hash['webhook_code'] = 'webhook_code'
+      @_hash['item_id'] = 'item_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type:, webhook_code:, item_id:, account_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type
+      @webhook_code = webhook_code
+      @item_id = item_id
+      @account_id = account_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.
+      webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      account_id = hash.key?('account_id') ? hash['account_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.
+      VerificationExpiredWebhook.new(webhook_type: webhook_type,
+                                     webhook_code: webhook_code,
+                                     item_id: item_id,
+                                     account_id: account_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} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, item_id:"\
+      " #{@item_id}, account_id: #{@account_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} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
+      " #{@webhook_code.inspect}, item_id: #{@item_id.inspect}, account_id:"\
+      " #{@account_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/verification_refresh_status.rb

@@ -0,0 +1,29 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The verification refresh status. One of the following:
+  # `"VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED"` User presence is
+  # required to refresh an income verification.
+  class VerificationRefreshStatus
+    VERIFICATION_REFRESH_STATUS = [
+      # TODO: Write general description for
+      # VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED
+      VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED = 'VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/plaid/models/verification_status.rb

@@ -0,0 +1,53 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # 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.
+  class VerificationStatus
+    VERIFICATION_STATUS = [
+      # TODO: Write general description for VERIFIED
+      VERIFIED = 'VERIFIED'.freeze,
+
+      # TODO: Write general description for UNVERIFIED
+      UNVERIFIED = 'UNVERIFIED'.freeze,
+
+      # TODO: Write general description for NEEDS_INFO
+      NEEDS_INFO = 'NEEDS_INFO'.freeze,
+
+      # TODO: Write general description for UNABLE_TO_VERIFY
+      UNABLE_TO_VERIFY = 'UNABLE_TO_VERIFY'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verified' then VERIFIED
+      when 'unverified' then UNVERIFIED
+      when 'needs_info' then NEEDS_INFO
+      when 'unable_to_verify' then UNABLE_TO_VERIFY
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/verification_status1.rb

@@ -0,0 +1,36 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The verification status to set the account to.
+  class VerificationStatus1
+    VERIFICATION_STATUS1 = [
+      # TODO: Write general description for AUTOMATICALLY_VERIFIED
+      AUTOMATICALLY_VERIFIED = 'automatically_verified'.freeze,
+
+      # TODO: Write general description for VERIFICATION_EXPIRED
+      VERIFICATION_EXPIRED = 'verification_expired'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTOMATICALLY_VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'automatically_verified' then AUTOMATICALLY_VERIFIED
+      when 'verification_expired' then VERIFICATION_EXPIRED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/verification_status3.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status
+  # processing has completed. `VERIFICATION_STATUS_DOCUMENT_REJECTED`: The
+  # documentation uploaded by the end user was recognized as a supported file
+  # format, but not recognized as a valid paystub.
+  # `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting
+  # to process the verification documentation.
+  class VerificationStatus3
+    VERIFICATION_STATUS3 = [
+      # TODO: Write general description for
+      # VERIFICATION_STATUS_PROCESSING_COMPLETE
+      VERIFICATION_STATUS_PROCESSING_COMPLETE = 'VERIFICATION_STATUS_PROCESSING_COMPLETE'.freeze,
+
+      # TODO: Write general description for
+      # VERIFICATION_STATUS_DOCUMENT_REJECTED
+      VERIFICATION_STATUS_DOCUMENT_REJECTED = 'VERIFICATION_STATUS_DOCUMENT_REJECTED'.freeze,
+
+      # TODO: Write general description for
+      # VERIFICATION_STATUS_PROCESSING_FAILED
+      VERIFICATION_STATUS_PROCESSING_FAILED = 'VERIFICATION_STATUS_PROCESSING_FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VERIFICATION_STATUS_PROCESSING_COMPLETE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verification_status_processing_complete' then VERIFICATION_STATUS_PROCESSING_COMPLETE
+      when 'verification_status_document_rejected' then VERIFICATION_STATUS_DOCUMENT_REJECTED
+      when 'verification_status_processing_failed' then VERIFICATION_STATUS_PROCESSING_FAILED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/verification_status4.rb

@@ -0,0 +1,65 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The current verification status of an Auth Item initiated through Automated
+  # or Manual micro-deposits.  Returned for Auth Items only.
+  # `pending_automatic_verification`: The Item is pending automatic verification
+  # `pending_manual_verification`: The Item is pending manual micro-deposit
+  # verification. Items remain in this state until the user successfully
+  # verifies the two amounts. `automatically_verified`: The Item has
+  # successfully been automatically verified	 `manually_verified`: The Item has
+  # successfully been manually verified `verification_expired`: Plaid was unable
+  # to automatically verify the deposit within 7 calendar days and will no
+  # longer attempt to validate the Item. Users may retry by submitting their
+  # information again through Link. `verification_failed`: The Item failed
+  # manual micro-deposit verification because the user exhausted all 3
+  # verification attempts. Users may retry by submitting their information again
+  # through Link.
+  class VerificationStatus4
+    VERIFICATION_STATUS4 = [
+      # TODO: Write general description for AUTOMATICALLY_VERIFIED
+      AUTOMATICALLY_VERIFIED = 'automatically_verified'.freeze,
+
+      # TODO: Write general description for PENDING_AUTOMATIC_VERIFICATION
+      PENDING_AUTOMATIC_VERIFICATION = 'pending_automatic_verification'.freeze,
+
+      # TODO: Write general description for PENDING_MANUAL_VERIFICATION
+      PENDING_MANUAL_VERIFICATION = 'pending_manual_verification'.freeze,
+
+      # TODO: Write general description for MANUALLY_VERIFIED
+      MANUALLY_VERIFIED = 'manually_verified'.freeze,
+
+      # TODO: Write general description for VERIFICATION_EXPIRED
+      VERIFICATION_EXPIRED = 'verification_expired'.freeze,
+
+      # TODO: Write general description for VERIFICATION_FAILED
+      VERIFICATION_FAILED = 'verification_failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTOMATICALLY_VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'automatically_verified' then AUTOMATICALLY_VERIFIED
+      when 'pending_automatic_verification' then PENDING_AUTOMATIC_VERIFICATION
+      when 'pending_manual_verification' then PENDING_MANUAL_VERIFICATION
+      when 'manually_verified' then MANUALLY_VERIFIED
+      when 'verification_expired' then VERIFICATION_EXPIRED
+      when 'verification_failed' then VERIFICATION_FAILED
+      else
+        default_value
+      end
+    end
+  end
+end