plaid 14.0.0.beta.5 → 14.3.0

data/lib/plaid/models/transfer_event.rb

@@ -0,0 +1,355 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.33.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Represents an event in the Transfers API.
+  class TransferEvent
+    # Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
+    attr_accessor :event_id
+
+    # The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`.
+    attr_accessor :timestamp
+
+    attr_accessor :event_type
+
+    # The account ID associated with the transfer.
+    attr_accessor :account_id
+
+    # Plaid’s unique identifier for a transfer.
+    attr_accessor :transfer_id
+
+    # The ID of the origination account that this balance belongs to.
+    attr_accessor :origination_account_id
+
+    attr_accessor :transfer_type
+
+    # The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).
+    attr_accessor :transfer_amount
+
+    attr_accessor :failure_reason
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_id' => :'event_id',
+        :'timestamp' => :'timestamp',
+        :'event_type' => :'event_type',
+        :'account_id' => :'account_id',
+        :'transfer_id' => :'transfer_id',
+        :'origination_account_id' => :'origination_account_id',
+        :'transfer_type' => :'transfer_type',
+        :'transfer_amount' => :'transfer_amount',
+        :'failure_reason' => :'failure_reason'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'event_id' => :'Integer',
+        :'timestamp' => :'Time',
+        :'event_type' => :'TransferEventType',
+        :'account_id' => :'String',
+        :'transfer_id' => :'String',
+        :'origination_account_id' => :'String',
+        :'transfer_type' => :'TransferType',
+        :'transfer_amount' => :'String',
+        :'failure_reason' => :'TransferFailure'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'origination_account_id',
+        :'failure_reason'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferEvent` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'transfer_id')
+        self.transfer_id = attributes[:'transfer_id']
+      end
+
+      if attributes.key?(:'origination_account_id')
+        self.origination_account_id = attributes[:'origination_account_id']
+      end
+
+      if attributes.key?(:'transfer_type')
+        self.transfer_type = attributes[:'transfer_type']
+      end
+
+      if attributes.key?(:'transfer_amount')
+        self.transfer_amount = attributes[:'transfer_amount']
+      end
+
+      if attributes.key?(:'failure_reason')
+        self.failure_reason = attributes[:'failure_reason']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @event_id.nil?
+        invalid_properties.push('invalid value for "event_id", event_id cannot be nil.')
+      end
+
+      if @event_id < 0
+        invalid_properties.push('invalid value for "event_id", must be greater than or equal to 0.')
+      end
+
+
+      if @timestamp.nil?
+        invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @transfer_id.nil?
+        invalid_properties.push('invalid value for "transfer_id", transfer_id cannot be nil.')
+      end
+
+      if @transfer_type.nil?
+        invalid_properties.push('invalid value for "transfer_type", transfer_type cannot be nil.')
+      end
+
+      if @transfer_amount.nil?
+        invalid_properties.push('invalid value for "transfer_amount", transfer_amount cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @event_id.nil?
+      return false if @event_id < 0
+      return false if @timestamp.nil?
+      return false if @event_type.nil?
+      return false if @account_id.nil?
+      return false if @transfer_id.nil?
+      return false if @transfer_type.nil?
+      return false if @transfer_amount.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_id Value to be assigned
+    def event_id=(event_id)
+      if event_id.nil?
+        fail ArgumentError, 'event_id cannot be nil'
+      end
+
+      if event_id < 0
+        fail ArgumentError, 'invalid value for "event_id", must be greater than or equal to 0.'
+      end
+
+
+      @event_id = event_id
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          event_id == o.event_id &&
+          timestamp == o.timestamp &&
+          event_type == o.event_type &&
+          account_id == o.account_id &&
+          transfer_id == o.transfer_id &&
+          origination_account_id == o.origination_account_id &&
+          transfer_type == o.transfer_type &&
+          transfer_amount == o.transfer_amount &&
+          failure_reason == o.failure_reason
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [event_id, timestamp, event_type, account_id, transfer_id, origination_account_id, transfer_type, transfer_amount, failure_reason].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Plaid.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/plaid/models/transfer_event_list_request.rb

@@ -0,0 +1,411 @@
+=begin
+#The Plaid API
+
+#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
+
+The version of the OpenAPI document: 2020-09-14_1.33.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Plaid
+  # Defines the request schema for `/transfer/event/list`
+  class TransferEventListRequest
+    # 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.
+    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.
+    attr_accessor :secret
+
+    # The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
+    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`)
+    attr_accessor :end_date
+
+    # Plaid’s unique identifier for a transfer.
+    attr_accessor :transfer_id
+
+    # The account ID to get events for all transactions to/from an account.
+    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.
+    attr_accessor :transfer_type
+
+    # Filter events by event type.
+    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.
+    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.
+    attr_accessor :offset
+
+    # The origination account ID to get events for transfers from a specific origination account.
+    attr_accessor :origination_account_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'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'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'client_id' => :'String',
+        :'secret' => :'String',
+        :'start_date' => :'Time',
+        :'end_date' => :'Time',
+        :'transfer_id' => :'String',
+        :'account_id' => :'String',
+        :'transfer_type' => :'String',
+        :'event_types' => :'Array<TransferEventType>',
+        :'count' => :'Integer',
+        :'offset' => :'Integer',
+        :'origination_account_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'start_date',
+        :'end_date',
+        :'transfer_id',
+        :'account_id',
+        :'transfer_type',
+        :'count',
+        :'offset',
+        :'origination_account_id'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferEventListRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferEventListRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'secret')
+        self.secret = attributes[:'secret']
+      end
+
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'transfer_id')
+        self.transfer_id = attributes[:'transfer_id']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'transfer_type')
+        self.transfer_type = attributes[:'transfer_type']
+      end
+
+      if attributes.key?(:'event_types')
+        if (value = attributes[:'event_types']).is_a?(Array)
+          self.event_types = value
+        end
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      else
+        self.count = 25
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      else
+        self.offset = 0
+      end
+
+      if attributes.key?(:'origination_account_id')
+        self.origination_account_id = attributes[:'origination_account_id']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@count.nil? && @count > 25
+        invalid_properties.push('invalid value for "count", must be smaller than or equal to 25.')
+      end
+
+      if !@count.nil? && @count < 1
+        invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
+      end
+
+
+      if !@offset.nil? && @offset < 0
+        invalid_properties.push('invalid value for "offset", must be greater than or equal to 0.')
+      end
+
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      transfer_type_validator = EnumAttributeValidator.new('String', ["debit", "credit", "null"])
+      return false unless transfer_type_validator.valid?(@transfer_type)
+      return false if !@count.nil? && @count > 25
+      return false if !@count.nil? && @count < 1
+      return false if !@offset.nil? && @offset < 0
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transfer_type Object to be assigned
+    def transfer_type=(transfer_type)
+      validator = EnumAttributeValidator.new('String', ["debit", "credit", "null"])
+      unless validator.valid?(transfer_type)
+        fail ArgumentError, "invalid value for \"transfer_type\", must be one of #{validator.allowable_values}."
+      end
+      @transfer_type = transfer_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] count Value to be assigned
+    def count=(count)
+      if !count.nil? && count > 25
+        fail ArgumentError, 'invalid value for "count", must be smaller than or equal to 25.'
+      end
+
+      if !count.nil? && count < 1
+        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.'
+      end
+
+
+      @count = count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] offset Value to be assigned
+    def offset=(offset)
+      if !offset.nil? && offset < 0
+        fail ArgumentError, 'invalid value for "offset", must be greater than or equal to 0.'
+      end
+
+
+      @offset = offset
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          client_id == o.client_id &&
+          secret == o.secret &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          transfer_id == o.transfer_id &&
+          account_id == o.account_id &&
+          transfer_type == o.transfer_type &&
+          event_types == o.event_types &&
+          count == o.count &&
+          offset == o.offset &&
+          origination_account_id == o.origination_account_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [client_id, secret, start_date, end_date, transfer_id, account_id, transfer_type, event_types, count, offset, origination_account_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Plaid.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end