docusign_esign.models.billing_charge
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 BillingCharge(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 'allowed_quantity': 'str', 37 'blocked': 'str', 38 'charge_name': 'str', 39 'charge_type': 'str', 40 'charge_unit_of_measure': 'str', 41 'discounts': 'list[BillingDiscount]', 42 'first_effective_date': 'str', 43 'included_quantity': 'str', 44 'incremental_quantity': 'str', 45 'last_effective_date': 'str', 46 'prices': 'list[BillingPrice]', 47 'unit_price': 'str', 48 'used_quantity': 'str' 49 } 50 51 attribute_map = { 52 'allowed_quantity': 'allowedQuantity', 53 'blocked': 'blocked', 54 'charge_name': 'chargeName', 55 'charge_type': 'chargeType', 56 'charge_unit_of_measure': 'chargeUnitOfMeasure', 57 'discounts': 'discounts', 58 'first_effective_date': 'firstEffectiveDate', 59 'included_quantity': 'includedQuantity', 60 'incremental_quantity': 'incrementalQuantity', 61 'last_effective_date': 'lastEffectiveDate', 62 'prices': 'prices', 63 'unit_price': 'unitPrice', 64 'used_quantity': 'usedQuantity' 65 } 66 67 def __init__(self, _configuration=None, **kwargs): # noqa: E501 68 """BillingCharge - a model defined in Swagger""" # noqa: E501 69 if _configuration is None: 70 _configuration = Configuration() 71 self._configuration = _configuration 72 73 self._allowed_quantity = None 74 self._blocked = None 75 self._charge_name = None 76 self._charge_type = None 77 self._charge_unit_of_measure = None 78 self._discounts = None 79 self._first_effective_date = None 80 self._included_quantity = None 81 self._incremental_quantity = None 82 self._last_effective_date = None 83 self._prices = None 84 self._unit_price = None 85 self._used_quantity = None 86 self.discriminator = None 87 88 setattr(self, "_{}".format('allowed_quantity'), kwargs.get('allowed_quantity', None)) 89 setattr(self, "_{}".format('blocked'), kwargs.get('blocked', None)) 90 setattr(self, "_{}".format('charge_name'), kwargs.get('charge_name', None)) 91 setattr(self, "_{}".format('charge_type'), kwargs.get('charge_type', None)) 92 setattr(self, "_{}".format('charge_unit_of_measure'), kwargs.get('charge_unit_of_measure', None)) 93 setattr(self, "_{}".format('discounts'), kwargs.get('discounts', None)) 94 setattr(self, "_{}".format('first_effective_date'), kwargs.get('first_effective_date', None)) 95 setattr(self, "_{}".format('included_quantity'), kwargs.get('included_quantity', None)) 96 setattr(self, "_{}".format('incremental_quantity'), kwargs.get('incremental_quantity', None)) 97 setattr(self, "_{}".format('last_effective_date'), kwargs.get('last_effective_date', None)) 98 setattr(self, "_{}".format('prices'), kwargs.get('prices', None)) 99 setattr(self, "_{}".format('unit_price'), kwargs.get('unit_price', None)) 100 setattr(self, "_{}".format('used_quantity'), kwargs.get('used_quantity', None)) 101 102 @property 103 def allowed_quantity(self): 104 """Gets the allowed_quantity of this BillingCharge. # noqa: E501 105 106 Reserved: TBD # noqa: E501 107 108 :return: The allowed_quantity of this BillingCharge. # noqa: E501 109 :rtype: str 110 """ 111 return self._allowed_quantity 112 113 @allowed_quantity.setter 114 def allowed_quantity(self, allowed_quantity): 115 """Sets the allowed_quantity of this BillingCharge. 116 117 Reserved: TBD # noqa: E501 118 119 :param allowed_quantity: The allowed_quantity of this BillingCharge. # noqa: E501 120 :type: str 121 """ 122 123 self._allowed_quantity = allowed_quantity 124 125 @property 126 def blocked(self): 127 """Gets the blocked of this BillingCharge. # noqa: E501 128 129 Reserved: TBD # noqa: E501 130 131 :return: The blocked of this BillingCharge. # noqa: E501 132 :rtype: str 133 """ 134 return self._blocked 135 136 @blocked.setter 137 def blocked(self, blocked): 138 """Sets the blocked of this BillingCharge. 139 140 Reserved: TBD # noqa: E501 141 142 :param blocked: The blocked of this BillingCharge. # noqa: E501 143 :type: str 144 """ 145 146 self._blocked = blocked 147 148 @property 149 def charge_name(self): 150 """Gets the charge_name of this BillingCharge. # noqa: E501 151 152 Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | # noqa: E501 153 154 :return: The charge_name of this BillingCharge. # noqa: E501 155 :rtype: str 156 """ 157 return self._charge_name 158 159 @charge_name.setter 160 def charge_name(self, charge_name): 161 """Sets the charge_name of this BillingCharge. 162 163 Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | # noqa: E501 164 165 :param charge_name: The charge_name of this BillingCharge. # noqa: E501 166 :type: str 167 """ 168 169 self._charge_name = charge_name 170 171 @property 172 def charge_type(self): 173 """Gets the charge_type of this BillingCharge. # noqa: E501 174 175 Reserved: TBD # noqa: E501 176 177 :return: The charge_type of this BillingCharge. # noqa: E501 178 :rtype: str 179 """ 180 return self._charge_type 181 182 @charge_type.setter 183 def charge_type(self, charge_type): 184 """Sets the charge_type of this BillingCharge. 185 186 Reserved: TBD # noqa: E501 187 188 :param charge_type: The charge_type of this BillingCharge. # noqa: E501 189 :type: str 190 """ 191 192 self._charge_type = charge_type 193 194 @property 195 def charge_unit_of_measure(self): 196 """Gets the charge_unit_of_measure of this BillingCharge. # noqa: E501 197 198 Reserved: TBD # noqa: E501 199 200 :return: The charge_unit_of_measure of this BillingCharge. # noqa: E501 201 :rtype: str 202 """ 203 return self._charge_unit_of_measure 204 205 @charge_unit_of_measure.setter 206 def charge_unit_of_measure(self, charge_unit_of_measure): 207 """Sets the charge_unit_of_measure of this BillingCharge. 208 209 Reserved: TBD # noqa: E501 210 211 :param charge_unit_of_measure: The charge_unit_of_measure of this BillingCharge. # noqa: E501 212 :type: str 213 """ 214 215 self._charge_unit_of_measure = charge_unit_of_measure 216 217 @property 218 def discounts(self): 219 """Gets the discounts of this BillingCharge. # noqa: E501 220 221 # noqa: E501 222 223 :return: The discounts of this BillingCharge. # noqa: E501 224 :rtype: list[BillingDiscount] 225 """ 226 return self._discounts 227 228 @discounts.setter 229 def discounts(self, discounts): 230 """Sets the discounts of this BillingCharge. 231 232 # noqa: E501 233 234 :param discounts: The discounts of this BillingCharge. # noqa: E501 235 :type: list[BillingDiscount] 236 """ 237 238 self._discounts = discounts 239 240 @property 241 def first_effective_date(self): 242 """Gets the first_effective_date of this BillingCharge. # noqa: E501 243 244 # noqa: E501 245 246 :return: The first_effective_date of this BillingCharge. # noqa: E501 247 :rtype: str 248 """ 249 return self._first_effective_date 250 251 @first_effective_date.setter 252 def first_effective_date(self, first_effective_date): 253 """Sets the first_effective_date of this BillingCharge. 254 255 # noqa: E501 256 257 :param first_effective_date: The first_effective_date of this BillingCharge. # noqa: E501 258 :type: str 259 """ 260 261 self._first_effective_date = first_effective_date 262 263 @property 264 def included_quantity(self): 265 """Gets the included_quantity of this BillingCharge. # noqa: E501 266 267 # noqa: E501 268 269 :return: The included_quantity of this BillingCharge. # noqa: E501 270 :rtype: str 271 """ 272 return self._included_quantity 273 274 @included_quantity.setter 275 def included_quantity(self, included_quantity): 276 """Sets the included_quantity of this BillingCharge. 277 278 # noqa: E501 279 280 :param included_quantity: The included_quantity of this BillingCharge. # noqa: E501 281 :type: str 282 """ 283 284 self._included_quantity = included_quantity 285 286 @property 287 def incremental_quantity(self): 288 """Gets the incremental_quantity of this BillingCharge. # noqa: E501 289 290 Reserved: TBD # noqa: E501 291 292 :return: The incremental_quantity of this BillingCharge. # noqa: E501 293 :rtype: str 294 """ 295 return self._incremental_quantity 296 297 @incremental_quantity.setter 298 def incremental_quantity(self, incremental_quantity): 299 """Sets the incremental_quantity of this BillingCharge. 300 301 Reserved: TBD # noqa: E501 302 303 :param incremental_quantity: The incremental_quantity of this BillingCharge. # noqa: E501 304 :type: str 305 """ 306 307 self._incremental_quantity = incremental_quantity 308 309 @property 310 def last_effective_date(self): 311 """Gets the last_effective_date of this BillingCharge. # noqa: E501 312 313 # noqa: E501 314 315 :return: The last_effective_date of this BillingCharge. # noqa: E501 316 :rtype: str 317 """ 318 return self._last_effective_date 319 320 @last_effective_date.setter 321 def last_effective_date(self, last_effective_date): 322 """Sets the last_effective_date of this BillingCharge. 323 324 # noqa: E501 325 326 :param last_effective_date: The last_effective_date of this BillingCharge. # noqa: E501 327 :type: str 328 """ 329 330 self._last_effective_date = last_effective_date 331 332 @property 333 def prices(self): 334 """Gets the prices of this BillingCharge. # noqa: E501 335 336 # noqa: E501 337 338 :return: The prices of this BillingCharge. # noqa: E501 339 :rtype: list[BillingPrice] 340 """ 341 return self._prices 342 343 @prices.setter 344 def prices(self, prices): 345 """Sets the prices of this BillingCharge. 346 347 # noqa: E501 348 349 :param prices: The prices of this BillingCharge. # noqa: E501 350 :type: list[BillingPrice] 351 """ 352 353 self._prices = prices 354 355 @property 356 def unit_price(self): 357 """Gets the unit_price of this BillingCharge. # noqa: E501 358 359 Reserved: TBD # noqa: E501 360 361 :return: The unit_price of this BillingCharge. # noqa: E501 362 :rtype: str 363 """ 364 return self._unit_price 365 366 @unit_price.setter 367 def unit_price(self, unit_price): 368 """Sets the unit_price of this BillingCharge. 369 370 Reserved: TBD # noqa: E501 371 372 :param unit_price: The unit_price of this BillingCharge. # noqa: E501 373 :type: str 374 """ 375 376 self._unit_price = unit_price 377 378 @property 379 def used_quantity(self): 380 """Gets the used_quantity of this BillingCharge. # noqa: E501 381 382 # noqa: E501 383 384 :return: The used_quantity of this BillingCharge. # noqa: E501 385 :rtype: str 386 """ 387 return self._used_quantity 388 389 @used_quantity.setter 390 def used_quantity(self, used_quantity): 391 """Sets the used_quantity of this BillingCharge. 392 393 # noqa: E501 394 395 :param used_quantity: The used_quantity of this BillingCharge. # noqa: E501 396 :type: str 397 """ 398 399 self._used_quantity = used_quantity 400 401 def to_dict(self): 402 """Returns the model properties as a dict""" 403 result = {} 404 405 for attr, _ in six.iteritems(self.swagger_types): 406 value = getattr(self, attr) 407 if isinstance(value, list): 408 result[attr] = list(map( 409 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 410 value 411 )) 412 elif hasattr(value, "to_dict"): 413 result[attr] = value.to_dict() 414 elif isinstance(value, dict): 415 result[attr] = dict(map( 416 lambda item: (item[0], item[1].to_dict()) 417 if hasattr(item[1], "to_dict") else item, 418 value.items() 419 )) 420 else: 421 result[attr] = value 422 if issubclass(BillingCharge, dict): 423 for key, value in self.items(): 424 result[key] = value 425 426 return result 427 428 def to_str(self): 429 """Returns the string representation of the model""" 430 return pprint.pformat(self.to_dict()) 431 432 def __repr__(self): 433 """For `print` and `pprint`""" 434 return self.to_str() 435 436 def __eq__(self, other): 437 """Returns true if both objects are equal""" 438 if not isinstance(other, BillingCharge): 439 return False 440 441 return self.to_dict() == other.to_dict() 442 443 def __ne__(self, other): 444 """Returns true if both objects are not equal""" 445 if not isinstance(other, BillingCharge): 446 return True 447 448 return self.to_dict() != other.to_dict()
class
BillingCharge:
23class BillingCharge(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 'allowed_quantity': 'str', 38 'blocked': 'str', 39 'charge_name': 'str', 40 'charge_type': 'str', 41 'charge_unit_of_measure': 'str', 42 'discounts': 'list[BillingDiscount]', 43 'first_effective_date': 'str', 44 'included_quantity': 'str', 45 'incremental_quantity': 'str', 46 'last_effective_date': 'str', 47 'prices': 'list[BillingPrice]', 48 'unit_price': 'str', 49 'used_quantity': 'str' 50 } 51 52 attribute_map = { 53 'allowed_quantity': 'allowedQuantity', 54 'blocked': 'blocked', 55 'charge_name': 'chargeName', 56 'charge_type': 'chargeType', 57 'charge_unit_of_measure': 'chargeUnitOfMeasure', 58 'discounts': 'discounts', 59 'first_effective_date': 'firstEffectiveDate', 60 'included_quantity': 'includedQuantity', 61 'incremental_quantity': 'incrementalQuantity', 62 'last_effective_date': 'lastEffectiveDate', 63 'prices': 'prices', 64 'unit_price': 'unitPrice', 65 'used_quantity': 'usedQuantity' 66 } 67 68 def __init__(self, _configuration=None, **kwargs): # noqa: E501 69 """BillingCharge - a model defined in Swagger""" # noqa: E501 70 if _configuration is None: 71 _configuration = Configuration() 72 self._configuration = _configuration 73 74 self._allowed_quantity = None 75 self._blocked = None 76 self._charge_name = None 77 self._charge_type = None 78 self._charge_unit_of_measure = None 79 self._discounts = None 80 self._first_effective_date = None 81 self._included_quantity = None 82 self._incremental_quantity = None 83 self._last_effective_date = None 84 self._prices = None 85 self._unit_price = None 86 self._used_quantity = None 87 self.discriminator = None 88 89 setattr(self, "_{}".format('allowed_quantity'), kwargs.get('allowed_quantity', None)) 90 setattr(self, "_{}".format('blocked'), kwargs.get('blocked', None)) 91 setattr(self, "_{}".format('charge_name'), kwargs.get('charge_name', None)) 92 setattr(self, "_{}".format('charge_type'), kwargs.get('charge_type', None)) 93 setattr(self, "_{}".format('charge_unit_of_measure'), kwargs.get('charge_unit_of_measure', None)) 94 setattr(self, "_{}".format('discounts'), kwargs.get('discounts', None)) 95 setattr(self, "_{}".format('first_effective_date'), kwargs.get('first_effective_date', None)) 96 setattr(self, "_{}".format('included_quantity'), kwargs.get('included_quantity', None)) 97 setattr(self, "_{}".format('incremental_quantity'), kwargs.get('incremental_quantity', None)) 98 setattr(self, "_{}".format('last_effective_date'), kwargs.get('last_effective_date', None)) 99 setattr(self, "_{}".format('prices'), kwargs.get('prices', None)) 100 setattr(self, "_{}".format('unit_price'), kwargs.get('unit_price', None)) 101 setattr(self, "_{}".format('used_quantity'), kwargs.get('used_quantity', None)) 102 103 @property 104 def allowed_quantity(self): 105 """Gets the allowed_quantity of this BillingCharge. # noqa: E501 106 107 Reserved: TBD # noqa: E501 108 109 :return: The allowed_quantity of this BillingCharge. # noqa: E501 110 :rtype: str 111 """ 112 return self._allowed_quantity 113 114 @allowed_quantity.setter 115 def allowed_quantity(self, allowed_quantity): 116 """Sets the allowed_quantity of this BillingCharge. 117 118 Reserved: TBD # noqa: E501 119 120 :param allowed_quantity: The allowed_quantity of this BillingCharge. # noqa: E501 121 :type: str 122 """ 123 124 self._allowed_quantity = allowed_quantity 125 126 @property 127 def blocked(self): 128 """Gets the blocked of this BillingCharge. # noqa: E501 129 130 Reserved: TBD # noqa: E501 131 132 :return: The blocked of this BillingCharge. # noqa: E501 133 :rtype: str 134 """ 135 return self._blocked 136 137 @blocked.setter 138 def blocked(self, blocked): 139 """Sets the blocked of this BillingCharge. 140 141 Reserved: TBD # noqa: E501 142 143 :param blocked: The blocked of this BillingCharge. # noqa: E501 144 :type: str 145 """ 146 147 self._blocked = blocked 148 149 @property 150 def charge_name(self): 151 """Gets the charge_name of this BillingCharge. # noqa: E501 152 153 Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | # noqa: E501 154 155 :return: The charge_name of this BillingCharge. # noqa: E501 156 :rtype: str 157 """ 158 return self._charge_name 159 160 @charge_name.setter 161 def charge_name(self, charge_name): 162 """Sets the charge_name of this BillingCharge. 163 164 Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | # noqa: E501 165 166 :param charge_name: The charge_name of this BillingCharge. # noqa: E501 167 :type: str 168 """ 169 170 self._charge_name = charge_name 171 172 @property 173 def charge_type(self): 174 """Gets the charge_type of this BillingCharge. # noqa: E501 175 176 Reserved: TBD # noqa: E501 177 178 :return: The charge_type of this BillingCharge. # noqa: E501 179 :rtype: str 180 """ 181 return self._charge_type 182 183 @charge_type.setter 184 def charge_type(self, charge_type): 185 """Sets the charge_type of this BillingCharge. 186 187 Reserved: TBD # noqa: E501 188 189 :param charge_type: The charge_type of this BillingCharge. # noqa: E501 190 :type: str 191 """ 192 193 self._charge_type = charge_type 194 195 @property 196 def charge_unit_of_measure(self): 197 """Gets the charge_unit_of_measure of this BillingCharge. # noqa: E501 198 199 Reserved: TBD # noqa: E501 200 201 :return: The charge_unit_of_measure of this BillingCharge. # noqa: E501 202 :rtype: str 203 """ 204 return self._charge_unit_of_measure 205 206 @charge_unit_of_measure.setter 207 def charge_unit_of_measure(self, charge_unit_of_measure): 208 """Sets the charge_unit_of_measure of this BillingCharge. 209 210 Reserved: TBD # noqa: E501 211 212 :param charge_unit_of_measure: The charge_unit_of_measure of this BillingCharge. # noqa: E501 213 :type: str 214 """ 215 216 self._charge_unit_of_measure = charge_unit_of_measure 217 218 @property 219 def discounts(self): 220 """Gets the discounts of this BillingCharge. # noqa: E501 221 222 # noqa: E501 223 224 :return: The discounts of this BillingCharge. # noqa: E501 225 :rtype: list[BillingDiscount] 226 """ 227 return self._discounts 228 229 @discounts.setter 230 def discounts(self, discounts): 231 """Sets the discounts of this BillingCharge. 232 233 # noqa: E501 234 235 :param discounts: The discounts of this BillingCharge. # noqa: E501 236 :type: list[BillingDiscount] 237 """ 238 239 self._discounts = discounts 240 241 @property 242 def first_effective_date(self): 243 """Gets the first_effective_date of this BillingCharge. # noqa: E501 244 245 # noqa: E501 246 247 :return: The first_effective_date of this BillingCharge. # noqa: E501 248 :rtype: str 249 """ 250 return self._first_effective_date 251 252 @first_effective_date.setter 253 def first_effective_date(self, first_effective_date): 254 """Sets the first_effective_date of this BillingCharge. 255 256 # noqa: E501 257 258 :param first_effective_date: The first_effective_date of this BillingCharge. # noqa: E501 259 :type: str 260 """ 261 262 self._first_effective_date = first_effective_date 263 264 @property 265 def included_quantity(self): 266 """Gets the included_quantity of this BillingCharge. # noqa: E501 267 268 # noqa: E501 269 270 :return: The included_quantity of this BillingCharge. # noqa: E501 271 :rtype: str 272 """ 273 return self._included_quantity 274 275 @included_quantity.setter 276 def included_quantity(self, included_quantity): 277 """Sets the included_quantity of this BillingCharge. 278 279 # noqa: E501 280 281 :param included_quantity: The included_quantity of this BillingCharge. # noqa: E501 282 :type: str 283 """ 284 285 self._included_quantity = included_quantity 286 287 @property 288 def incremental_quantity(self): 289 """Gets the incremental_quantity of this BillingCharge. # noqa: E501 290 291 Reserved: TBD # noqa: E501 292 293 :return: The incremental_quantity of this BillingCharge. # noqa: E501 294 :rtype: str 295 """ 296 return self._incremental_quantity 297 298 @incremental_quantity.setter 299 def incremental_quantity(self, incremental_quantity): 300 """Sets the incremental_quantity of this BillingCharge. 301 302 Reserved: TBD # noqa: E501 303 304 :param incremental_quantity: The incremental_quantity of this BillingCharge. # noqa: E501 305 :type: str 306 """ 307 308 self._incremental_quantity = incremental_quantity 309 310 @property 311 def last_effective_date(self): 312 """Gets the last_effective_date of this BillingCharge. # noqa: E501 313 314 # noqa: E501 315 316 :return: The last_effective_date of this BillingCharge. # noqa: E501 317 :rtype: str 318 """ 319 return self._last_effective_date 320 321 @last_effective_date.setter 322 def last_effective_date(self, last_effective_date): 323 """Sets the last_effective_date of this BillingCharge. 324 325 # noqa: E501 326 327 :param last_effective_date: The last_effective_date of this BillingCharge. # noqa: E501 328 :type: str 329 """ 330 331 self._last_effective_date = last_effective_date 332 333 @property 334 def prices(self): 335 """Gets the prices of this BillingCharge. # noqa: E501 336 337 # noqa: E501 338 339 :return: The prices of this BillingCharge. # noqa: E501 340 :rtype: list[BillingPrice] 341 """ 342 return self._prices 343 344 @prices.setter 345 def prices(self, prices): 346 """Sets the prices of this BillingCharge. 347 348 # noqa: E501 349 350 :param prices: The prices of this BillingCharge. # noqa: E501 351 :type: list[BillingPrice] 352 """ 353 354 self._prices = prices 355 356 @property 357 def unit_price(self): 358 """Gets the unit_price of this BillingCharge. # noqa: E501 359 360 Reserved: TBD # noqa: E501 361 362 :return: The unit_price of this BillingCharge. # noqa: E501 363 :rtype: str 364 """ 365 return self._unit_price 366 367 @unit_price.setter 368 def unit_price(self, unit_price): 369 """Sets the unit_price of this BillingCharge. 370 371 Reserved: TBD # noqa: E501 372 373 :param unit_price: The unit_price of this BillingCharge. # noqa: E501 374 :type: str 375 """ 376 377 self._unit_price = unit_price 378 379 @property 380 def used_quantity(self): 381 """Gets the used_quantity of this BillingCharge. # noqa: E501 382 383 # noqa: E501 384 385 :return: The used_quantity of this BillingCharge. # noqa: E501 386 :rtype: str 387 """ 388 return self._used_quantity 389 390 @used_quantity.setter 391 def used_quantity(self, used_quantity): 392 """Sets the used_quantity of this BillingCharge. 393 394 # noqa: E501 395 396 :param used_quantity: The used_quantity of this BillingCharge. # noqa: E501 397 :type: str 398 """ 399 400 self._used_quantity = used_quantity 401 402 def to_dict(self): 403 """Returns the model properties as a dict""" 404 result = {} 405 406 for attr, _ in six.iteritems(self.swagger_types): 407 value = getattr(self, attr) 408 if isinstance(value, list): 409 result[attr] = list(map( 410 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 411 value 412 )) 413 elif hasattr(value, "to_dict"): 414 result[attr] = value.to_dict() 415 elif isinstance(value, dict): 416 result[attr] = dict(map( 417 lambda item: (item[0], item[1].to_dict()) 418 if hasattr(item[1], "to_dict") else item, 419 value.items() 420 )) 421 else: 422 result[attr] = value 423 if issubclass(BillingCharge, dict): 424 for key, value in self.items(): 425 result[key] = value 426 427 return result 428 429 def to_str(self): 430 """Returns the string representation of the model""" 431 return pprint.pformat(self.to_dict()) 432 433 def __repr__(self): 434 """For `print` and `pprint`""" 435 return self.to_str() 436 437 def __eq__(self, other): 438 """Returns true if both objects are equal""" 439 if not isinstance(other, BillingCharge): 440 return False 441 442 return self.to_dict() == other.to_dict() 443 444 def __ne__(self, other): 445 """Returns true if both objects are not equal""" 446 if not isinstance(other, BillingCharge): 447 return True 448 449 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.
BillingCharge(_configuration=None, **kwargs)
68 def __init__(self, _configuration=None, **kwargs): # noqa: E501 69 """BillingCharge - a model defined in Swagger""" # noqa: E501 70 if _configuration is None: 71 _configuration = Configuration() 72 self._configuration = _configuration 73 74 self._allowed_quantity = None 75 self._blocked = None 76 self._charge_name = None 77 self._charge_type = None 78 self._charge_unit_of_measure = None 79 self._discounts = None 80 self._first_effective_date = None 81 self._included_quantity = None 82 self._incremental_quantity = None 83 self._last_effective_date = None 84 self._prices = None 85 self._unit_price = None 86 self._used_quantity = None 87 self.discriminator = None 88 89 setattr(self, "_{}".format('allowed_quantity'), kwargs.get('allowed_quantity', None)) 90 setattr(self, "_{}".format('blocked'), kwargs.get('blocked', None)) 91 setattr(self, "_{}".format('charge_name'), kwargs.get('charge_name', None)) 92 setattr(self, "_{}".format('charge_type'), kwargs.get('charge_type', None)) 93 setattr(self, "_{}".format('charge_unit_of_measure'), kwargs.get('charge_unit_of_measure', None)) 94 setattr(self, "_{}".format('discounts'), kwargs.get('discounts', None)) 95 setattr(self, "_{}".format('first_effective_date'), kwargs.get('first_effective_date', None)) 96 setattr(self, "_{}".format('included_quantity'), kwargs.get('included_quantity', None)) 97 setattr(self, "_{}".format('incremental_quantity'), kwargs.get('incremental_quantity', None)) 98 setattr(self, "_{}".format('last_effective_date'), kwargs.get('last_effective_date', None)) 99 setattr(self, "_{}".format('prices'), kwargs.get('prices', None)) 100 setattr(self, "_{}".format('unit_price'), kwargs.get('unit_price', None)) 101 setattr(self, "_{}".format('used_quantity'), kwargs.get('used_quantity', None))
BillingCharge - a model defined in Swagger
swagger_types = {'allowed_quantity': 'str', 'blocked': 'str', 'charge_name': 'str', 'charge_type': 'str', 'charge_unit_of_measure': 'str', 'discounts': 'list[BillingDiscount]', 'first_effective_date': 'str', 'included_quantity': 'str', 'incremental_quantity': 'str', 'last_effective_date': 'str', 'prices': 'list[BillingPrice]', 'unit_price': 'str', 'used_quantity': 'str'}
attribute_map = {'allowed_quantity': 'allowedQuantity', 'blocked': 'blocked', 'charge_name': 'chargeName', 'charge_type': 'chargeType', 'charge_unit_of_measure': 'chargeUnitOfMeasure', 'discounts': 'discounts', 'first_effective_date': 'firstEffectiveDate', 'included_quantity': 'includedQuantity', 'incremental_quantity': 'incrementalQuantity', 'last_effective_date': 'lastEffectiveDate', 'prices': 'prices', 'unit_price': 'unitPrice', 'used_quantity': 'usedQuantity'}
allowed_quantity
Gets the allowed_quantity of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The allowed_quantity of this BillingCharge. # noqa: E501
blocked
Gets the blocked of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The blocked of this BillingCharge. # noqa: E501
charge_name
Gets the charge_name of this BillingCharge. # noqa: E501
Provides information on what services the charge item is for. The following table provides a description of the different chargeName values available at this time. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge | # noqa: E501
Returns
The charge_name of this BillingCharge. # noqa: E501
charge_type
Gets the charge_type of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The charge_type of this BillingCharge. # noqa: E501
charge_unit_of_measure
Gets the charge_unit_of_measure of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The charge_unit_of_measure of this BillingCharge. # noqa: E501
discounts
Gets the discounts of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The discounts of this BillingCharge. # noqa: E501
first_effective_date
Gets the first_effective_date of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The first_effective_date of this BillingCharge. # noqa: E501
included_quantity
Gets the included_quantity of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The included_quantity of this BillingCharge. # noqa: E501
incremental_quantity
Gets the incremental_quantity of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The incremental_quantity of this BillingCharge. # noqa: E501
last_effective_date
Gets the last_effective_date of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The last_effective_date of this BillingCharge. # noqa: E501
prices
Gets the prices of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The prices of this BillingCharge. # noqa: E501
unit_price
Gets the unit_price of this BillingCharge. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The unit_price of this BillingCharge. # noqa: E501
used_quantity
Gets the used_quantity of this BillingCharge. # noqa: E501
# noqa: E501
Returns
The used_quantity of this BillingCharge. # noqa: E501
def
to_dict(self)
402 def to_dict(self): 403 """Returns the model properties as a dict""" 404 result = {} 405 406 for attr, _ in six.iteritems(self.swagger_types): 407 value = getattr(self, attr) 408 if isinstance(value, list): 409 result[attr] = list(map( 410 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 411 value 412 )) 413 elif hasattr(value, "to_dict"): 414 result[attr] = value.to_dict() 415 elif isinstance(value, dict): 416 result[attr] = dict(map( 417 lambda item: (item[0], item[1].to_dict()) 418 if hasattr(item[1], "to_dict") else item, 419 value.items() 420 )) 421 else: 422 result[attr] = value 423 if issubclass(BillingCharge, dict): 424 for key, value in self.items(): 425 result[key] = value 426 427 return result
Returns the model properties as a dict