apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/deposit_switch_token_create_request.rb

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

data/lib/plaid/models/deposit_switch_token_create_response.rb

@@ -0,0 +1,101 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # DepositSwitchTokenCreateResponse defines the response schema for
+  # `/deposit_switch/token/create`
+  class DepositSwitchTokenCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deposit switch token, used to initialize Link for the Deposit Switch
+    # product
+    # @return [String]
+    attr_accessor :deposit_switch_token
+
+    # Expiration time of the token, in [ISO
+    # 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # @return [String]
+    attr_accessor :deposit_switch_token_expiration_time
+
+    # 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_token'] = 'deposit_switch_token'
+      @_hash['deposit_switch_token_expiration_time'] =
+        'deposit_switch_token_expiration_time'
+      @_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(deposit_switch_token:, deposit_switch_token_expiration_time:,
+                   request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_switch_token = deposit_switch_token
+      @deposit_switch_token_expiration_time = deposit_switch_token_expiration_time
+      @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_token =
+        hash.key?('deposit_switch_token') ? hash['deposit_switch_token'] : nil
+      deposit_switch_token_expiration_time =
+        hash.key?('deposit_switch_token_expiration_time') ? hash['deposit_switch_token_expiration_time'] : 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.
+      DepositSwitchTokenCreateResponse.new(deposit_switch_token: deposit_switch_token,
+                                           deposit_switch_token_expiration_time: deposit_switch_token_expiration_time,
+                                           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} deposit_switch_token: #{@deposit_switch_token},"\
+      " deposit_switch_token_expiration_time: #{@deposit_switch_token_expiration_time},"\
+      " 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_token: #{@deposit_switch_token.inspect},"\
+      " deposit_switch_token_expiration_time: #{@deposit_switch_token_expiration_time.inspect},"\
+      " request_id: #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/depository.rb

@@ -0,0 +1,80 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `depository`-type accounts
+  class Depository < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of account subtypes to display in Link. If not specified, all
+    # account subtypes will be shown. For a full list of valid types and
+    # subtypes, see the [Account
+    # schema](https://plaid.com/docs/api/accounts#accounts-schema).
+    # @return [Array[AccountSubtype]]
+    attr_accessor :account_subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtypes'] = 'account_subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_subtypes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes unless account_subtypes == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_subtypes =
+        hash.key?('account_subtypes') ? hash['account_subtypes'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Depository.new(account_subtypes: account_subtypes,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/depository_account.rb

@@ -0,0 +1,147 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An account type holding cash, in which funds are deposited. Supported
+  # products for `depository` accounts are: Auth, Balance, Transactions,
+  # Identity, Payment Initiation, and Assets.
+  class DepositoryAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Checking account
+    # @return [String]
+    attr_accessor :checking
+
+    # Savings account
+    # @return [String]
+    attr_accessor :savings
+
+    # Health Savings Account (US only) that can only hold cash
+    # @return [String]
+    attr_accessor :hsa
+
+    # Certificate of deposit account
+    # @return [String]
+    attr_accessor :cd
+
+    # Money market account
+    # @return [String]
+    attr_accessor :money_market
+
+    # PayPal depository account
+    # @return [String]
+    attr_accessor :paypal
+
+    # Prepaid debit card
+    # @return [String]
+    attr_accessor :prepaid
+
+    # A cash management account, typically a cash account at a brokerage
+    # @return [String]
+    attr_accessor :cash_management
+
+    # An Electronic Benefit Transfer (EBT) account, used by certain public
+    # assistance programs to distribute funds (US only)
+    # @return [String]
+    attr_accessor :ebt
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checking'] = 'checking'
+      @_hash['savings'] = 'savings'
+      @_hash['hsa'] = 'hsa'
+      @_hash['cd'] = 'cd'
+      @_hash['money_market'] = 'money market'
+      @_hash['paypal'] = 'paypal'
+      @_hash['prepaid'] = 'prepaid'
+      @_hash['cash_management'] = 'cash management'
+      @_hash['ebt'] = 'ebt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checking:, savings:, hsa:, cd:, money_market:, paypal:,
+                   prepaid:, cash_management:, ebt:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @checking = checking
+      @savings = savings
+      @hsa = hsa
+      @cd = cd
+      @money_market = money_market
+      @paypal = paypal
+      @prepaid = prepaid
+      @cash_management = cash_management
+      @ebt = ebt
+      @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.
+      checking = hash.key?('checking') ? hash['checking'] : nil
+      savings = hash.key?('savings') ? hash['savings'] : nil
+      hsa = hash.key?('hsa') ? hash['hsa'] : nil
+      cd = hash.key?('cd') ? hash['cd'] : nil
+      money_market = hash.key?('money market') ? hash['money market'] : nil
+      paypal = hash.key?('paypal') ? hash['paypal'] : nil
+      prepaid = hash.key?('prepaid') ? hash['prepaid'] : nil
+      cash_management =
+        hash.key?('cash management') ? hash['cash management'] : nil
+      ebt = hash.key?('ebt') ? hash['ebt'] : 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.
+      DepositoryAccount.new(checking: checking,
+                            savings: savings,
+                            hsa: hsa,
+                            cd: cd,
+                            money_market: money_market,
+                            paypal: paypal,
+                            prepaid: prepaid,
+                            cash_management: cash_management,
+                            ebt: ebt,
+                            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} checking: #{@checking}, savings: #{@savings}, hsa: #{@hsa}, cd: #{@cd},"\
+      " money_market: #{@money_market}, paypal: #{@paypal}, prepaid: #{@prepaid}, cash_management:"\
+      " #{@cash_management}, ebt: #{@ebt}, 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} checking: #{@checking.inspect}, savings: #{@savings.inspect}, hsa:"\
+      " #{@hsa.inspect}, cd: #{@cd.inspect}, money_market: #{@money_market.inspect}, paypal:"\
+      " #{@paypal.inspect}, prepaid: #{@prepaid.inspect}, cash_management:"\
+      " #{@cash_management.inspect}, ebt: #{@ebt.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/depository_filter.rb

@@ -0,0 +1,78 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # A filter to apply to `depository`-type accounts
+  class DepositoryFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of account subtypes to display in Link. If not specified, all
+    # account subtypes will be shown. For a full list of valid types and
+    # subtypes, see the [Account
+    # schema](https://plaid.com/docs/api/accounts#accounts-schema).
+    # @return [Array[AccountSubtype]]
+    attr_accessor :account_subtypes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_subtypes'] = 'account_subtypes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_subtypes:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_subtypes = account_subtypes
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_subtypes =
+        hash.key?('account_subtypes') ? hash['account_subtypes'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DepositoryFilter.new(account_subtypes: account_subtypes,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_subtypes: #{@account_subtypes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/distribution_details.rb

@@ -0,0 +1,126 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # An object representing information about a distribution from the paycheck
+  # (for example, the amount distributed to a specific checking account, or to a
+  # retirement plan).
+  class DistributionDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account number of the account being deposited to.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of bank account (e.g. Checking or Savings)
+    # @return [String]
+    attr_accessor :bank_account_type
+
+    # The name of the bank that the payment is being deposited to.
+    # @return [String]
+    attr_accessor :bank_name
+
+    # An object representing a monetary amount.
+    # @return [Pay]
+    attr_accessor :current_pay
+
+    # A description of the distribution type.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['bank_account_type'] = 'bank_account_type'
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['current_pay'] = 'current_pay'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        bank_account_type
+        bank_name
+        current_pay
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_number
+        bank_account_type
+        bank_name
+        description
+      ]
+    end
+
+    def initialize(account_number: SKIP, bank_account_type: SKIP,
+                   bank_name: SKIP, current_pay: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number unless account_number == SKIP
+      @bank_account_type = bank_account_type unless bank_account_type == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @current_pay = current_pay unless current_pay == SKIP
+      @description = description unless description == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      bank_account_type =
+        hash.key?('bank_account_type') ? hash['bank_account_type'] : SKIP
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : SKIP
+      current_pay = Pay.from_hash(hash['current_pay']) if hash['current_pay']
+      description = hash.key?('description') ? hash['description'] : 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.
+      DistributionDetails.new(account_number: account_number,
+                              bank_account_type: bank_account_type,
+                              bank_name: bank_name,
+                              current_pay: current_pay,
+                              description: description,
+                              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}, bank_account_type:"\
+      " #{@bank_account_type}, bank_name: #{@bank_name}, current_pay: #{@current_pay},"\
+      " description: #{@description}, 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}, bank_account_type:"\
+      " #{@bank_account_type.inspect}, bank_name: #{@bank_name.inspect}, current_pay:"\
+      " #{@current_pay.inspect}, description: #{@description.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end