docusign_esign.models.referral_information
DocuSign REST API
The DocuSign 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 REST API 5 6 The DocuSign 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 ReferralInformation(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 'advertisement_id': 'str', 37 'enable_support': 'str', 38 'external_org_id': 'str', 39 'group_member_id': 'str', 40 'id_type': 'str', 41 'included_seats': 'str', 42 'industry': 'str', 43 'plan_start_month': 'str', 44 'promo_code': 'str', 45 'publisher_id': 'str', 46 'referral_code': 'str', 47 'referrer_name': 'str', 48 'sale_discount_amount': 'str', 49 'sale_discount_fixed_amount': 'str', 50 'sale_discount_percent': 'str', 51 'sale_discount_periods': 'str', 52 'sale_discount_seat_price_override': 'str', 53 'shopper_id': 'str' 54 } 55 56 attribute_map = { 57 'advertisement_id': 'advertisementId', 58 'enable_support': 'enableSupport', 59 'external_org_id': 'externalOrgId', 60 'group_member_id': 'groupMemberId', 61 'id_type': 'idType', 62 'included_seats': 'includedSeats', 63 'industry': 'industry', 64 'plan_start_month': 'planStartMonth', 65 'promo_code': 'promoCode', 66 'publisher_id': 'publisherId', 67 'referral_code': 'referralCode', 68 'referrer_name': 'referrerName', 69 'sale_discount_amount': 'saleDiscountAmount', 70 'sale_discount_fixed_amount': 'saleDiscountFixedAmount', 71 'sale_discount_percent': 'saleDiscountPercent', 72 'sale_discount_periods': 'saleDiscountPeriods', 73 'sale_discount_seat_price_override': 'saleDiscountSeatPriceOverride', 74 'shopper_id': 'shopperId' 75 } 76 77 def __init__(self, _configuration=None, **kwargs): # noqa: E501 78 """ReferralInformation - a model defined in Swagger""" # noqa: E501 79 if _configuration is None: 80 _configuration = Configuration() 81 self._configuration = _configuration 82 83 self._advertisement_id = None 84 self._enable_support = None 85 self._external_org_id = None 86 self._group_member_id = None 87 self._id_type = None 88 self._included_seats = None 89 self._industry = None 90 self._plan_start_month = None 91 self._promo_code = None 92 self._publisher_id = None 93 self._referral_code = None 94 self._referrer_name = None 95 self._sale_discount_amount = None 96 self._sale_discount_fixed_amount = None 97 self._sale_discount_percent = None 98 self._sale_discount_periods = None 99 self._sale_discount_seat_price_override = None 100 self._shopper_id = None 101 self.discriminator = None 102 103 setattr(self, "_{}".format('advertisement_id'), kwargs.get('advertisement_id', None)) 104 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 105 setattr(self, "_{}".format('external_org_id'), kwargs.get('external_org_id', None)) 106 setattr(self, "_{}".format('group_member_id'), kwargs.get('group_member_id', None)) 107 setattr(self, "_{}".format('id_type'), kwargs.get('id_type', None)) 108 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 109 setattr(self, "_{}".format('industry'), kwargs.get('industry', None)) 110 setattr(self, "_{}".format('plan_start_month'), kwargs.get('plan_start_month', None)) 111 setattr(self, "_{}".format('promo_code'), kwargs.get('promo_code', None)) 112 setattr(self, "_{}".format('publisher_id'), kwargs.get('publisher_id', None)) 113 setattr(self, "_{}".format('referral_code'), kwargs.get('referral_code', None)) 114 setattr(self, "_{}".format('referrer_name'), kwargs.get('referrer_name', None)) 115 setattr(self, "_{}".format('sale_discount_amount'), kwargs.get('sale_discount_amount', None)) 116 setattr(self, "_{}".format('sale_discount_fixed_amount'), kwargs.get('sale_discount_fixed_amount', None)) 117 setattr(self, "_{}".format('sale_discount_percent'), kwargs.get('sale_discount_percent', None)) 118 setattr(self, "_{}".format('sale_discount_periods'), kwargs.get('sale_discount_periods', None)) 119 setattr(self, "_{}".format('sale_discount_seat_price_override'), kwargs.get('sale_discount_seat_price_override', None)) 120 setattr(self, "_{}".format('shopper_id'), kwargs.get('shopper_id', None)) 121 122 @property 123 def advertisement_id(self): 124 """Gets the advertisement_id of this ReferralInformation. # noqa: E501 125 126 A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. # noqa: E501 127 128 :return: The advertisement_id of this ReferralInformation. # noqa: E501 129 :rtype: str 130 """ 131 return self._advertisement_id 132 133 @advertisement_id.setter 134 def advertisement_id(self, advertisement_id): 135 """Sets the advertisement_id of this ReferralInformation. 136 137 A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. # noqa: E501 138 139 :param advertisement_id: The advertisement_id of this ReferralInformation. # noqa: E501 140 :type: str 141 """ 142 143 self._advertisement_id = advertisement_id 144 145 @property 146 def enable_support(self): 147 """Gets the enable_support of this ReferralInformation. # noqa: E501 148 149 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 150 151 :return: The enable_support of this ReferralInformation. # noqa: E501 152 :rtype: str 153 """ 154 return self._enable_support 155 156 @enable_support.setter 157 def enable_support(self, enable_support): 158 """Sets the enable_support of this ReferralInformation. 159 160 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 161 162 :param enable_support: The enable_support of this ReferralInformation. # noqa: E501 163 :type: str 164 """ 165 166 self._enable_support = enable_support 167 168 @property 169 def external_org_id(self): 170 """Gets the external_org_id of this ReferralInformation. # noqa: E501 171 172 # noqa: E501 173 174 :return: The external_org_id of this ReferralInformation. # noqa: E501 175 :rtype: str 176 """ 177 return self._external_org_id 178 179 @external_org_id.setter 180 def external_org_id(self, external_org_id): 181 """Sets the external_org_id of this ReferralInformation. 182 183 # noqa: E501 184 185 :param external_org_id: The external_org_id of this ReferralInformation. # noqa: E501 186 :type: str 187 """ 188 189 self._external_org_id = external_org_id 190 191 @property 192 def group_member_id(self): 193 """Gets the group_member_id of this ReferralInformation. # noqa: E501 194 195 # noqa: E501 196 197 :return: The group_member_id of this ReferralInformation. # noqa: E501 198 :rtype: str 199 """ 200 return self._group_member_id 201 202 @group_member_id.setter 203 def group_member_id(self, group_member_id): 204 """Sets the group_member_id of this ReferralInformation. 205 206 # noqa: E501 207 208 :param group_member_id: The group_member_id of this ReferralInformation. # noqa: E501 209 :type: str 210 """ 211 212 self._group_member_id = group_member_id 213 214 @property 215 def id_type(self): 216 """Gets the id_type of this ReferralInformation. # noqa: E501 217 218 # noqa: E501 219 220 :return: The id_type of this ReferralInformation. # noqa: E501 221 :rtype: str 222 """ 223 return self._id_type 224 225 @id_type.setter 226 def id_type(self, id_type): 227 """Sets the id_type of this ReferralInformation. 228 229 # noqa: E501 230 231 :param id_type: The id_type of this ReferralInformation. # noqa: E501 232 :type: str 233 """ 234 235 self._id_type = id_type 236 237 @property 238 def included_seats(self): 239 """Gets the included_seats of this ReferralInformation. # noqa: E501 240 241 The number of seats (users) included. # noqa: E501 242 243 :return: The included_seats of this ReferralInformation. # noqa: E501 244 :rtype: str 245 """ 246 return self._included_seats 247 248 @included_seats.setter 249 def included_seats(self, included_seats): 250 """Sets the included_seats of this ReferralInformation. 251 252 The number of seats (users) included. # noqa: E501 253 254 :param included_seats: The included_seats of this ReferralInformation. # noqa: E501 255 :type: str 256 """ 257 258 self._included_seats = included_seats 259 260 @property 261 def industry(self): 262 """Gets the industry of this ReferralInformation. # noqa: E501 263 264 # noqa: E501 265 266 :return: The industry of this ReferralInformation. # noqa: E501 267 :rtype: str 268 """ 269 return self._industry 270 271 @industry.setter 272 def industry(self, industry): 273 """Sets the industry of this ReferralInformation. 274 275 # noqa: E501 276 277 :param industry: The industry of this ReferralInformation. # noqa: E501 278 :type: str 279 """ 280 281 self._industry = industry 282 283 @property 284 def plan_start_month(self): 285 """Gets the plan_start_month of this ReferralInformation. # noqa: E501 286 287 # noqa: E501 288 289 :return: The plan_start_month of this ReferralInformation. # noqa: E501 290 :rtype: str 291 """ 292 return self._plan_start_month 293 294 @plan_start_month.setter 295 def plan_start_month(self, plan_start_month): 296 """Sets the plan_start_month of this ReferralInformation. 297 298 # noqa: E501 299 300 :param plan_start_month: The plan_start_month of this ReferralInformation. # noqa: E501 301 :type: str 302 """ 303 304 self._plan_start_month = plan_start_month 305 306 @property 307 def promo_code(self): 308 """Gets the promo_code of this ReferralInformation. # noqa: E501 309 310 # noqa: E501 311 312 :return: The promo_code of this ReferralInformation. # noqa: E501 313 :rtype: str 314 """ 315 return self._promo_code 316 317 @promo_code.setter 318 def promo_code(self, promo_code): 319 """Sets the promo_code of this ReferralInformation. 320 321 # noqa: E501 322 323 :param promo_code: The promo_code of this ReferralInformation. # noqa: E501 324 :type: str 325 """ 326 327 self._promo_code = promo_code 328 329 @property 330 def publisher_id(self): 331 """Gets the publisher_id of this ReferralInformation. # noqa: E501 332 333 # noqa: E501 334 335 :return: The publisher_id of this ReferralInformation. # noqa: E501 336 :rtype: str 337 """ 338 return self._publisher_id 339 340 @publisher_id.setter 341 def publisher_id(self, publisher_id): 342 """Sets the publisher_id of this ReferralInformation. 343 344 # noqa: E501 345 346 :param publisher_id: The publisher_id of this ReferralInformation. # noqa: E501 347 :type: str 348 """ 349 350 self._publisher_id = publisher_id 351 352 @property 353 def referral_code(self): 354 """Gets the referral_code of this ReferralInformation. # noqa: E501 355 356 # noqa: E501 357 358 :return: The referral_code of this ReferralInformation. # noqa: E501 359 :rtype: str 360 """ 361 return self._referral_code 362 363 @referral_code.setter 364 def referral_code(self, referral_code): 365 """Sets the referral_code of this ReferralInformation. 366 367 # noqa: E501 368 369 :param referral_code: The referral_code of this ReferralInformation. # noqa: E501 370 :type: str 371 """ 372 373 self._referral_code = referral_code 374 375 @property 376 def referrer_name(self): 377 """Gets the referrer_name of this ReferralInformation. # noqa: E501 378 379 # noqa: E501 380 381 :return: The referrer_name of this ReferralInformation. # noqa: E501 382 :rtype: str 383 """ 384 return self._referrer_name 385 386 @referrer_name.setter 387 def referrer_name(self, referrer_name): 388 """Sets the referrer_name of this ReferralInformation. 389 390 # noqa: E501 391 392 :param referrer_name: The referrer_name of this ReferralInformation. # noqa: E501 393 :type: str 394 """ 395 396 self._referrer_name = referrer_name 397 398 @property 399 def sale_discount_amount(self): 400 """Gets the sale_discount_amount of this ReferralInformation. # noqa: E501 401 402 Reserved for DocuSign use only. # noqa: E501 403 404 :return: The sale_discount_amount of this ReferralInformation. # noqa: E501 405 :rtype: str 406 """ 407 return self._sale_discount_amount 408 409 @sale_discount_amount.setter 410 def sale_discount_amount(self, sale_discount_amount): 411 """Sets the sale_discount_amount of this ReferralInformation. 412 413 Reserved for DocuSign use only. # noqa: E501 414 415 :param sale_discount_amount: The sale_discount_amount of this ReferralInformation. # noqa: E501 416 :type: str 417 """ 418 419 self._sale_discount_amount = sale_discount_amount 420 421 @property 422 def sale_discount_fixed_amount(self): 423 """Gets the sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 424 425 Reserved for DocuSign use only. # noqa: E501 426 427 :return: The sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 428 :rtype: str 429 """ 430 return self._sale_discount_fixed_amount 431 432 @sale_discount_fixed_amount.setter 433 def sale_discount_fixed_amount(self, sale_discount_fixed_amount): 434 """Sets the sale_discount_fixed_amount of this ReferralInformation. 435 436 Reserved for DocuSign use only. # noqa: E501 437 438 :param sale_discount_fixed_amount: The sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 439 :type: str 440 """ 441 442 self._sale_discount_fixed_amount = sale_discount_fixed_amount 443 444 @property 445 def sale_discount_percent(self): 446 """Gets the sale_discount_percent of this ReferralInformation. # noqa: E501 447 448 Reserved for DocuSign use only. # noqa: E501 449 450 :return: The sale_discount_percent of this ReferralInformation. # noqa: E501 451 :rtype: str 452 """ 453 return self._sale_discount_percent 454 455 @sale_discount_percent.setter 456 def sale_discount_percent(self, sale_discount_percent): 457 """Sets the sale_discount_percent of this ReferralInformation. 458 459 Reserved for DocuSign use only. # noqa: E501 460 461 :param sale_discount_percent: The sale_discount_percent of this ReferralInformation. # noqa: E501 462 :type: str 463 """ 464 465 self._sale_discount_percent = sale_discount_percent 466 467 @property 468 def sale_discount_periods(self): 469 """Gets the sale_discount_periods of this ReferralInformation. # noqa: E501 470 471 Reserved for DocuSign use only. # noqa: E501 472 473 :return: The sale_discount_periods of this ReferralInformation. # noqa: E501 474 :rtype: str 475 """ 476 return self._sale_discount_periods 477 478 @sale_discount_periods.setter 479 def sale_discount_periods(self, sale_discount_periods): 480 """Sets the sale_discount_periods of this ReferralInformation. 481 482 Reserved for DocuSign use only. # noqa: E501 483 484 :param sale_discount_periods: The sale_discount_periods of this ReferralInformation. # noqa: E501 485 :type: str 486 """ 487 488 self._sale_discount_periods = sale_discount_periods 489 490 @property 491 def sale_discount_seat_price_override(self): 492 """Gets the sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 493 494 Reserved for DocuSign use only. # noqa: E501 495 496 :return: The sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 497 :rtype: str 498 """ 499 return self._sale_discount_seat_price_override 500 501 @sale_discount_seat_price_override.setter 502 def sale_discount_seat_price_override(self, sale_discount_seat_price_override): 503 """Sets the sale_discount_seat_price_override of this ReferralInformation. 504 505 Reserved for DocuSign use only. # noqa: E501 506 507 :param sale_discount_seat_price_override: The sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 508 :type: str 509 """ 510 511 self._sale_discount_seat_price_override = sale_discount_seat_price_override 512 513 @property 514 def shopper_id(self): 515 """Gets the shopper_id of this ReferralInformation. # noqa: E501 516 517 # noqa: E501 518 519 :return: The shopper_id of this ReferralInformation. # noqa: E501 520 :rtype: str 521 """ 522 return self._shopper_id 523 524 @shopper_id.setter 525 def shopper_id(self, shopper_id): 526 """Sets the shopper_id of this ReferralInformation. 527 528 # noqa: E501 529 530 :param shopper_id: The shopper_id of this ReferralInformation. # noqa: E501 531 :type: str 532 """ 533 534 self._shopper_id = shopper_id 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(ReferralInformation, 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, ReferralInformation): 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, ReferralInformation): 581 return True 582 583 return self.to_dict() != other.to_dict()
class
ReferralInformation:
23class ReferralInformation(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 'advertisement_id': 'str', 38 'enable_support': 'str', 39 'external_org_id': 'str', 40 'group_member_id': 'str', 41 'id_type': 'str', 42 'included_seats': 'str', 43 'industry': 'str', 44 'plan_start_month': 'str', 45 'promo_code': 'str', 46 'publisher_id': 'str', 47 'referral_code': 'str', 48 'referrer_name': 'str', 49 'sale_discount_amount': 'str', 50 'sale_discount_fixed_amount': 'str', 51 'sale_discount_percent': 'str', 52 'sale_discount_periods': 'str', 53 'sale_discount_seat_price_override': 'str', 54 'shopper_id': 'str' 55 } 56 57 attribute_map = { 58 'advertisement_id': 'advertisementId', 59 'enable_support': 'enableSupport', 60 'external_org_id': 'externalOrgId', 61 'group_member_id': 'groupMemberId', 62 'id_type': 'idType', 63 'included_seats': 'includedSeats', 64 'industry': 'industry', 65 'plan_start_month': 'planStartMonth', 66 'promo_code': 'promoCode', 67 'publisher_id': 'publisherId', 68 'referral_code': 'referralCode', 69 'referrer_name': 'referrerName', 70 'sale_discount_amount': 'saleDiscountAmount', 71 'sale_discount_fixed_amount': 'saleDiscountFixedAmount', 72 'sale_discount_percent': 'saleDiscountPercent', 73 'sale_discount_periods': 'saleDiscountPeriods', 74 'sale_discount_seat_price_override': 'saleDiscountSeatPriceOverride', 75 'shopper_id': 'shopperId' 76 } 77 78 def __init__(self, _configuration=None, **kwargs): # noqa: E501 79 """ReferralInformation - a model defined in Swagger""" # noqa: E501 80 if _configuration is None: 81 _configuration = Configuration() 82 self._configuration = _configuration 83 84 self._advertisement_id = None 85 self._enable_support = None 86 self._external_org_id = None 87 self._group_member_id = None 88 self._id_type = None 89 self._included_seats = None 90 self._industry = None 91 self._plan_start_month = None 92 self._promo_code = None 93 self._publisher_id = None 94 self._referral_code = None 95 self._referrer_name = None 96 self._sale_discount_amount = None 97 self._sale_discount_fixed_amount = None 98 self._sale_discount_percent = None 99 self._sale_discount_periods = None 100 self._sale_discount_seat_price_override = None 101 self._shopper_id = None 102 self.discriminator = None 103 104 setattr(self, "_{}".format('advertisement_id'), kwargs.get('advertisement_id', None)) 105 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 106 setattr(self, "_{}".format('external_org_id'), kwargs.get('external_org_id', None)) 107 setattr(self, "_{}".format('group_member_id'), kwargs.get('group_member_id', None)) 108 setattr(self, "_{}".format('id_type'), kwargs.get('id_type', None)) 109 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 110 setattr(self, "_{}".format('industry'), kwargs.get('industry', None)) 111 setattr(self, "_{}".format('plan_start_month'), kwargs.get('plan_start_month', None)) 112 setattr(self, "_{}".format('promo_code'), kwargs.get('promo_code', None)) 113 setattr(self, "_{}".format('publisher_id'), kwargs.get('publisher_id', None)) 114 setattr(self, "_{}".format('referral_code'), kwargs.get('referral_code', None)) 115 setattr(self, "_{}".format('referrer_name'), kwargs.get('referrer_name', None)) 116 setattr(self, "_{}".format('sale_discount_amount'), kwargs.get('sale_discount_amount', None)) 117 setattr(self, "_{}".format('sale_discount_fixed_amount'), kwargs.get('sale_discount_fixed_amount', None)) 118 setattr(self, "_{}".format('sale_discount_percent'), kwargs.get('sale_discount_percent', None)) 119 setattr(self, "_{}".format('sale_discount_periods'), kwargs.get('sale_discount_periods', None)) 120 setattr(self, "_{}".format('sale_discount_seat_price_override'), kwargs.get('sale_discount_seat_price_override', None)) 121 setattr(self, "_{}".format('shopper_id'), kwargs.get('shopper_id', None)) 122 123 @property 124 def advertisement_id(self): 125 """Gets the advertisement_id of this ReferralInformation. # noqa: E501 126 127 A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. # noqa: E501 128 129 :return: The advertisement_id of this ReferralInformation. # noqa: E501 130 :rtype: str 131 """ 132 return self._advertisement_id 133 134 @advertisement_id.setter 135 def advertisement_id(self, advertisement_id): 136 """Sets the advertisement_id of this ReferralInformation. 137 138 A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. # noqa: E501 139 140 :param advertisement_id: The advertisement_id of this ReferralInformation. # noqa: E501 141 :type: str 142 """ 143 144 self._advertisement_id = advertisement_id 145 146 @property 147 def enable_support(self): 148 """Gets the enable_support of this ReferralInformation. # noqa: E501 149 150 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 151 152 :return: The enable_support of this ReferralInformation. # noqa: E501 153 :rtype: str 154 """ 155 return self._enable_support 156 157 @enable_support.setter 158 def enable_support(self, enable_support): 159 """Sets the enable_support of this ReferralInformation. 160 161 When set to **true**, then customer support is provided as part of the account plan. # noqa: E501 162 163 :param enable_support: The enable_support of this ReferralInformation. # noqa: E501 164 :type: str 165 """ 166 167 self._enable_support = enable_support 168 169 @property 170 def external_org_id(self): 171 """Gets the external_org_id of this ReferralInformation. # noqa: E501 172 173 # noqa: E501 174 175 :return: The external_org_id of this ReferralInformation. # noqa: E501 176 :rtype: str 177 """ 178 return self._external_org_id 179 180 @external_org_id.setter 181 def external_org_id(self, external_org_id): 182 """Sets the external_org_id of this ReferralInformation. 183 184 # noqa: E501 185 186 :param external_org_id: The external_org_id of this ReferralInformation. # noqa: E501 187 :type: str 188 """ 189 190 self._external_org_id = external_org_id 191 192 @property 193 def group_member_id(self): 194 """Gets the group_member_id of this ReferralInformation. # noqa: E501 195 196 # noqa: E501 197 198 :return: The group_member_id of this ReferralInformation. # noqa: E501 199 :rtype: str 200 """ 201 return self._group_member_id 202 203 @group_member_id.setter 204 def group_member_id(self, group_member_id): 205 """Sets the group_member_id of this ReferralInformation. 206 207 # noqa: E501 208 209 :param group_member_id: The group_member_id of this ReferralInformation. # noqa: E501 210 :type: str 211 """ 212 213 self._group_member_id = group_member_id 214 215 @property 216 def id_type(self): 217 """Gets the id_type of this ReferralInformation. # noqa: E501 218 219 # noqa: E501 220 221 :return: The id_type of this ReferralInformation. # noqa: E501 222 :rtype: str 223 """ 224 return self._id_type 225 226 @id_type.setter 227 def id_type(self, id_type): 228 """Sets the id_type of this ReferralInformation. 229 230 # noqa: E501 231 232 :param id_type: The id_type of this ReferralInformation. # noqa: E501 233 :type: str 234 """ 235 236 self._id_type = id_type 237 238 @property 239 def included_seats(self): 240 """Gets the included_seats of this ReferralInformation. # noqa: E501 241 242 The number of seats (users) included. # noqa: E501 243 244 :return: The included_seats of this ReferralInformation. # noqa: E501 245 :rtype: str 246 """ 247 return self._included_seats 248 249 @included_seats.setter 250 def included_seats(self, included_seats): 251 """Sets the included_seats of this ReferralInformation. 252 253 The number of seats (users) included. # noqa: E501 254 255 :param included_seats: The included_seats of this ReferralInformation. # noqa: E501 256 :type: str 257 """ 258 259 self._included_seats = included_seats 260 261 @property 262 def industry(self): 263 """Gets the industry of this ReferralInformation. # noqa: E501 264 265 # noqa: E501 266 267 :return: The industry of this ReferralInformation. # noqa: E501 268 :rtype: str 269 """ 270 return self._industry 271 272 @industry.setter 273 def industry(self, industry): 274 """Sets the industry of this ReferralInformation. 275 276 # noqa: E501 277 278 :param industry: The industry of this ReferralInformation. # noqa: E501 279 :type: str 280 """ 281 282 self._industry = industry 283 284 @property 285 def plan_start_month(self): 286 """Gets the plan_start_month of this ReferralInformation. # noqa: E501 287 288 # noqa: E501 289 290 :return: The plan_start_month of this ReferralInformation. # noqa: E501 291 :rtype: str 292 """ 293 return self._plan_start_month 294 295 @plan_start_month.setter 296 def plan_start_month(self, plan_start_month): 297 """Sets the plan_start_month of this ReferralInformation. 298 299 # noqa: E501 300 301 :param plan_start_month: The plan_start_month of this ReferralInformation. # noqa: E501 302 :type: str 303 """ 304 305 self._plan_start_month = plan_start_month 306 307 @property 308 def promo_code(self): 309 """Gets the promo_code of this ReferralInformation. # noqa: E501 310 311 # noqa: E501 312 313 :return: The promo_code of this ReferralInformation. # noqa: E501 314 :rtype: str 315 """ 316 return self._promo_code 317 318 @promo_code.setter 319 def promo_code(self, promo_code): 320 """Sets the promo_code of this ReferralInformation. 321 322 # noqa: E501 323 324 :param promo_code: The promo_code of this ReferralInformation. # noqa: E501 325 :type: str 326 """ 327 328 self._promo_code = promo_code 329 330 @property 331 def publisher_id(self): 332 """Gets the publisher_id of this ReferralInformation. # noqa: E501 333 334 # noqa: E501 335 336 :return: The publisher_id of this ReferralInformation. # noqa: E501 337 :rtype: str 338 """ 339 return self._publisher_id 340 341 @publisher_id.setter 342 def publisher_id(self, publisher_id): 343 """Sets the publisher_id of this ReferralInformation. 344 345 # noqa: E501 346 347 :param publisher_id: The publisher_id of this ReferralInformation. # noqa: E501 348 :type: str 349 """ 350 351 self._publisher_id = publisher_id 352 353 @property 354 def referral_code(self): 355 """Gets the referral_code of this ReferralInformation. # noqa: E501 356 357 # noqa: E501 358 359 :return: The referral_code of this ReferralInformation. # noqa: E501 360 :rtype: str 361 """ 362 return self._referral_code 363 364 @referral_code.setter 365 def referral_code(self, referral_code): 366 """Sets the referral_code of this ReferralInformation. 367 368 # noqa: E501 369 370 :param referral_code: The referral_code of this ReferralInformation. # noqa: E501 371 :type: str 372 """ 373 374 self._referral_code = referral_code 375 376 @property 377 def referrer_name(self): 378 """Gets the referrer_name of this ReferralInformation. # noqa: E501 379 380 # noqa: E501 381 382 :return: The referrer_name of this ReferralInformation. # noqa: E501 383 :rtype: str 384 """ 385 return self._referrer_name 386 387 @referrer_name.setter 388 def referrer_name(self, referrer_name): 389 """Sets the referrer_name of this ReferralInformation. 390 391 # noqa: E501 392 393 :param referrer_name: The referrer_name of this ReferralInformation. # noqa: E501 394 :type: str 395 """ 396 397 self._referrer_name = referrer_name 398 399 @property 400 def sale_discount_amount(self): 401 """Gets the sale_discount_amount of this ReferralInformation. # noqa: E501 402 403 Reserved for DocuSign use only. # noqa: E501 404 405 :return: The sale_discount_amount of this ReferralInformation. # noqa: E501 406 :rtype: str 407 """ 408 return self._sale_discount_amount 409 410 @sale_discount_amount.setter 411 def sale_discount_amount(self, sale_discount_amount): 412 """Sets the sale_discount_amount of this ReferralInformation. 413 414 Reserved for DocuSign use only. # noqa: E501 415 416 :param sale_discount_amount: The sale_discount_amount of this ReferralInformation. # noqa: E501 417 :type: str 418 """ 419 420 self._sale_discount_amount = sale_discount_amount 421 422 @property 423 def sale_discount_fixed_amount(self): 424 """Gets the sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 425 426 Reserved for DocuSign use only. # noqa: E501 427 428 :return: The sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 429 :rtype: str 430 """ 431 return self._sale_discount_fixed_amount 432 433 @sale_discount_fixed_amount.setter 434 def sale_discount_fixed_amount(self, sale_discount_fixed_amount): 435 """Sets the sale_discount_fixed_amount of this ReferralInformation. 436 437 Reserved for DocuSign use only. # noqa: E501 438 439 :param sale_discount_fixed_amount: The sale_discount_fixed_amount of this ReferralInformation. # noqa: E501 440 :type: str 441 """ 442 443 self._sale_discount_fixed_amount = sale_discount_fixed_amount 444 445 @property 446 def sale_discount_percent(self): 447 """Gets the sale_discount_percent of this ReferralInformation. # noqa: E501 448 449 Reserved for DocuSign use only. # noqa: E501 450 451 :return: The sale_discount_percent of this ReferralInformation. # noqa: E501 452 :rtype: str 453 """ 454 return self._sale_discount_percent 455 456 @sale_discount_percent.setter 457 def sale_discount_percent(self, sale_discount_percent): 458 """Sets the sale_discount_percent of this ReferralInformation. 459 460 Reserved for DocuSign use only. # noqa: E501 461 462 :param sale_discount_percent: The sale_discount_percent of this ReferralInformation. # noqa: E501 463 :type: str 464 """ 465 466 self._sale_discount_percent = sale_discount_percent 467 468 @property 469 def sale_discount_periods(self): 470 """Gets the sale_discount_periods of this ReferralInformation. # noqa: E501 471 472 Reserved for DocuSign use only. # noqa: E501 473 474 :return: The sale_discount_periods of this ReferralInformation. # noqa: E501 475 :rtype: str 476 """ 477 return self._sale_discount_periods 478 479 @sale_discount_periods.setter 480 def sale_discount_periods(self, sale_discount_periods): 481 """Sets the sale_discount_periods of this ReferralInformation. 482 483 Reserved for DocuSign use only. # noqa: E501 484 485 :param sale_discount_periods: The sale_discount_periods of this ReferralInformation. # noqa: E501 486 :type: str 487 """ 488 489 self._sale_discount_periods = sale_discount_periods 490 491 @property 492 def sale_discount_seat_price_override(self): 493 """Gets the sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 494 495 Reserved for DocuSign use only. # noqa: E501 496 497 :return: The sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 498 :rtype: str 499 """ 500 return self._sale_discount_seat_price_override 501 502 @sale_discount_seat_price_override.setter 503 def sale_discount_seat_price_override(self, sale_discount_seat_price_override): 504 """Sets the sale_discount_seat_price_override of this ReferralInformation. 505 506 Reserved for DocuSign use only. # noqa: E501 507 508 :param sale_discount_seat_price_override: The sale_discount_seat_price_override of this ReferralInformation. # noqa: E501 509 :type: str 510 """ 511 512 self._sale_discount_seat_price_override = sale_discount_seat_price_override 513 514 @property 515 def shopper_id(self): 516 """Gets the shopper_id of this ReferralInformation. # noqa: E501 517 518 # noqa: E501 519 520 :return: The shopper_id of this ReferralInformation. # noqa: E501 521 :rtype: str 522 """ 523 return self._shopper_id 524 525 @shopper_id.setter 526 def shopper_id(self, shopper_id): 527 """Sets the shopper_id of this ReferralInformation. 528 529 # noqa: E501 530 531 :param shopper_id: The shopper_id of this ReferralInformation. # noqa: E501 532 :type: str 533 """ 534 535 self._shopper_id = shopper_id 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(ReferralInformation, 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, ReferralInformation): 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, ReferralInformation): 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.
ReferralInformation(_configuration=None, **kwargs)
78 def __init__(self, _configuration=None, **kwargs): # noqa: E501 79 """ReferralInformation - a model defined in Swagger""" # noqa: E501 80 if _configuration is None: 81 _configuration = Configuration() 82 self._configuration = _configuration 83 84 self._advertisement_id = None 85 self._enable_support = None 86 self._external_org_id = None 87 self._group_member_id = None 88 self._id_type = None 89 self._included_seats = None 90 self._industry = None 91 self._plan_start_month = None 92 self._promo_code = None 93 self._publisher_id = None 94 self._referral_code = None 95 self._referrer_name = None 96 self._sale_discount_amount = None 97 self._sale_discount_fixed_amount = None 98 self._sale_discount_percent = None 99 self._sale_discount_periods = None 100 self._sale_discount_seat_price_override = None 101 self._shopper_id = None 102 self.discriminator = None 103 104 setattr(self, "_{}".format('advertisement_id'), kwargs.get('advertisement_id', None)) 105 setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None)) 106 setattr(self, "_{}".format('external_org_id'), kwargs.get('external_org_id', None)) 107 setattr(self, "_{}".format('group_member_id'), kwargs.get('group_member_id', None)) 108 setattr(self, "_{}".format('id_type'), kwargs.get('id_type', None)) 109 setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None)) 110 setattr(self, "_{}".format('industry'), kwargs.get('industry', None)) 111 setattr(self, "_{}".format('plan_start_month'), kwargs.get('plan_start_month', None)) 112 setattr(self, "_{}".format('promo_code'), kwargs.get('promo_code', None)) 113 setattr(self, "_{}".format('publisher_id'), kwargs.get('publisher_id', None)) 114 setattr(self, "_{}".format('referral_code'), kwargs.get('referral_code', None)) 115 setattr(self, "_{}".format('referrer_name'), kwargs.get('referrer_name', None)) 116 setattr(self, "_{}".format('sale_discount_amount'), kwargs.get('sale_discount_amount', None)) 117 setattr(self, "_{}".format('sale_discount_fixed_amount'), kwargs.get('sale_discount_fixed_amount', None)) 118 setattr(self, "_{}".format('sale_discount_percent'), kwargs.get('sale_discount_percent', None)) 119 setattr(self, "_{}".format('sale_discount_periods'), kwargs.get('sale_discount_periods', None)) 120 setattr(self, "_{}".format('sale_discount_seat_price_override'), kwargs.get('sale_discount_seat_price_override', None)) 121 setattr(self, "_{}".format('shopper_id'), kwargs.get('shopper_id', None))
ReferralInformation - a model defined in Swagger
swagger_types = {'advertisement_id': 'str', 'enable_support': 'str', 'external_org_id': 'str', 'group_member_id': 'str', 'id_type': 'str', 'included_seats': 'str', 'industry': 'str', 'plan_start_month': 'str', 'promo_code': 'str', 'publisher_id': 'str', 'referral_code': 'str', 'referrer_name': 'str', 'sale_discount_amount': 'str', 'sale_discount_fixed_amount': 'str', 'sale_discount_percent': 'str', 'sale_discount_periods': 'str', 'sale_discount_seat_price_override': 'str', 'shopper_id': 'str'}
attribute_map = {'advertisement_id': 'advertisementId', 'enable_support': 'enableSupport', 'external_org_id': 'externalOrgId', 'group_member_id': 'groupMemberId', 'id_type': 'idType', 'included_seats': 'includedSeats', 'industry': 'industry', 'plan_start_month': 'planStartMonth', 'promo_code': 'promoCode', 'publisher_id': 'publisherId', 'referral_code': 'referralCode', 'referrer_name': 'referrerName', 'sale_discount_amount': 'saleDiscountAmount', 'sale_discount_fixed_amount': 'saleDiscountFixedAmount', 'sale_discount_percent': 'saleDiscountPercent', 'sale_discount_periods': 'saleDiscountPeriods', 'sale_discount_seat_price_override': 'saleDiscountSeatPriceOverride', 'shopper_id': 'shopperId'}
advertisement_id
Gets the advertisement_id of this ReferralInformation. # noqa: E501
A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry. ###### Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DoucSign use only. # noqa: E501
Returns
The advertisement_id of this ReferralInformation. # noqa: E501
enable_support
Gets the enable_support of this ReferralInformation. # noqa: E501
When set to true, then customer support is provided as part of the account plan. # noqa: E501
Returns
The enable_support of this ReferralInformation. # noqa: E501
external_org_id
Gets the external_org_id of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The external_org_id of this ReferralInformation. # noqa: E501
group_member_id
Gets the group_member_id of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The group_member_id of this ReferralInformation. # noqa: E501
id_type
Gets the id_type of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The id_type of this ReferralInformation. # noqa: E501
included_seats
Gets the included_seats of this ReferralInformation. # noqa: E501
The number of seats (users) included. # noqa: E501
Returns
The included_seats of this ReferralInformation. # noqa: E501
industry
Gets the industry of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The industry of this ReferralInformation. # noqa: E501
plan_start_month
Gets the plan_start_month of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The plan_start_month of this ReferralInformation. # noqa: E501
promo_code
Gets the promo_code of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The promo_code of this ReferralInformation. # noqa: E501
publisher_id
Gets the publisher_id of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The publisher_id of this ReferralInformation. # noqa: E501
referral_code
Gets the referral_code of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The referral_code of this ReferralInformation. # noqa: E501
referrer_name
Gets the referrer_name of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The referrer_name of this ReferralInformation. # noqa: E501
sale_discount_amount
Gets the sale_discount_amount of this ReferralInformation. # noqa: E501
Reserved for DocuSign use only. # noqa: E501
Returns
The sale_discount_amount of this ReferralInformation. # noqa: E501
sale_discount_fixed_amount
Gets the sale_discount_fixed_amount of this ReferralInformation. # noqa: E501
Reserved for DocuSign use only. # noqa: E501
Returns
The sale_discount_fixed_amount of this ReferralInformation. # noqa: E501
sale_discount_percent
Gets the sale_discount_percent of this ReferralInformation. # noqa: E501
Reserved for DocuSign use only. # noqa: E501
Returns
The sale_discount_percent of this ReferralInformation. # noqa: E501
sale_discount_periods
Gets the sale_discount_periods of this ReferralInformation. # noqa: E501
Reserved for DocuSign use only. # noqa: E501
Returns
The sale_discount_periods of this ReferralInformation. # noqa: E501
sale_discount_seat_price_override
Gets the sale_discount_seat_price_override of this ReferralInformation. # noqa: E501
Reserved for DocuSign use only. # noqa: E501
Returns
The sale_discount_seat_price_override of this ReferralInformation. # noqa: E501
shopper_id
Gets the shopper_id of this ReferralInformation. # noqa: E501
# noqa: E501
Returns
The shopper_id of this ReferralInformation. # 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(ReferralInformation, dict): 559 for key, value in self.items(): 560 result[key] = value 561 562 return result
Returns the model properties as a dict