apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/bank_transfer_sweep.rb

@@ -0,0 +1,129 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # BankTransferSweep describes a sweep transfer.
+  class BankTransferSweep < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the sweep.
+    # @return [Integer]
+    attr_accessor :id
+
+    # Identifier of the sweep transfer.
+    # @return [String]
+    attr_accessor :transfer_id
+
+    # The datetime when the sweep occurred, in RFC 3339 format.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The amount of the sweep.
+    # @return [String]
+    attr_accessor :amount
+
+    # The currency of the sweep, e.g. "USD".
+    # @return [String]
+    attr_accessor :iso_currency_code
+
+    # The account where the funds are swept to.
+    # @return [BankTransferSweepAccount]
+    attr_accessor :sweep_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['transfer_id'] = 'transfer_id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['amount'] = 'amount'
+      @_hash['iso_currency_code'] = 'iso_currency_code'
+      @_hash['sweep_account'] = 'sweep_account'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        transfer_id
+      ]
+    end
+
+    def initialize(id:, transfer_id:, created_at:, amount:, iso_currency_code:,
+                   sweep_account:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @transfer_id = transfer_id
+      @created_at = created_at
+      @amount = amount
+      @iso_currency_code = iso_currency_code
+      @sweep_account = sweep_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.
+      id = hash.key?('id') ? hash['id'] : nil
+      transfer_id = hash.key?('transfer_id') ? hash['transfer_id'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      iso_currency_code =
+        hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
+      sweep_account = BankTransferSweepAccount.from_hash(hash['sweep_account']) if
+        hash['sweep_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.
+      BankTransferSweep.new(id: id,
+                            transfer_id: transfer_id,
+                            created_at: created_at,
+                            amount: amount,
+                            iso_currency_code: iso_currency_code,
+                            sweep_account: sweep_account,
+                            additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, transfer_id: #{@transfer_id}, created_at: #{@created_at},"\
+      " amount: #{@amount}, iso_currency_code: #{@iso_currency_code}, sweep_account:"\
+      " #{@sweep_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} id: #{@id.inspect}, transfer_id: #{@transfer_id.inspect}, created_at:"\
+      " #{@created_at.inspect}, amount: #{@amount.inspect}, iso_currency_code:"\
+      " #{@iso_currency_code.inspect}, sweep_account: #{@sweep_account.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_sweep_account.rb

@@ -0,0 +1,84 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The account where the funds are swept to.
+  class BankTransferSweepAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :routing_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['routing_number'] = 'routing_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number:, routing_number:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_number = account_number
+      @routing_number = routing_number
+      @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
+
+      # 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.
+      BankTransferSweepAccount.new(account_number: account_number,
+                                   routing_number: routing_number,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number}, routing_number: #{@routing_number},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number.inspect}, routing_number:"\
+      " #{@routing_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_sweep_get_request.rb

@@ -0,0 +1,113 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # BankTransferSweepGetRequest defines the request schema for
+  # `/bank_transfer/sweep/get`
+  class BankTransferSweepGetRequest < 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
+
+    # Identifier of the sweep.
+    # @return [Integer]
+    attr_accessor :sweep_id
+
+    # If multiple origination accounts are available, `origination_account_id`
+    # must be used to specify the account that the sweep belongs to.
+    # @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['sweep_id'] = 'sweep_id'
+      @_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(sweep_id:, 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
+      @sweep_id = sweep_id
+      @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.
+      sweep_id = hash.key?('sweep_id') ? hash['sweep_id'] : nil
+      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.
+      BankTransferSweepGetRequest.new(sweep_id: sweep_id,
+                                      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}, sweep_id: #{@sweep_id},"\
+      " 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}, sweep_id:"\
+      " #{@sweep_id.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_sweep_get_response.rb

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

data/lib/plaid/models/bank_transfer_sweep_list_request.rb

@@ -0,0 +1,164 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # BankTransferSweepListRequest defines the request schema for
+  # `/bank_transfer/sweep/list`
+  class BankTransferSweepListRequest < 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 that the sweeps belong to.
+    # @return [String]
+    attr_accessor :origination_account_id
+
+    # Starting ID of sweeps to return.
+    # @return [Integer]
+    attr_accessor :start_id
+
+    # The start datetime of sweeps to return (RFC 3339 format).
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # The end datetime of sweeps to return (RFC 3339 format).
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # The maximum number of sweeps to return.
+    # @return [Integer]
+    attr_accessor :count
+
+    # 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['start_id'] = 'start_id'
+      @_hash['start_time'] = 'start_time'
+      @_hash['end_time'] = 'end_time'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        origination_account_id
+        start_id
+        start_time
+        end_time
+        count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        origination_account_id
+        start_id
+        start_time
+        end_time
+        count
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, origination_account_id: SKIP,
+                   start_id: SKIP, start_time: SKIP, end_time: SKIP, count: 25,
+                   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
+      @start_id = start_id unless start_id == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == SKIP
+      @count = count unless count == 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
+      start_id = hash.key?('start_id') ? hash['start_id'] : SKIP
+      start_time = if hash.key?('start_time')
+                     (DateTimeHelper.from_rfc3339(hash['start_time']) if hash['start_time'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('end_time')
+                   (DateTimeHelper.from_rfc3339(hash['end_time']) if hash['end_time'])
+                 else
+                   SKIP
+                 end
+      count = hash['count'] ||= 25
+
+      # 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.
+      BankTransferSweepListRequest.new(client_id: client_id,
+                                       secret: secret,
+                                       origination_account_id: origination_account_id,
+                                       start_id: start_id,
+                                       start_time: start_time,
+                                       end_time: end_time,
+                                       count: count,
+                                       additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_custom_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    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}, start_id: #{@start_id}, start_time: #{@start_time}, end_time:"\
+      " #{@end_time}, count: #{@count}, 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}, start_id:"\
+      " #{@start_id.inspect}, start_time: #{@start_time.inspect}, end_time: #{@end_time.inspect},"\
+      " count: #{@count.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/bank_transfer_sweep_list_response.rb

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