Class: Tradenity::Promotion

Inherits:
Object
  • Object
show all
Defined in:
lib/tradenity/resources/promotion.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Promotion

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
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
 
# File 'lib/tradenity/resources/promotion.rb', line 106

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.__meta = 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?(:'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/promotion.rb', line 32

def __meta
  @__meta
end

#begins_at ⇒ Object

Returns the value of attribute begins_at.



44
45
46
 
# File 'lib/tradenity/resources/promotion.rb', line 44

def begins_at
  @begins_at
end

#created_at ⇒ Object

Returns the value of attribute created_at.



34
35
36
 
# File 'lib/tradenity/resources/promotion.rb', line 34

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



40
41
42
 
# File 'lib/tradenity/resources/promotion.rb', line 40

def description
  @description
end

#ends_at ⇒ Object

Returns the value of attribute ends_at.



46
47
48
 
# File 'lib/tradenity/resources/promotion.rb', line 46

def ends_at
  @ends_at
end

#include ⇒ Object

Returns the value of attribute include.



48
49
50
 
# File 'lib/tradenity/resources/promotion.rb', line 48

def include
  @include
end

#name ⇒ Object

Returns the value of attribute name.



38
39
40
 
# File 'lib/tradenity/resources/promotion.rb', line 38

def name
  @name
end

#status ⇒ Object

Returns the value of attribute status.



42
43
44
 
# File 'lib/tradenity/resources/promotion.rb', line 42

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



36
37
38
 
# File 'lib/tradenity/resources/promotion.rb', line 36

def updated_at
  @updated_at
end

Class Method Details

.api_client ⇒ Object 



336
337
338
 
# File 'lib/tradenity/resources/promotion.rb', line 336

def self.api_client
  ApiClient.default
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/tradenity/resources/promotion.rb', line 73

def self.attribute_map
  { 
    :'id' => :'id',
    :'__meta' => :'__meta',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'name' => :'name',
    :'description' => :'description',
    :'status' => :'status',
    :'begins_at' => :'beginsAt',
    :'ends_at' => :'endsAt',
    :'include' => :'include'
  }
end

.find_all ⇒ Page<Promotion>

List Promotions Return a list of Promotions

Parameters:

  • opts (Hash) —

    the optional parameters

Returns:



347
348
349
 
# File 'lib/tradenity/resources/promotion.rb', line 347

def find_all
  list_all_promotions
end

.find_all_by(opts = {}) ⇒ Page<Collection>

Find List of Promotion Return multiple instances of Promotion by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the search parameters

Returns:



355
356
357
 
# File 'lib/tradenity/resources/promotion.rb', line 355

def find_all_by(opts = {})
  list_all_promotions(opts)
end

.find_one_by(opts = {}) ⇒ Promotion

Find Promotion by its parameters Return single instance of Collection by its attributes.

Parameters:

  • opts (Hash) (defaults to: {}) —

    search parameters

Returns:



363
364
365
 
# File 'lib/tradenity/resources/promotion.rb', line 363

def find_one_by(opts = {})
  list_all_promotions(opts)[0]
end

.list_all_promotions(opts = {}) ⇒ Page<Promotion>

List Promotions Return a list of Promotions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:



375
376
377
378
 
# File 'lib/tradenity/resources/promotion.rb', line 375

def list_all_promotions(opts = {})
  data, _status_code, _headers = list_all_promotions_with_http_info(opts)
  data
end

.list_all_promotions_with_http_info(opts = {}) ⇒ Array<(Page<Promotion>, Fixnum, Hash)>

List Promotions Return a list of Promotions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    page number

  • :size (Integer) —

    page size

  • :sort (String) —

    page order

Returns:

  • (Array<(Page<Promotion>, Fixnum, Hash)>) —

    Page<Promotion> data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/tradenity/resources/promotion.rb', line 387

def list_all_promotions_with_http_info(opts = {})
  if api_client.config.debugging
    api_client.config.logger.debug 'Calling API: Promotion.list_all_promotions ...'
  end
  # resource path
  local_var_path = '/promotions'

  # 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<Promotion>')
  if api_client.config.debugging
    api_client.config.logger.debug "API called: Promotion#list_all_promotions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/tradenity/resources/promotion.rb', line 89

def self.swagger_types
  { 
    :'id' => :'String', 
    :'__meta' => :'InstanceMeta',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'name' => :'String',
    :'description' => :'String',
    :'status' => :'String',
    :'begins_at' => :'DateTime',
    :'ends_at' => :'DateTime',
    :'include' => :'ItemsSelector'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/tradenity/resources/promotion.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      __meta == o.__meta &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      description == o.description &&
      status == o.status &&
      begins_at == o.begins_at &&
      ends_at == o.ends_at &&
      include == o.include
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/tradenity/resources/promotion.rb', line 255

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/tradenity/resources/promotion.rb', line 321

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/tradenity/resources/promotion.rb', line 234

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/tradenity/resources/promotion.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



227
228
229
 
# File 'lib/tradenity/resources/promotion.rb', line 227

def hash
  [__meta, created_at, updated_at, name, description, status, begins_at, ends_at, include].hash
end

#id ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/tradenity/resources/promotion.rb', line 21

def id
  if instance_variable_defined?('@id') && @id != nil
    @id
  elsif __meta && __meta.href != nil
    @id = __meta.href.split('/')[-1]
    @id
  else
    nil
  end
end

#id=(id) ⇒ Object 



17
18
19
 
# File 'lib/tradenity/resources/promotion.rb', line 17

def id=(id)
  @id = id
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/tradenity/resources/promotion.rb', line 170

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



301
302
303
 
# File 'lib/tradenity/resources/promotion.rb', line 301

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
310
311
312
313
314
315
 
# File 'lib/tradenity/resources/promotion.rb', line 307

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

Returns:

  • (String) —

    String presentation of the object



295
296
297
 
# File 'lib/tradenity/resources/promotion.rb', line 295

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



185
186
187
188
189
190
191
 
# File 'lib/tradenity/resources/promotion.rb', line 185

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)
  true
end