Class: Shortcut::StorySearchResults
- Inherits:
-
Object
- Object
- Shortcut::StorySearchResults
- Defined in:
- lib/shortcut_client_ruby/models/story_search_results.rb
Overview
The results of the Story search query.
Instance Attribute Summary collapse
-
#_next ⇒ Object
The URL path and query string for the next page of search results.
-
#cursors ⇒ Object
Returns the value of attribute cursors.
-
#data ⇒ Object
A list of search results.
-
#total ⇒ Object
The total number of matches for the search query.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ StorySearchResults
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ StorySearchResults
Initializes the object
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 64 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::StorySearchResults` 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 `Shortcut::StorySearchResults`. 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?(:'total') self.total = attributes[:'total'] end if attributes.key?(:'data') if (value = attributes[:'data']).is_a?(Array) self.data = value end end if attributes.key?(:'_next') self._next = attributes[:'_next'] end if attributes.key?(:'cursors') if (value = attributes[:'cursors']).is_a?(Array) self.cursors = value end end end |
Instance Attribute Details
#_next ⇒ Object
The URL path and query string for the next page of search results.
26 27 28 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 26 def _next @_next end |
#cursors ⇒ Object
Returns the value of attribute cursors.
28 29 30 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 28 def cursors @cursors end |
#data ⇒ Object
A list of search results.
23 24 25 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 23 def data @data end |
#total ⇒ Object
The total number of matches for the search query. The first 1000 matches can be paged through via the API.
20 21 22 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 20 def total @total end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
41 42 43 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 41 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
31 32 33 34 35 36 37 38 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 31 def self.attribute_map { :'total' => :'total', :'data' => :'data', :'_next' => :'next', :'cursors' => :'cursors' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
147 148 149 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 147 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
56 57 58 59 60 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 56 def self.openapi_nullable Set.new([ :'_next', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
46 47 48 49 50 51 52 53 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 46 def self.openapi_types { :'total' => :'Integer', :'data' => :'Array<Story>', :'_next' => :'String', :'cursors' => :'Array<String>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
123 124 125 126 127 128 129 130 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 123 def ==(o) return true if self.equal?(o) self.class == o.class && total == o.total && data == o.data && _next == o._next && cursors == o.cursors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 178 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 = Shortcut.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 249 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 154 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 |
#eql?(o) ⇒ Boolean
134 135 136 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 134 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
140 141 142 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 140 def hash [total, data, _next, cursors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 100 def list_invalid_properties invalid_properties = Array.new if @total.nil? invalid_properties.push('invalid value for "total", total cannot be nil.') end if @data.nil? invalid_properties.push('invalid value for "data", data cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
225 226 227 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 225 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 231 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 |
#to_s ⇒ String
Returns the string representation of the object
219 220 221 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 219 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
115 116 117 118 119 |
# File 'lib/shortcut_client_ruby/models/story_search_results.rb', line 115 def valid? return false if @total.nil? return false if @data.nil? true end |