docusign_esign.models.billing_plan

Docusign eSignature REST API

The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501

OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git

  1# coding: utf-8
  2
  3"""
  4    Docusign eSignature REST API
  5
  6    The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class BillingPlan(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_products': 'list[AppStoreProduct]',
 37        'currency_plan_prices': 'list[CurrencyPlanPrice]',
 38        'enable_support': 'str',
 39        'included_seats': 'str',
 40        'other_discount_percent': 'str',
 41        'payment_cycle': 'str',
 42        'payment_method': 'str',
 43        'per_seat_price': 'str',
 44        'plan_classification': 'str',
 45        'plan_feature_sets': 'list[FeatureSet]',
 46        'plan_id': 'str',
 47        'plan_name': 'str',
 48        'seat_discounts': 'list[SeatDiscount]',
 49        'support_incident_fee': 'str',
 50        'support_plan_fee': 'str'
 51    }
 52
 53    attribute_map = {
 54        'app_store_products': 'appStoreProducts',
 55        'currency_plan_prices': 'currencyPlanPrices',
 56        'enable_support': 'enableSupport',
 57        'included_seats': 'includedSeats',
 58        'other_discount_percent': 'otherDiscountPercent',
 59        'payment_cycle': 'paymentCycle',
 60        'payment_method': 'paymentMethod',
 61        'per_seat_price': 'perSeatPrice',
 62        'plan_classification': 'planClassification',
 63        'plan_feature_sets': 'planFeatureSets',
 64        'plan_id': 'planId',
 65        'plan_name': 'planName',
 66        'seat_discounts': 'seatDiscounts',
 67        'support_incident_fee': 'supportIncidentFee',
 68        'support_plan_fee': 'supportPlanFee'
 69    }
 70
 71    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 72        """BillingPlan - a model defined in Swagger"""  # noqa: E501
 73        if _configuration is None:
 74            _configuration = Configuration()
 75        self._configuration = _configuration
 76
 77        self._app_store_products = None
 78        self._currency_plan_prices = None
 79        self._enable_support = None
 80        self._included_seats = None
 81        self._other_discount_percent = None
 82        self._payment_cycle = None
 83        self._payment_method = None
 84        self._per_seat_price = None
 85        self._plan_classification = None
 86        self._plan_feature_sets = None
 87        self._plan_id = None
 88        self._plan_name = None
 89        self._seat_discounts = None
 90        self._support_incident_fee = None
 91        self._support_plan_fee = None
 92        self.discriminator = None
 93
 94        setattr(self, "_{}".format('app_store_products'), kwargs.get('app_store_products', None))
 95        setattr(self, "_{}".format('currency_plan_prices'), kwargs.get('currency_plan_prices', None))
 96        setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None))
 97        setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None))
 98        setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None))
 99        setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None))
100        setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None))
101        setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None))
102        setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None))
103        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
104        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
105        setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None))
106        setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None))
107        setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None))
108        setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None))
109
110    @property
111    def app_store_products(self):
112        """Gets the app_store_products of this BillingPlan.  # noqa: E501
113
114        Reserved: TBD  # noqa: E501
115
116        :return: The app_store_products of this BillingPlan.  # noqa: E501
117        :rtype: list[AppStoreProduct]
118        """
119        return self._app_store_products
120
121    @app_store_products.setter
122    def app_store_products(self, app_store_products):
123        """Sets the app_store_products of this BillingPlan.
124
125        Reserved: TBD  # noqa: E501
126
127        :param app_store_products: The app_store_products of this BillingPlan.  # noqa: E501
128        :type: list[AppStoreProduct]
129        """
130
131        self._app_store_products = app_store_products
132
133    @property
134    def currency_plan_prices(self):
135        """Gets the currency_plan_prices of this BillingPlan.  # noqa: E501
136
137        Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.  # noqa: E501
138
139        :return: The currency_plan_prices of this BillingPlan.  # noqa: E501
140        :rtype: list[CurrencyPlanPrice]
141        """
142        return self._currency_plan_prices
143
144    @currency_plan_prices.setter
145    def currency_plan_prices(self, currency_plan_prices):
146        """Sets the currency_plan_prices of this BillingPlan.
147
148        Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.  # noqa: E501
149
150        :param currency_plan_prices: The currency_plan_prices of this BillingPlan.  # noqa: E501
151        :type: list[CurrencyPlanPrice]
152        """
153
154        self._currency_plan_prices = currency_plan_prices
155
156    @property
157    def enable_support(self):
158        """Gets the enable_support of this BillingPlan.  # noqa: E501
159
160        When set to **true**, then customer support is provided as part of the account plan.  # noqa: E501
161
162        :return: The enable_support of this BillingPlan.  # noqa: E501
163        :rtype: str
164        """
165        return self._enable_support
166
167    @enable_support.setter
168    def enable_support(self, enable_support):
169        """Sets the enable_support of this BillingPlan.
170
171        When set to **true**, then customer support is provided as part of the account plan.  # noqa: E501
172
173        :param enable_support: The enable_support of this BillingPlan.  # noqa: E501
174        :type: str
175        """
176
177        self._enable_support = enable_support
178
179    @property
180    def included_seats(self):
181        """Gets the included_seats of this BillingPlan.  # noqa: E501
182
183        The number of seats (users) included.  # noqa: E501
184
185        :return: The included_seats of this BillingPlan.  # noqa: E501
186        :rtype: str
187        """
188        return self._included_seats
189
190    @included_seats.setter
191    def included_seats(self, included_seats):
192        """Sets the included_seats of this BillingPlan.
193
194        The number of seats (users) included.  # noqa: E501
195
196        :param included_seats: The included_seats of this BillingPlan.  # noqa: E501
197        :type: str
198        """
199
200        self._included_seats = included_seats
201
202    @property
203    def other_discount_percent(self):
204        """Gets the other_discount_percent of this BillingPlan.  # noqa: E501
205
206          # noqa: E501
207
208        :return: The other_discount_percent of this BillingPlan.  # noqa: E501
209        :rtype: str
210        """
211        return self._other_discount_percent
212
213    @other_discount_percent.setter
214    def other_discount_percent(self, other_discount_percent):
215        """Sets the other_discount_percent of this BillingPlan.
216
217          # noqa: E501
218
219        :param other_discount_percent: The other_discount_percent of this BillingPlan.  # noqa: E501
220        :type: str
221        """
222
223        self._other_discount_percent = other_discount_percent
224
225    @property
226    def payment_cycle(self):
227        """Gets the payment_cycle of this BillingPlan.  # noqa: E501
228
229         The payment cycle associated with the plan. The possible values are: Monthly or Annually.   # noqa: E501
230
231        :return: The payment_cycle of this BillingPlan.  # noqa: E501
232        :rtype: str
233        """
234        return self._payment_cycle
235
236    @payment_cycle.setter
237    def payment_cycle(self, payment_cycle):
238        """Sets the payment_cycle of this BillingPlan.
239
240         The payment cycle associated with the plan. The possible values are: Monthly or Annually.   # noqa: E501
241
242        :param payment_cycle: The payment_cycle of this BillingPlan.  # noqa: E501
243        :type: str
244        """
245
246        self._payment_cycle = payment_cycle
247
248    @property
249    def payment_method(self):
250        """Gets the payment_method of this BillingPlan.  # noqa: E501
251
252          # noqa: E501
253
254        :return: The payment_method of this BillingPlan.  # noqa: E501
255        :rtype: str
256        """
257        return self._payment_method
258
259    @payment_method.setter
260    def payment_method(self, payment_method):
261        """Sets the payment_method of this BillingPlan.
262
263          # noqa: E501
264
265        :param payment_method: The payment_method of this BillingPlan.  # noqa: E501
266        :type: str
267        """
268
269        self._payment_method = payment_method
270
271    @property
272    def per_seat_price(self):
273        """Gets the per_seat_price of this BillingPlan.  # noqa: E501
274
275        The per seat price for the plan.  # noqa: E501
276
277        :return: The per_seat_price of this BillingPlan.  # noqa: E501
278        :rtype: str
279        """
280        return self._per_seat_price
281
282    @per_seat_price.setter
283    def per_seat_price(self, per_seat_price):
284        """Sets the per_seat_price of this BillingPlan.
285
286        The per seat price for the plan.  # noqa: E501
287
288        :param per_seat_price: The per_seat_price of this BillingPlan.  # noqa: E501
289        :type: str
290        """
291
292        self._per_seat_price = per_seat_price
293
294    @property
295    def plan_classification(self):
296        """Gets the plan_classification of this BillingPlan.  # noqa: E501
297
298        Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.  # noqa: E501
299
300        :return: The plan_classification of this BillingPlan.  # noqa: E501
301        :rtype: str
302        """
303        return self._plan_classification
304
305    @plan_classification.setter
306    def plan_classification(self, plan_classification):
307        """Sets the plan_classification of this BillingPlan.
308
309        Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.  # noqa: E501
310
311        :param plan_classification: The plan_classification of this BillingPlan.  # noqa: E501
312        :type: str
313        """
314
315        self._plan_classification = plan_classification
316
317    @property
318    def plan_feature_sets(self):
319        """Gets the plan_feature_sets of this BillingPlan.  # noqa: E501
320
321          # noqa: E501
322
323        :return: The plan_feature_sets of this BillingPlan.  # noqa: E501
324        :rtype: list[FeatureSet]
325        """
326        return self._plan_feature_sets
327
328    @plan_feature_sets.setter
329    def plan_feature_sets(self, plan_feature_sets):
330        """Sets the plan_feature_sets of this BillingPlan.
331
332          # noqa: E501
333
334        :param plan_feature_sets: The plan_feature_sets of this BillingPlan.  # noqa: E501
335        :type: list[FeatureSet]
336        """
337
338        self._plan_feature_sets = plan_feature_sets
339
340    @property
341    def plan_id(self):
342        """Gets the plan_id of this BillingPlan.  # noqa: E501
343
344          # noqa: E501
345
346        :return: The plan_id of this BillingPlan.  # noqa: E501
347        :rtype: str
348        """
349        return self._plan_id
350
351    @plan_id.setter
352    def plan_id(self, plan_id):
353        """Sets the plan_id of this BillingPlan.
354
355          # noqa: E501
356
357        :param plan_id: The plan_id of this BillingPlan.  # noqa: E501
358        :type: str
359        """
360
361        self._plan_id = plan_id
362
363    @property
364    def plan_name(self):
365        """Gets the plan_name of this BillingPlan.  # noqa: E501
366
367        The name of the Billing Plan.  # noqa: E501
368
369        :return: The plan_name of this BillingPlan.  # noqa: E501
370        :rtype: str
371        """
372        return self._plan_name
373
374    @plan_name.setter
375    def plan_name(self, plan_name):
376        """Sets the plan_name of this BillingPlan.
377
378        The name of the Billing Plan.  # noqa: E501
379
380        :param plan_name: The plan_name of this BillingPlan.  # noqa: E501
381        :type: str
382        """
383
384        self._plan_name = plan_name
385
386    @property
387    def seat_discounts(self):
388        """Gets the seat_discounts of this BillingPlan.  # noqa: E501
389
390          # noqa: E501
391
392        :return: The seat_discounts of this BillingPlan.  # noqa: E501
393        :rtype: list[SeatDiscount]
394        """
395        return self._seat_discounts
396
397    @seat_discounts.setter
398    def seat_discounts(self, seat_discounts):
399        """Sets the seat_discounts of this BillingPlan.
400
401          # noqa: E501
402
403        :param seat_discounts: The seat_discounts of this BillingPlan.  # noqa: E501
404        :type: list[SeatDiscount]
405        """
406
407        self._seat_discounts = seat_discounts
408
409    @property
410    def support_incident_fee(self):
411        """Gets the support_incident_fee of this BillingPlan.  # noqa: E501
412
413        The support incident fee charged for each support incident.  # noqa: E501
414
415        :return: The support_incident_fee of this BillingPlan.  # noqa: E501
416        :rtype: str
417        """
418        return self._support_incident_fee
419
420    @support_incident_fee.setter
421    def support_incident_fee(self, support_incident_fee):
422        """Sets the support_incident_fee of this BillingPlan.
423
424        The support incident fee charged for each support incident.  # noqa: E501
425
426        :param support_incident_fee: The support_incident_fee of this BillingPlan.  # noqa: E501
427        :type: str
428        """
429
430        self._support_incident_fee = support_incident_fee
431
432    @property
433    def support_plan_fee(self):
434        """Gets the support_plan_fee of this BillingPlan.  # noqa: E501
435
436        The support plan fee charged for this plan.  # noqa: E501
437
438        :return: The support_plan_fee of this BillingPlan.  # noqa: E501
439        :rtype: str
440        """
441        return self._support_plan_fee
442
443    @support_plan_fee.setter
444    def support_plan_fee(self, support_plan_fee):
445        """Sets the support_plan_fee of this BillingPlan.
446
447        The support plan fee charged for this plan.  # noqa: E501
448
449        :param support_plan_fee: The support_plan_fee of this BillingPlan.  # noqa: E501
450        :type: str
451        """
452
453        self._support_plan_fee = support_plan_fee
454
455    def to_dict(self):
456        """Returns the model properties as a dict"""
457        result = {}
458
459        for attr, _ in six.iteritems(self.swagger_types):
460            value = getattr(self, attr)
461            if isinstance(value, list):
462                result[attr] = list(map(
463                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
464                    value
465                ))
466            elif hasattr(value, "to_dict"):
467                result[attr] = value.to_dict()
468            elif isinstance(value, dict):
469                result[attr] = dict(map(
470                    lambda item: (item[0], item[1].to_dict())
471                    if hasattr(item[1], "to_dict") else item,
472                    value.items()
473                ))
474            else:
475                result[attr] = value
476        if issubclass(BillingPlan, dict):
477            for key, value in self.items():
478                result[key] = value
479
480        return result
481
482    def to_str(self):
483        """Returns the string representation of the model"""
484        return pprint.pformat(self.to_dict())
485
486    def __repr__(self):
487        """For `print` and `pprint`"""
488        return self.to_str()
489
490    def __eq__(self, other):
491        """Returns true if both objects are equal"""
492        if not isinstance(other, BillingPlan):
493            return False
494
495        return self.to_dict() == other.to_dict()
496
497    def __ne__(self, other):
498        """Returns true if both objects are not equal"""
499        if not isinstance(other, BillingPlan):
500            return True
501
502        return self.to_dict() != other.to_dict()
class BillingPlan:
 23class BillingPlan(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        'app_store_products': 'list[AppStoreProduct]',
 38        'currency_plan_prices': 'list[CurrencyPlanPrice]',
 39        'enable_support': 'str',
 40        'included_seats': 'str',
 41        'other_discount_percent': 'str',
 42        'payment_cycle': 'str',
 43        'payment_method': 'str',
 44        'per_seat_price': 'str',
 45        'plan_classification': 'str',
 46        'plan_feature_sets': 'list[FeatureSet]',
 47        'plan_id': 'str',
 48        'plan_name': 'str',
 49        'seat_discounts': 'list[SeatDiscount]',
 50        'support_incident_fee': 'str',
 51        'support_plan_fee': 'str'
 52    }
 53
 54    attribute_map = {
 55        'app_store_products': 'appStoreProducts',
 56        'currency_plan_prices': 'currencyPlanPrices',
 57        'enable_support': 'enableSupport',
 58        'included_seats': 'includedSeats',
 59        'other_discount_percent': 'otherDiscountPercent',
 60        'payment_cycle': 'paymentCycle',
 61        'payment_method': 'paymentMethod',
 62        'per_seat_price': 'perSeatPrice',
 63        'plan_classification': 'planClassification',
 64        'plan_feature_sets': 'planFeatureSets',
 65        'plan_id': 'planId',
 66        'plan_name': 'planName',
 67        'seat_discounts': 'seatDiscounts',
 68        'support_incident_fee': 'supportIncidentFee',
 69        'support_plan_fee': 'supportPlanFee'
 70    }
 71
 72    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 73        """BillingPlan - a model defined in Swagger"""  # noqa: E501
 74        if _configuration is None:
 75            _configuration = Configuration()
 76        self._configuration = _configuration
 77
 78        self._app_store_products = None
 79        self._currency_plan_prices = None
 80        self._enable_support = None
 81        self._included_seats = None
 82        self._other_discount_percent = None
 83        self._payment_cycle = None
 84        self._payment_method = None
 85        self._per_seat_price = None
 86        self._plan_classification = None
 87        self._plan_feature_sets = None
 88        self._plan_id = None
 89        self._plan_name = None
 90        self._seat_discounts = None
 91        self._support_incident_fee = None
 92        self._support_plan_fee = None
 93        self.discriminator = None
 94
 95        setattr(self, "_{}".format('app_store_products'), kwargs.get('app_store_products', None))
 96        setattr(self, "_{}".format('currency_plan_prices'), kwargs.get('currency_plan_prices', None))
 97        setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None))
 98        setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None))
 99        setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None))
100        setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None))
101        setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None))
102        setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None))
103        setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None))
104        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
105        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
106        setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None))
107        setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None))
108        setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None))
109        setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None))
110
111    @property
112    def app_store_products(self):
113        """Gets the app_store_products of this BillingPlan.  # noqa: E501
114
115        Reserved: TBD  # noqa: E501
116
117        :return: The app_store_products of this BillingPlan.  # noqa: E501
118        :rtype: list[AppStoreProduct]
119        """
120        return self._app_store_products
121
122    @app_store_products.setter
123    def app_store_products(self, app_store_products):
124        """Sets the app_store_products of this BillingPlan.
125
126        Reserved: TBD  # noqa: E501
127
128        :param app_store_products: The app_store_products of this BillingPlan.  # noqa: E501
129        :type: list[AppStoreProduct]
130        """
131
132        self._app_store_products = app_store_products
133
134    @property
135    def currency_plan_prices(self):
136        """Gets the currency_plan_prices of this BillingPlan.  # noqa: E501
137
138        Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.  # noqa: E501
139
140        :return: The currency_plan_prices of this BillingPlan.  # noqa: E501
141        :rtype: list[CurrencyPlanPrice]
142        """
143        return self._currency_plan_prices
144
145    @currency_plan_prices.setter
146    def currency_plan_prices(self, currency_plan_prices):
147        """Sets the currency_plan_prices of this BillingPlan.
148
149        Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set.  # noqa: E501
150
151        :param currency_plan_prices: The currency_plan_prices of this BillingPlan.  # noqa: E501
152        :type: list[CurrencyPlanPrice]
153        """
154
155        self._currency_plan_prices = currency_plan_prices
156
157    @property
158    def enable_support(self):
159        """Gets the enable_support of this BillingPlan.  # noqa: E501
160
161        When set to **true**, then customer support is provided as part of the account plan.  # noqa: E501
162
163        :return: The enable_support of this BillingPlan.  # noqa: E501
164        :rtype: str
165        """
166        return self._enable_support
167
168    @enable_support.setter
169    def enable_support(self, enable_support):
170        """Sets the enable_support of this BillingPlan.
171
172        When set to **true**, then customer support is provided as part of the account plan.  # noqa: E501
173
174        :param enable_support: The enable_support of this BillingPlan.  # noqa: E501
175        :type: str
176        """
177
178        self._enable_support = enable_support
179
180    @property
181    def included_seats(self):
182        """Gets the included_seats of this BillingPlan.  # noqa: E501
183
184        The number of seats (users) included.  # noqa: E501
185
186        :return: The included_seats of this BillingPlan.  # noqa: E501
187        :rtype: str
188        """
189        return self._included_seats
190
191    @included_seats.setter
192    def included_seats(self, included_seats):
193        """Sets the included_seats of this BillingPlan.
194
195        The number of seats (users) included.  # noqa: E501
196
197        :param included_seats: The included_seats of this BillingPlan.  # noqa: E501
198        :type: str
199        """
200
201        self._included_seats = included_seats
202
203    @property
204    def other_discount_percent(self):
205        """Gets the other_discount_percent of this BillingPlan.  # noqa: E501
206
207          # noqa: E501
208
209        :return: The other_discount_percent of this BillingPlan.  # noqa: E501
210        :rtype: str
211        """
212        return self._other_discount_percent
213
214    @other_discount_percent.setter
215    def other_discount_percent(self, other_discount_percent):
216        """Sets the other_discount_percent of this BillingPlan.
217
218          # noqa: E501
219
220        :param other_discount_percent: The other_discount_percent of this BillingPlan.  # noqa: E501
221        :type: str
222        """
223
224        self._other_discount_percent = other_discount_percent
225
226    @property
227    def payment_cycle(self):
228        """Gets the payment_cycle of this BillingPlan.  # noqa: E501
229
230         The payment cycle associated with the plan. The possible values are: Monthly or Annually.   # noqa: E501
231
232        :return: The payment_cycle of this BillingPlan.  # noqa: E501
233        :rtype: str
234        """
235        return self._payment_cycle
236
237    @payment_cycle.setter
238    def payment_cycle(self, payment_cycle):
239        """Sets the payment_cycle of this BillingPlan.
240
241         The payment cycle associated with the plan. The possible values are: Monthly or Annually.   # noqa: E501
242
243        :param payment_cycle: The payment_cycle of this BillingPlan.  # noqa: E501
244        :type: str
245        """
246
247        self._payment_cycle = payment_cycle
248
249    @property
250    def payment_method(self):
251        """Gets the payment_method of this BillingPlan.  # noqa: E501
252
253          # noqa: E501
254
255        :return: The payment_method of this BillingPlan.  # noqa: E501
256        :rtype: str
257        """
258        return self._payment_method
259
260    @payment_method.setter
261    def payment_method(self, payment_method):
262        """Sets the payment_method of this BillingPlan.
263
264          # noqa: E501
265
266        :param payment_method: The payment_method of this BillingPlan.  # noqa: E501
267        :type: str
268        """
269
270        self._payment_method = payment_method
271
272    @property
273    def per_seat_price(self):
274        """Gets the per_seat_price of this BillingPlan.  # noqa: E501
275
276        The per seat price for the plan.  # noqa: E501
277
278        :return: The per_seat_price of this BillingPlan.  # noqa: E501
279        :rtype: str
280        """
281        return self._per_seat_price
282
283    @per_seat_price.setter
284    def per_seat_price(self, per_seat_price):
285        """Sets the per_seat_price of this BillingPlan.
286
287        The per seat price for the plan.  # noqa: E501
288
289        :param per_seat_price: The per_seat_price of this BillingPlan.  # noqa: E501
290        :type: str
291        """
292
293        self._per_seat_price = per_seat_price
294
295    @property
296    def plan_classification(self):
297        """Gets the plan_classification of this BillingPlan.  # noqa: E501
298
299        Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.  # noqa: E501
300
301        :return: The plan_classification of this BillingPlan.  # noqa: E501
302        :rtype: str
303        """
304        return self._plan_classification
305
306    @plan_classification.setter
307    def plan_classification(self, plan_classification):
308        """Sets the plan_classification of this BillingPlan.
309
310        Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.  # noqa: E501
311
312        :param plan_classification: The plan_classification of this BillingPlan.  # noqa: E501
313        :type: str
314        """
315
316        self._plan_classification = plan_classification
317
318    @property
319    def plan_feature_sets(self):
320        """Gets the plan_feature_sets of this BillingPlan.  # noqa: E501
321
322          # noqa: E501
323
324        :return: The plan_feature_sets of this BillingPlan.  # noqa: E501
325        :rtype: list[FeatureSet]
326        """
327        return self._plan_feature_sets
328
329    @plan_feature_sets.setter
330    def plan_feature_sets(self, plan_feature_sets):
331        """Sets the plan_feature_sets of this BillingPlan.
332
333          # noqa: E501
334
335        :param plan_feature_sets: The plan_feature_sets of this BillingPlan.  # noqa: E501
336        :type: list[FeatureSet]
337        """
338
339        self._plan_feature_sets = plan_feature_sets
340
341    @property
342    def plan_id(self):
343        """Gets the plan_id of this BillingPlan.  # noqa: E501
344
345          # noqa: E501
346
347        :return: The plan_id of this BillingPlan.  # noqa: E501
348        :rtype: str
349        """
350        return self._plan_id
351
352    @plan_id.setter
353    def plan_id(self, plan_id):
354        """Sets the plan_id of this BillingPlan.
355
356          # noqa: E501
357
358        :param plan_id: The plan_id of this BillingPlan.  # noqa: E501
359        :type: str
360        """
361
362        self._plan_id = plan_id
363
364    @property
365    def plan_name(self):
366        """Gets the plan_name of this BillingPlan.  # noqa: E501
367
368        The name of the Billing Plan.  # noqa: E501
369
370        :return: The plan_name of this BillingPlan.  # noqa: E501
371        :rtype: str
372        """
373        return self._plan_name
374
375    @plan_name.setter
376    def plan_name(self, plan_name):
377        """Sets the plan_name of this BillingPlan.
378
379        The name of the Billing Plan.  # noqa: E501
380
381        :param plan_name: The plan_name of this BillingPlan.  # noqa: E501
382        :type: str
383        """
384
385        self._plan_name = plan_name
386
387    @property
388    def seat_discounts(self):
389        """Gets the seat_discounts of this BillingPlan.  # noqa: E501
390
391          # noqa: E501
392
393        :return: The seat_discounts of this BillingPlan.  # noqa: E501
394        :rtype: list[SeatDiscount]
395        """
396        return self._seat_discounts
397
398    @seat_discounts.setter
399    def seat_discounts(self, seat_discounts):
400        """Sets the seat_discounts of this BillingPlan.
401
402          # noqa: E501
403
404        :param seat_discounts: The seat_discounts of this BillingPlan.  # noqa: E501
405        :type: list[SeatDiscount]
406        """
407
408        self._seat_discounts = seat_discounts
409
410    @property
411    def support_incident_fee(self):
412        """Gets the support_incident_fee of this BillingPlan.  # noqa: E501
413
414        The support incident fee charged for each support incident.  # noqa: E501
415
416        :return: The support_incident_fee of this BillingPlan.  # noqa: E501
417        :rtype: str
418        """
419        return self._support_incident_fee
420
421    @support_incident_fee.setter
422    def support_incident_fee(self, support_incident_fee):
423        """Sets the support_incident_fee of this BillingPlan.
424
425        The support incident fee charged for each support incident.  # noqa: E501
426
427        :param support_incident_fee: The support_incident_fee of this BillingPlan.  # noqa: E501
428        :type: str
429        """
430
431        self._support_incident_fee = support_incident_fee
432
433    @property
434    def support_plan_fee(self):
435        """Gets the support_plan_fee of this BillingPlan.  # noqa: E501
436
437        The support plan fee charged for this plan.  # noqa: E501
438
439        :return: The support_plan_fee of this BillingPlan.  # noqa: E501
440        :rtype: str
441        """
442        return self._support_plan_fee
443
444    @support_plan_fee.setter
445    def support_plan_fee(self, support_plan_fee):
446        """Sets the support_plan_fee of this BillingPlan.
447
448        The support plan fee charged for this plan.  # noqa: E501
449
450        :param support_plan_fee: The support_plan_fee of this BillingPlan.  # noqa: E501
451        :type: str
452        """
453
454        self._support_plan_fee = support_plan_fee
455
456    def to_dict(self):
457        """Returns the model properties as a dict"""
458        result = {}
459
460        for attr, _ in six.iteritems(self.swagger_types):
461            value = getattr(self, attr)
462            if isinstance(value, list):
463                result[attr] = list(map(
464                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
465                    value
466                ))
467            elif hasattr(value, "to_dict"):
468                result[attr] = value.to_dict()
469            elif isinstance(value, dict):
470                result[attr] = dict(map(
471                    lambda item: (item[0], item[1].to_dict())
472                    if hasattr(item[1], "to_dict") else item,
473                    value.items()
474                ))
475            else:
476                result[attr] = value
477        if issubclass(BillingPlan, dict):
478            for key, value in self.items():
479                result[key] = value
480
481        return result
482
483    def to_str(self):
484        """Returns the string representation of the model"""
485        return pprint.pformat(self.to_dict())
486
487    def __repr__(self):
488        """For `print` and `pprint`"""
489        return self.to_str()
490
491    def __eq__(self, other):
492        """Returns true if both objects are equal"""
493        if not isinstance(other, BillingPlan):
494            return False
495
496        return self.to_dict() == other.to_dict()
497
498    def __ne__(self, other):
499        """Returns true if both objects are not equal"""
500        if not isinstance(other, BillingPlan):
501            return True
502
503        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.

BillingPlan(_configuration=None, **kwargs)
 72    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 73        """BillingPlan - a model defined in Swagger"""  # noqa: E501
 74        if _configuration is None:
 75            _configuration = Configuration()
 76        self._configuration = _configuration
 77
 78        self._app_store_products = None
 79        self._currency_plan_prices = None
 80        self._enable_support = None
 81        self._included_seats = None
 82        self._other_discount_percent = None
 83        self._payment_cycle = None
 84        self._payment_method = None
 85        self._per_seat_price = None
 86        self._plan_classification = None
 87        self._plan_feature_sets = None
 88        self._plan_id = None
 89        self._plan_name = None
 90        self._seat_discounts = None
 91        self._support_incident_fee = None
 92        self._support_plan_fee = None
 93        self.discriminator = None
 94
 95        setattr(self, "_{}".format('app_store_products'), kwargs.get('app_store_products', None))
 96        setattr(self, "_{}".format('currency_plan_prices'), kwargs.get('currency_plan_prices', None))
 97        setattr(self, "_{}".format('enable_support'), kwargs.get('enable_support', None))
 98        setattr(self, "_{}".format('included_seats'), kwargs.get('included_seats', None))
 99        setattr(self, "_{}".format('other_discount_percent'), kwargs.get('other_discount_percent', None))
100        setattr(self, "_{}".format('payment_cycle'), kwargs.get('payment_cycle', None))
101        setattr(self, "_{}".format('payment_method'), kwargs.get('payment_method', None))
102        setattr(self, "_{}".format('per_seat_price'), kwargs.get('per_seat_price', None))
103        setattr(self, "_{}".format('plan_classification'), kwargs.get('plan_classification', None))
104        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
105        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
106        setattr(self, "_{}".format('plan_name'), kwargs.get('plan_name', None))
107        setattr(self, "_{}".format('seat_discounts'), kwargs.get('seat_discounts', None))
108        setattr(self, "_{}".format('support_incident_fee'), kwargs.get('support_incident_fee', None))
109        setattr(self, "_{}".format('support_plan_fee'), kwargs.get('support_plan_fee', None))

BillingPlan - a model defined in Swagger

swagger_types = {'app_store_products': 'list[AppStoreProduct]', 'currency_plan_prices': 'list[CurrencyPlanPrice]', 'enable_support': 'str', 'included_seats': 'str', 'other_discount_percent': 'str', 'payment_cycle': 'str', 'payment_method': 'str', 'per_seat_price': 'str', 'plan_classification': 'str', 'plan_feature_sets': 'list[FeatureSet]', 'plan_id': 'str', 'plan_name': 'str', 'seat_discounts': 'list[SeatDiscount]', 'support_incident_fee': 'str', 'support_plan_fee': 'str'}
attribute_map = {'app_store_products': 'appStoreProducts', 'currency_plan_prices': 'currencyPlanPrices', 'enable_support': 'enableSupport', 'included_seats': 'includedSeats', 'other_discount_percent': 'otherDiscountPercent', 'payment_cycle': 'paymentCycle', 'payment_method': 'paymentMethod', 'per_seat_price': 'perSeatPrice', 'plan_classification': 'planClassification', 'plan_feature_sets': 'planFeatureSets', 'plan_id': 'planId', 'plan_name': 'planName', 'seat_discounts': 'seatDiscounts', 'support_incident_fee': 'supportIncidentFee', 'support_plan_fee': 'supportPlanFee'}
app_store_products

Gets the app_store_products of this BillingPlan. # noqa: E501

Reserved: TBD # noqa: E501

Returns

The app_store_products of this BillingPlan. # noqa: E501

currency_plan_prices

Gets the currency_plan_prices of this BillingPlan. # noqa: E501

Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, and seatFee that are configured for this plan feature set. # noqa: E501

Returns

The currency_plan_prices of this BillingPlan. # noqa: E501

enable_support

Gets the enable_support of this BillingPlan. # 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 BillingPlan. # noqa: E501

included_seats

Gets the included_seats of this BillingPlan. # noqa: E501

The number of seats (users) included. # noqa: E501

Returns

The included_seats of this BillingPlan. # noqa: E501

other_discount_percent

Gets the other_discount_percent of this BillingPlan. # noqa: E501

# noqa: E501

Returns

The other_discount_percent of this BillingPlan. # noqa: E501

payment_cycle

Gets the payment_cycle of this BillingPlan. # noqa: E501

The payment cycle associated with the plan. The possible values are: Monthly or Annually. # noqa: E501

Returns

The payment_cycle of this BillingPlan. # noqa: E501

payment_method

Gets the payment_method of this BillingPlan. # noqa: E501

# noqa: E501

Returns

The payment_method of this BillingPlan. # noqa: E501

per_seat_price

Gets the per_seat_price of this BillingPlan. # noqa: E501

The per seat price for the plan. # noqa: E501

Returns

The per_seat_price of this BillingPlan. # noqa: E501

plan_classification

Gets the plan_classification of this BillingPlan. # noqa: E501

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free. # noqa: E501

Returns

The plan_classification of this BillingPlan. # noqa: E501

plan_feature_sets

Gets the plan_feature_sets of this BillingPlan. # noqa: E501

# noqa: E501

Returns

The plan_feature_sets of this BillingPlan. # noqa: E501

plan_id

Gets the plan_id of this BillingPlan. # noqa: E501

# noqa: E501

Returns

The plan_id of this BillingPlan. # noqa: E501

plan_name

Gets the plan_name of this BillingPlan. # noqa: E501

The name of the Billing Plan. # noqa: E501

Returns

The plan_name of this BillingPlan. # noqa: E501

seat_discounts

Gets the seat_discounts of this BillingPlan. # noqa: E501

# noqa: E501

Returns

The seat_discounts of this BillingPlan. # noqa: E501

support_incident_fee

Gets the support_incident_fee of this BillingPlan. # noqa: E501

The support incident fee charged for each support incident. # noqa: E501

Returns

The support_incident_fee of this BillingPlan. # noqa: E501

support_plan_fee

Gets the support_plan_fee of this BillingPlan. # noqa: E501

The support plan fee charged for this plan. # noqa: E501

Returns

The support_plan_fee of this BillingPlan. # noqa: E501

def to_dict(self)
456    def to_dict(self):
457        """Returns the model properties as a dict"""
458        result = {}
459
460        for attr, _ in six.iteritems(self.swagger_types):
461            value = getattr(self, attr)
462            if isinstance(value, list):
463                result[attr] = list(map(
464                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
465                    value
466                ))
467            elif hasattr(value, "to_dict"):
468                result[attr] = value.to_dict()
469            elif isinstance(value, dict):
470                result[attr] = dict(map(
471                    lambda item: (item[0], item[1].to_dict())
472                    if hasattr(item[1], "to_dict") else item,
473                    value.items()
474                ))
475            else:
476                result[attr] = value
477        if issubclass(BillingPlan, dict):
478            for key, value in self.items():
479                result[key] = value
480
481        return result

Returns the model properties as a dict

def to_str(self)
483    def to_str(self):
484        """Returns the string representation of the model"""
485        return pprint.pformat(self.to_dict())

Returns the string representation of the model