Class: Dropbox::Sign::SubWhiteLabelingOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/sub_white_labeling_options.rb

Overview

An array of elements and values serialized to a string, to be used to customize the app’s signer page. (Only applies to some API plans) Take a look at our [white labeling guide](developers.hellosign.com/api/reference/premium-branding/) to learn more.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubWhiteLabelingOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
247
248
249
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
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 175

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubWhiteLabelingOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubWhiteLabelingOptions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'header_background_color')
    self.header_background_color = attributes[:'header_background_color']
  else
    self.header_background_color = '#1a1a1a'
  end

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

  if attributes.key?(:'link_color')
    self.link_color = attributes[:'link_color']
  else
    self.link_color = '#0061FE'
  end

  if attributes.key?(:'page_background_color')
    self.page_background_color = attributes[:'page_background_color']
  else
    self.page_background_color = '#f7f8f9'
  end

  if attributes.key?(:'primary_button_color')
    self.primary_button_color = attributes[:'primary_button_color']
  else
    self.primary_button_color = '#0061FE'
  end

  if attributes.key?(:'primary_button_color_hover')
    self.primary_button_color_hover = attributes[:'primary_button_color_hover']
  else
    self.primary_button_color_hover = '#0061FE'
  end

  if attributes.key?(:'primary_button_text_color')
    self.primary_button_text_color = attributes[:'primary_button_text_color']
  else
    self.primary_button_text_color = '#ffffff'
  end

  if attributes.key?(:'primary_button_text_color_hover')
    self.primary_button_text_color_hover = attributes[:'primary_button_text_color_hover']
  else
    self.primary_button_text_color_hover = '#ffffff'
  end

  if attributes.key?(:'secondary_button_color')
    self.secondary_button_color = attributes[:'secondary_button_color']
  else
    self.secondary_button_color = '#ffffff'
  end

  if attributes.key?(:'secondary_button_color_hover')
    self.secondary_button_color_hover = attributes[:'secondary_button_color_hover']
  else
    self.secondary_button_color_hover = '#ffffff'
  end

  if attributes.key?(:'secondary_button_text_color')
    self.secondary_button_text_color = attributes[:'secondary_button_text_color']
  else
    self.secondary_button_text_color = '#0061FE'
  end

  if attributes.key?(:'secondary_button_text_color_hover')
    self.secondary_button_text_color_hover = attributes[:'secondary_button_text_color_hover']
  else
    self.secondary_button_text_color_hover = '#0061FE'
  end

  if attributes.key?(:'text_color1')
    self.text_color1 = attributes[:'text_color1']
  else
    self.text_color1 = '#808080'
  end

  if attributes.key?(:'text_color2')
    self.text_color2 = attributes[:'text_color2']
  else
    self.text_color2 = '#ffffff'
  end

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

Instance Attribute Details

#header_background_color ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 23

def header_background_color
  @header_background_color
end

#legal_version ⇒ String

Returns:

  • (String) 


26
27
28
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 26

def legal_version
  @legal_version
end

#link_color ⇒ String

Returns:

  • (String) 


29
30
31
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 29

def link_color
  @link_color
end

#page_background_color ⇒ String

Returns:

  • (String) 


32
33
34
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 32

def page_background_color
  @page_background_color
end

#primary_button_color ⇒ String

Returns:

  • (String) 


35
36
37
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 35

def primary_button_color
  @primary_button_color
end

#primary_button_color_hover ⇒ String

Returns:

  • (String) 


38
39
40
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 38

def primary_button_color_hover
  @primary_button_color_hover
end

#primary_button_text_color ⇒ String

Returns:

  • (String) 


41
42
43
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 41

def primary_button_text_color
  @primary_button_text_color
end

#primary_button_text_color_hover ⇒ String

Returns:

  • (String) 


44
45
46
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 44

def primary_button_text_color_hover
  @primary_button_text_color_hover
end

#reset_to_default ⇒ Boolean

Resets white labeling options to defaults. Only useful when updating an API App.

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 66

def reset_to_default
  @reset_to_default
end

#secondary_button_color ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 47

def secondary_button_color
  @secondary_button_color
end

#secondary_button_color_hover ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 50

def secondary_button_color_hover
  @secondary_button_color_hover
end

#secondary_button_text_color ⇒ String

Returns:

  • (String) 


53
54
55
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 53

def secondary_button_text_color
  @secondary_button_text_color
end

#secondary_button_text_color_hover ⇒ String

Returns:

  • (String) 


56
57
58
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 56

def secondary_button_text_color_hover
  @secondary_button_text_color_hover
end

#text_color1 ⇒ String

Returns:

  • (String) 


59
60
61
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 59

def text_color1
  @text_color1
end

#text_color2 ⇒ String

Returns:

  • (String) 


62
63
64
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 62

def text_color2
  @text_color2
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



112
113
114
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 112

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 117

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 91

def self.attribute_map
  {
    :'header_background_color' => :'header_background_color',
    :'legal_version' => :'legal_version',
    :'link_color' => :'link_color',
    :'page_background_color' => :'page_background_color',
    :'primary_button_color' => :'primary_button_color',
    :'primary_button_color_hover' => :'primary_button_color_hover',
    :'primary_button_text_color' => :'primary_button_text_color',
    :'primary_button_text_color_hover' => :'primary_button_text_color_hover',
    :'secondary_button_color' => :'secondary_button_color',
    :'secondary_button_color_hover' => :'secondary_button_color_hover',
    :'secondary_button_text_color' => :'secondary_button_text_color',
    :'secondary_button_text_color_hover' => :'secondary_button_text_color_hover',
    :'text_color1' => :'text_color1',
    :'text_color2' => :'text_color2',
    :'reset_to_default' => :'reset_to_default'
  }
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



340
341
342
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 340

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

.init(data) ⇒ SubWhiteLabelingOptions

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



166
167
168
169
170
171
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 166

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "SubWhiteLabelingOptions"
  ) || SubWhiteLabelingOptions.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



149
150
151
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 149

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



159
160
161
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 159

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



154
155
156
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 154

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 143

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
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 122

def self.openapi_types
  {
    :'header_background_color' => :'String',
    :'legal_version' => :'String',
    :'link_color' => :'String',
    :'page_background_color' => :'String',
    :'primary_button_color' => :'String',
    :'primary_button_color_hover' => :'String',
    :'primary_button_text_color' => :'String',
    :'primary_button_text_color_hover' => :'String',
    :'secondary_button_color' => :'String',
    :'secondary_button_color_hover' => :'String',
    :'secondary_button_text_color' => :'String',
    :'secondary_button_text_color_hover' => :'String',
    :'text_color1' => :'String',
    :'text_color2' => :'String',
    :'reset_to_default' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 305

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      header_background_color == o.header_background_color &&
      legal_version == o.legal_version &&
      link_color == o.link_color &&
      page_background_color == o.page_background_color &&
      primary_button_color == o.primary_button_color &&
      primary_button_color_hover == o.primary_button_color_hover &&
      primary_button_text_color == o.primary_button_text_color &&
      primary_button_text_color_hover == o.primary_button_text_color_hover &&
      secondary_button_color == o.secondary_button_color &&
      secondary_button_color_hover == o.secondary_button_color_hover &&
      secondary_button_text_color == o.secondary_button_text_color &&
      secondary_button_text_color_hover == o.secondary_button_text_color_hover &&
      text_color1 == o.text_color1 &&
      text_color2 == o.text_color2 &&
      reset_to_default == o.reset_to_default
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



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
398
399
400
401
402
403
404
405
406
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 370

def _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
    klass = Dropbox::Sign.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

#_to_hash(value, include_nil = true) ⇒ 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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 441

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 347

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


327
328
329
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



333
334
335
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 333

def hash
  [header_background_color, legal_version, link_color, page_background_color, primary_button_color, primary_button_color_hover, primary_button_text_color, primary_button_text_color_hover, secondary_button_color, secondary_button_color_hover, secondary_button_text_color, secondary_button_text_color_hover, text_color1, text_color2, reset_to_default].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



280
281
282
283
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 280

def list_invalid_properties
  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



416
417
418
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 416

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 422

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



410
411
412
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 410

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



287
288
289
290
291
 
# File 'lib/dropbox-sign/models/sub_white_labeling_options.rb', line 287

def valid?
  legal_version_validator = EnumAttributeValidator.new('String', ["terms1", "terms2"])
  return false unless legal_version_validator.valid?(@legal_version)
  true
end