Class: OrderCloud::Promotion

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/models/promotion.rb

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



100
101
102
103
104
105
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
 
# File 'lib/order_cloud/models/promotion.rb', line 100

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?(:'Code')
    self.code = attributes[:'Code']
  end

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

  if attributes.has_key?(:'RedemptionLimit')
    self.redemption_limit = attributes[:'RedemptionLimit']
  end

  if attributes.has_key?(:'RedemptionLimitPerUser')
    self.redemption_limit_per_user = attributes[:'RedemptionLimitPerUser']
  end

  if attributes.has_key?(:'RedemptionCount')
    self.redemption_count = attributes[:'RedemptionCount']
  end

  if attributes.has_key?(:'Description')
    self.description = attributes[:'Description']
  end

  if attributes.has_key?(:'FinePrint')
    self.fine_print = attributes[:'FinePrint']
  end

  if attributes.has_key?(:'StartDate')
    self.start_date = attributes[:'StartDate']
  end

  if attributes.has_key?(:'ExpirationDate')
    self.expiration_date = attributes[:'ExpirationDate']
  end

  if attributes.has_key?(:'EligibleExpression')
    self.eligible_expression = attributes[:'EligibleExpression']
  end

  if attributes.has_key?(:'ValueExpression')
    self.value_expression = attributes[:'ValueExpression']
  end

  if attributes.has_key?(:'CanCombine')
    self.can_combine = attributes[:'CanCombine']
  end

  if attributes.has_key?(:'xp')
    self.xp = attributes[:'xp']
  end

end

Instance Attribute Details

#can_combine ⇒ Object

Returns the value of attribute can_combine.



53
54
55
 
# File 'lib/order_cloud/models/promotion.rb', line 53

def can_combine
  @can_combine
end

#code ⇒ Object

Returns the value of attribute code.



31
32
33
 
# File 'lib/order_cloud/models/promotion.rb', line 31

def code
  @code
end

#description ⇒ Object

Returns the value of attribute description.



41
42
43
 
# File 'lib/order_cloud/models/promotion.rb', line 41

def description
  @description
end

#eligible_expression ⇒ Object

Returns the value of attribute eligible_expression.



49
50
51
 
# File 'lib/order_cloud/models/promotion.rb', line 49

def eligible_expression
  @eligible_expression
end

#expiration_date ⇒ Object

Returns the value of attribute expiration_date.



47
48
49
 
# File 'lib/order_cloud/models/promotion.rb', line 47

def expiration_date
  @expiration_date
end

#fine_print ⇒ Object

Returns the value of attribute fine_print.



43
44
45
 
# File 'lib/order_cloud/models/promotion.rb', line 43

def fine_print
  @fine_print
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/order_cloud/models/promotion.rb', line 29

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



33
34
35
 
# File 'lib/order_cloud/models/promotion.rb', line 33

def name
  @name
end

#redemption_count ⇒ Object

Returns the value of attribute redemption_count.



39
40
41
 
# File 'lib/order_cloud/models/promotion.rb', line 39

def redemption_count
  @redemption_count
end

#redemption_limit ⇒ Object

Returns the value of attribute redemption_limit.



35
36
37
 
# File 'lib/order_cloud/models/promotion.rb', line 35

def redemption_limit
  @redemption_limit
end

#redemption_limit_per_user ⇒ Object

Returns the value of attribute redemption_limit_per_user.



37
38
39
 
# File 'lib/order_cloud/models/promotion.rb', line 37

def redemption_limit_per_user
  @redemption_limit_per_user
end

#start_date ⇒ Object

Returns the value of attribute start_date.



45
46
47
 
# File 'lib/order_cloud/models/promotion.rb', line 45

def start_date
  @start_date
end

#value_expression ⇒ Object

Returns the value of attribute value_expression.



51
52
53
 
# File 'lib/order_cloud/models/promotion.rb', line 51

def value_expression
  @value_expression
end

#xp ⇒ Object

Returns the value of attribute xp.



55
56
57
 
# File 'lib/order_cloud/models/promotion.rb', line 55

def xp
  @xp
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
70
71
72
73
74
75
76
 
# File 'lib/order_cloud/models/promotion.rb', line 59

def self.attribute_map
  {
    :'id' => :'ID',
    :'code' => :'Code',
    :'name' => :'Name',
    :'redemption_limit' => :'RedemptionLimit',
    :'redemption_limit_per_user' => :'RedemptionLimitPerUser',
    :'redemption_count' => :'RedemptionCount',
    :'description' => :'Description',
    :'fine_print' => :'FinePrint',
    :'start_date' => :'StartDate',
    :'expiration_date' => :'ExpirationDate',
    :'eligible_expression' => :'EligibleExpression',
    :'value_expression' => :'ValueExpression',
    :'can_combine' => :'CanCombine',
    :'xp' => :'xp'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/order_cloud/models/promotion.rb', line 79

def self.swagger_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'name' => :'String',
    :'redemption_limit' => :'Integer',
    :'redemption_limit_per_user' => :'Integer',
    :'redemption_count' => :'Integer',
    :'description' => :'String',
    :'fine_print' => :'String',
    :'start_date' => :'String',
    :'expiration_date' => :'String',
    :'eligible_expression' => :'String',
    :'value_expression' => :'String',
    :'can_combine' => :'BOOLEAN',
    :'xp' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/order_cloud/models/promotion.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      name == o.name &&
      redemption_limit == o.redemption_limit &&
      redemption_limit_per_user == o.redemption_limit_per_user &&
      redemption_count == o.redemption_count &&
      description == o.description &&
      fine_print == o.fine_print &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      eligible_expression == o.eligible_expression &&
      value_expression == o.value_expression &&
      can_combine == o.can_combine &&
      xp == o.xp
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/order_cloud/models/promotion.rb', line 234

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 =~ /^(true|t|yes|y|1)$/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 = OrderCloud.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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/order_cloud/models/promotion.rb', line 300

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/order_cloud/models/promotion.rb', line 213

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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


200
201
202
 
# File 'lib/order_cloud/models/promotion.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/order_cloud/models/promotion.rb', line 206

def hash
  [id, code, name, redemption_limit, redemption_limit_per_user, redemption_count, description, fine_print, start_date, expiration_date, eligible_expression, value_expression, can_combine, xp].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



166
167
168
169
 
# File 'lib/order_cloud/models/promotion.rb', line 166

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
 
# File 'lib/order_cloud/models/promotion.rb', line 280

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



286
287
288
289
290
291
292
293
294
 
# File 'lib/order_cloud/models/promotion.rb', line 286

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



274
275
276
 
# File 'lib/order_cloud/models/promotion.rb', line 274

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



173
174
175
 
# File 'lib/order_cloud/models/promotion.rb', line 173

def valid?
  return true
end