class Plaid::SandboxTransferTestClockListRequest
Defines the request schema for ‘/sandbox/transfer/test_clock/list`
Attributes
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.
The maximum number of test clocks to return.
The end virtual timestamp of test clocks to return. This should be in RFC 3339 format (i.e. ‘2019-12-06T22:35:49Z`)
The number of test clocks to skip before returning results.
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.
The start virtual timestamp of test clocks to return. This should be in RFC 3339 format (i.e. ‘2019-12-06T22:35:49Z`)
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 50 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 38 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'start_virtual_time' => :'start_virtual_time', :'end_virtual_time' => :'end_virtual_time', :'count' => :'count', :'offset' => :'offset' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 203 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 77 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SandboxTransferTestClockListRequest` 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::SandboxTransferTestClockListRequest`. 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_virtual_time') self.start_virtual_time = attributes[:'start_virtual_time'] end if attributes.key?(:'end_virtual_time') self.end_virtual_time = attributes[:'end_virtual_time'] 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 end
List of attributes with nullable: true
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 67 def self.openapi_nullable Set.new([ :'start_virtual_time', :'end_virtual_time', :'count', ]) end
Attribute type mapping.
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 55 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'start_virtual_time' => :'Time', :'end_virtual_time' => :'Time', :'count' => :'Integer', :'offset' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 177 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && start_virtual_time == o.start_virtual_time && end_virtual_time == o.end_virtual_time && count == o.count && offset == o.offset end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 234 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
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
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 305 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 210 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) 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
Custom attribute writer method with validation @param [Object] count Value to be assigned
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 151 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 190 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 196 def hash [client_id, secret, start_virtual_time, end_virtual_time, count, offset].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 121 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
Custom attribute writer method with validation @param [Object] offset Value to be assigned
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 166 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 287 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 275 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/sandbox_transfer_test_clock_list_request.rb, line 142 def valid? return false if !@count.nil? && @count > 25 return false if !@count.nil? && @count < 1 return false if !@offset.nil? && @offset < 0 true end