Class: DocuSign_eSign::Brand
- Inherits:
-
Object
- Object
- DocuSign_eSign::Brand
- Defined in:
- lib/docusign_esign/models/brand.rb
Instance Attribute Summary collapse
-
#brand_company ⇒ Object
The name of the company associated with this brand.
-
#brand_id ⇒ Object
The ID used to identify a specific brand in API calls.
-
#brand_languages ⇒ Object
Returns the value of attribute brand_languages.
-
#brand_name ⇒ Object
The name of the brand.
-
#colors ⇒ Object
Returns the value of attribute colors.
-
#default_brand_language ⇒ Object
Returns the value of attribute default_brand_language.
-
#email_content ⇒ Object
Returns the value of attribute email_content.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#is_overriding_company_name ⇒ Object
Returns the value of attribute is_overriding_company_name.
-
#is_sending_default ⇒ Object
Returns the value of attribute is_sending_default.
-
#is_signing_default ⇒ Object
Returns the value of attribute is_signing_default.
-
#landing_pages ⇒ Object
Returns the value of attribute landing_pages.
-
#links ⇒ Object
Returns the value of attribute links.
-
#logos ⇒ Object
Returns the value of attribute logos.
-
#resources ⇒ Object
Returns the value of attribute resources.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Brand
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Brand
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 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 |
# File 'lib/docusign_esign/models/brand.rb', line 102 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?(:'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?(:'resources') self.resources = attributes[:'resources'] end end |
Instance Attribute Details
#brand_company ⇒ Object
The name of the company associated with this brand.
17 18 19 |
# File 'lib/docusign_esign/models/brand.rb', line 17 def brand_company @brand_company end |
#brand_id ⇒ Object
The ID used to identify a specific brand in API calls.
20 21 22 |
# File 'lib/docusign_esign/models/brand.rb', line 20 def brand_id @brand_id end |
#brand_languages ⇒ Object
Returns the value of attribute brand_languages.
23 24 25 |
# File 'lib/docusign_esign/models/brand.rb', line 23 def brand_languages @brand_languages end |
#brand_name ⇒ Object
The name of the brand.
26 27 28 |
# File 'lib/docusign_esign/models/brand.rb', line 26 def brand_name @brand_name end |
#colors ⇒ Object
Returns the value of attribute colors.
29 30 31 |
# File 'lib/docusign_esign/models/brand.rb', line 29 def colors @colors end |
#default_brand_language ⇒ Object
Returns the value of attribute default_brand_language.
32 33 34 |
# File 'lib/docusign_esign/models/brand.rb', line 32 def default_brand_language @default_brand_language end |
#email_content ⇒ Object
Returns the value of attribute email_content.
35 36 37 |
# File 'lib/docusign_esign/models/brand.rb', line 35 def email_content @email_content end |
#error_details ⇒ Object
Returns the value of attribute error_details.
37 38 39 |
# File 'lib/docusign_esign/models/brand.rb', line 37 def error_details @error_details end |
#is_overriding_company_name ⇒ Object
Returns the value of attribute is_overriding_company_name.
40 41 42 |
# File 'lib/docusign_esign/models/brand.rb', line 40 def is_overriding_company_name @is_overriding_company_name end |
#is_sending_default ⇒ Object
Returns the value of attribute is_sending_default.
43 44 45 |
# File 'lib/docusign_esign/models/brand.rb', line 43 def is_sending_default @is_sending_default end |
#is_signing_default ⇒ Object
Returns the value of attribute is_signing_default.
46 47 48 |
# File 'lib/docusign_esign/models/brand.rb', line 46 def is_signing_default @is_signing_default end |
#landing_pages ⇒ Object
Returns the value of attribute landing_pages.
49 50 51 |
# File 'lib/docusign_esign/models/brand.rb', line 49 def landing_pages @landing_pages end |
#links ⇒ Object
Returns the value of attribute links.
52 53 54 |
# File 'lib/docusign_esign/models/brand.rb', line 52 def links @links end |
#logos ⇒ Object
Returns the value of attribute logos.
54 55 56 |
# File 'lib/docusign_esign/models/brand.rb', line 54 def logos @logos end |
#resources ⇒ Object
Returns the value of attribute resources.
56 57 58 |
# File 'lib/docusign_esign/models/brand.rb', line 56 def resources @resources end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/docusign_esign/models/brand.rb', line 59 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_overriding_company_name' => :'isOverridingCompanyName', :'is_sending_default' => :'isSendingDefault', :'is_signing_default' => :'isSigningDefault', :'landing_pages' => :'landingPages', :'links' => :'links', :'logos' => :'logos', :'resources' => :'resources' } end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/docusign_esign/models/brand.rb', line 80 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_overriding_company_name' => :'BOOLEAN', :'is_sending_default' => :'BOOLEAN', :'is_signing_default' => :'BOOLEAN', :'landing_pages' => :'Array<NameValue>', :'links' => :'Array<BrandLink>', :'logos' => :'BrandLogos', :'resources' => :'BrandResourceUrls' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/docusign_esign/models/brand.rb', line 194 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_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 && resources == o.resources end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/docusign_esign/models/brand.rb', line 250 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
316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/docusign_esign/models/brand.rb', line 316 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
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/docusign_esign/models/brand.rb', line 229 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
216 217 218 |
# File 'lib/docusign_esign/models/brand.rb', line 216 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
222 223 224 |
# File 'lib/docusign_esign/models/brand.rb', line 222 def hash [brand_company, brand_id, brand_languages, brand_name, colors, default_brand_language, email_content, error_details, 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?
181 182 183 184 |
# File 'lib/docusign_esign/models/brand.rb', line 181 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
296 297 298 |
# File 'lib/docusign_esign/models/brand.rb', line 296 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
302 303 304 305 306 307 308 309 310 |
# File 'lib/docusign_esign/models/brand.rb', line 302 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
290 291 292 |
# File 'lib/docusign_esign/models/brand.rb', line 290 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
188 189 190 |
# File 'lib/docusign_esign/models/brand.rb', line 188 def valid? true end |