apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/bank_transfer_balance_get_request.rb

@@ -0,0 +1,103 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/balance/get`
+  class BankTransferBalanceGetRequest < 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
+
+    # If multiple origination accounts are available, `origination_account_id`
+    # must be used to specify the account for which balance will be returned.
+    # @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['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        origination_account_id
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: 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
+      @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.
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      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.
+      BankTransferBalanceGetRequest.new(client_id: client_id,
+                                        secret: secret,
+                                        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}, 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},"\
+      " origination_account_id: #{@origination_account_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_balance_get_response.rb

@@ -0,0 +1,97 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/balance/get`
+  class BankTransferBalanceGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [BankTransferBalance]
+    attr_accessor :balance
+
+    # The ID of the origination account that this balance belongs to.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # 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['balance'] = 'balance'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash['request_id'] = 'request_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        origination_account_id
+      ]
+    end
+
+    def initialize(balance:, origination_account_id:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @balance = balance
+      @origination_account_id = origination_account_id
+      @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.
+      balance = BankTransferBalance.from_hash(hash['balance']) if hash['balance']
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_account_id'] : 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.
+      BankTransferBalanceGetResponse.new(balance: balance,
+                                         origination_account_id: origination_account_id,
+                                         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} balance: #{@balance}, origination_account_id: #{@origination_account_id},"\
+      " 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} balance: #{@balance.inspect}, origination_account_id:"\
+      " #{@origination_account_id.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_cancel_request.rb

@@ -0,0 +1,99 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/cancel`
+  class BankTransferCancelRequest < 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
+
+    # Plaid’s unique identifier for a bank transfer.
+    # @return [String]
+    attr_accessor :bank_transfer_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['bank_transfer_id'] = 'bank_transfer_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(bank_transfer_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
+      @bank_transfer_id = bank_transfer_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.
+      bank_transfer_id =
+        hash.key?('bank_transfer_id') ? hash['bank_transfer_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.
+      BankTransferCancelRequest.new(bank_transfer_id: bank_transfer_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}, bank_transfer_id:"\
+      " #{@bank_transfer_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},"\
+      " bank_transfer_id: #{@bank_transfer_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_cancel_response.rb

@@ -0,0 +1,76 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/cancel`
+  class BankTransferCancelResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique identifier for the request, which can be used for
+    # troubleshooting. This identifier, like all Plaid identifiers, is case
+    # sensitive.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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.
+      BankTransferCancelResponse.new(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} 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} request_id: #{@request_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_create_request.rb

@@ -0,0 +1,254 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/create`
+  class BankTransferCreateRequest < 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
+
+    # A random key provided by the client, per unique bank transfer. Maximum of
+    # 50 characters.
+    # The API supports idempotency for safely retrying requests without
+    # accidentally performing the same operation twice. For example, if a
+    # request to create a bank transfer fails due to a network connection error,
+    # you can retry the request with the same idempotency key to guarantee that
+    # only a single bank transfer is created.
+    # @return [String]
+    attr_accessor :idempotency_key
+
+    # 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 bank 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 [BankTransferType]
+    attr_accessor :type
+
+    # The network or rails used for the transfer. Valid options are `ach`,
+    # `same-day-ach`, or `wire`.
+    # @return [BankTransferNetwork]
+    attr_accessor :network
+
+    # The amount of the bank transfer (decimal string with two digits of
+    # precision e.g. “10.00”).
+    # @return [String]
+    attr_accessor :amount
+
+    # The currency of the transfer amount – should be set to "USD".
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The transfer description. Maximum of 10 characters.
+    # @return [String]
+    attr_accessor :description
+
+    # 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 [BankTransferUser]
+    attr_accessor :user
+
+    # An arbitrary string provided by the client for storage with the bank
+    # transfer. May be up to 100 characters.
+    # @return [String]
+    attr_accessor :custom_tag
+
+    # The Metadata object is a mapping of client-provided string fields to any
+    # string value. The following limitations apply:
+    # - The JSON values must be Strings (no nested JSON objects allowed)
+    # - Only ASCII characters may be used
+    # - Maximum of 50 key/value pairs
+    # - Maximum key length of 40 characters
+    # - Maximum value length of 500 characters
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Plaid’s unique identifier for the origination account for this transfer.
+    # If you have more than one origination account, this value must be
+    # specified.
+    # @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['idempotency_key'] = 'idempotency_key'
+      @_hash['access_token'] = 'access_token'
+      @_hash['account_id'] = 'account_id'
+      @_hash['type'] = 'type'
+      @_hash['network'] = 'network'
+      @_hash['amount'] = 'amount'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['description'] = 'description'
+      @_hash['ach_class'] = 'ach_class'
+      @_hash['user'] = 'user'
+      @_hash['custom_tag'] = 'custom_tag'
+      @_hash['metadata'] = 'metadata'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        ach_class
+        custom_tag
+        metadata
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        custom_tag
+        origination_account_id
+      ]
+    end
+
+    def initialize(idempotency_key:, access_token:, account_id:, type:,
+                   network:, amount:, iso_currency_code:, description:, user:,
+                   client_id: SKIP, secret: SKIP, ach_class: SKIP,
+                   custom_tag: SKIP, metadata: 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
+      @idempotency_key = idempotency_key
+      @access_token = access_token
+      @account_id = account_id
+      @type = type
+      @network = network
+      @amount = amount
+      @iso_currency_code = iso_currency_code
+      @description = description
+      @ach_class = ach_class unless ach_class == SKIP
+      @user = user
+      @custom_tag = custom_tag unless custom_tag == SKIP
+      @metadata = metadata unless metadata == 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.
+      idempotency_key =
+        hash.key?('idempotency_key') ? hash['idempotency_key'] : nil
+      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
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      user = BankTransferUser.from_hash(hash['user']) if hash['user']
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      ach_class = hash.key?('ach_class') ? hash['ach_class'] : SKIP
+      custom_tag = hash.key?('custom_tag') ? hash['custom_tag'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      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.
+      BankTransferCreateRequest.new(idempotency_key: idempotency_key,
+                                    access_token: access_token,
+                                    account_id: account_id,
+                                    type: type,
+                                    network: network,
+                                    amount: amount,
+                                    iso_currency_code: iso_currency_code,
+                                    description: description,
+                                    user: user,
+                                    client_id: client_id,
+                                    secret: secret,
+                                    ach_class: ach_class,
+                                    custom_tag: custom_tag,
+                                    metadata: metadata,
+                                    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}, idempotency_key:"\
+      " #{@idempotency_key}, access_token: #{@access_token}, account_id: #{@account_id}, type:"\
+      " #{@type}, network: #{@network}, amount: #{@amount}, iso_currency_code:"\
+      " #{@iso_currency_code}, description: #{@description}, ach_class: #{@ach_class}, user:"\
+      " #{@user}, custom_tag: #{@custom_tag}, metadata: #{@metadata}, 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},"\
+      " idempotency_key: #{@idempotency_key.inspect}, access_token: #{@access_token.inspect},"\
+      " account_id: #{@account_id.inspect}, type: #{@type.inspect}, network: #{@network.inspect},"\
+      " amount: #{@amount.inspect}, iso_currency_code: #{@iso_currency_code.inspect}, description:"\
+      " #{@description.inspect}, ach_class: #{@ach_class.inspect}, user: #{@user.inspect},"\
+      " custom_tag: #{@custom_tag.inspect}, metadata: #{@metadata.inspect},"\
+      " origination_account_id: #{@origination_account_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end