class PostFinanceCheckout::EntityQuery
The entity query allows to search for specific entities by providing filters. This is similar to a SQL query.
Attributes
The filter node defines the root filter node of the query. The root node may contain multiple sub nodes with different filters in it.
The language is applied to the ordering of the entities returned. Some entity fields are language dependent and hence the language is required to order them.
The number of entities defines how many entities should be returned. There is a maximum of 100 entities.
The order bys allows to define the ordering of the entities returned by the search.
The 'starting entity' defines the entity number at which the returned result should start. The entity number is the consecutive number of the entity as returned and it is not the entity id.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 39 def self.attribute_map { :'filter' => :'filter', :'language' => :'language', :'number_of_entities' => :'numberOfEntities', :'order_bys' => :'orderBys', :'starting_entity' => :'startingEntity' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 62 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'filter') self.filter = attributes[:'filter'] end if attributes.has_key?(:'language') self.language = attributes[:'language'] end if attributes.has_key?(:'numberOfEntities') self.number_of_entities = attributes[:'numberOfEntities'] end if attributes.has_key?(:'orderBys') if (value = attributes[:'orderBys']).is_a?(Array) self.order_bys = value end end if attributes.has_key?(:'startingEntity') self.starting_entity = attributes[:'startingEntity'] end end
Attribute type mapping.
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 50 def self.swagger_types { :'filter' => :'EntityQueryFilter', :'language' => :'String', :'number_of_entities' => :'Integer', :'order_bys' => :'Array<EntityQueryOrderBy>', :'starting_entity' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 106 def ==(o) return true if self.equal?(o) self.class == o.class && filter == o.filter && language == o.language && number_of_entities == o.number_of_entities && order_bys == o.order_bys && starting_entity == o.starting_entity 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/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 152 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = PostFinanceCheckout.const_get(type).new temp_model.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/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 218 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/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 131 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 118 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 124 def hash [filter, language, number_of_entities, order_bys, starting_entity].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 93 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 204 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 192 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/postfinancecheckout-ruby-sdk/models/entity_query.rb, line 100 def valid? true end