Class: TalonOne::Environment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Environment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/talon_one/models/environment.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#achievements ⇒ Object

The achievements, linked to the campaigns, belonging to the application.



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

def achievements
  @achievements
end

#additional_costs ⇒ Object

The additional costs that the application is subscribed to.



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

def additional_costs
  @additional_costs
end

#application_cart_item_filters ⇒ Object

The cart item filters belonging to the Application.



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

def application_cart_item_filters
  @application_cart_item_filters
end

#application_id ⇒ Object

The ID of the application that owns this entity.



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

def application_id
  @application_id
end

#attributes ⇒ Object

The attributes that the application is subscribed to.



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

def attributes
  @attributes
end

#audiences ⇒ Object

The audiences contained in the account which the application belongs to.



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

def audiences
  @audiences
end

#collections ⇒ Object

The account-level collections that the application is subscribed to.



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

def collections
  @collections
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
end

#functions ⇒ Object

The functions defined for this application.



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

def functions
  @functions
end

#giveaways_pools ⇒ Object

The giveaways pools that the application is subscribed to.



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

def giveaways_pools
  @giveaways_pools
end

#id ⇒ Object

Internal ID of this entity.



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

def id
  @id
end

#loyalty_programs ⇒ Object

The loyalty programs that the application is subscribed to.



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

def loyalty_programs
  @loyalty_programs
end

#slots ⇒ Object

The slots defined for this application.



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

def slots
  @slots
end

#templates ⇒ Object

The templates defined for this application.



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

def templates
  @templates
end

#variables ⇒ Object

A stringified version of the environment’s Talang variables scope.



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

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/talon_one/models/environment.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'application_id' => :'applicationId',
    :'slots' => :'slots',
    :'functions' => :'functions',
    :'templates' => :'templates',
    :'variables' => :'variables',
    :'giveaways_pools' => :'giveawaysPools',
    :'loyalty_programs' => :'loyaltyPrograms',
    :'achievements' => :'achievements',
    :'attributes' => :'attributes',
    :'additional_costs' => :'additionalCosts',
    :'audiences' => :'audiences',
    :'collections' => :'collections',
    :'application_cart_item_filters' => :'applicationCartItemFilters'
  }
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



294
295
296
 
# File 'lib/talon_one/models/environment.rb', line 294

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/talon_one/models/environment.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/talon_one/models/environment.rb', line 85

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'application_id' => :'Integer',
    :'slots' => :'Array<SlotDef>',
    :'functions' => :'Array<FunctionDef>',
    :'templates' => :'Array<TemplateDef>',
    :'variables' => :'String',
    :'giveaways_pools' => :'Array<GiveawaysPool>',
    :'loyalty_programs' => :'Array<LoyaltyProgram>',
    :'achievements' => :'Array<Achievement>',
    :'attributes' => :'Array<Attribute>',
    :'additional_costs' => :'Array<AccountAdditionalCost>',
    :'audiences' => :'Array<Audience>',
    :'collections' => :'Array<Collection>',
    :'application_cart_item_filters' => :'Array<ApplicationCIF>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/talon_one/models/environment.rb', line 259

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      application_id == o.application_id &&
      slots == o.slots &&
      functions == o.functions &&
      templates == o.templates &&
      variables == o.variables &&
      giveaways_pools == o.giveaways_pools &&
      loyalty_programs == o.loyalty_programs &&
      achievements == o.achievements &&
      attributes == o.attributes &&
      additional_costs == o.additional_costs &&
      audiences == o.audiences &&
      collections == o.collections &&
      application_cart_item_filters == o.application_cart_item_filters
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/talon_one/models/environment.rb', line 322

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/talon_one/models/environment.rb', line 391

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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/talon_one/models/environment.rb', line 301

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


281
282
283
 
# File 'lib/talon_one/models/environment.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



287
288
289
 
# File 'lib/talon_one/models/environment.rb', line 287

def hash
  [id, created, application_id, slots, functions, templates, variables, giveaways_pools, loyalty_programs, achievements, attributes, additional_costs, audiences, collections, application_cart_item_filters].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



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
 
# File 'lib/talon_one/models/environment.rb', line 211

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 @application_id.nil?
    invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
  end

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

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

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

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



367
368
369
 
# File 'lib/talon_one/models/environment.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/talon_one/models/environment.rb', line 373

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



361
362
363
 
# File 'lib/talon_one/models/environment.rb', line 361

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



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/talon_one/models/environment.rb', line 246

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @application_id.nil?
  return false if @slots.nil?
  return false if @functions.nil?
  return false if @templates.nil?
  return false if @variables.nil?
  true
end