Class: KoronaCloudClient::CustomerDisplayConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/models/customer_display_configuration.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerDisplayConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

indicates whether the object is active for use or not



19
20
21
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 19

def active
  @active
end

#booking_image ⇒ Object

Returns the value of attribute booking_image.



36
37
38
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 36

def booking_image
  @booking_image
end

#booking_image_id ⇒ Object

Returns the value of attribute booking_image_id.



38
39
40
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 38

def booking_image_id
  @booking_image_id
end

#booking_url ⇒ Object

Returns the value of attribute booking_url.



34
35
36
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 34

def booking_url
  @booking_url
end

#closed_image ⇒ Object

Returns the value of attribute closed_image.



44
45
46
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 44

def closed_image
  @closed_image
end

#closed_image_id ⇒ Object

Returns the value of attribute closed_image_id.



46
47
48
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 46

def closed_image_id
  @closed_image_id
end

#closed_text ⇒ Object

Returns the value of attribute closed_text.



42
43
44
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 42

def closed_text
  @closed_text
end

#closed_url ⇒ Object

Returns the value of attribute closed_url.



40
41
42
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 40

def closed_url
  @closed_url
end

#font_scale ⇒ Object

Returns the value of attribute font_scale.



30
31
32
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 30

def font_scale
  @font_scale
end

#graphical_display ⇒ Object

Returns the value of attribute graphical_display.



56
57
58
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 56

def graphical_display
  @graphical_display
end

#id ⇒ Object

global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)



22
23
24
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 22

def id
  @id
end

#layout_type ⇒ Object

Returns the value of attribute layout_type.



58
59
60
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 58

def layout_type
  @layout_type
end

#name ⇒ Object

Returns the value of attribute name.



32
33
34
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 32

def name
  @name
end

#number ⇒ Object

number of the object, like it is set in backoffice; will be removed when active=false



28
29
30
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 28

def number
  @number
end

#revision ⇒ Object

the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.



25
26
27
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 25

def revision
  @revision
end

#theme_color ⇒ Object

Returns the value of attribute theme_color.



60
61
62
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 60

def theme_color
  @theme_color
end

#welcome_image ⇒ Object

Returns the value of attribute welcome_image.



52
53
54
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 52

def welcome_image
  @welcome_image
end

#welcome_image_id ⇒ Object

Returns the value of attribute welcome_image_id.



54
55
56
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 54

def welcome_image_id
  @welcome_image_id
end

#welcome_text ⇒ Object

Returns the value of attribute welcome_text.



48
49
50
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 48

def welcome_text
  @welcome_text
end

#welcome_url ⇒ Object

Returns the value of attribute welcome_url.



50
51
52
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 50

def welcome_url
  @welcome_url
end

Class Method Details

._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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 360

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KoronaCloudClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



111
112
113
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 111

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 85

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'font_scale' => :'fontScale',
    :'name' => :'name',
    :'booking_url' => :'bookingUrl',
    :'booking_image' => :'bookingImage',
    :'booking_image_id' => :'bookingImageId',
    :'closed_url' => :'closedUrl',
    :'closed_text' => :'closedText',
    :'closed_image' => :'closedImage',
    :'closed_image_id' => :'closedImageId',
    :'welcome_text' => :'welcomeText',
    :'welcome_url' => :'welcomeUrl',
    :'welcome_image' => :'welcomeImage',
    :'welcome_image_id' => :'welcomeImageId',
    :'graphical_display' => :'graphicalDisplay',
    :'layout_type' => :'layoutType',
    :'theme_color' => :'themeColor'
  }
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 336

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 142

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

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 116

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'font_scale' => :'Integer',
    :'name' => :'String',
    :'booking_url' => :'String',
    :'booking_image' => :'ModelReference',
    :'booking_image_id' => :'String',
    :'closed_url' => :'String',
    :'closed_text' => :'String',
    :'closed_image' => :'ModelReference',
    :'closed_image_id' => :'String',
    :'welcome_text' => :'String',
    :'welcome_url' => :'String',
    :'welcome_image' => :'ModelReference',
    :'welcome_image_id' => :'String',
    :'graphical_display' => :'String',
    :'layout_type' => :'String',
    :'theme_color' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 296

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      font_scale == o.font_scale &&
      name == o.name &&
      booking_url == o.booking_url &&
      booking_image == o.booking_image &&
      booking_image_id == o.booking_image_id &&
      closed_url == o.closed_url &&
      closed_text == o.closed_text &&
      closed_image == o.closed_image &&
      closed_image_id == o.closed_image_id &&
      welcome_text == o.welcome_text &&
      welcome_url == o.welcome_url &&
      welcome_image == o.welcome_image &&
      welcome_image_id == o.welcome_image_id &&
      graphical_display == o.graphical_display &&
      layout_type == o.layout_type &&
      theme_color == o.theme_color
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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 431

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


323
324
325
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 329

def hash
  [active, id, revision, number, font_scale, name, booking_url, booking_image, booking_image_id, closed_url, closed_text, closed_image, closed_image_id, welcome_text, welcome_url, welcome_image, welcome_image_id, graphical_display, layout_type, theme_color].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



245
246
247
248
249
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 245

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



407
408
409
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 413

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



401
402
403
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 401

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



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/korona-cloud-client/models/customer_display_configuration.rb', line 253

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  graphical_display_validator = EnumAttributeValidator.new('String', ["NONE", "DISPLAY_1", "DISPLAY_2", "DISPLAY_3", "DISPLAY_4"])
  return false unless graphical_display_validator.valid?(@graphical_display)
  layout_type_validator = EnumAttributeValidator.new('String', ["AD_FULL", "AD_FULL_WITH_LINE_DISPLAY", "AD_LEFT", "AD_LEFT_HALF", "AD_NONE", "AD_RIGHT", "AD_RIGHT_HALF"])
  return false unless layout_type_validator.valid?(@layout_type)
  theme_color_validator = EnumAttributeValidator.new('String', ["GREY", "RED", "PINK", "PURPLE", "DEEP_PURPLE", "INDIGO", "BLUE", "LIGHT_BLUE", "CYAN", "TEAL", "GREEN", "LIGHT_GREEN", "LIME", "YELLOW", "AMBER", "ORANGE", "DEEP_ORANGE", "BROWN"])
  return false unless theme_color_validator.valid?(@theme_color)
  true
end