apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/bank_transfer_list_request.rb

@@ -0,0 +1,175 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Defines the request schema for `/bank_transfer/list`
+  class BankTransferListRequest < 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 start datetime of bank transfers to list. This should be in RFC 3339
+    # format (i.e. `2019-12-06T22:35:49Z`)
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end datetime of bank transfers to list. This should be in RFC 3339
+    # format (i.e. `2019-12-06T22:35:49Z`)
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The maximum number of bank transfers to return.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The number of bank transfers to skip before returning results.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # Filter bank transfers to only those originated through the specified
+    # origination account.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # Indicates the direction of the transfer: `outbound` for API-initiated
+    # transfers, or `inbound` for payments received by the FBO account.
+    # @return [BankTransferDirection]
+    attr_accessor :direction
+
+    # 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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash['direction'] = 'direction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        start_date
+        end_date
+        count
+        offset
+        origination_account_id
+        direction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        origination_account_id
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, start_date: SKIP,
+                   end_date: SKIP, count: 25, offset: 0,
+                   origination_account_id: SKIP, direction: 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
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @count = count unless count == SKIP
+      @offset = offset unless offset == SKIP
+      @origination_account_id = origination_account_id unless origination_account_id == SKIP
+      @direction = direction unless direction == 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
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   else
+                     SKIP
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 else
+                   SKIP
+                 end
+      count = hash['count'] ||= 25
+      offset = hash['offset'] ||= 0
+      origination_account_id =
+        hash.key?('origination_account_id') ? hash['origination_account_id'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : 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.
+      BankTransferListRequest.new(client_id: client_id,
+                                  secret: secret,
+                                  start_date: start_date,
+                                  end_date: end_date,
+                                  count: count,
+                                  offset: offset,
+                                  origination_account_id: origination_account_id,
+                                  direction: direction,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    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}, start_date: #{@start_date},"\
+      " end_date: #{@end_date}, count: #{@count}, offset: #{@offset}, origination_account_id:"\
+      " #{@origination_account_id}, direction: #{@direction}, 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}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, count: #{@count.inspect}, offset:"\
+      " #{@offset.inspect}, origination_account_id: #{@origination_account_id.inspect}, direction:"\
+      " #{@direction.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_list_response.rb

@@ -0,0 +1,93 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/list`
+  class BankTransferListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[BankTransfer]]
+    attr_accessor :bank_transfers
+
+    # 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['bank_transfers'] = 'bank_transfers'
+      @_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(bank_transfers:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_transfers = bank_transfers
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      bank_transfers = nil
+      unless hash['bank_transfers'].nil?
+        bank_transfers = []
+        hash['bank_transfers'].each do |structure|
+          bank_transfers << (BankTransfer.from_hash(structure) if structure)
+        end
+      end
+
+      bank_transfers = nil unless hash.key?('bank_transfers')
+      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.
+      BankTransferListResponse.new(bank_transfers: bank_transfers,
+                                   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} bank_transfers: #{@bank_transfers}, 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} bank_transfers: #{@bank_transfers.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_migrate_account_request.rb

@@ -0,0 +1,117 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/bank_transfer/migrate_account`
+  class BankTransferMigrateAccountRequest < 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 user's account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The user's routing number.
+    # @return [String]
+    attr_accessor :routing_number
+
+    # The type of the bank account (`checking` or `savings`).
+    # @return [String]
+    attr_accessor :account_type
+
+    # 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['account_number'] = 'account_number'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash['account_type'] = 'account_type'
+      @_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(account_number:, routing_number:, account_type:,
+                   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
+      @account_number = account_number
+      @routing_number = routing_number
+      @account_type = account_type
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      routing_number =
+        hash.key?('routing_number') ? hash['routing_number'] : nil
+      account_type = hash.key?('account_type') ? hash['account_type'] : 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.
+      BankTransferMigrateAccountRequest.new(account_number: account_number,
+                                            routing_number: routing_number,
+                                            account_type: account_type,
+                                            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}, account_number:"\
+      " #{@account_number}, routing_number: #{@routing_number}, account_type: #{@account_type},"\
+      " 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},"\
+      " account_number: #{@account_number.inspect}, routing_number: #{@routing_number.inspect},"\
+      " account_type: #{@account_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_migrate_account_response.rb

@@ -0,0 +1,93 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the response schema for `/bank_transfer/migrate_account`
+  class BankTransferMigrateAccountResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Plaid `access_token` for the newly created Item.
+    # @return [String]
+    attr_accessor :access_token
+
+    # The Plaid `account_id` for the newly created Item.
+    # @return [String]
+    attr_accessor :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['access_token'] = 'access_token'
+      @_hash['account_id'] = '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
+      []
+    end
+
+    def initialize(access_token:, account_id:, request_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @access_token = access_token
+      @account_id = 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.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      account_id = hash.key?('account_id') ? hash['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.
+      BankTransferMigrateAccountResponse.new(access_token: access_token,
+                                             account_id: 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} access_token: #{@access_token}, account_id: #{@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} access_token: #{@access_token.inspect}, account_id: #{@account_id.inspect},"\
+      " request_id: #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_network.rb

@@ -0,0 +1,41 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The network or rails used for the transfer. Valid options are `ach`,
+  # `same-day-ach`, or `wire`.
+  class BankTransferNetwork
+    BANK_TRANSFER_NETWORK = [
+      # TODO: Write general description for ACH
+      ACH = 'ach'.freeze,
+
+      # TODO: Write general description for SAMEDAYACH
+      SAMEDAYACH = 'same-day-ach'.freeze,
+
+      # TODO: Write general description for WIRE
+      WIRE = 'wire'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ach' then ACH
+      when 'samedayach' then SAMEDAYACH
+      when 'wire' then WIRE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_receiver_details.rb

@@ -0,0 +1,79 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The receiver details if the type of this event is `reciever_pending` or
+  # `reciever_posted`. Null value otherwise.
+  class BankTransferReceiverDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The sign of the available balance for the receiver bank account associated
+    # with the receiver event at the time the matching transaction was found.
+    # Can be `positive`, `negative`, or null if the balance was not available at
+    # the time.
+    # @return [AvailableBalance]
+    attr_accessor :available_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['available_balance'] = 'available_balance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(available_balance:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @available_balance = available_balance
+      @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.
+      available_balance =
+        hash.key?('available_balance') ? hash['available_balance'] : 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.
+      BankTransferReceiverDetails.new(available_balance: available_balance,
+                                      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} available_balance: #{@available_balance}, 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} available_balance: #{@available_balance.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_status.rb

@@ -0,0 +1,48 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The status of the transfer.
+  class BankTransferStatus
+    BANK_TRANSFER_STATUS = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'posted'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for REVERSED
+      REVERSED = 'reversed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'posted' then POSTED
+      when 'cancelled' then CANCELLED
+      when 'failed' then FAILED
+      when 'reversed' then REVERSED
+      else
+        default_value
+      end
+    end
+  end
+end