docusign_esign.models.brand
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class Brand(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'brand_company': 'str', 37 'brand_id': 'str', 38 'brand_languages': 'list[str]', 39 'brand_name': 'str', 40 'colors': 'list[NameValue]', 41 'default_brand_language': 'str', 42 'email_content': 'list[BrandEmailContent]', 43 'error_details': 'ErrorDetails', 44 'is_organization_brand': 'str', 45 'is_overriding_company_name': 'bool', 46 'is_sending_default': 'bool', 47 'is_signing_default': 'bool', 48 'landing_pages': 'list[NameValue]', 49 'links': 'list[BrandLink]', 50 'logos': 'BrandLogos', 51 'organization_brand_logo': 'str', 52 'resources': 'BrandResourceUrls' 53 } 54 55 attribute_map = { 56 'brand_company': 'brandCompany', 57 'brand_id': 'brandId', 58 'brand_languages': 'brandLanguages', 59 'brand_name': 'brandName', 60 'colors': 'colors', 61 'default_brand_language': 'defaultBrandLanguage', 62 'email_content': 'emailContent', 63 'error_details': 'errorDetails', 64 'is_organization_brand': 'isOrganizationBrand', 65 'is_overriding_company_name': 'isOverridingCompanyName', 66 'is_sending_default': 'isSendingDefault', 67 'is_signing_default': 'isSigningDefault', 68 'landing_pages': 'landingPages', 69 'links': 'links', 70 'logos': 'logos', 71 'organization_brand_logo': 'organizationBrandLogo', 72 'resources': 'resources' 73 } 74 75 def __init__(self, _configuration=None, **kwargs): # noqa: E501 76 """Brand - a model defined in Swagger""" # noqa: E501 77 if _configuration is None: 78 _configuration = Configuration() 79 self._configuration = _configuration 80 81 self._brand_company = None 82 self._brand_id = None 83 self._brand_languages = None 84 self._brand_name = None 85 self._colors = None 86 self._default_brand_language = None 87 self._email_content = None 88 self._error_details = None 89 self._is_organization_brand = None 90 self._is_overriding_company_name = None 91 self._is_sending_default = None 92 self._is_signing_default = None 93 self._landing_pages = None 94 self._links = None 95 self._logos = None 96 self._organization_brand_logo = None 97 self._resources = None 98 self.discriminator = None 99 100 setattr(self, "_{}".format('brand_company'), kwargs.get('brand_company', None)) 101 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 102 setattr(self, "_{}".format('brand_languages'), kwargs.get('brand_languages', None)) 103 setattr(self, "_{}".format('brand_name'), kwargs.get('brand_name', None)) 104 setattr(self, "_{}".format('colors'), kwargs.get('colors', None)) 105 setattr(self, "_{}".format('default_brand_language'), kwargs.get('default_brand_language', None)) 106 setattr(self, "_{}".format('email_content'), kwargs.get('email_content', None)) 107 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 108 setattr(self, "_{}".format('is_organization_brand'), kwargs.get('is_organization_brand', None)) 109 setattr(self, "_{}".format('is_overriding_company_name'), kwargs.get('is_overriding_company_name', None)) 110 setattr(self, "_{}".format('is_sending_default'), kwargs.get('is_sending_default', None)) 111 setattr(self, "_{}".format('is_signing_default'), kwargs.get('is_signing_default', None)) 112 setattr(self, "_{}".format('landing_pages'), kwargs.get('landing_pages', None)) 113 setattr(self, "_{}".format('links'), kwargs.get('links', None)) 114 setattr(self, "_{}".format('logos'), kwargs.get('logos', None)) 115 setattr(self, "_{}".format('organization_brand_logo'), kwargs.get('organization_brand_logo', None)) 116 setattr(self, "_{}".format('resources'), kwargs.get('resources', None)) 117 118 @property 119 def brand_company(self): 120 """Gets the brand_company of this Brand. # noqa: E501 121 122 The name of the company associated with this brand. # noqa: E501 123 124 :return: The brand_company of this Brand. # noqa: E501 125 :rtype: str 126 """ 127 return self._brand_company 128 129 @brand_company.setter 130 def brand_company(self, brand_company): 131 """Sets the brand_company of this Brand. 132 133 The name of the company associated with this brand. # noqa: E501 134 135 :param brand_company: The brand_company of this Brand. # noqa: E501 136 :type: str 137 """ 138 139 self._brand_company = brand_company 140 141 @property 142 def brand_id(self): 143 """Gets the brand_id of this Brand. # noqa: E501 144 145 The ID used to identify a specific brand in API calls. # noqa: E501 146 147 :return: The brand_id of this Brand. # noqa: E501 148 :rtype: str 149 """ 150 return self._brand_id 151 152 @brand_id.setter 153 def brand_id(self, brand_id): 154 """Sets the brand_id of this Brand. 155 156 The ID used to identify a specific brand in API calls. # noqa: E501 157 158 :param brand_id: The brand_id of this Brand. # noqa: E501 159 :type: str 160 """ 161 162 self._brand_id = brand_id 163 164 @property 165 def brand_languages(self): 166 """Gets the brand_languages of this Brand. # noqa: E501 167 168 # noqa: E501 169 170 :return: The brand_languages of this Brand. # noqa: E501 171 :rtype: list[str] 172 """ 173 return self._brand_languages 174 175 @brand_languages.setter 176 def brand_languages(self, brand_languages): 177 """Sets the brand_languages of this Brand. 178 179 # noqa: E501 180 181 :param brand_languages: The brand_languages of this Brand. # noqa: E501 182 :type: list[str] 183 """ 184 185 self._brand_languages = brand_languages 186 187 @property 188 def brand_name(self): 189 """Gets the brand_name of this Brand. # noqa: E501 190 191 The name of the brand. # noqa: E501 192 193 :return: The brand_name of this Brand. # noqa: E501 194 :rtype: str 195 """ 196 return self._brand_name 197 198 @brand_name.setter 199 def brand_name(self, brand_name): 200 """Sets the brand_name of this Brand. 201 202 The name of the brand. # noqa: E501 203 204 :param brand_name: The brand_name of this Brand. # noqa: E501 205 :type: str 206 """ 207 208 self._brand_name = brand_name 209 210 @property 211 def colors(self): 212 """Gets the colors of this Brand. # noqa: E501 213 214 # noqa: E501 215 216 :return: The colors of this Brand. # noqa: E501 217 :rtype: list[NameValue] 218 """ 219 return self._colors 220 221 @colors.setter 222 def colors(self, colors): 223 """Sets the colors of this Brand. 224 225 # noqa: E501 226 227 :param colors: The colors of this Brand. # noqa: E501 228 :type: list[NameValue] 229 """ 230 231 self._colors = colors 232 233 @property 234 def default_brand_language(self): 235 """Gets the default_brand_language of this Brand. # noqa: E501 236 237 # noqa: E501 238 239 :return: The default_brand_language of this Brand. # noqa: E501 240 :rtype: str 241 """ 242 return self._default_brand_language 243 244 @default_brand_language.setter 245 def default_brand_language(self, default_brand_language): 246 """Sets the default_brand_language of this Brand. 247 248 # noqa: E501 249 250 :param default_brand_language: The default_brand_language of this Brand. # noqa: E501 251 :type: str 252 """ 253 254 self._default_brand_language = default_brand_language 255 256 @property 257 def email_content(self): 258 """Gets the email_content of this Brand. # noqa: E501 259 260 # noqa: E501 261 262 :return: The email_content of this Brand. # noqa: E501 263 :rtype: list[BrandEmailContent] 264 """ 265 return self._email_content 266 267 @email_content.setter 268 def email_content(self, email_content): 269 """Sets the email_content of this Brand. 270 271 # noqa: E501 272 273 :param email_content: The email_content of this Brand. # noqa: E501 274 :type: list[BrandEmailContent] 275 """ 276 277 self._email_content = email_content 278 279 @property 280 def error_details(self): 281 """Gets the error_details of this Brand. # noqa: E501 282 283 Array or errors. # noqa: E501 284 285 :return: The error_details of this Brand. # noqa: E501 286 :rtype: ErrorDetails 287 """ 288 return self._error_details 289 290 @error_details.setter 291 def error_details(self, error_details): 292 """Sets the error_details of this Brand. 293 294 Array or errors. # noqa: E501 295 296 :param error_details: The error_details of this Brand. # noqa: E501 297 :type: ErrorDetails 298 """ 299 300 self._error_details = error_details 301 302 @property 303 def is_organization_brand(self): 304 """Gets the is_organization_brand of this Brand. # noqa: E501 305 306 # noqa: E501 307 308 :return: The is_organization_brand of this Brand. # noqa: E501 309 :rtype: str 310 """ 311 return self._is_organization_brand 312 313 @is_organization_brand.setter 314 def is_organization_brand(self, is_organization_brand): 315 """Sets the is_organization_brand of this Brand. 316 317 # noqa: E501 318 319 :param is_organization_brand: The is_organization_brand of this Brand. # noqa: E501 320 :type: str 321 """ 322 323 self._is_organization_brand = is_organization_brand 324 325 @property 326 def is_overriding_company_name(self): 327 """Gets the is_overriding_company_name of this Brand. # noqa: E501 328 329 # noqa: E501 330 331 :return: The is_overriding_company_name of this Brand. # noqa: E501 332 :rtype: bool 333 """ 334 return self._is_overriding_company_name 335 336 @is_overriding_company_name.setter 337 def is_overriding_company_name(self, is_overriding_company_name): 338 """Sets the is_overriding_company_name of this Brand. 339 340 # noqa: E501 341 342 :param is_overriding_company_name: The is_overriding_company_name of this Brand. # noqa: E501 343 :type: bool 344 """ 345 346 self._is_overriding_company_name = is_overriding_company_name 347 348 @property 349 def is_sending_default(self): 350 """Gets the is_sending_default of this Brand. # noqa: E501 351 352 # noqa: E501 353 354 :return: The is_sending_default of this Brand. # noqa: E501 355 :rtype: bool 356 """ 357 return self._is_sending_default 358 359 @is_sending_default.setter 360 def is_sending_default(self, is_sending_default): 361 """Sets the is_sending_default of this Brand. 362 363 # noqa: E501 364 365 :param is_sending_default: The is_sending_default of this Brand. # noqa: E501 366 :type: bool 367 """ 368 369 self._is_sending_default = is_sending_default 370 371 @property 372 def is_signing_default(self): 373 """Gets the is_signing_default of this Brand. # noqa: E501 374 375 # noqa: E501 376 377 :return: The is_signing_default of this Brand. # noqa: E501 378 :rtype: bool 379 """ 380 return self._is_signing_default 381 382 @is_signing_default.setter 383 def is_signing_default(self, is_signing_default): 384 """Sets the is_signing_default of this Brand. 385 386 # noqa: E501 387 388 :param is_signing_default: The is_signing_default of this Brand. # noqa: E501 389 :type: bool 390 """ 391 392 self._is_signing_default = is_signing_default 393 394 @property 395 def landing_pages(self): 396 """Gets the landing_pages of this Brand. # noqa: E501 397 398 # noqa: E501 399 400 :return: The landing_pages of this Brand. # noqa: E501 401 :rtype: list[NameValue] 402 """ 403 return self._landing_pages 404 405 @landing_pages.setter 406 def landing_pages(self, landing_pages): 407 """Sets the landing_pages of this Brand. 408 409 # noqa: E501 410 411 :param landing_pages: The landing_pages of this Brand. # noqa: E501 412 :type: list[NameValue] 413 """ 414 415 self._landing_pages = landing_pages 416 417 @property 418 def links(self): 419 """Gets the links of this Brand. # noqa: E501 420 421 # noqa: E501 422 423 :return: The links of this Brand. # noqa: E501 424 :rtype: list[BrandLink] 425 """ 426 return self._links 427 428 @links.setter 429 def links(self, links): 430 """Sets the links of this Brand. 431 432 # noqa: E501 433 434 :param links: The links of this Brand. # noqa: E501 435 :type: list[BrandLink] 436 """ 437 438 self._links = links 439 440 @property 441 def logos(self): 442 """Gets the logos of this Brand. # noqa: E501 443 444 The URIs for retrieving the logos that are associated with the brand. # noqa: E501 445 446 :return: The logos of this Brand. # noqa: E501 447 :rtype: BrandLogos 448 """ 449 return self._logos 450 451 @logos.setter 452 def logos(self, logos): 453 """Sets the logos of this Brand. 454 455 The URIs for retrieving the logos that are associated with the brand. # noqa: E501 456 457 :param logos: The logos of this Brand. # noqa: E501 458 :type: BrandLogos 459 """ 460 461 self._logos = logos 462 463 @property 464 def organization_brand_logo(self): 465 """Gets the organization_brand_logo of this Brand. # noqa: E501 466 467 # noqa: E501 468 469 :return: The organization_brand_logo of this Brand. # noqa: E501 470 :rtype: str 471 """ 472 return self._organization_brand_logo 473 474 @organization_brand_logo.setter 475 def organization_brand_logo(self, organization_brand_logo): 476 """Sets the organization_brand_logo of this Brand. 477 478 # noqa: E501 479 480 :param organization_brand_logo: The organization_brand_logo of this Brand. # noqa: E501 481 :type: str 482 """ 483 484 self._organization_brand_logo = organization_brand_logo 485 486 @property 487 def resources(self): 488 """Gets the resources of this Brand. # noqa: E501 489 490 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`. # noqa: E501 491 492 :return: The resources of this Brand. # noqa: E501 493 :rtype: BrandResourceUrls 494 """ 495 return self._resources 496 497 @resources.setter 498 def resources(self, resources): 499 """Sets the resources of this Brand. 500 501 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`. # noqa: E501 502 503 :param resources: The resources of this Brand. # noqa: E501 504 :type: BrandResourceUrls 505 """ 506 507 self._resources = resources 508 509 def to_dict(self): 510 """Returns the model properties as a dict""" 511 result = {} 512 513 for attr, _ in six.iteritems(self.swagger_types): 514 value = getattr(self, attr) 515 if isinstance(value, list): 516 result[attr] = list(map( 517 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 518 value 519 )) 520 elif hasattr(value, "to_dict"): 521 result[attr] = value.to_dict() 522 elif isinstance(value, dict): 523 result[attr] = dict(map( 524 lambda item: (item[0], item[1].to_dict()) 525 if hasattr(item[1], "to_dict") else item, 526 value.items() 527 )) 528 else: 529 result[attr] = value 530 if issubclass(Brand, dict): 531 for key, value in self.items(): 532 result[key] = value 533 534 return result 535 536 def to_str(self): 537 """Returns the string representation of the model""" 538 return pprint.pformat(self.to_dict()) 539 540 def __repr__(self): 541 """For `print` and `pprint`""" 542 return self.to_str() 543 544 def __eq__(self, other): 545 """Returns true if both objects are equal""" 546 if not isinstance(other, Brand): 547 return False 548 549 return self.to_dict() == other.to_dict() 550 551 def __ne__(self, other): 552 """Returns true if both objects are not equal""" 553 if not isinstance(other, Brand): 554 return True 555 556 return self.to_dict() != other.to_dict()
class
Brand:
23class Brand(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'brand_company': 'str', 38 'brand_id': 'str', 39 'brand_languages': 'list[str]', 40 'brand_name': 'str', 41 'colors': 'list[NameValue]', 42 'default_brand_language': 'str', 43 'email_content': 'list[BrandEmailContent]', 44 'error_details': 'ErrorDetails', 45 'is_organization_brand': 'str', 46 'is_overriding_company_name': 'bool', 47 'is_sending_default': 'bool', 48 'is_signing_default': 'bool', 49 'landing_pages': 'list[NameValue]', 50 'links': 'list[BrandLink]', 51 'logos': 'BrandLogos', 52 'organization_brand_logo': 'str', 53 'resources': 'BrandResourceUrls' 54 } 55 56 attribute_map = { 57 'brand_company': 'brandCompany', 58 'brand_id': 'brandId', 59 'brand_languages': 'brandLanguages', 60 'brand_name': 'brandName', 61 'colors': 'colors', 62 'default_brand_language': 'defaultBrandLanguage', 63 'email_content': 'emailContent', 64 'error_details': 'errorDetails', 65 'is_organization_brand': 'isOrganizationBrand', 66 'is_overriding_company_name': 'isOverridingCompanyName', 67 'is_sending_default': 'isSendingDefault', 68 'is_signing_default': 'isSigningDefault', 69 'landing_pages': 'landingPages', 70 'links': 'links', 71 'logos': 'logos', 72 'organization_brand_logo': 'organizationBrandLogo', 73 'resources': 'resources' 74 } 75 76 def __init__(self, _configuration=None, **kwargs): # noqa: E501 77 """Brand - a model defined in Swagger""" # noqa: E501 78 if _configuration is None: 79 _configuration = Configuration() 80 self._configuration = _configuration 81 82 self._brand_company = None 83 self._brand_id = None 84 self._brand_languages = None 85 self._brand_name = None 86 self._colors = None 87 self._default_brand_language = None 88 self._email_content = None 89 self._error_details = None 90 self._is_organization_brand = None 91 self._is_overriding_company_name = None 92 self._is_sending_default = None 93 self._is_signing_default = None 94 self._landing_pages = None 95 self._links = None 96 self._logos = None 97 self._organization_brand_logo = None 98 self._resources = None 99 self.discriminator = None 100 101 setattr(self, "_{}".format('brand_company'), kwargs.get('brand_company', None)) 102 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 103 setattr(self, "_{}".format('brand_languages'), kwargs.get('brand_languages', None)) 104 setattr(self, "_{}".format('brand_name'), kwargs.get('brand_name', None)) 105 setattr(self, "_{}".format('colors'), kwargs.get('colors', None)) 106 setattr(self, "_{}".format('default_brand_language'), kwargs.get('default_brand_language', None)) 107 setattr(self, "_{}".format('email_content'), kwargs.get('email_content', None)) 108 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 109 setattr(self, "_{}".format('is_organization_brand'), kwargs.get('is_organization_brand', None)) 110 setattr(self, "_{}".format('is_overriding_company_name'), kwargs.get('is_overriding_company_name', None)) 111 setattr(self, "_{}".format('is_sending_default'), kwargs.get('is_sending_default', None)) 112 setattr(self, "_{}".format('is_signing_default'), kwargs.get('is_signing_default', None)) 113 setattr(self, "_{}".format('landing_pages'), kwargs.get('landing_pages', None)) 114 setattr(self, "_{}".format('links'), kwargs.get('links', None)) 115 setattr(self, "_{}".format('logos'), kwargs.get('logos', None)) 116 setattr(self, "_{}".format('organization_brand_logo'), kwargs.get('organization_brand_logo', None)) 117 setattr(self, "_{}".format('resources'), kwargs.get('resources', None)) 118 119 @property 120 def brand_company(self): 121 """Gets the brand_company of this Brand. # noqa: E501 122 123 The name of the company associated with this brand. # noqa: E501 124 125 :return: The brand_company of this Brand. # noqa: E501 126 :rtype: str 127 """ 128 return self._brand_company 129 130 @brand_company.setter 131 def brand_company(self, brand_company): 132 """Sets the brand_company of this Brand. 133 134 The name of the company associated with this brand. # noqa: E501 135 136 :param brand_company: The brand_company of this Brand. # noqa: E501 137 :type: str 138 """ 139 140 self._brand_company = brand_company 141 142 @property 143 def brand_id(self): 144 """Gets the brand_id of this Brand. # noqa: E501 145 146 The ID used to identify a specific brand in API calls. # noqa: E501 147 148 :return: The brand_id of this Brand. # noqa: E501 149 :rtype: str 150 """ 151 return self._brand_id 152 153 @brand_id.setter 154 def brand_id(self, brand_id): 155 """Sets the brand_id of this Brand. 156 157 The ID used to identify a specific brand in API calls. # noqa: E501 158 159 :param brand_id: The brand_id of this Brand. # noqa: E501 160 :type: str 161 """ 162 163 self._brand_id = brand_id 164 165 @property 166 def brand_languages(self): 167 """Gets the brand_languages of this Brand. # noqa: E501 168 169 # noqa: E501 170 171 :return: The brand_languages of this Brand. # noqa: E501 172 :rtype: list[str] 173 """ 174 return self._brand_languages 175 176 @brand_languages.setter 177 def brand_languages(self, brand_languages): 178 """Sets the brand_languages of this Brand. 179 180 # noqa: E501 181 182 :param brand_languages: The brand_languages of this Brand. # noqa: E501 183 :type: list[str] 184 """ 185 186 self._brand_languages = brand_languages 187 188 @property 189 def brand_name(self): 190 """Gets the brand_name of this Brand. # noqa: E501 191 192 The name of the brand. # noqa: E501 193 194 :return: The brand_name of this Brand. # noqa: E501 195 :rtype: str 196 """ 197 return self._brand_name 198 199 @brand_name.setter 200 def brand_name(self, brand_name): 201 """Sets the brand_name of this Brand. 202 203 The name of the brand. # noqa: E501 204 205 :param brand_name: The brand_name of this Brand. # noqa: E501 206 :type: str 207 """ 208 209 self._brand_name = brand_name 210 211 @property 212 def colors(self): 213 """Gets the colors of this Brand. # noqa: E501 214 215 # noqa: E501 216 217 :return: The colors of this Brand. # noqa: E501 218 :rtype: list[NameValue] 219 """ 220 return self._colors 221 222 @colors.setter 223 def colors(self, colors): 224 """Sets the colors of this Brand. 225 226 # noqa: E501 227 228 :param colors: The colors of this Brand. # noqa: E501 229 :type: list[NameValue] 230 """ 231 232 self._colors = colors 233 234 @property 235 def default_brand_language(self): 236 """Gets the default_brand_language of this Brand. # noqa: E501 237 238 # noqa: E501 239 240 :return: The default_brand_language of this Brand. # noqa: E501 241 :rtype: str 242 """ 243 return self._default_brand_language 244 245 @default_brand_language.setter 246 def default_brand_language(self, default_brand_language): 247 """Sets the default_brand_language of this Brand. 248 249 # noqa: E501 250 251 :param default_brand_language: The default_brand_language of this Brand. # noqa: E501 252 :type: str 253 """ 254 255 self._default_brand_language = default_brand_language 256 257 @property 258 def email_content(self): 259 """Gets the email_content of this Brand. # noqa: E501 260 261 # noqa: E501 262 263 :return: The email_content of this Brand. # noqa: E501 264 :rtype: list[BrandEmailContent] 265 """ 266 return self._email_content 267 268 @email_content.setter 269 def email_content(self, email_content): 270 """Sets the email_content of this Brand. 271 272 # noqa: E501 273 274 :param email_content: The email_content of this Brand. # noqa: E501 275 :type: list[BrandEmailContent] 276 """ 277 278 self._email_content = email_content 279 280 @property 281 def error_details(self): 282 """Gets the error_details of this Brand. # noqa: E501 283 284 Array or errors. # noqa: E501 285 286 :return: The error_details of this Brand. # noqa: E501 287 :rtype: ErrorDetails 288 """ 289 return self._error_details 290 291 @error_details.setter 292 def error_details(self, error_details): 293 """Sets the error_details of this Brand. 294 295 Array or errors. # noqa: E501 296 297 :param error_details: The error_details of this Brand. # noqa: E501 298 :type: ErrorDetails 299 """ 300 301 self._error_details = error_details 302 303 @property 304 def is_organization_brand(self): 305 """Gets the is_organization_brand of this Brand. # noqa: E501 306 307 # noqa: E501 308 309 :return: The is_organization_brand of this Brand. # noqa: E501 310 :rtype: str 311 """ 312 return self._is_organization_brand 313 314 @is_organization_brand.setter 315 def is_organization_brand(self, is_organization_brand): 316 """Sets the is_organization_brand of this Brand. 317 318 # noqa: E501 319 320 :param is_organization_brand: The is_organization_brand of this Brand. # noqa: E501 321 :type: str 322 """ 323 324 self._is_organization_brand = is_organization_brand 325 326 @property 327 def is_overriding_company_name(self): 328 """Gets the is_overriding_company_name of this Brand. # noqa: E501 329 330 # noqa: E501 331 332 :return: The is_overriding_company_name of this Brand. # noqa: E501 333 :rtype: bool 334 """ 335 return self._is_overriding_company_name 336 337 @is_overriding_company_name.setter 338 def is_overriding_company_name(self, is_overriding_company_name): 339 """Sets the is_overriding_company_name of this Brand. 340 341 # noqa: E501 342 343 :param is_overriding_company_name: The is_overriding_company_name of this Brand. # noqa: E501 344 :type: bool 345 """ 346 347 self._is_overriding_company_name = is_overriding_company_name 348 349 @property 350 def is_sending_default(self): 351 """Gets the is_sending_default of this Brand. # noqa: E501 352 353 # noqa: E501 354 355 :return: The is_sending_default of this Brand. # noqa: E501 356 :rtype: bool 357 """ 358 return self._is_sending_default 359 360 @is_sending_default.setter 361 def is_sending_default(self, is_sending_default): 362 """Sets the is_sending_default of this Brand. 363 364 # noqa: E501 365 366 :param is_sending_default: The is_sending_default of this Brand. # noqa: E501 367 :type: bool 368 """ 369 370 self._is_sending_default = is_sending_default 371 372 @property 373 def is_signing_default(self): 374 """Gets the is_signing_default of this Brand. # noqa: E501 375 376 # noqa: E501 377 378 :return: The is_signing_default of this Brand. # noqa: E501 379 :rtype: bool 380 """ 381 return self._is_signing_default 382 383 @is_signing_default.setter 384 def is_signing_default(self, is_signing_default): 385 """Sets the is_signing_default of this Brand. 386 387 # noqa: E501 388 389 :param is_signing_default: The is_signing_default of this Brand. # noqa: E501 390 :type: bool 391 """ 392 393 self._is_signing_default = is_signing_default 394 395 @property 396 def landing_pages(self): 397 """Gets the landing_pages of this Brand. # noqa: E501 398 399 # noqa: E501 400 401 :return: The landing_pages of this Brand. # noqa: E501 402 :rtype: list[NameValue] 403 """ 404 return self._landing_pages 405 406 @landing_pages.setter 407 def landing_pages(self, landing_pages): 408 """Sets the landing_pages of this Brand. 409 410 # noqa: E501 411 412 :param landing_pages: The landing_pages of this Brand. # noqa: E501 413 :type: list[NameValue] 414 """ 415 416 self._landing_pages = landing_pages 417 418 @property 419 def links(self): 420 """Gets the links of this Brand. # noqa: E501 421 422 # noqa: E501 423 424 :return: The links of this Brand. # noqa: E501 425 :rtype: list[BrandLink] 426 """ 427 return self._links 428 429 @links.setter 430 def links(self, links): 431 """Sets the links of this Brand. 432 433 # noqa: E501 434 435 :param links: The links of this Brand. # noqa: E501 436 :type: list[BrandLink] 437 """ 438 439 self._links = links 440 441 @property 442 def logos(self): 443 """Gets the logos of this Brand. # noqa: E501 444 445 The URIs for retrieving the logos that are associated with the brand. # noqa: E501 446 447 :return: The logos of this Brand. # noqa: E501 448 :rtype: BrandLogos 449 """ 450 return self._logos 451 452 @logos.setter 453 def logos(self, logos): 454 """Sets the logos of this Brand. 455 456 The URIs for retrieving the logos that are associated with the brand. # noqa: E501 457 458 :param logos: The logos of this Brand. # noqa: E501 459 :type: BrandLogos 460 """ 461 462 self._logos = logos 463 464 @property 465 def organization_brand_logo(self): 466 """Gets the organization_brand_logo of this Brand. # noqa: E501 467 468 # noqa: E501 469 470 :return: The organization_brand_logo of this Brand. # noqa: E501 471 :rtype: str 472 """ 473 return self._organization_brand_logo 474 475 @organization_brand_logo.setter 476 def organization_brand_logo(self, organization_brand_logo): 477 """Sets the organization_brand_logo of this Brand. 478 479 # noqa: E501 480 481 :param organization_brand_logo: The organization_brand_logo of this Brand. # noqa: E501 482 :type: str 483 """ 484 485 self._organization_brand_logo = organization_brand_logo 486 487 @property 488 def resources(self): 489 """Gets the resources of this Brand. # noqa: E501 490 491 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`. # noqa: E501 492 493 :return: The resources of this Brand. # noqa: E501 494 :rtype: BrandResourceUrls 495 """ 496 return self._resources 497 498 @resources.setter 499 def resources(self, resources): 500 """Sets the resources of this Brand. 501 502 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`. # noqa: E501 503 504 :param resources: The resources of this Brand. # noqa: E501 505 :type: BrandResourceUrls 506 """ 507 508 self._resources = resources 509 510 def to_dict(self): 511 """Returns the model properties as a dict""" 512 result = {} 513 514 for attr, _ in six.iteritems(self.swagger_types): 515 value = getattr(self, attr) 516 if isinstance(value, list): 517 result[attr] = list(map( 518 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 519 value 520 )) 521 elif hasattr(value, "to_dict"): 522 result[attr] = value.to_dict() 523 elif isinstance(value, dict): 524 result[attr] = dict(map( 525 lambda item: (item[0], item[1].to_dict()) 526 if hasattr(item[1], "to_dict") else item, 527 value.items() 528 )) 529 else: 530 result[attr] = value 531 if issubclass(Brand, dict): 532 for key, value in self.items(): 533 result[key] = value 534 535 return result 536 537 def to_str(self): 538 """Returns the string representation of the model""" 539 return pprint.pformat(self.to_dict()) 540 541 def __repr__(self): 542 """For `print` and `pprint`""" 543 return self.to_str() 544 545 def __eq__(self, other): 546 """Returns true if both objects are equal""" 547 if not isinstance(other, Brand): 548 return False 549 550 return self.to_dict() == other.to_dict() 551 552 def __ne__(self, other): 553 """Returns true if both objects are not equal""" 554 if not isinstance(other, Brand): 555 return True 556 557 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Brand(_configuration=None, **kwargs)
76 def __init__(self, _configuration=None, **kwargs): # noqa: E501 77 """Brand - a model defined in Swagger""" # noqa: E501 78 if _configuration is None: 79 _configuration = Configuration() 80 self._configuration = _configuration 81 82 self._brand_company = None 83 self._brand_id = None 84 self._brand_languages = None 85 self._brand_name = None 86 self._colors = None 87 self._default_brand_language = None 88 self._email_content = None 89 self._error_details = None 90 self._is_organization_brand = None 91 self._is_overriding_company_name = None 92 self._is_sending_default = None 93 self._is_signing_default = None 94 self._landing_pages = None 95 self._links = None 96 self._logos = None 97 self._organization_brand_logo = None 98 self._resources = None 99 self.discriminator = None 100 101 setattr(self, "_{}".format('brand_company'), kwargs.get('brand_company', None)) 102 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 103 setattr(self, "_{}".format('brand_languages'), kwargs.get('brand_languages', None)) 104 setattr(self, "_{}".format('brand_name'), kwargs.get('brand_name', None)) 105 setattr(self, "_{}".format('colors'), kwargs.get('colors', None)) 106 setattr(self, "_{}".format('default_brand_language'), kwargs.get('default_brand_language', None)) 107 setattr(self, "_{}".format('email_content'), kwargs.get('email_content', None)) 108 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 109 setattr(self, "_{}".format('is_organization_brand'), kwargs.get('is_organization_brand', None)) 110 setattr(self, "_{}".format('is_overriding_company_name'), kwargs.get('is_overriding_company_name', None)) 111 setattr(self, "_{}".format('is_sending_default'), kwargs.get('is_sending_default', None)) 112 setattr(self, "_{}".format('is_signing_default'), kwargs.get('is_signing_default', None)) 113 setattr(self, "_{}".format('landing_pages'), kwargs.get('landing_pages', None)) 114 setattr(self, "_{}".format('links'), kwargs.get('links', None)) 115 setattr(self, "_{}".format('logos'), kwargs.get('logos', None)) 116 setattr(self, "_{}".format('organization_brand_logo'), kwargs.get('organization_brand_logo', None)) 117 setattr(self, "_{}".format('resources'), kwargs.get('resources', None))
Brand - a model defined in Swagger
swagger_types = {'brand_company': 'str', 'brand_id': 'str', 'brand_languages': 'list[str]', 'brand_name': 'str', 'colors': 'list[NameValue]', 'default_brand_language': 'str', 'email_content': 'list[BrandEmailContent]', 'error_details': 'ErrorDetails', 'is_organization_brand': 'str', 'is_overriding_company_name': 'bool', 'is_sending_default': 'bool', 'is_signing_default': 'bool', 'landing_pages': 'list[NameValue]', 'links': 'list[BrandLink]', 'logos': 'BrandLogos', 'organization_brand_logo': 'str', 'resources': 'BrandResourceUrls'}
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'}
brand_company
Gets the brand_company of this Brand. # noqa: E501
The name of the company associated with this brand. # noqa: E501
Returns
The brand_company of this Brand. # noqa: E501
brand_id
Gets the brand_id of this Brand. # noqa: E501
The ID used to identify a specific brand in API calls. # noqa: E501
Returns
The brand_id of this Brand. # noqa: E501
brand_languages
Gets the brand_languages of this Brand. # noqa: E501
# noqa: E501
Returns
The brand_languages of this Brand. # noqa: E501
brand_name
Gets the brand_name of this Brand. # noqa: E501
The name of the brand. # noqa: E501
Returns
The brand_name of this Brand. # noqa: E501
colors
Gets the colors of this Brand. # noqa: E501
# noqa: E501
Returns
The colors of this Brand. # noqa: E501
default_brand_language
Gets the default_brand_language of this Brand. # noqa: E501
# noqa: E501
Returns
The default_brand_language of this Brand. # noqa: E501
email_content
Gets the email_content of this Brand. # noqa: E501
# noqa: E501
Returns
The email_content of this Brand. # noqa: E501
error_details
Gets the error_details of this Brand. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this Brand. # noqa: E501
is_organization_brand
Gets the is_organization_brand of this Brand. # noqa: E501
# noqa: E501
Returns
The is_organization_brand of this Brand. # noqa: E501
is_overriding_company_name
Gets the is_overriding_company_name of this Brand. # noqa: E501
# noqa: E501
Returns
The is_overriding_company_name of this Brand. # noqa: E501
is_sending_default
Gets the is_sending_default of this Brand. # noqa: E501
# noqa: E501
Returns
The is_sending_default of this Brand. # noqa: E501
is_signing_default
Gets the is_signing_default of this Brand. # noqa: E501
# noqa: E501
Returns
The is_signing_default of this Brand. # noqa: E501
landing_pages
Gets the landing_pages of this Brand. # noqa: E501
# noqa: E501
Returns
The landing_pages of this Brand. # noqa: E501
links
Gets the links of this Brand. # noqa: E501
# noqa: E501
Returns
The links of this Brand. # noqa: E501
logos
Gets the logos of this Brand. # noqa: E501
The URIs for retrieving the logos that are associated with the brand. # noqa: E501
Returns
The logos of this Brand. # noqa: E501
organization_brand_logo
Gets the organization_brand_logo of this Brand. # noqa: E501
# noqa: E501
Returns
The organization_brand_logo of this Brand. # noqa: E501
resources
Gets the resources of this Brand. # noqa: E501
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. # noqa: E501
Returns
The resources of this Brand. # noqa: E501
def
to_dict(self)
510 def to_dict(self): 511 """Returns the model properties as a dict""" 512 result = {} 513 514 for attr, _ in six.iteritems(self.swagger_types): 515 value = getattr(self, attr) 516 if isinstance(value, list): 517 result[attr] = list(map( 518 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 519 value 520 )) 521 elif hasattr(value, "to_dict"): 522 result[attr] = value.to_dict() 523 elif isinstance(value, dict): 524 result[attr] = dict(map( 525 lambda item: (item[0], item[1].to_dict()) 526 if hasattr(item[1], "to_dict") else item, 527 value.items() 528 )) 529 else: 530 result[attr] = value 531 if issubclass(Brand, dict): 532 for key, value in self.items(): 533 result[key] = value 534 535 return result
Returns the model properties as a dict