docusign_esign.models.billing_charge

  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 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()