Class: SquareConnect::SearchCatalogObjectsRequest
- Inherits:
-
Object
- Object
- SquareConnect::SearchCatalogObjectsRequest
- Defined in:
- lib/square_connect/models/search_catalog_objects_request.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#begin_time ⇒ Object
Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z".
-
#cursor ⇒ Object
The pagination cursor returned in the previous response.
-
#include_deleted_objects ⇒ Object
If ‘true`, deleted objects will be included in the results.
-
#include_related_objects ⇒ Object
If ‘true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response.
-
#limit ⇒ Object
A limit on the number of results to be returned in a single page.
-
#object_types ⇒ Object
The desired set of object types to appear in the search results.
-
#query ⇒ Object
A query to be used to filter or sort the results.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_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 ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SearchCatalogObjectsRequest
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 = {}) ⇒ SearchCatalogObjectsRequest
Initializes the object
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 86 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?(:'cursor') self.cursor = attributes[:'cursor'] end if attributes.has_key?(:'object_types') if (value = attributes[:'object_types']).is_a?(Array) self.object_types = value end end if attributes.has_key?(:'include_deleted_objects') self.include_deleted_objects = attributes[:'include_deleted_objects'] end if attributes.has_key?(:'include_related_objects') self. = attributes[:'include_related_objects'] end if attributes.has_key?(:'begin_time') self.begin_time = attributes[:'begin_time'] end if attributes.has_key?(:'query') self.query = attributes[:'query'] end if attributes.has_key?(:'limit') self.limit = attributes[:'limit'] end end |
Instance Attribute Details
#begin_time ⇒ Object
Return objects modified after this [timestamp](#workingwithdates), in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". The timestamp is exclusive - objects with a timestamp equal to ‘begin_time` will not be included in the response.
28 29 30 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 28 def begin_time @begin_time end |
#cursor ⇒ Object
The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information.
16 17 18 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 16 def cursor @cursor end |
#include_deleted_objects ⇒ Object
If ‘true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.
22 23 24 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 22 def include_deleted_objects @include_deleted_objects end |
#include_related_objects ⇒ Object
If ‘true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response.
25 26 27 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 25 def @include_related_objects end |
#limit ⇒ Object
A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.
34 35 36 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 34 def limit @limit end |
#object_types ⇒ Object
The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely ‘"ITEM"`, `"ITEM_VARIATION"`, `"CATEGORY"`, `"DISCOUNT"`, `"TAX"`, `"MODIFIER"`, or `"MODIFIER_LIST"`.
19 20 21 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 19 def object_types @object_types end |
#query ⇒ Object
A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.
31 32 33 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 31 def query @query end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 59 def self.attribute_map { :'cursor' => :'cursor', :'object_types' => :'object_types', :'include_deleted_objects' => :'include_deleted_objects', :'include_related_objects' => :'include_related_objects', :'begin_time' => :'begin_time', :'query' => :'query', :'limit' => :'limit' } end |
.swagger_types ⇒ Object
Attribute type mapping.
72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 72 def self.swagger_types { :'cursor' => :'String', :'object_types' => :'Array<String>', :'include_deleted_objects' => :'BOOLEAN', :'include_related_objects' => :'BOOLEAN', :'begin_time' => :'String', :'query' => :'CatalogQuery', :'limit' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 139 def ==(o) return true if self.equal?(o) self.class == o.class && cursor == o.cursor && object_types == o.object_types && include_deleted_objects == o.include_deleted_objects && == o. && begin_time == o.begin_time && query == o.query && limit == o.limit end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 216 217 218 219 220 221 222 223 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 187 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 = SquareConnect.const_get(type).new temp_model.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
253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 253 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
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 166 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 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 |
#eql?(o) ⇒ Boolean
153 154 155 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 153 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
159 160 161 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 159 def hash [cursor, object_types, include_deleted_objects, , begin_time, query, limit].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
126 127 128 129 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 126 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
233 234 235 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 233 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
239 240 241 242 243 244 245 246 247 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 239 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 |
#to_s ⇒ String
Returns the string representation of the object
227 228 229 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 227 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
133 134 135 |
# File 'lib/square_connect/models/search_catalog_objects_request.rb', line 133 def valid? return true end |