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