apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transfer_authorization_create_request.rb

@@ -0,0 +1,197 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/transfer/authorization/create`
+  class TransferAuthorizationCreateRequest < 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 Plaid `access_token` for the account that will be debited or credited.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The Plaid `account_id` for the account that will be debited or credited.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The type of transfer. This will be either `debit` or `credit`.  A `debit`
+    # indicates a transfer of money into the origination account; a `credit`
+    # indicates a transfer of money out of the origination account.
+    # @return [TransferType1]
+    attr_accessor :type
+
+    # The network or rails used for the transfer. Valid options are `ach` or
+    # `same-day-ach`.
+    # @return [TransferNetwork]
+    attr_accessor :network
+
+    # The amount of the transfer (decimal string with two digits of precision
+    # e.g. “10.00”).
+    # @return [String]
+    attr_accessor :amount
+
+    # Specifies the use case of the transfer.  Required for transfers on an ACH
+    # network.
+    # `"arc"` - Accounts Receivable Entry
+    # `"cbr`" - Cross Border Entry
+    # `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate
+    # bank accounts
+    # `"cie"` - Customer Initiated Entry
+    # `"cor"` - Automated Notification of Change
+    # `"ctx"` - Corporate Trade Exchange
+    # `"iat"` - International
+    # `"mte"` - Machine Transfer Entry
+    # `"pbr"` - Cross Border Entry
+    # `"pop"` - Point-of-Purchase Entry
+    # `"pos"` - Point-of-Sale Entry
+    # `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a
+    # pre-existing relationship with a consumer, eg. bill payment
+    # `"rck"` - Re-presented Check Entry
+    # `"tel"` - Telephone-Initiated Entry
+    # `"web"` - Internet-Initiated Entry - debits from a consumer’s account
+    # where their authorization is obtained over the Internet
+    # @return [AchClass]
+    attr_accessor :ach_class
+
+    # The legal name and other information for the account holder.
+    # @return [TransferUserInRequest]
+    attr_accessor :user
+
+    # Information about the device being used to initiate the authorization.
+    # @return [TransferAuthorizationDevice]
+    attr_accessor :device
+
+    # Plaid's unique identifier for the origination account for this
+    # authorization. If not specified, the default account will be used.
+    # @return [String]
+    attr_accessor :origination_account_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['access_token'] = 'access_token'
+      @_hash['account_id'] = 'account_id'
+      @_hash['type'] = 'type'
+      @_hash['network'] = 'network'
+      @_hash['amount'] = 'amount'
+      @_hash['ach_class'] = 'ach_class'
+      @_hash['user'] = 'user'
+      @_hash['device'] = 'device'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        device
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, account_id:, type:, network:, amount:,
+                   ach_class:, user:, client_id: SKIP, secret: SKIP,
+                   device: SKIP, origination_account_id: 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
+      @access_token = access_token
+      @account_id = account_id
+      @type = type
+      @network = network
+      @amount = amount
+      @ach_class = ach_class
+      @user = user
+      @device = device unless device == SKIP
+      @origination_account_id = origination_account_id unless origination_account_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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      network = hash.key?('network') ? hash['network'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      ach_class = hash.key?('ach_class') ? hash['ach_class'] : nil
+      user = TransferUserInRequest.from_hash(hash['user']) if hash['user']
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      device = TransferAuthorizationDevice.from_hash(hash['device']) if hash['device']
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_account_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.
+      TransferAuthorizationCreateRequest.new(access_token: access_token,
+                                             account_id: account_id,
+                                             type: type,
+                                             network: network,
+                                             amount: amount,
+                                             ach_class: ach_class,
+                                             user: user,
+                                             client_id: client_id,
+                                             secret: secret,
+                                             device: device,
+                                             origination_account_id: origination_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} client_id: #{@client_id}, secret: #{@secret}, access_token:"\
+      " #{@access_token}, account_id: #{@account_id}, type: #{@type}, network: #{@network},"\
+      " amount: #{@amount}, ach_class: #{@ach_class}, user: #{@user}, device: #{@device},"\
+      " origination_account_id: #{@origination_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} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, access_token:"\
+      " #{@access_token.inspect}, account_id: #{@account_id.inspect}, type: #{@type.inspect},"\
+      " network: #{@network.inspect}, amount: #{@amount.inspect}, ach_class:"\
+      " #{@ach_class.inspect}, user: #{@user.inspect}, device: #{@device.inspect},"\
+      " origination_account_id: #{@origination_account_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_authorization_create_response.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/transfer/authorization/create`
+  class TransferAuthorizationCreateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TransferAuthorization contains the authorization decision for a proposed
+    # transfer
+    # @return [TransferAuthorization]
+    attr_accessor :authorization
+
+    # 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['authorization'] = 'authorization'
+      @_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(authorization:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @authorization = authorization
+      @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.
+      authorization = TransferAuthorization.from_hash(hash['authorization']) if
+        hash['authorization']
+      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.
+      TransferAuthorizationCreateResponse.new(authorization: authorization,
+                                              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} authorization: #{@authorization}, 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} authorization: #{@authorization.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_authorization_decision_rationale.rb

@@ -0,0 +1,96 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The rationale for Plaid's decision regarding a proposed transfer. Will be
+  # null for `approved` decisions.
+  class TransferAuthorizationDecisionRationale < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A code representing the rationale for permitting or declining the proposed
+    # transfer. Possible values are:
+    # `NSF` – Transaction likely to result in a return due to insufficient
+    # funds.
+    # `RISK` - Transaction is high-risk.
+    # `MANUALLY_VERIFIED_ITEM` – Item created via same-day micro deposits,
+    # limited information available. Plaid can only offer `permitted` as a
+    # transaction decision.
+    # `LOGIN_REQUIRED` – Unable to collect the account information required for
+    # an authorization decision due to Item staleness. Can be rectified using
+    # Link update mode.
+    # `ERROR` – Unable to collect the account information required for an
+    # authorization decision due to an error.
+    # @return [Code]
+    attr_accessor :code
+
+    # A human-readable description of the code associated with a permitted
+    # transfer or transfer decline.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code:, description:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code
+      @description = description
+      @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.
+      code = hash.key?('code') ? hash['code'] : nil
+      description = hash.key?('description') ? hash['description'] : 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.
+      TransferAuthorizationDecisionRationale.new(code: code,
+                                                 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} code: #{@code}, 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} code: #{@code.inspect}, description: #{@description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_authorization_device.rb

@@ -0,0 +1,86 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Information about the device being used to initiate the authorization.
+  class TransferAuthorizationDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The IP address of the device being used to initiate the authorization.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # The user agent of the device being used to initiate the authorization.
+    # @return [String]
+    attr_accessor :user_agent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['user_agent'] = 'user_agent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ip_address
+        user_agent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ip_address: SKIP, user_agent: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ip_address = ip_address unless ip_address == SKIP
+      @user_agent = user_agent unless user_agent == 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.
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+      user_agent = hash.key?('user_agent') ? hash['user_agent'] : 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.
+      TransferAuthorizationDevice.new(ip_address: ip_address,
+                                      user_agent: user_agent,
+                                      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} ip_address: #{@ip_address}, user_agent: #{@user_agent},"\
+      " 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} ip_address: #{@ip_address.inspect}, user_agent: #{@user_agent.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_authorization_proposed_transfer.rb

@@ -0,0 +1,150 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Details regarding the proposed transfer.
+  class TransferAuthorizationProposedTransfer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the use case of the transfer.  Required for transfers on an ACH
+    # network.
+    # `"arc"` - Accounts Receivable Entry
+    # `"cbr`" - Cross Border Entry
+    # `"ccd"` - Corporate Credit or Debit - fund transfer between two corporate
+    # bank accounts
+    # `"cie"` - Customer Initiated Entry
+    # `"cor"` - Automated Notification of Change
+    # `"ctx"` - Corporate Trade Exchange
+    # `"iat"` - International
+    # `"mte"` - Machine Transfer Entry
+    # `"pbr"` - Cross Border Entry
+    # `"pop"` - Point-of-Purchase Entry
+    # `"pos"` - Point-of-Sale Entry
+    # `"ppd"` - Prearranged Payment or Deposit - the transfer is part of a
+    # pre-existing relationship with a consumer, eg. bill payment
+    # `"rck"` - Re-presented Check Entry
+    # `"tel"` - Telephone-Initiated Entry
+    # `"web"` - Internet-Initiated Entry - debits from a consumer’s account
+    # where their authorization is obtained over the Internet
+    # @return [AchClass]
+    attr_accessor :ach_class
+
+    # The Plaid `account_id` for the account that will be debited or credited.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The type of transfer. This will be either `debit` or `credit`.  A `debit`
+    # indicates a transfer of money into the origination account; a `credit`
+    # indicates a transfer of money out of the origination account.
+    # @return [TransferType1]
+    attr_accessor :type
+
+    # The legal name and other information for the account holder.
+    # @return [TransferUserInResponse]
+    attr_accessor :user
+
+    # The amount of the transfer (decimal string with two digits of precision
+    # e.g. “10.00”).
+    # @return [String]
+    attr_accessor :amount
+
+    # The network or rails used for the transfer.
+    # @return [String]
+    attr_accessor :network
+
+    # Plaid's unique identifier for the origination account that was used for
+    # this transfer.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ach_class'] = 'ach_class'
+      @_hash['account_id'] = 'account_id'
+      @_hash['type'] = 'type'
+      @_hash['user'] = 'user'
+      @_hash['amount'] = 'amount'
+      @_hash['network'] = 'network'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ach_class:, account_id:, type:, user:, amount:, network:,
+                   origination_account_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ach_class = ach_class
+      @account_id = account_id
+      @type = type
+      @user = user
+      @amount = amount
+      @network = network
+      @origination_account_id = origination_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.
+      ach_class = hash.key?('ach_class') ? hash['ach_class'] : nil
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      user = TransferUserInResponse.from_hash(hash['user']) if hash['user']
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      network = hash.key?('network') ? hash['network'] : nil
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_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.
+      TransferAuthorizationProposedTransfer.new(ach_class: ach_class,
+                                                account_id: account_id,
+                                                type: type,
+                                                user: user,
+                                                amount: amount,
+                                                network: network,
+                                                origination_account_id: origination_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} ach_class: #{@ach_class}, account_id: #{@account_id}, type: #{@type}, user:"\
+      " #{@user}, amount: #{@amount}, network: #{@network}, origination_account_id:"\
+      " #{@origination_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} ach_class: #{@ach_class.inspect}, account_id: #{@account_id.inspect}, type:"\
+      " #{@type.inspect}, user: #{@user.inspect}, amount: #{@amount.inspect}, network:"\
+      " #{@network.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end