Class: TalonOne::Application

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/application.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Application

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/talon_one/models/application.rb', line 154

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::Application` 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 `TalonOne::Application`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'modified')
    self.modified = attributes[:'modified']
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  end

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

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

  if attributes.key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'case_sensitivity')
    self.case_sensitivity = attributes[:'case_sensitivity']
  end

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

  if attributes.key?(:'limits')
    if (value = attributes[:'limits']).is_a?(Array)
      self.limits = value
    end
  end

  if attributes.key?(:'campaign_priority')
    self.campaign_priority = attributes[:'campaign_priority']
  end

  if attributes.key?(:'exclusive_campaigns_strategy')
    self.exclusive_campaigns_strategy = attributes[:'exclusive_campaigns_strategy']
  end

  if attributes.key?(:'default_discount_scope')
    self.default_discount_scope = attributes[:'default_discount_scope']
  end

  if attributes.key?(:'enable_cascading_discounts')
    self.enable_cascading_discounts = attributes[:'enable_cascading_discounts']
  end

  if attributes.key?(:'enable_flattened_cart_items')
    self.enable_flattened_cart_items = attributes[:'enable_flattened_cart_items']
  end

  if attributes.key?(:'attributes_settings')
    self.attributes_settings = attributes[:'attributes_settings']
  end

  if attributes.key?(:'sandbox')
    self.sandbox = attributes[:'sandbox']
  end

  if attributes.key?(:'loyalty_programs')
    if (value = attributes[:'loyalty_programs']).is_a?(Array)
      self.loyalty_programs = value
    end
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



28
29
30
 
# File 'lib/talon_one/models/application.rb', line 28

def 
  @account_id
end

#attributes ⇒ Object

Arbitrary properties associated with this campaign



46
47
48
 
# File 'lib/talon_one/models/application.rb', line 46

def attributes
  @attributes
end

#attributes_settings ⇒ Object

Returns the value of attribute attributes_settings.



66
67
68
 
# File 'lib/talon_one/models/application.rb', line 66

def attributes_settings
  @attributes_settings
end

#campaign_priority ⇒ Object

Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to "universal"



52
53
54
 
# File 'lib/talon_one/models/application.rb', line 52

def campaign_priority
  @campaign_priority
end

#case_sensitivity ⇒ Object

A string indicating how should campaigns in this application deal with case sensitivity on coupon codes.



43
44
45
 
# File 'lib/talon_one/models/application.rb', line 43

def case_sensitivity
  @case_sensitivity
end

#created ⇒ Object

The exact moment this entity was created.



22
23
24
 
# File 'lib/talon_one/models/application.rb', line 22

def created
  @created
end

#currency ⇒ Object

A string describing a default currency for new customer sessions.



40
41
42
 
# File 'lib/talon_one/models/application.rb', line 40

def currency
  @currency
end

#default_discount_scope ⇒ Object

The default scope to apply "setDiscount" effects on if no scope was provided with the effect.



58
59
60
 
# File 'lib/talon_one/models/application.rb', line 58

def default_discount_scope
  @default_discount_scope
end

#description ⇒ Object

A longer description of the application.



34
35
36
 
# File 'lib/talon_one/models/application.rb', line 34

def description
  @description
end

#enable_cascading_discounts ⇒ Object

Flag indicating if discounts should cascade for this application



61
62
63
 
# File 'lib/talon_one/models/application.rb', line 61

def enable_cascading_discounts
  @enable_cascading_discounts
end

#enable_flattened_cart_items ⇒ Object

Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one



64
65
66
 
# File 'lib/talon_one/models/application.rb', line 64

def enable_flattened_cart_items
  @enable_flattened_cart_items
end

#exclusive_campaigns_strategy ⇒ Object

The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to "listOrder"



55
56
57
 
# File 'lib/talon_one/models/application.rb', line 55

def exclusive_campaigns_strategy
  @exclusive_campaigns_strategy
end

#id ⇒ Object

Unique ID for this entity.



19
20
21
 
# File 'lib/talon_one/models/application.rb', line 19

def id
  @id
end

#limits ⇒ Object

Default limits for campaigns created in this application



49
50
51
 
# File 'lib/talon_one/models/application.rb', line 49

def limits
  @limits
end

#loyalty_programs ⇒ Object

An array containing all the loyalty programs to which this application is subscribed



72
73
74
 
# File 'lib/talon_one/models/application.rb', line 72

def loyalty_programs
  @loyalty_programs
end

#modified ⇒ Object

The exact moment this entity was last modified.



25
26
27
 
# File 'lib/talon_one/models/application.rb', line 25

def modified
  @modified
end

#name ⇒ Object

The name of this application.



31
32
33
 
# File 'lib/talon_one/models/application.rb', line 31

def name
  @name
end

#sandbox ⇒ Object

Flag indicating if this is a live or sandbox application



69
70
71
 
# File 'lib/talon_one/models/application.rb', line 69

def sandbox
  @sandbox
end

#timezone ⇒ Object

A string containing an IANA timezone descriptor.



37
38
39
 
# File 'lib/talon_one/models/application.rb', line 37

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/talon_one/models/application.rb', line 97

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'modified' => :'modified',
    :'account_id' => :'accountId',
    :'name' => :'name',
    :'description' => :'description',
    :'timezone' => :'timezone',
    :'currency' => :'currency',
    :'case_sensitivity' => :'caseSensitivity',
    :'attributes' => :'attributes',
    :'limits' => :'limits',
    :'campaign_priority' => :'campaignPriority',
    :'exclusive_campaigns_strategy' => :'exclusiveCampaignsStrategy',
    :'default_discount_scope' => :'defaultDiscountScope',
    :'enable_cascading_discounts' => :'enableCascadingDiscounts',
    :'enable_flattened_cart_items' => :'enableFlattenedCartItems',
    :'attributes_settings' => :'attributesSettings',
    :'sandbox' => :'sandbox',
    :'loyalty_programs' => :'loyaltyPrograms'
  }
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



447
448
449
 
# File 'lib/talon_one/models/application.rb', line 447

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
 
# File 'lib/talon_one/models/application.rb', line 147

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/talon_one/models/application.rb', line 122

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'modified' => :'DateTime',
    :'account_id' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'timezone' => :'String',
    :'currency' => :'String',
    :'case_sensitivity' => :'String',
    :'attributes' => :'Object',
    :'limits' => :'Array<LimitConfig>',
    :'campaign_priority' => :'String',
    :'exclusive_campaigns_strategy' => :'String',
    :'default_discount_scope' => :'String',
    :'enable_cascading_discounts' => :'Boolean',
    :'enable_flattened_cart_items' => :'Boolean',
    :'attributes_settings' => :'AttributesSettings',
    :'sandbox' => :'Boolean',
    :'loyalty_programs' => :'Array<LoyaltyProgram>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/talon_one/models/application.rb', line 408

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      modified == o.modified &&
       == o. &&
      name == o.name &&
      description == o.description &&
      timezone == o.timezone &&
      currency == o.currency &&
      case_sensitivity == o.case_sensitivity &&
      attributes == o.attributes &&
      limits == o.limits &&
      campaign_priority == o.campaign_priority &&
      exclusive_campaigns_strategy == o.exclusive_campaigns_strategy &&
      default_discount_scope == o.default_discount_scope &&
      enable_cascading_discounts == o.enable_cascading_discounts &&
      enable_flattened_cart_items == o.enable_flattened_cart_items &&
      attributes_settings == o.attributes_settings &&
      sandbox == o.sandbox &&
      loyalty_programs == o.loyalty_programs
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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/talon_one/models/application.rb', line 475

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
    TalonOne.const_get(type).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



544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/talon_one/models/application.rb', line 544

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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/talon_one/models/application.rb', line 454

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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


434
435
436
 
# File 'lib/talon_one/models/application.rb', line 434

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



440
441
442
 
# File 'lib/talon_one/models/application.rb', line 440

def hash
  [id, created, modified, , name, description, timezone, currency, case_sensitivity, attributes, limits, campaign_priority, exclusive_campaigns_strategy, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, loyalty_programs].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



250
251
252
253
254
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
292
293
294
295
296
297
 
# File 'lib/talon_one/models/application.rb', line 250

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

  if @modified.nil?
    invalid_properties.push('invalid value for "modified", modified cannot be nil.')
  end

  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if @timezone.nil?
    invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
  end

  if @timezone.to_s.length < 1
    invalid_properties.push('invalid value for "timezone", the character length must be great than or equal to 1.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @currency.to_s.length < 1
    invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 1.')
  end

  if @loyalty_programs.nil?
    invalid_properties.push('invalid value for "loyalty_programs", loyalty_programs 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



520
521
522
 
# File 'lib/talon_one/models/application.rb', line 520

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



526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/talon_one/models/application.rb', line 526

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

Returns:

  • (String) —

    String presentation of the object



514
515
516
 
# File 'lib/talon_one/models/application.rb', line 514

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/talon_one/models/application.rb', line 301

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @modified.nil?
  return false if @account_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @timezone.nil?
  return false if @timezone.to_s.length < 1
  return false if @currency.nil?
  return false if @currency.to_s.length < 1
  case_sensitivity_validator = EnumAttributeValidator.new('String', ["sensitive", "insensitive-uppercase", "insensitive-lowercase"])
  return false unless case_sensitivity_validator.valid?(@case_sensitivity)
  campaign_priority_validator = EnumAttributeValidator.new('String', ["universal", "stackable", "exclusive"])
  return false unless campaign_priority_validator.valid?(@campaign_priority)
  exclusive_campaigns_strategy_validator = EnumAttributeValidator.new('String', ["listOrder", "lowestDiscount", "highestDiscount"])
  return false unless exclusive_campaigns_strategy_validator.valid?(@exclusive_campaigns_strategy)
  default_discount_scope_validator = EnumAttributeValidator.new('String', ["sessionTotal", "cartItems", "additionalCosts"])
  return false unless default_discount_scope_validator.valid?(@default_discount_scope)
  return false if @loyalty_programs.nil?
  true
end