docusign_esign.models.billing_plan_information

  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 BillingPlanInformation(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        'app_store_receipt': 'AppStoreReceipt',
 37        'billing_address': 'AccountAddress',
 38        'credit_card_information': 'CreditCardInformation',
 39        'direct_debit_processor_information': 'DirectDebitProcessorInformation',
 40        'downgrade_reason': 'str',
 41        'enable_pre_auth': 'str',
 42        'enable_support': 'str',
 43        'included_seats': 'str',
 44        'incremental_seats': 'str',
 45        'payment_method': 'str',
 46        'payment_processor': 'str',
 47        'payment_processor_information': 'PaymentProcessorInformation',
 48        'plan_information': 'PlanInformation',
 49        'process_payment': 'str',
 50        'referral_information': 'ReferralInformation',
 51        'renewal_status': 'str',
 52        'sale_discount_amount': 'str',
 53        'sale_discount_fixed_amount': 'str',
 54        'sale_discount_percent': 'str',
 55        'sale_discount_periods': 'str',
 56        'sale_discount_seat_price_override': 'str',
 57        'tax_exempt_id': 'str'
 58    }
 59
 60    attribute_map = {
 61        'app_store_receipt': 'appStoreReceipt',
 62        'billing_address': 'billingAddress',
 63        'credit_card_information': 'creditCardInformation',
 64        'direct_debit_processor_information': 'directDebitProcessorInformation',
 65        'downgrade_reason': 'downgradeReason',
 66        'enable_pre_auth': 'enablePreAuth',
 67        'enable_support': 'enableSupport',
 68        'included_seats': 'includedSeats',
 69        'incremental_seats': 'incrementalSeats',
 70        'payment_method': 'paymentMethod',
 71        'payment_processor': 'paymentProcessor',
 72        'payment_processor_information': 'paymentProcessorInformation',
 73        'plan_information': 'planInformation',
 74        'process_payment': 'processPayment',
 75        'referral_information': 'referralInformation',
 76        'renewal_status': 'renewalStatus',
 77        'sale_discount_amount': 'saleDiscountAmount',
 78        'sale_discount_fixed_amount': 'saleDiscountFixedAmount',
 79        'sale_discount_percent': 'saleDiscountPercent',
 80        'sale_discount_periods': 'saleDiscountPeriods',
 81        'sale_discount_seat_price_override': 'saleDiscountSeatPriceOverride',
 82        'tax_exempt_id': 'taxExemptId'
 83    }
 84
 85    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 86        """BillingPlanInformation - a model defined in Swagger"""  # noqa: E501
 87        if _configuration is None:
 88            _configuration = Configuration()
 89        self._configuration = _configuration
 90
 91        self._app_store_receipt = None
 92        self._billing_address = None
 93        self._credit_card_information = None
 94        self._direct_debit_processor_information = None
 95        self._downgrade_reason = None
 96        self._enable_pre_auth = None
 97        self._enable_support = None
 98        self._included_seats = None
 99        self._incremental_seats = None
100        self._payment_method = None
101        self._payment_processor = None
102        self._payment_processor_information = None
103        self._plan_information = None
104        self._process_payment = None
105        self._referral_information = None
106        self._renewal_status = None
107        self._sale_discount_amount = None
108        self._sale_discount_fixed_amount = None
109        self._sale_discount_percent = None
110        self._sale_discount_periods = None
111        self._sale_discount_seat_price_override = None
112        self._tax_exempt_id = None
113        self.discriminator = None
114
115        setattr(self, "_{}".format('app_store_receipt'), kwargs.get('app_store_receipt', None))
116        setattr(self, "_{}".format('billing_address'), kwargs.get('billing_address', None))
117        setattr(self, "_{}".format('credit_card_information'), kwargs.get('credit_card_information', None))
118        setattr(self, "_{}".format('direct_debit_processor_information'), kwargs.get('direct_debit_processor_information', None))
119        setattr(self, "_{}".format('downgrade_reason'), kwargs.get('downgrade_reason', None))
120        setattr(self, "_{}".format('enable_pre_auth'), kwargs.get('enable_pre_auth', None))
121        setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None))
122        setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None))
123        setattr(self, "_{}".format('incremental_seats'), kwargs.get('incremental_seats', None))
124        setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None))
125        setattr(self, "_{}".format('payment_processor'), kwargs.get('payment_processor', None))
126        setattr(self, "_{}".format('payment_processor_information'), kwargs.get('payment_processor_information', None))
127        setattr(self, "_{}".format('plan_information'), kwargs.get('plan_information', None))
128        setattr(self, "_{}".format('process_payment'), kwargs.get('process_payment', None))
129        setattr(self, "_{}".format('referral_information'), kwargs.get('referral_information', None))
130        setattr(self, "_{}".format('renewal_status'), kwargs.get('renewal_status', None))
131        setattr(self, "_{}".format('sale_discount_amount'), kwargs.get('sale_discount_amount', None))
132        setattr(self, "_{}".format('sale_discount_fixed_amount'), kwargs.get('sale_discount_fixed_amount', None))
133        setattr(self, "_{}".format('sale_discount_percent'), kwargs.get('sale_discount_percent', None))
134        setattr(self, "_{}".format('sale_discount_periods'), kwargs.get('sale_discount_periods', None))
135        setattr(self, "_{}".format('sale_discount_seat_price_override'), kwargs.get('sale_discount_seat_price_override', None))
136        setattr(self, "_{}".format('tax_exempt_id'), kwargs.get('tax_exempt_id', None))
137
138    @property
139    def app_store_receipt(self):
140        """Gets the app_store_receipt of this BillingPlanInformation.  # noqa: E501
141
142          # noqa: E501
143
144        :return: The app_store_receipt of this BillingPlanInformation.  # noqa: E501
145        :rtype: AppStoreReceipt
146        """
147        return self._app_store_receipt
148
149    @app_store_receipt.setter
150    def app_store_receipt(self, app_store_receipt):
151        """Sets the app_store_receipt of this BillingPlanInformation.
152
153          # noqa: E501
154
155        :param app_store_receipt: The app_store_receipt of this BillingPlanInformation.  # noqa: E501
156        :type: AppStoreReceipt
157        """
158
159        self._app_store_receipt = app_store_receipt
160
161    @property
162    def billing_address(self):
163        """Gets the billing_address of this BillingPlanInformation.  # noqa: E501
164
165        The billing address for the account.  # noqa: E501
166
167        :return: The billing_address of this BillingPlanInformation.  # noqa: E501
168        :rtype: AccountAddress
169        """
170        return self._billing_address
171
172    @billing_address.setter
173    def billing_address(self, billing_address):
174        """Sets the billing_address of this BillingPlanInformation.
175
176        The billing address for the account.  # noqa: E501
177
178        :param billing_address: The billing_address of this BillingPlanInformation.  # noqa: E501
179        :type: AccountAddress
180        """
181
182        self._billing_address = billing_address
183
184    @property
185    def credit_card_information(self):
186        """Gets the credit_card_information of this BillingPlanInformation.  # noqa: E501
187
188        A complex type that has information about the credit card used to pay for this account.  # noqa: E501
189
190        :return: The credit_card_information of this BillingPlanInformation.  # noqa: E501
191        :rtype: CreditCardInformation
192        """
193        return self._credit_card_information
194
195    @credit_card_information.setter
196    def credit_card_information(self, credit_card_information):
197        """Sets the credit_card_information of this BillingPlanInformation.
198
199        A complex type that has information about the credit card used to pay for this account.  # noqa: E501
200
201        :param credit_card_information: The credit_card_information of this BillingPlanInformation.  # noqa: E501
202        :type: CreditCardInformation
203        """
204
205        self._credit_card_information = credit_card_information
206
207    @property
208    def direct_debit_processor_information(self):
209        """Gets the direct_debit_processor_information of this BillingPlanInformation.  # noqa: E501
210
211        Information about the bank that processes direct debits for the payment plan.  # noqa: E501
212
213        :return: The direct_debit_processor_information of this BillingPlanInformation.  # noqa: E501
214        :rtype: DirectDebitProcessorInformation
215        """
216        return self._direct_debit_processor_information
217
218    @direct_debit_processor_information.setter
219    def direct_debit_processor_information(self, direct_debit_processor_information):
220        """Sets the direct_debit_processor_information of this BillingPlanInformation.
221
222        Information about the bank that processes direct debits for the payment plan.  # noqa: E501
223
224        :param direct_debit_processor_information: The direct_debit_processor_information of this BillingPlanInformation.  # noqa: E501
225        :type: DirectDebitProcessorInformation
226        """
227
228        self._direct_debit_processor_information = direct_debit_processor_information
229
230    @property
231    def downgrade_reason(self):
232        """Gets the downgrade_reason of this BillingPlanInformation.  # noqa: E501
233
234          # noqa: E501
235
236        :return: The downgrade_reason of this BillingPlanInformation.  # noqa: E501
237        :rtype: str
238        """
239        return self._downgrade_reason
240
241    @downgrade_reason.setter
242    def downgrade_reason(self, downgrade_reason):
243        """Sets the downgrade_reason of this BillingPlanInformation.
244
245          # noqa: E501
246
247        :param downgrade_reason: The downgrade_reason of this BillingPlanInformation.  # noqa: E501
248        :type: str
249        """
250
251        self._downgrade_reason = downgrade_reason
252
253    @property
254    def enable_pre_auth(self):
255        """Gets the enable_pre_auth of this BillingPlanInformation.  # noqa: E501
256
257          # noqa: E501
258
259        :return: The enable_pre_auth of this BillingPlanInformation.  # noqa: E501
260        :rtype: str
261        """
262        return self._enable_pre_auth
263
264    @enable_pre_auth.setter
265    def enable_pre_auth(self, enable_pre_auth):
266        """Sets the enable_pre_auth of this BillingPlanInformation.
267
268          # noqa: E501
269
270        :param enable_pre_auth: The enable_pre_auth of this BillingPlanInformation.  # noqa: E501
271        :type: str
272        """
273
274        self._enable_pre_auth = enable_pre_auth
275
276    @property
277    def enable_support(self):
278        """Gets the enable_support of this BillingPlanInformation.  # noqa: E501
279
280          # noqa: E501
281
282        :return: The enable_support of this BillingPlanInformation.  # noqa: E501
283        :rtype: str
284        """
285        return self._enable_support
286
287    @enable_support.setter
288    def enable_support(self, enable_support):
289        """Sets the enable_support of this BillingPlanInformation.
290
291          # noqa: E501
292
293        :param enable_support: The enable_support of this BillingPlanInformation.  # noqa: E501
294        :type: str
295        """
296
297        self._enable_support = enable_support
298
299    @property
300    def included_seats(self):
301        """Gets the included_seats of this BillingPlanInformation.  # noqa: E501
302
303        The number of seats (users) included.  # noqa: E501
304
305        :return: The included_seats of this BillingPlanInformation.  # noqa: E501
306        :rtype: str
307        """
308        return self._included_seats
309
310    @included_seats.setter
311    def included_seats(self, included_seats):
312        """Sets the included_seats of this BillingPlanInformation.
313
314        The number of seats (users) included.  # noqa: E501
315
316        :param included_seats: The included_seats of this BillingPlanInformation.  # noqa: E501
317        :type: str
318        """
319
320        self._included_seats = included_seats
321
322    @property
323    def incremental_seats(self):
324        """Gets the incremental_seats of this BillingPlanInformation.  # noqa: E501
325
326        Reserved: TBD  # noqa: E501
327
328        :return: The incremental_seats of this BillingPlanInformation.  # noqa: E501
329        :rtype: str
330        """
331        return self._incremental_seats
332
333    @incremental_seats.setter
334    def incremental_seats(self, incremental_seats):
335        """Sets the incremental_seats of this BillingPlanInformation.
336
337        Reserved: TBD  # noqa: E501
338
339        :param incremental_seats: The incremental_seats of this BillingPlanInformation.  # noqa: E501
340        :type: str
341        """
342
343        self._incremental_seats = incremental_seats
344
345    @property
346    def payment_method(self):
347        """Gets the payment_method of this BillingPlanInformation.  # noqa: E501
348
349          # noqa: E501
350
351        :return: The payment_method of this BillingPlanInformation.  # noqa: E501
352        :rtype: str
353        """
354        return self._payment_method
355
356    @payment_method.setter
357    def payment_method(self, payment_method):
358        """Sets the payment_method of this BillingPlanInformation.
359
360          # noqa: E501
361
362        :param payment_method: The payment_method of this BillingPlanInformation.  # noqa: E501
363        :type: str
364        """
365
366        self._payment_method = payment_method
367
368    @property
369    def payment_processor(self):
370        """Gets the payment_processor of this BillingPlanInformation.  # noqa: E501
371
372          # noqa: E501
373
374        :return: The payment_processor of this BillingPlanInformation.  # noqa: E501
375        :rtype: str
376        """
377        return self._payment_processor
378
379    @payment_processor.setter
380    def payment_processor(self, payment_processor):
381        """Sets the payment_processor of this BillingPlanInformation.
382
383          # noqa: E501
384
385        :param payment_processor: The payment_processor of this BillingPlanInformation.  # noqa: E501
386        :type: str
387        """
388
389        self._payment_processor = payment_processor
390
391    @property
392    def payment_processor_information(self):
393        """Gets the payment_processor_information of this BillingPlanInformation.  # noqa: E501
394
395        Information about the entity that processes payments for the billing plan.  # noqa: E501
396
397        :return: The payment_processor_information of this BillingPlanInformation.  # noqa: E501
398        :rtype: PaymentProcessorInformation
399        """
400        return self._payment_processor_information
401
402    @payment_processor_information.setter
403    def payment_processor_information(self, payment_processor_information):
404        """Sets the payment_processor_information of this BillingPlanInformation.
405
406        Information about the entity that processes payments for the billing plan.  # noqa: E501
407
408        :param payment_processor_information: The payment_processor_information of this BillingPlanInformation.  # noqa: E501
409        :type: PaymentProcessorInformation
410        """
411
412        self._payment_processor_information = payment_processor_information
413
414    @property
415    def plan_information(self):
416        """Gets the plan_information of this BillingPlanInformation.  # noqa: E501
417
418        An object used to identify the features and attributes of the account being created.  # noqa: E501
419
420        :return: The plan_information of this BillingPlanInformation.  # noqa: E501
421        :rtype: PlanInformation
422        """
423        return self._plan_information
424
425    @plan_information.setter
426    def plan_information(self, plan_information):
427        """Sets the plan_information of this BillingPlanInformation.
428
429        An object used to identify the features and attributes of the account being created.  # noqa: E501
430
431        :param plan_information: The plan_information of this BillingPlanInformation.  # noqa: E501
432        :type: PlanInformation
433        """
434
435        self._plan_information = plan_information
436
437    @property
438    def process_payment(self):
439        """Gets the process_payment of this BillingPlanInformation.  # noqa: E501
440
441          # noqa: E501
442
443        :return: The process_payment of this BillingPlanInformation.  # noqa: E501
444        :rtype: str
445        """
446        return self._process_payment
447
448    @process_payment.setter
449    def process_payment(self, process_payment):
450        """Sets the process_payment of this BillingPlanInformation.
451
452          # noqa: E501
453
454        :param process_payment: The process_payment of this BillingPlanInformation.  # noqa: E501
455        :type: str
456        """
457
458        self._process_payment = process_payment
459
460    @property
461    def referral_information(self):
462        """Gets the referral_information of this BillingPlanInformation.  # noqa: E501
463
464        A complex type that contains properties for entering referral and discount information.  # noqa: E501
465
466        :return: The referral_information of this BillingPlanInformation.  # noqa: E501
467        :rtype: ReferralInformation
468        """
469        return self._referral_information
470
471    @referral_information.setter
472    def referral_information(self, referral_information):
473        """Sets the referral_information of this BillingPlanInformation.
474
475        A complex type that contains properties for entering referral and discount information.  # noqa: E501
476
477        :param referral_information: The referral_information of this BillingPlanInformation.  # noqa: E501
478        :type: ReferralInformation
479        """
480
481        self._referral_information = referral_information
482
483    @property
484    def renewal_status(self):
485        """Gets the renewal_status of this BillingPlanInformation.  # noqa: E501
486
487          # noqa: E501
488
489        :return: The renewal_status of this BillingPlanInformation.  # noqa: E501
490        :rtype: str
491        """
492        return self._renewal_status
493
494    @renewal_status.setter
495    def renewal_status(self, renewal_status):
496        """Sets the renewal_status of this BillingPlanInformation.
497
498          # noqa: E501
499
500        :param renewal_status: The renewal_status of this BillingPlanInformation.  # noqa: E501
501        :type: str
502        """
503
504        self._renewal_status = renewal_status
505
506    @property
507    def sale_discount_amount(self):
508        """Gets the sale_discount_amount of this BillingPlanInformation.  # noqa: E501
509
510          # noqa: E501
511
512        :return: The sale_discount_amount of this BillingPlanInformation.  # noqa: E501
513        :rtype: str
514        """
515        return self._sale_discount_amount
516
517    @sale_discount_amount.setter
518    def sale_discount_amount(self, sale_discount_amount):
519        """Sets the sale_discount_amount of this BillingPlanInformation.
520
521          # noqa: E501
522
523        :param sale_discount_amount: The sale_discount_amount of this BillingPlanInformation.  # noqa: E501
524        :type: str
525        """
526
527        self._sale_discount_amount = sale_discount_amount
528
529    @property
530    def sale_discount_fixed_amount(self):
531        """Gets the sale_discount_fixed_amount of this BillingPlanInformation.  # noqa: E501
532
533          # noqa: E501
534
535        :return: The sale_discount_fixed_amount of this BillingPlanInformation.  # noqa: E501
536        :rtype: str
537        """
538        return self._sale_discount_fixed_amount
539
540    @sale_discount_fixed_amount.setter
541    def sale_discount_fixed_amount(self, sale_discount_fixed_amount):
542        """Sets the sale_discount_fixed_amount of this BillingPlanInformation.
543
544          # noqa: E501
545
546        :param sale_discount_fixed_amount: The sale_discount_fixed_amount of this BillingPlanInformation.  # noqa: E501
547        :type: str
548        """
549
550        self._sale_discount_fixed_amount = sale_discount_fixed_amount
551
552    @property
553    def sale_discount_percent(self):
554        """Gets the sale_discount_percent of this BillingPlanInformation.  # noqa: E501
555
556          # noqa: E501
557
558        :return: The sale_discount_percent of this BillingPlanInformation.  # noqa: E501
559        :rtype: str
560        """
561        return self._sale_discount_percent
562
563    @sale_discount_percent.setter
564    def sale_discount_percent(self, sale_discount_percent):
565        """Sets the sale_discount_percent of this BillingPlanInformation.
566
567          # noqa: E501
568
569        :param sale_discount_percent: The sale_discount_percent of this BillingPlanInformation.  # noqa: E501
570        :type: str
571        """
572
573        self._sale_discount_percent = sale_discount_percent
574
575    @property
576    def sale_discount_periods(self):
577        """Gets the sale_discount_periods of this BillingPlanInformation.  # noqa: E501
578
579          # noqa: E501
580
581        :return: The sale_discount_periods of this BillingPlanInformation.  # noqa: E501
582        :rtype: str
583        """
584        return self._sale_discount_periods
585
586    @sale_discount_periods.setter
587    def sale_discount_periods(self, sale_discount_periods):
588        """Sets the sale_discount_periods of this BillingPlanInformation.
589
590          # noqa: E501
591
592        :param sale_discount_periods: The sale_discount_periods of this BillingPlanInformation.  # noqa: E501
593        :type: str
594        """
595
596        self._sale_discount_periods = sale_discount_periods
597
598    @property
599    def sale_discount_seat_price_override(self):
600        """Gets the sale_discount_seat_price_override of this BillingPlanInformation.  # noqa: E501
601
602          # noqa: E501
603
604        :return: The sale_discount_seat_price_override of this BillingPlanInformation.  # noqa: E501
605        :rtype: str
606        """
607        return self._sale_discount_seat_price_override
608
609    @sale_discount_seat_price_override.setter
610    def sale_discount_seat_price_override(self, sale_discount_seat_price_override):
611        """Sets the sale_discount_seat_price_override of this BillingPlanInformation.
612
613          # noqa: E501
614
615        :param sale_discount_seat_price_override: The sale_discount_seat_price_override of this BillingPlanInformation.  # noqa: E501
616        :type: str
617        """
618
619        self._sale_discount_seat_price_override = sale_discount_seat_price_override
620
621    @property
622    def tax_exempt_id(self):
623        """Gets the tax_exempt_id of this BillingPlanInformation.  # noqa: E501
624
625          # noqa: E501
626
627        :return: The tax_exempt_id of this BillingPlanInformation.  # noqa: E501
628        :rtype: str
629        """
630        return self._tax_exempt_id
631
632    @tax_exempt_id.setter
633    def tax_exempt_id(self, tax_exempt_id):
634        """Sets the tax_exempt_id of this BillingPlanInformation.
635
636          # noqa: E501
637
638        :param tax_exempt_id: The tax_exempt_id of this BillingPlanInformation.  # noqa: E501
639        :type: str
640        """
641
642        self._tax_exempt_id = tax_exempt_id
643
644    def to_dict(self):
645        """Returns the model properties as a dict"""
646        result = {}
647
648        for attr, _ in six.iteritems(self.swagger_types):
649            value = getattr(self, attr)
650            if isinstance(value, list):
651                result[attr] = list(map(
652                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
653                    value
654                ))
655            elif hasattr(value, "to_dict"):
656                result[attr] = value.to_dict()
657            elif isinstance(value, dict):
658                result[attr] = dict(map(
659                    lambda item: (item[0], item[1].to_dict())
660                    if hasattr(item[1], "to_dict") else item,
661                    value.items()
662                ))
663            else:
664                result[attr] = value
665        if issubclass(BillingPlanInformation, dict):
666            for key, value in self.items():
667                result[key] = value
668
669        return result
670
671    def to_str(self):
672        """Returns the string representation of the model"""
673        return pprint.pformat(self.to_dict())
674
675    def __repr__(self):
676        """For `print` and `pprint`"""
677        return self.to_str()
678
679    def __eq__(self, other):
680        """Returns true if both objects are equal"""
681        if not isinstance(other, BillingPlanInformation):
682            return False
683
684        return self.to_dict() == other.to_dict()
685
686    def __ne__(self, other):
687        """Returns true if both objects are not equal"""
688        if not isinstance(other, BillingPlanInformation):
689            return True
690
691        return self.to_dict() != other.to_dict()