Class: DocuSign_eSign::Brand

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/brand.rb

Overview

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Brand

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/docusign_esign/models/brand.rb', line 116

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'brandCompany')
    self.brand_company = attributes[:'brandCompany']
  end

  if attributes.has_key?(:'brandId')
    self.brand_id = attributes[:'brandId']
  end

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

  if attributes.has_key?(:'brandName')
    self.brand_name = attributes[:'brandName']
  end

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

  if attributes.has_key?(:'defaultBrandLanguage')
    self.default_brand_language = attributes[:'defaultBrandLanguage']
  end

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

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

  if attributes.has_key?(:'isOrganizationBrand')
    self.is_organization_brand = attributes[:'isOrganizationBrand']
  end

  if attributes.has_key?(:'isOverridingCompanyName')
    self.is_overriding_company_name = attributes[:'isOverridingCompanyName']
  end

  if attributes.has_key?(:'isSendingDefault')
    self.is_sending_default = attributes[:'isSendingDefault']
  end

  if attributes.has_key?(:'isSigningDefault')
    self.is_signing_default = attributes[:'isSigningDefault']
  end

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

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

  if attributes.has_key?(:'logos')
    self.logos = attributes[:'logos']
  end

  if attributes.has_key?(:'organizationBrandLogo')
    self. = attributes[:'organizationBrandLogo']
  end

  if attributes.has_key?(:'resources')
    self.resources = attributes[:'resources']
  end
end

Instance Attribute Details

#brand_company ⇒ Object

The name of the company associated with this brand.



18
19
20
 
# File 'lib/docusign_esign/models/brand.rb', line 18

def brand_company
  @brand_company
end

#brand_id ⇒ Object

The ID used to identify a specific brand in API calls.



21
22
23
 
# File 'lib/docusign_esign/models/brand.rb', line 21

def brand_id
  @brand_id
end

#brand_languages ⇒ Object

Returns the value of attribute brand_languages.



24
25
26
 
# File 'lib/docusign_esign/models/brand.rb', line 24

def brand_languages
  @brand_languages
end

#brand_name ⇒ Object

The name of the brand.



27
28
29
 
# File 'lib/docusign_esign/models/brand.rb', line 27

def brand_name
  @brand_name
end

#colors ⇒ Object

Returns the value of attribute colors.



30
31
32
 
# File 'lib/docusign_esign/models/brand.rb', line 30

def colors
  @colors
end

#default_brand_language ⇒ Object

Returns the value of attribute default_brand_language.



33
34
35
 
# File 'lib/docusign_esign/models/brand.rb', line 33

def default_brand_language
  @default_brand_language
end

#email_content ⇒ Object

Returns the value of attribute email_content.



36
37
38
 
# File 'lib/docusign_esign/models/brand.rb', line 36

def email_content
  @email_content
end

#error_details ⇒ Object

Array or errors.



39
40
41
 
# File 'lib/docusign_esign/models/brand.rb', line 39

def error_details
  @error_details
end

#is_organization_brand ⇒ Object

Returns the value of attribute is_organization_brand.



42
43
44
 
# File 'lib/docusign_esign/models/brand.rb', line 42

def is_organization_brand
  @is_organization_brand
end

#is_overriding_company_name ⇒ Object

Returns the value of attribute is_overriding_company_name.



45
46
47
 
# File 'lib/docusign_esign/models/brand.rb', line 45

def is_overriding_company_name
  @is_overriding_company_name
end

#is_sending_default ⇒ Object

Returns the value of attribute is_sending_default.



48
49
50
 
# File 'lib/docusign_esign/models/brand.rb', line 48

def is_sending_default
  @is_sending_default
end

#is_signing_default ⇒ Object

Returns the value of attribute is_signing_default.



51
52
53
 
# File 'lib/docusign_esign/models/brand.rb', line 51

def is_signing_default
  @is_signing_default
end

#landing_pages ⇒ Object

Returns the value of attribute landing_pages.



54
55
56
 
# File 'lib/docusign_esign/models/brand.rb', line 54

def landing_pages
  @landing_pages
end

#links ⇒ Object

Returns the value of attribute links.



57
58
59
 
# File 'lib/docusign_esign/models/brand.rb', line 57

def links
  @links
end

#logos ⇒ Object

The URIs for retrieving the logos that are associated with the brand.



60
61
62
 
# File 'lib/docusign_esign/models/brand.rb', line 60

def logos
  @logos
end

#organization_brand_logo ⇒ Object

Returns the value of attribute organization_brand_logo.



63
64
65
 
# File 'lib/docusign_esign/models/brand.rb', line 63

def 
  @organization_brand_logo
end

#resources ⇒ Object

An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the ‘resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`.



66
67
68
 
# File 'lib/docusign_esign/models/brand.rb', line 66

def resources
  @resources
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/docusign_esign/models/brand.rb', line 69

def self.attribute_map
  {
    :'brand_company' => :'brandCompany',
    :'brand_id' => :'brandId',
    :'brand_languages' => :'brandLanguages',
    :'brand_name' => :'brandName',
    :'colors' => :'colors',
    :'default_brand_language' => :'defaultBrandLanguage',
    :'email_content' => :'emailContent',
    :'error_details' => :'errorDetails',
    :'is_organization_brand' => :'isOrganizationBrand',
    :'is_overriding_company_name' => :'isOverridingCompanyName',
    :'is_sending_default' => :'isSendingDefault',
    :'is_signing_default' => :'isSigningDefault',
    :'landing_pages' => :'landingPages',
    :'links' => :'links',
    :'logos' => :'logos',
    :'organization_brand_logo' => :'organizationBrandLogo',
    :'resources' => :'resources'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/docusign_esign/models/brand.rb', line 92

def self.swagger_types
  {
    :'brand_company' => :'String',
    :'brand_id' => :'String',
    :'brand_languages' => :'Array<String>',
    :'brand_name' => :'String',
    :'colors' => :'Array<NameValue>',
    :'default_brand_language' => :'String',
    :'email_content' => :'Array<BrandEmailContent>',
    :'error_details' => :'ErrorDetails',
    :'is_organization_brand' => :'String',
    :'is_overriding_company_name' => :'BOOLEAN',
    :'is_sending_default' => :'BOOLEAN',
    :'is_signing_default' => :'BOOLEAN',
    :'landing_pages' => :'Array<NameValue>',
    :'links' => :'Array<BrandLink>',
    :'logos' => :'BrandLogos',
    :'organization_brand_logo' => :'String',
    :'resources' => :'BrandResourceUrls'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/docusign_esign/models/brand.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      brand_company == o.brand_company &&
      brand_id == o.brand_id &&
      brand_languages == o.brand_languages &&
      brand_name == o.brand_name &&
      colors == o.colors &&
      default_brand_language == o.default_brand_language &&
      email_content == o.email_content &&
      error_details == o.error_details &&
      is_organization_brand == o.is_organization_brand &&
      is_overriding_company_name == o.is_overriding_company_name &&
      is_sending_default == o.is_sending_default &&
      is_signing_default == o.is_signing_default &&
      landing_pages == o.landing_pages &&
      links == o.links &&
      logos == o.logos &&
       == o. &&
      resources == o.resources
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/docusign_esign/models/brand.rb', line 274

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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/docusign_esign/models/brand.rb', line 340

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/docusign_esign/models/brand.rb', line 253

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


240
241
242
 
# File 'lib/docusign_esign/models/brand.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



246
247
248
 
# File 'lib/docusign_esign/models/brand.rb', line 246

def hash
  [brand_company, brand_id, brand_languages, brand_name, colors, default_brand_language, email_content, error_details, is_organization_brand, is_overriding_company_name, is_sending_default, is_signing_default, landing_pages, links, logos, , resources].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



203
204
205
206
 
# File 'lib/docusign_esign/models/brand.rb', line 203

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



320
321
322
 
# File 'lib/docusign_esign/models/brand.rb', line 320

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



326
327
328
329
330
331
332
333
334
 
# File 'lib/docusign_esign/models/brand.rb', line 326

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



314
315
316
 
# File 'lib/docusign_esign/models/brand.rb', line 314

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



210
211
212
 
# File 'lib/docusign_esign/models/brand.rb', line 210

def valid?
  true
end