Class: Tradenity::Coupon
- Inherits:
-
Object
- Object
- Tradenity::Coupon
- Defined in:
- lib/tradenity/resources/coupon.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#__meta ⇒ Object
Returns the value of attribute __meta.
-
#begins_at ⇒ Object
Returns the value of attribute begins_at.
-
#code ⇒ Object
Returns the value of attribute code.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#description ⇒ Object
Returns the value of attribute description.
-
#ends_at ⇒ Object
Returns the value of attribute ends_at.
-
#include ⇒ Object
Returns the value of attribute include.
-
#minimum_order ⇒ Object
Returns the value of attribute minimum_order.
-
#name ⇒ Object
Returns the value of attribute name.
-
#status ⇒ Object
Returns the value of attribute status.
-
#updated_at ⇒ Object
Returns the value of attribute updated_at.
Class Method Summary collapse
- .api_client ⇒ Object
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.find_all ⇒ Page<Coupon>
List Coupons Return a list of Coupons.
-
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of Coupon Return multiple instances of Coupon by its attributes.
-
.find_one_by(opts = {}) ⇒ Coupon
Find Coupon by its parameters Return single instance of Collection by its attributes.
-
.list_all_coupons(opts = {}) ⇒ Page<Coupon>
List Coupons Return a list of Coupons.
-
.list_all_coupons_with_http_info(opts = {}) ⇒ Array<(Page<Coupon>, Fixnum, Hash)>
List Coupons Return a list of Coupons.
-
.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.
- #id ⇒ Object
- #id=(id) ⇒ Object
-
#initialize(attributes = {}) ⇒ Coupon
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 = {}) ⇒ Coupon
Initializes the object
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/tradenity/resources/coupon.rb', line 114 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'__meta') self. = attributes[:'__meta'] end if attributes.has_key?(:'createdAt') self.created_at = attributes[:'createdAt'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'updatedAt') self.updated_at = attributes[:'updatedAt'] end if attributes.has_key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'minimumOrder') self.minimum_order = attributes[:'minimumOrder'] end if attributes.has_key?(:'minimum_order') self.minimum_order = attributes[:'minimum_order'] end if attributes.has_key?(:'code') self.code = attributes[:'code'] end if attributes.has_key?(:'beginsAt') self.begins_at = attributes[:'beginsAt'] end if attributes.has_key?(:'begins_at') self.begins_at = attributes[:'begins_at'] end if attributes.has_key?(:'endsAt') self.ends_at = attributes[:'endsAt'] end if attributes.has_key?(:'ends_at') self.ends_at = attributes[:'ends_at'] end if attributes.has_key?(:'include') self.include = attributes[:'include'] end end |
Instance Attribute Details
#__meta ⇒ Object
Returns the value of attribute __meta.
32 33 34 |
# File 'lib/tradenity/resources/coupon.rb', line 32 def @__meta end |
#begins_at ⇒ Object
Returns the value of attribute begins_at.
48 49 50 |
# File 'lib/tradenity/resources/coupon.rb', line 48 def begins_at @begins_at end |
#code ⇒ Object
Returns the value of attribute code.
46 47 48 |
# File 'lib/tradenity/resources/coupon.rb', line 46 def code @code end |
#created_at ⇒ Object
Returns the value of attribute created_at.
34 35 36 |
# File 'lib/tradenity/resources/coupon.rb', line 34 def created_at @created_at end |
#description ⇒ Object
Returns the value of attribute description.
40 41 42 |
# File 'lib/tradenity/resources/coupon.rb', line 40 def description @description end |
#ends_at ⇒ Object
Returns the value of attribute ends_at.
50 51 52 |
# File 'lib/tradenity/resources/coupon.rb', line 50 def ends_at @ends_at end |
#include ⇒ Object
Returns the value of attribute include.
52 53 54 |
# File 'lib/tradenity/resources/coupon.rb', line 52 def include @include end |
#minimum_order ⇒ Object
Returns the value of attribute minimum_order.
44 45 46 |
# File 'lib/tradenity/resources/coupon.rb', line 44 def minimum_order @minimum_order end |
#name ⇒ Object
Returns the value of attribute name.
38 39 40 |
# File 'lib/tradenity/resources/coupon.rb', line 38 def name @name end |
#status ⇒ Object
Returns the value of attribute status.
42 43 44 |
# File 'lib/tradenity/resources/coupon.rb', line 42 def status @status end |
#updated_at ⇒ Object
Returns the value of attribute updated_at.
36 37 38 |
# File 'lib/tradenity/resources/coupon.rb', line 36 def updated_at @updated_at end |
Class Method Details
.api_client ⇒ Object
363 364 365 |
# File 'lib/tradenity/resources/coupon.rb', line 363 def self.api_client ApiClient.default end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/tradenity/resources/coupon.rb', line 77 def self.attribute_map { :'id' => :'id', :'__meta' => :'__meta', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt', :'name' => :'name', :'description' => :'description', :'status' => :'status', :'minimum_order' => :'minimumOrder', :'code' => :'code', :'begins_at' => :'beginsAt', :'ends_at' => :'endsAt', :'include' => :'include' } end |
.find_all ⇒ Page<Coupon>
List Coupons Return a list of Coupons
374 375 376 |
# File 'lib/tradenity/resources/coupon.rb', line 374 def find_all list_all_coupons end |
.find_all_by(opts = {}) ⇒ Page<Collection>
Find List of Coupon Return multiple instances of Coupon by its attributes.
382 383 384 |
# File 'lib/tradenity/resources/coupon.rb', line 382 def find_all_by(opts = {}) list_all_coupons(opts) end |
.find_one_by(opts = {}) ⇒ Coupon
Find Coupon by its parameters Return single instance of Collection by its attributes.
390 391 392 |
# File 'lib/tradenity/resources/coupon.rb', line 390 def find_one_by(opts = {}) list_all_coupons(opts)[0] end |
.list_all_coupons(opts = {}) ⇒ Page<Coupon>
List Coupons Return a list of Coupons
402 403 404 405 |
# File 'lib/tradenity/resources/coupon.rb', line 402 def list_all_coupons(opts = {}) data, _status_code, _headers = list_all_coupons_with_http_info(opts) data end |
.list_all_coupons_with_http_info(opts = {}) ⇒ Array<(Page<Coupon>, Fixnum, Hash)>
List Coupons Return a list of Coupons
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/tradenity/resources/coupon.rb', line 414 def list_all_coupons_with_http_info(opts = {}) if api_client.config.debugging api_client.config.logger.debug 'Calling API: Coupon.list_all_coupons ...' end # resource path local_var_path = '/coupons' # query parameters query_params = opts # query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? # query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Page<Coupon>') if api_client.config.debugging api_client.config.logger.debug "API called: Coupon#list_all_coupons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
.swagger_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/tradenity/resources/coupon.rb', line 95 def self.swagger_types { :'id' => :'String', :'__meta' => :'InstanceMeta', :'created_at' => :'DateTime', :'updated_at' => :'DateTime', :'name' => :'String', :'description' => :'String', :'status' => :'String', :'minimum_order' => :'Integer', :'code' => :'String', :'begins_at' => :'DateTime', :'ends_at' => :'DateTime', :'include' => :'ItemsSelector' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/tradenity/resources/coupon.rb', line 230 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && created_at == o.created_at && updated_at == o.updated_at && name == o.name && description == o.description && status == o.status && minimum_order == o.minimum_order && code == o.code && begins_at == o.begins_at && ends_at == o.ends_at && include == o.include end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/tradenity/resources/coupon.rb', line 282 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 = Tradenity.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
348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/tradenity/resources/coupon.rb', line 348 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
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/tradenity/resources/coupon.rb', line 261 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
248 249 250 |
# File 'lib/tradenity/resources/coupon.rb', line 248 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
254 255 256 |
# File 'lib/tradenity/resources/coupon.rb', line 254 def hash [, created_at, updated_at, name, description, status, minimum_order, code, begins_at, ends_at, include].hash end |
#id ⇒ Object
21 22 23 24 25 26 27 28 29 30 |
# File 'lib/tradenity/resources/coupon.rb', line 21 def id if instance_variable_defined?('@id') && @id != nil @id elsif && .href != nil @id = .href.split('/')[-1] @id else nil end end |
#id=(id) ⇒ Object
17 18 19 |
# File 'lib/tradenity/resources/coupon.rb', line 17 def id=(id) @id = id end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/tradenity/resources/coupon.rb', line 190 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @code.nil? invalid_properties.push('invalid value for "code", code cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
328 329 330 |
# File 'lib/tradenity/resources/coupon.rb', line 328 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
334 335 336 337 338 339 340 341 342 |
# File 'lib/tradenity/resources/coupon.rb', line 334 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
322 323 324 |
# File 'lib/tradenity/resources/coupon.rb', line 322 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
209 210 211 212 213 214 215 216 |
# File 'lib/tradenity/resources/coupon.rb', line 209 def valid? return false if @name.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ['enabled', 'disabled']) return false unless status_validator.valid?(@status) return false if @code.nil? true end |