apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/processor_auth_get_response.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorAuthGetResponse defines the response schema for
+  # `/processor/auth/get`
+  class ProcessorAuthGetResponse < 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
+
+    # An object containing identifying numbers used for making electronic
+    # transfers to and from the `account`. The identifying number type (ACH,
+    # EFT, IBAN, or BACS) used will depend on the country of the account. An
+    # account may have more than one number type. If a particular identifying
+    # number type is not used by the `account` for which auth data has been
+    # requested, a null value will be returned.
+    # @return [ProcessorNumber]
+    attr_accessor :numbers
+
+    # A single account at a financial institution.
+    # @return [Account]
+    attr_accessor :account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'request_id'
+      @_hash['numbers'] = 'numbers'
+      @_hash['account'] = 'account'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id:, numbers:, account:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @request_id = request_id
+      @numbers = numbers
+      @account = account
+      @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
+      numbers = ProcessorNumber.from_hash(hash['numbers']) if hash['numbers']
+      account = Account.from_hash(hash['account']) if hash['account']
+
+      # 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.
+      ProcessorAuthGetResponse.new(request_id: request_id,
+                                   numbers: numbers,
+                                   account: account,
+                                   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}, numbers: #{@numbers}, account: #{@account},"\
+      " 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}, numbers: #{@numbers.inspect}, account:"\
+      " #{@account.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor_balance_get_request.rb

@@ -0,0 +1,111 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorBalanceGetRequest defines the request schema for
+  # `/processor/balance/get`
+  class ProcessorBalanceGetRequest < 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 processor token obtained from the Plaid integration partner. Processor
+    # tokens are in the format: `processor-<environment>-<identifier>`
+    # @return [String]
+    attr_accessor :processor_token
+
+    # An optional object to filter `/processor/balance/get` results.
+    # @return [ProcessorBalanceGetRequestOptions]
+    attr_accessor :options
+
+    # 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['processor_token'] = 'processor_token'
+      @_hash['options'] = 'options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(processor_token:, client_id: SKIP, secret: SKIP,
+                   options: 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
+      @processor_token = processor_token
+      @options = options unless options == 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.
+      processor_token =
+        hash.key?('processor_token') ? hash['processor_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      options = ProcessorBalanceGetRequestOptions.from_hash(hash['options']) if hash['options']
+
+      # 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.
+      ProcessorBalanceGetRequest.new(processor_token: processor_token,
+                                     client_id: client_id,
+                                     secret: secret,
+                                     options: options,
+                                     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}, processor_token:"\
+      " #{@processor_token}, options: #{@options}, 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},"\
+      " processor_token: #{@processor_token.inspect}, options: #{@options.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor_balance_get_request_options.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # An optional object to filter `/processor/balance/get` results.
+  class ProcessorBalanceGetRequestOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
+    # (`YYYY-MM-DDTHH:mm:ssZ`) indicating the oldest acceptable balance when
+    # making a request to `/accounts/balance/get`.
+    # If the balance that is pulled for `ins_128026` (Capital One) is older than
+    # the given timestamp, an `INVALID_REQUEST` error with the code of
+    # `LAST_UPDATED_DATETIME_OUT_OF_RANGE` will be returned with the most recent
+    # timestamp for the requested account contained in the response.
+    # This field is only used when the institution is `ins_128026` (Capital
+    # One), in which case a value must be provided or an `INVALID_REQUEST` error
+    # with the code of `INVALID_FIELD` will be returned. For all other
+    # institutions, this field is ignored.
+    # @return [DateTime]
+    attr_accessor :min_last_updated_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['min_last_updated_datetime'] = 'min_last_updated_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        min_last_updated_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(min_last_updated_datetime: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless min_last_updated_datetime == SKIP
+        @min_last_updated_datetime =
+          min_last_updated_datetime
+      end
+      @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.
+      min_last_updated_datetime = if hash.key?('min_last_updated_datetime')
+                                    (DateTimeHelper.from_rfc3339(hash['min_last_updated_datetime']) if hash['min_last_updated_datetime'])
+                                  else
+                                    SKIP
+                                  end
+
+      # 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.
+      ProcessorBalanceGetRequestOptions.new(min_last_updated_datetime: min_last_updated_datetime,
+                                            additional_properties: additional_properties)
+    end
+
+    def to_custom_min_last_updated_datetime
+      DateTimeHelper.to_rfc3339(min_last_updated_datetime)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} min_last_updated_datetime: #{@min_last_updated_datetime},"\
+      " 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} min_last_updated_datetime: #{@min_last_updated_datetime.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor_balance_get_response.rb

@@ -0,0 +1,85 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # ProcessorBalanceGetResponse defines the response schema for
+  # `/processor/balance/get`
+  class ProcessorBalanceGetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A single account at a financial institution.
+    # @return [Account]
+    attr_accessor :account
+
+    # 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['account'] = 'account'
+      @_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(account:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account = account
+      @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.
+      account = Account.from_hash(hash['account']) if hash['account']
+      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.
+      ProcessorBalanceGetResponse.new(account: account,
+                                      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} account: #{@account}, 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} account: #{@account.inspect}, request_id: #{@request_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/processor_bank_transfer_create_request.rb

@@ -0,0 +1,248 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/processor/bank_transfer/create`
+  class ProcessorBankTransferCreateRequest < 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 processor token obtained from the Plaid integration partner. Processor
+    # tokens are in the format: `processor-<environment>-<identifier>`
+    # @return [String]
+    attr_accessor :processor_token
+
+    # 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['processor_token'] = 'processor_token'
+      @_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:, processor_token:, 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
+      @processor_token = processor_token
+      @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
+      processor_token =
+        hash.key?('processor_token') ? hash['processor_token'] : 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.
+      ProcessorBankTransferCreateRequest.new(idempotency_key: idempotency_key,
+                                             processor_token: processor_token,
+                                             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}, processor_token: #{@processor_token}, 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}, processor_token:"\
+      " #{@processor_token.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