apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/deposit_switch_get_response.rb

@@ -0,0 +1,277 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchGetResponse defines the response schema for
+  # `/deposit_switch/get`
+  class DepositSwitchGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the deposit switch.
+    # @return [String]
+    attr_accessor :deposit_switch_id
+
+    # The ID of the bank account the direct deposit was switched to.
+    # @return [String]
+    attr_accessor :target_account_id
+
+    # The ID of the Item the direct deposit was switched to.
+    # @return [String]
+    attr_accessor :target_item_id
+
+    # The state, or status, of the deposit switch.
+    # - `initialized` – The deposit switch has been initialized with the user
+    # entering the information required to submit the deposit switch request.
+    # - `processing` – The deposit switch request has been submitted and is
+    # being processed.
+    # - `completed` – The user's employer has fulfilled the deposit switch
+    # request.
+    # - `error` – There was an error processing the deposit switch request.
+    # @return [State]
+    attr_accessor :state
+
+    # The method used to make the deposit switch.
+    # - `instant` – User instantly switched their direct deposit to a new or
+    # existing bank account by connecting their payroll or employer account.
+    # - `mail` – User requested that Plaid contact their employer by mail to
+    # make the direct deposit switch.
+    # - `pdf` – User generated a PDF or email to be sent to their employer with
+    # the information necessary to make the deposit switch.'
+    # @return [SwitchMethod]
+    attr_accessor :switch_method
+
+    # When `true`, user’s direct deposit goes to multiple banks. When false,
+    # user’s direct deposit only goes to the target account. Always `null` if
+    # the deposit switch has not been completed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :account_has_multiple_allocations
+
+    # When `true`, the target account is allocated the remainder of direct
+    # deposit after all other allocations have been deducted. When `false`,
+    # user’s direct deposit is allocated as a percent or amount. Always `null`
+    # if the deposit switch has not been completed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_allocated_remainder
+
+    # The percentage of direct deposit allocated to the target account. Always
+    # `null` if the target account is not allocated a percentage or if the
+    # deposit switch has not been completed or if `is_allocated_remainder` is
+    # true.
+    # @return [Float]
+    attr_accessor :percent_allocated
+
+    # The dollar amount of direct deposit allocated to the target account.
+    # Always `null` if the target account is not allocated an amount or if the
+    # deposit switch has not been completed.
+    # @return [Float]
+    attr_accessor :amount_allocated
+
+    # The name of the employer selected by the user. If the user did not select
+    # an employer, the value returned is `null`.
+    # @return [String]
+    attr_accessor :employer_name
+
+    # The ID of the employer selected by the user. If the user did not select an
+    # employer, the value returned is `null`.
+    # @return [String]
+    attr_accessor :employer_id
+
+    # The name of the institution selected by the user. If the user did not
+    # select an institution, the value returned is `null`.
+    # @return [String]
+    attr_accessor :institution_name
+
+    # The ID of the institution selected by the user. If the user did not select
+    # an institution, the value returned is `null`.
+    # @return [String]
+    attr_accessor :institution_id
+
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch
+    # was created.
+    # @return [Date]
+    attr_accessor :date_created
+
+    # [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch
+    # was completed. Always `null` if the deposit switch has not been completed.
+    # @return [Date]
+    attr_accessor :date_completed
+
+    # 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['deposit_switch_id'] = 'deposit_switch_id'
+      @_hash['target_account_id'] = 'target_account_id'
+      @_hash['target_item_id'] = 'target_item_id'
+      @_hash['state'] = 'state'
+      @_hash['switch_method'] = 'switch_method'
+      @_hash['account_has_multiple_allocations'] =
+        'account_has_multiple_allocations'
+      @_hash['is_allocated_remainder'] = 'is_allocated_remainder'
+      @_hash['percent_allocated'] = 'percent_allocated'
+      @_hash['amount_allocated'] = 'amount_allocated'
+      @_hash['employer_name'] = 'employer_name'
+      @_hash['employer_id'] = 'employer_id'
+      @_hash['institution_name'] = 'institution_name'
+      @_hash['institution_id'] = 'institution_id'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_completed'] = 'date_completed'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        switch_method
+        employer_name
+        employer_id
+        institution_name
+        institution_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        target_account_id
+        target_item_id
+        account_has_multiple_allocations
+        is_allocated_remainder
+        percent_allocated
+        amount_allocated
+        employer_name
+        employer_id
+        institution_name
+        institution_id
+        date_completed
+      ]
+    end
+
+    def initialize(deposit_switch_id:, target_account_id:, target_item_id:,
+                   state:, account_has_multiple_allocations:,
+                   is_allocated_remainder:, percent_allocated:,
+                   amount_allocated:, date_created:, date_completed:,
+                   request_id:, switch_method: SKIP, employer_name: SKIP,
+                   employer_id: SKIP, institution_name: SKIP,
+                   institution_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_switch_id = deposit_switch_id
+      @target_account_id = target_account_id
+      @target_item_id = target_item_id
+      @state = state
+      @switch_method = switch_method unless switch_method == SKIP
+      @account_has_multiple_allocations = account_has_multiple_allocations
+      @is_allocated_remainder = is_allocated_remainder
+      @percent_allocated = percent_allocated
+      @amount_allocated = amount_allocated
+      @employer_name = employer_name unless employer_name == SKIP
+      @employer_id = employer_id unless employer_id == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @institution_id = institution_id unless institution_id == SKIP
+      @date_created = date_created
+      @date_completed = date_completed
+      @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.
+      deposit_switch_id =
+        hash.key?('deposit_switch_id') ? hash['deposit_switch_id'] : nil
+      target_account_id =
+        hash.key?('target_account_id') ? hash['target_account_id'] : nil
+      target_item_id =
+        hash.key?('target_item_id') ? hash['target_item_id'] : nil
+      state = hash.key?('state') ? hash['state'] : nil
+      account_has_multiple_allocations =
+        hash.key?('account_has_multiple_allocations') ? hash['account_has_multiple_allocations'] : nil
+      is_allocated_remainder =
+        hash.key?('is_allocated_remainder') ? hash['is_allocated_remainder'] : nil
+      percent_allocated =
+        hash.key?('percent_allocated') ? hash['percent_allocated'] : nil
+      amount_allocated =
+        hash.key?('amount_allocated') ? hash['amount_allocated'] : nil
+      date_created = hash.key?('date_created') ? hash['date_created'] : nil
+      date_completed =
+        hash.key?('date_completed') ? hash['date_completed'] : nil
+      request_id = hash.key?('request_id') ? hash['request_id'] : nil
+      switch_method = hash.key?('switch_method') ? hash['switch_method'] : SKIP
+      employer_name = hash.key?('employer_name') ? hash['employer_name'] : SKIP
+      employer_id = hash.key?('employer_id') ? hash['employer_id'] : SKIP
+      institution_name =
+        hash.key?('institution_name') ? hash['institution_name'] : SKIP
+      institution_id =
+        hash.key?('institution_id') ? hash['institution_id'] : 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.
+      DepositSwitchGetResponse.new(deposit_switch_id: deposit_switch_id,
+                                   target_account_id: target_account_id,
+                                   target_item_id: target_item_id,
+                                   state: state,
+                                   account_has_multiple_allocations: account_has_multiple_allocations,
+                                   is_allocated_remainder: is_allocated_remainder,
+                                   percent_allocated: percent_allocated,
+                                   amount_allocated: amount_allocated,
+                                   date_created: date_created,
+                                   date_completed: date_completed,
+                                   request_id: request_id,
+                                   switch_method: switch_method,
+                                   employer_name: employer_name,
+                                   employer_id: employer_id,
+                                   institution_name: institution_name,
+                                   institution_id: institution_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} deposit_switch_id: #{@deposit_switch_id}, target_account_id:"\
+      " #{@target_account_id}, target_item_id: #{@target_item_id}, state: #{@state},"\
+      " switch_method: #{@switch_method}, account_has_multiple_allocations:"\
+      " #{@account_has_multiple_allocations}, is_allocated_remainder: #{@is_allocated_remainder},"\
+      " percent_allocated: #{@percent_allocated}, amount_allocated: #{@amount_allocated},"\
+      " employer_name: #{@employer_name}, employer_id: #{@employer_id}, institution_name:"\
+      " #{@institution_name}, institution_id: #{@institution_id}, date_created: #{@date_created},"\
+      " date_completed: #{@date_completed}, 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} deposit_switch_id: #{@deposit_switch_id.inspect}, target_account_id:"\
+      " #{@target_account_id.inspect}, target_item_id: #{@target_item_id.inspect}, state:"\
+      " #{@state.inspect}, switch_method: #{@switch_method.inspect},"\
+      " account_has_multiple_allocations: #{@account_has_multiple_allocations.inspect},"\
+      " is_allocated_remainder: #{@is_allocated_remainder.inspect}, percent_allocated:"\
+      " #{@percent_allocated.inspect}, amount_allocated: #{@amount_allocated.inspect},"\
+      " employer_name: #{@employer_name.inspect}, employer_id: #{@employer_id.inspect},"\
+      " institution_name: #{@institution_name.inspect}, institution_id:"\
+      " #{@institution_id.inspect}, date_created: #{@date_created.inspect}, date_completed:"\
+      " #{@date_completed.inspect}, request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_state_update_webhook.rb

@@ -0,0 +1,116 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Fired when the status of a deposit switch request has changed.
+  class DepositSwitchStateUpdateWebhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # `"DEPOSIT_SWITCH"`
+    # @return [String]
+    attr_accessor :webhook_type
+
+    # `"SWITCH_STATE_UPDATE"`
+    # @return [String]
+    attr_accessor :webhook_code
+
+    # The state, or status, of the deposit switch.
+    # `initialized`: The deposit switch has been initialized with the user
+    # entering the information required to submit the deposit switch request.
+    # `processing`: The deposit switch request has been submitted and is being
+    # processed.
+    # `completed`: The user's employer has fulfilled and completed the deposit
+    # switch request.
+    # `error`: There was an error processing the deposit switch request.
+    # For more information, see the [Deposit Switch API
+    # reference](/docs/api/products#deposit_switchget).
+    # @return [String]
+    attr_accessor :state
+
+    # The ID of the deposit switch.
+    # @return [String]
+    attr_accessor :deposit_switch_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['state'] = 'state'
+      @_hash['deposit_switch_id'] = 'deposit_switch_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        webhook_type
+        webhook_code
+        state
+        deposit_switch_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(webhook_type: SKIP, webhook_code: SKIP, state: SKIP,
+                   deposit_switch_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @webhook_type = webhook_type unless webhook_type == SKIP
+      @webhook_code = webhook_code unless webhook_code == SKIP
+      @state = state unless state == SKIP
+      @deposit_switch_id = deposit_switch_id unless deposit_switch_id == 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'] : SKIP
+      webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      deposit_switch_id =
+        hash.key?('deposit_switch_id') ? hash['deposit_switch_id'] : 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.
+      DepositSwitchStateUpdateWebhook.new(webhook_type: webhook_type,
+                                          webhook_code: webhook_code,
+                                          state: state,
+                                          deposit_switch_id: deposit_switch_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}, state:"\
+      " #{@state}, deposit_switch_id: #{@deposit_switch_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}, state: #{@state.inspect}, deposit_switch_id:"\
+      " #{@deposit_switch_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_target_account.rb

@@ -0,0 +1,106 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchTargetAccount Model.
+  class DepositSwitchTargetAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account number for deposit switch destination
+    # @return [String]
+    attr_accessor :account_number
+
+    # Routing number for deposit switch destination
+    # @return [String]
+    attr_accessor :routing_number
+
+    # The name of the deposit switch destination account, as it will be
+    # displayed to the end user in the Deposit Switch interface. It is not
+    # required to match the name used in online banking.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The account subtype of the account, either `checking` or `savings`.
+    # @return [AccountSubtype1]
+    attr_accessor :account_subtype
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_subtype'] = 'account_subtype'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number:, routing_number:, account_name:,
+                   account_subtype:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number
+      @routing_number = routing_number
+      @account_name = account_name
+      @account_subtype = account_subtype
+      @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_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : nil
+      account_name = hash.key?('account_name') ? hash['account_name'] : nil
+      account_subtype =
+        hash.key?('account_subtype') ? hash['account_subtype'] : 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.
+      DepositSwitchTargetAccount.new(account_number: account_number,
+                                     routing_number: routing_number,
+                                     account_name: account_name,
+                                     account_subtype: account_subtype,
+                                     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_number: #{@account_number}, routing_number: #{@routing_number},"\
+      " account_name: #{@account_name}, account_subtype: #{@account_subtype},"\
+      " 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_number: #{@account_number.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, account_name: #{@account_name.inspect}, account_subtype:"\
+      " #{@account_subtype.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/deposit_switch_target_user.rb

@@ -0,0 +1,121 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchTargetUser Model.
+  class DepositSwitchTargetUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The given name (first name) of the user.
+    # @return [String]
+    attr_accessor :given_name
+
+    # The family name (last name) of the user.
+    # @return [String]
+    attr_accessor :family_name
+
+    # The phone number of the user. The endpoint can accept a variety of phone
+    # number formats, including E.164.
+    # @return [String]
+    attr_accessor :phone
+
+    # The email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # The user's address.
+    # @return [DepositSwitchAddressData]
+    attr_accessor :address
+
+    # The taxpayer ID of the user, generally their SSN, EIN, or TIN.
+    # @return [String]
+    attr_accessor :tax_payer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['given_name'] = 'given_name'
+      @_hash['family_name'] = 'family_name'
+      @_hash['phone'] = 'phone'
+      @_hash['email'] = 'email'
+      @_hash['address'] = 'address'
+      @_hash['tax_payer_id'] = 'tax_payer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        tax_payer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(given_name:, family_name:, phone:, email:, address: SKIP,
+                   tax_payer_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @given_name = given_name
+      @family_name = family_name
+      @phone = phone
+      @email = email
+      @address = address unless address == SKIP
+      @tax_payer_id = tax_payer_id unless tax_payer_id == 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.
+      given_name = hash.key?('given_name') ? hash['given_name'] : nil
+      family_name = hash.key?('family_name') ? hash['family_name'] : nil
+      phone = hash.key?('phone') ? hash['phone'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      address = DepositSwitchAddressData.from_hash(hash['address']) if hash['address']
+      tax_payer_id = hash.key?('tax_payer_id') ? hash['tax_payer_id'] : 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.
+      DepositSwitchTargetUser.new(given_name: given_name,
+                                  family_name: family_name,
+                                  phone: phone,
+                                  email: email,
+                                  address: address,
+                                  tax_payer_id: tax_payer_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} given_name: #{@given_name}, family_name: #{@family_name}, phone: #{@phone},"\
+      " email: #{@email}, address: #{@address}, tax_payer_id: #{@tax_payer_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} given_name: #{@given_name.inspect}, family_name: #{@family_name.inspect},"\
+      " phone: #{@phone.inspect}, email: #{@email.inspect}, address: #{@address.inspect},"\
+      " tax_payer_id: #{@tax_payer_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end