Class: Svix::SettingsOut

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/models/settings_out.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SettingsOut

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/svix/models/settings_out.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#color_palette_dark ⇒ Object

Returns the value of attribute color_palette_dark.



18
19
20
 
# File 'lib/svix/models/settings_out.rb', line 18

def color_palette_dark
  @color_palette_dark
end

#color_palette_light ⇒ Object

Returns the value of attribute color_palette_light.



20
21
22
 
# File 'lib/svix/models/settings_out.rb', line 20

def color_palette_light
  @color_palette_light
end

#custom_base_font_size ⇒ Object

Returns the value of attribute custom_base_font_size.



22
23
24
 
# File 'lib/svix/models/settings_out.rb', line 22

def custom_base_font_size
  @custom_base_font_size
end

#custom_color ⇒ Object

Returns the value of attribute custom_color.



24
25
26
 
# File 'lib/svix/models/settings_out.rb', line 24

def custom_color
  @custom_color
end

#custom_font_family ⇒ Object

Returns the value of attribute custom_font_family.



26
27
28
 
# File 'lib/svix/models/settings_out.rb', line 26

def custom_font_family
  @custom_font_family
end

#custom_font_family_url ⇒ Object

Returns the value of attribute custom_font_family_url.



28
29
30
 
# File 'lib/svix/models/settings_out.rb', line 28

def custom_font_family_url
  @custom_font_family_url
end

#custom_logo_url ⇒ Object

Returns the value of attribute custom_logo_url.



30
31
32
 
# File 'lib/svix/models/settings_out.rb', line 30

def custom_logo_url
  @custom_logo_url
end

#custom_strings_override ⇒ Object

Returns the value of attribute custom_strings_override.



32
33
34
 
# File 'lib/svix/models/settings_out.rb', line 32

def custom_strings_override
  @custom_strings_override
end

#custom_theme_override ⇒ Object

Returns the value of attribute custom_theme_override.



34
35
36
 
# File 'lib/svix/models/settings_out.rb', line 34

def custom_theme_override
  @custom_theme_override
end

#disable_endpoint_on_failure ⇒ Object

Returns the value of attribute disable_endpoint_on_failure.



36
37
38
 
# File 'lib/svix/models/settings_out.rb', line 36

def disable_endpoint_on_failure
  @disable_endpoint_on_failure
end

#display_name ⇒ Object

Returns the value of attribute display_name.



38
39
40
 
# File 'lib/svix/models/settings_out.rb', line 38

def display_name
  @display_name
end

#enable_channels ⇒ Object

Returns the value of attribute enable_channels.



40
41
42
 
# File 'lib/svix/models/settings_out.rb', line 40

def enable_channels
  @enable_channels
end

#enable_integration_management ⇒ Object

Returns the value of attribute enable_integration_management.



42
43
44
 
# File 'lib/svix/models/settings_out.rb', line 42

def enable_integration_management
  @enable_integration_management
end

#enable_transformations ⇒ Object

Returns the value of attribute enable_transformations.



44
45
46
 
# File 'lib/svix/models/settings_out.rb', line 44

def enable_transformations
  @enable_transformations
end

#enforce_https ⇒ Object

Returns the value of attribute enforce_https.



46
47
48
 
# File 'lib/svix/models/settings_out.rb', line 46

def enforce_https
  @enforce_https
end

#event_catalog_published ⇒ Object

Returns the value of attribute event_catalog_published.



48
49
50
 
# File 'lib/svix/models/settings_out.rb', line 48

def event_catalog_published
  @event_catalog_published
end

#read_only ⇒ Object

Returns the value of attribute read_only.



50
51
52
 
# File 'lib/svix/models/settings_out.rb', line 50

def read_only
  @read_only
end

#show_use_svix_play ⇒ Object

Returns the value of attribute show_use_svix_play.



52
53
54
 
# File 'lib/svix/models/settings_out.rb', line 52

def show_use_svix_play
  @show_use_svix_play
end

#wipe_successful_payload ⇒ Object

Returns the value of attribute wipe_successful_payload.



54
55
56
 
# File 'lib/svix/models/settings_out.rb', line 54

def wipe_successful_payload
  @wipe_successful_payload
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



378
379
380
381
382
383
384
385
386
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
 
# File 'lib/svix/models/settings_out.rb', line 378

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 = Svix.const_get(type)
    klass.respond_to?(:openapi_any_of) || 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



82
83
84
 
# File 'lib/svix/models/settings_out.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/svix/models/settings_out.rb', line 57

def self.attribute_map
  {
    :'color_palette_dark' => :'colorPaletteDark',
    :'color_palette_light' => :'colorPaletteLight',
    :'custom_base_font_size' => :'customBaseFontSize',
    :'custom_color' => :'customColor',
    :'custom_font_family' => :'customFontFamily',
    :'custom_font_family_url' => :'customFontFamilyUrl',
    :'custom_logo_url' => :'customLogoUrl',
    :'custom_strings_override' => :'customStringsOverride',
    :'custom_theme_override' => :'customThemeOverride',
    :'disable_endpoint_on_failure' => :'disableEndpointOnFailure',
    :'display_name' => :'displayName',
    :'enable_channels' => :'enableChannels',
    :'enable_integration_management' => :'enableIntegrationManagement',
    :'enable_transformations' => :'enableTransformations',
    :'enforce_https' => :'enforceHttps',
    :'event_catalog_published' => :'eventCatalogPublished',
    :'read_only' => :'readOnly',
    :'show_use_svix_play' => :'showUseSvixPlay',
    :'wipe_successful_payload' => :'wipeSuccessfulPayload'
  }
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/svix/models/settings_out.rb', line 354

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



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/svix/models/settings_out.rb', line 112

def self.openapi_nullable
  Set.new([
    :'custom_base_font_size',
    :'custom_color',
    :'custom_font_family',
    :'custom_font_family_url',
    :'custom_logo_url',
    :'display_name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/svix/models/settings_out.rb', line 87

def self.openapi_types
  {
    :'color_palette_dark' => :'CustomColorPalette',
    :'color_palette_light' => :'CustomColorPalette',
    :'custom_base_font_size' => :'Integer',
    :'custom_color' => :'String',
    :'custom_font_family' => :'String',
    :'custom_font_family_url' => :'String',
    :'custom_logo_url' => :'String',
    :'custom_strings_override' => :'CustomStringsOverride',
    :'custom_theme_override' => :'CustomThemeOverride',
    :'disable_endpoint_on_failure' => :'Boolean',
    :'display_name' => :'String',
    :'enable_channels' => :'Boolean',
    :'enable_integration_management' => :'Boolean',
    :'enable_transformations' => :'Boolean',
    :'enforce_https' => :'Boolean',
    :'event_catalog_published' => :'Boolean',
    :'read_only' => :'Boolean',
    :'show_use_svix_play' => :'Boolean',
    :'wipe_successful_payload' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/svix/models/settings_out.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      color_palette_dark == o.color_palette_dark &&
      color_palette_light == o.color_palette_light &&
      custom_base_font_size == o.custom_base_font_size &&
      custom_color == o.custom_color &&
      custom_font_family == o.custom_font_family &&
      custom_font_family_url == o.custom_font_family_url &&
      custom_logo_url == o.custom_logo_url &&
      custom_strings_override == o.custom_strings_override &&
      custom_theme_override == o.custom_theme_override &&
      disable_endpoint_on_failure == o.disable_endpoint_on_failure &&
      display_name == o.display_name &&
      enable_channels == o.enable_channels &&
      enable_integration_management == o.enable_integration_management &&
      enable_transformations == o.enable_transformations &&
      enforce_https == o.enforce_https &&
      event_catalog_published == o.event_catalog_published &&
      read_only == o.read_only &&
      show_use_svix_play == o.show_use_svix_play &&
      wipe_successful_payload == o.wipe_successful_payload
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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/svix/models/settings_out.rb', line 449

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


341
342
343
 
# File 'lib/svix/models/settings_out.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



347
348
349
 
# File 'lib/svix/models/settings_out.rb', line 347

def hash
  [color_palette_dark, color_palette_light, custom_base_font_size, custom_color, custom_font_family, custom_font_family_url, custom_logo_url, custom_strings_override, custom_theme_override, disable_endpoint_on_failure, display_name, enable_channels, enable_integration_management, enable_transformations, enforce_https, event_catalog_published, read_only, show_use_svix_play, wipe_successful_payload].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



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
 
# File 'lib/svix/models/settings_out.rb', line 235

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[a-zA-Z0-9\-_ ]+$/)
  if !@custom_font_family.nil? && @custom_font_family !~ pattern
    invalid_properties.push("invalid value for \"custom_font_family\", must conform to the pattern #{pattern}.")
  end

  if !@custom_font_family_url.nil? && @custom_font_family_url.to_s.length > 65536
    invalid_properties.push('invalid value for "custom_font_family_url", the character length must be smaller than or equal to 65536.')
  end

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

  if !@custom_logo_url.nil? && @custom_logo_url.to_s.length > 65536
    invalid_properties.push('invalid value for "custom_logo_url", the character length must be smaller than or equal to 65536.')
  end

  if !@custom_logo_url.nil? && @custom_logo_url.to_s.length < 1
    invalid_properties.push('invalid value for "custom_logo_url", the character length must be great than or equal to 1.')
  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



425
426
427
 
# File 'lib/svix/models/settings_out.rb', line 425

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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/svix/models/settings_out.rb', line 431

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



419
420
421
 
# File 'lib/svix/models/settings_out.rb', line 419

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



264
265
266
267
268
269
270
271
272
 
# File 'lib/svix/models/settings_out.rb', line 264

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@custom_font_family.nil? && @custom_font_family !~ Regexp.new(/^[a-zA-Z0-9\-_ ]+$/)
  return false if !@custom_font_family_url.nil? && @custom_font_family_url.to_s.length > 65536
  return false if !@custom_font_family_url.nil? && @custom_font_family_url.to_s.length < 1
  return false if !@custom_logo_url.nil? && @custom_logo_url.to_s.length > 65536
  return false if !@custom_logo_url.nil? && @custom_logo_url.to_s.length < 1
  true
end