Class: Dropbox::Sign::ApiAppResponseWhiteLabelingOptions

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

Overview

An object with options to customize the app’s signer page

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiAppResponseWhiteLabelingOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::ApiAppResponseWhiteLabelingOptions` 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.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::ApiAppResponseWhiteLabelingOptions`. 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?(:'header_background_color')
    self.header_background_color = attributes[:'header_background_color']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#header_background_color ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_white_labeling_options.rb', line 44

def primary_button_text_color_hover
  @primary_button_text_color_hover
end

#secondary_button_color ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/dropbox-sign/models/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_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/api_app_response_white_labeling_options.rb', line 62

def text_color2
  @text_color2
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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'
  }
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



261
262
263
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 261

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

.init(data) ⇒ ApiAppResponseWhiteLabelingOptions

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



133
134
135
136
137
138
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 133

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

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



116
117
118
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 116

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

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



126
127
128
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 126

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



121
122
123
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 121

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 110

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 227

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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 291

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 362

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 268

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


248
249
250
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 248

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



254
255
256
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 254

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



214
215
216
217
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 214

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



337
338
339
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 337

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 343

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



331
332
333
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 331

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



221
222
223
 
# File 'lib/dropbox-sign/models/api_app_response_white_labeling_options.rb', line 221

def valid?
  true
end