apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/transfer_event_list_request.rb

@@ -0,0 +1,214 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Plaid
+  # Defines the request schema for `/transfer/event/list`
+  class TransferEventListRequest < 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 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 transfers to list. This should be in RFC 3339 format
+    # (i.e. `2019-12-06T22:35:49Z`)
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # Plaid’s unique identifier for a transfer.
+    # @return [String]
+    attr_accessor :transfer_id
+
+    # The account ID to get events for all transactions to/from an account.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The type of transfer. This will be either `debit` or `credit`.  A `debit`
+    # indicates a transfer of money into your origination account; a `credit`
+    # indicates a transfer of money out of your origination account.
+    # @return [TransferType2]
+    attr_accessor :transfer_type
+
+    # Filter events by event type.
+    # @return [Array[TransferEventType]]
+    attr_accessor :event_types
+
+    # The maximum number of transfer events to return. If the number of events
+    # matching the above parameters is greater than `count`, the most recent
+    # events will be returned.
+    # @return [Integer]
+    attr_accessor :count
+
+    # The offset into the list of transfer events. When `count`=25 and
+    # `offset`=0, the first 25 events will be returned. When `count`=25 and
+    # `offset`=25, the next 25 bank transfer events will be returned.
+    # @return [Integer]
+    attr_accessor :offset
+
+    # The origination account ID to get events for transfers from a specific
+    # origination account.
+    # @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['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['transfer_id'] = 'transfer_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash['transfer_type'] = 'transfer_type'
+      @_hash['event_types'] = 'event_types'
+      @_hash['count'] = 'count'
+      @_hash['offset'] = 'offset'
+      @_hash['origination_account_id'] = 'origination_account_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        start_date
+        end_date
+        transfer_id
+        account_id
+        transfer_type
+        event_types
+        count
+        offset
+        origination_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+        transfer_id
+        account_id
+        count
+        offset
+        origination_account_id
+      ]
+    end
+
+    def initialize(client_id: SKIP, secret: SKIP, start_date: SKIP,
+                   end_date: SKIP, transfer_id: SKIP, account_id: SKIP,
+                   transfer_type: SKIP, event_types: SKIP, count: 25, offset: 0,
+                   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
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @transfer_id = transfer_id unless transfer_id == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @transfer_type = transfer_type unless transfer_type == SKIP
+      @event_types = event_types unless event_types == SKIP
+      @count = count unless count == SKIP
+      @offset = offset unless offset == 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
+      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
+      transfer_id = hash.key?('transfer_id') ? hash['transfer_id'] : SKIP
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      transfer_type = hash.key?('transfer_type') ? hash['transfer_type'] : SKIP
+      event_types = hash.key?('event_types') ? hash['event_types'] : SKIP
+      count = hash['count'] ||= 25
+      offset = hash['offset'] ||= 0
+      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.
+      TransferEventListRequest.new(client_id: client_id,
+                                   secret: secret,
+                                   start_date: start_date,
+                                   end_date: end_date,
+                                   transfer_id: transfer_id,
+                                   account_id: account_id,
+                                   transfer_type: transfer_type,
+                                   event_types: event_types,
+                                   count: count,
+                                   offset: offset,
+                                   origination_account_id: origination_account_id,
+                                   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}, transfer_id: #{@transfer_id}, account_id: #{@account_id},"\
+      " transfer_type: #{@transfer_type}, event_types: #{@event_types}, count: #{@count}, offset:"\
+      " #{@offset}, 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}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, transfer_id:"\
+      " #{@transfer_id.inspect}, account_id: #{@account_id.inspect}, transfer_type:"\
+      " #{@transfer_type.inspect}, event_types: #{@event_types.inspect}, count: #{@count.inspect},"\
+      " offset: #{@offset.inspect}, origination_account_id: #{@origination_account_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_event_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 `/transfer/event/list`
+  class TransferEventListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TransferEvent]]
+    attr_accessor :transfer_events
+
+    # 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['transfer_events'] = 'transfer_events'
+      @_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(transfer_events:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_events = transfer_events
+      @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
+      transfer_events = nil
+      unless hash['transfer_events'].nil?
+        transfer_events = []
+        hash['transfer_events'].each do |structure|
+          transfer_events << (TransferEvent.from_hash(structure) if structure)
+        end
+      end
+
+      transfer_events = nil unless hash.key?('transfer_events')
+      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.
+      TransferEventListResponse.new(transfer_events: transfer_events,
+                                    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} transfer_events: #{@transfer_events}, 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} transfer_events: #{@transfer_events.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_event_sync_request.rb

@@ -0,0 +1,110 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # Defines the request schema for `/transfer/event/sync`
+  class TransferEventSyncRequest < 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 latest (largest) `event_id` fetched via the sync endpoint, or 0
+    # initially.
+    # @return [Integer]
+    attr_accessor :after_id
+
+    # The maximum number of transfer events 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['after_id'] = 'after_id'
+      @_hash['count'] = 'count'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_id
+        secret
+        count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        count
+      ]
+    end
+
+    def initialize(after_id:, client_id: SKIP, secret: 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
+      @after_id = after_id
+      @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.
+      after_id = hash.key?('after_id') ? hash['after_id'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
+      secret = hash.key?('secret') ? hash['secret'] : SKIP
+      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.
+      TransferEventSyncRequest.new(after_id: after_id,
+                                   client_id: client_id,
+                                   secret: secret,
+                                   count: count,
+                                   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}, after_id: #{@after_id},"\
+      " 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}, after_id:"\
+      " #{@after_id.inspect}, count: #{@count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_event_sync_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 `/transfer/event/sync`
+  class TransferEventSyncResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TransferEvent]]
+    attr_accessor :transfer_events
+
+    # 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['transfer_events'] = 'transfer_events'
+      @_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(transfer_events:, request_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_events = transfer_events
+      @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
+      transfer_events = nil
+      unless hash['transfer_events'].nil?
+        transfer_events = []
+        hash['transfer_events'].each do |structure|
+          transfer_events << (TransferEvent.from_hash(structure) if structure)
+        end
+      end
+
+      transfer_events = nil unless hash.key?('transfer_events')
+      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.
+      TransferEventSyncResponse.new(transfer_events: transfer_events,
+                                    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} transfer_events: #{@transfer_events}, 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} transfer_events: #{@transfer_events.inspect}, request_id:"\
+      " #{@request_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/transfer_event_type.rb

@@ -0,0 +1,52 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The type of event that this transfer represents. `pending`: A new transfer
+  # was created; it is in the pending state. `cancelled`: The transfer was
+  # cancelled by the client. `failed`: The transfer failed, no funds were moved.
+  # `posted`: The transfer has been successfully submitted to the payment
+  # network. `reversed`: A posted transfer was reversed.
+  class TransferEventType
+    TRANSFER_EVENT_TYPE = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'posted'.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 'cancelled' then CANCELLED
+      when 'failed' then FAILED
+      when 'posted' then POSTED
+      when 'reversed' then REVERSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/transfer_failure.rb

@@ -0,0 +1,93 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The failure reason if the type of this transfer is `"failed"` or
+  # `"reversed"`. Null value otherwise.
+  class TransferFailure < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ACH return code, e.g. `R01`.  A return code will be provided if and
+    # only if the transfer status is `reversed`. For a full listing of ACH
+    # return codes, see [Bank Transfers
+    # errors](https://plaid.com/docs/errors/bank-transfers/#ach-return-codes).
+    # @return [String]
+    attr_accessor :ach_return_code
+
+    # A human-readable description of the reason for the failure or reversal.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ach_return_code'] = 'ach_return_code'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ach_return_code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        ach_return_code
+      ]
+    end
+
+    def initialize(ach_return_code: SKIP, description: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @ach_return_code = ach_return_code unless ach_return_code == SKIP
+      @description = description unless description == 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.
+      ach_return_code =
+        hash.key?('ach_return_code') ? hash['ach_return_code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : 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.
+      TransferFailure.new(ach_return_code: ach_return_code,
+                          description: description,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ach_return_code: #{@ach_return_code}, description: #{@description},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ach_return_code: #{@ach_return_code.inspect}, description:"\
+      " #{@description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end