docusign_esign.models.plan_information

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 PlanInformation(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        'add_ons': 'list[AddOn]',
 37        'currency_code': 'str',
 38        'free_trial_days_override': 'str',
 39        'plan_feature_sets': 'list[FeatureSet]',
 40        'plan_id': 'str',
 41        'recipient_domains': 'list[RecipientDomain]'
 42    }
 43
 44    attribute_map = {
 45        'add_ons': 'addOns',
 46        'currency_code': 'currencyCode',
 47        'free_trial_days_override': 'freeTrialDaysOverride',
 48        'plan_feature_sets': 'planFeatureSets',
 49        'plan_id': 'planId',
 50        'recipient_domains': 'recipientDomains'
 51    }
 52
 53    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 54        """PlanInformation - a model defined in Swagger"""  # noqa: E501
 55        if _configuration is None:
 56            _configuration = Configuration()
 57        self._configuration = _configuration
 58
 59        self._add_ons = None
 60        self._currency_code = None
 61        self._free_trial_days_override = None
 62        self._plan_feature_sets = None
 63        self._plan_id = None
 64        self._recipient_domains = None
 65        self.discriminator = None
 66
 67        setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None))
 68        setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None))
 69        setattr(self, "_{}".format('free_trial_days_override'), kwargs.get('free_trial_days_override', None))
 70        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
 71        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
 72        setattr(self, "_{}".format('recipient_domains'), kwargs.get('recipient_domains', None))
 73
 74    @property
 75    def add_ons(self):
 76        """Gets the add_ons of this PlanInformation.  # noqa: E501
 77
 78        Reserved:  # noqa: E501
 79
 80        :return: The add_ons of this PlanInformation.  # noqa: E501
 81        :rtype: list[AddOn]
 82        """
 83        return self._add_ons
 84
 85    @add_ons.setter
 86    def add_ons(self, add_ons):
 87        """Sets the add_ons of this PlanInformation.
 88
 89        Reserved:  # noqa: E501
 90
 91        :param add_ons: The add_ons of this PlanInformation.  # noqa: E501
 92        :type: list[AddOn]
 93        """
 94
 95        self._add_ons = add_ons
 96
 97    @property
 98    def currency_code(self):
 99        """Gets the currency_code of this PlanInformation.  # noqa: E501
100
101        Specifies the ISO currency code for the account.  # noqa: E501
102
103        :return: The currency_code of this PlanInformation.  # noqa: E501
104        :rtype: str
105        """
106        return self._currency_code
107
108    @currency_code.setter
109    def currency_code(self, currency_code):
110        """Sets the currency_code of this PlanInformation.
111
112        Specifies the ISO currency code for the account.  # noqa: E501
113
114        :param currency_code: The currency_code of this PlanInformation.  # noqa: E501
115        :type: str
116        """
117
118        self._currency_code = currency_code
119
120    @property
121    def free_trial_days_override(self):
122        """Gets the free_trial_days_override of this PlanInformation.  # noqa: E501
123
124        Reserved for DocuSign use only.  # noqa: E501
125
126        :return: The free_trial_days_override of this PlanInformation.  # noqa: E501
127        :rtype: str
128        """
129        return self._free_trial_days_override
130
131    @free_trial_days_override.setter
132    def free_trial_days_override(self, free_trial_days_override):
133        """Sets the free_trial_days_override of this PlanInformation.
134
135        Reserved for DocuSign use only.  # noqa: E501
136
137        :param free_trial_days_override: The free_trial_days_override of this PlanInformation.  # noqa: E501
138        :type: str
139        """
140
141        self._free_trial_days_override = free_trial_days_override
142
143    @property
144    def plan_feature_sets(self):
145        """Gets the plan_feature_sets of this PlanInformation.  # noqa: E501
146
147        A complex type that sets the feature sets for the account.  # noqa: E501
148
149        :return: The plan_feature_sets of this PlanInformation.  # noqa: E501
150        :rtype: list[FeatureSet]
151        """
152        return self._plan_feature_sets
153
154    @plan_feature_sets.setter
155    def plan_feature_sets(self, plan_feature_sets):
156        """Sets the plan_feature_sets of this PlanInformation.
157
158        A complex type that sets the feature sets for the account.  # noqa: E501
159
160        :param plan_feature_sets: The plan_feature_sets of this PlanInformation.  # noqa: E501
161        :type: list[FeatureSet]
162        """
163
164        self._plan_feature_sets = plan_feature_sets
165
166    @property
167    def plan_id(self):
168        """Gets the plan_id of this PlanInformation.  # noqa: E501
169
170        The DocuSign Plan ID for the account.  # noqa: E501
171
172        :return: The plan_id of this PlanInformation.  # noqa: E501
173        :rtype: str
174        """
175        return self._plan_id
176
177    @plan_id.setter
178    def plan_id(self, plan_id):
179        """Sets the plan_id of this PlanInformation.
180
181        The DocuSign Plan ID for the account.  # noqa: E501
182
183        :param plan_id: The plan_id of this PlanInformation.  # noqa: E501
184        :type: str
185        """
186
187        self._plan_id = plan_id
188
189    @property
190    def recipient_domains(self):
191        """Gets the recipient_domains of this PlanInformation.  # noqa: E501
192
193          # noqa: E501
194
195        :return: The recipient_domains of this PlanInformation.  # noqa: E501
196        :rtype: list[RecipientDomain]
197        """
198        return self._recipient_domains
199
200    @recipient_domains.setter
201    def recipient_domains(self, recipient_domains):
202        """Sets the recipient_domains of this PlanInformation.
203
204          # noqa: E501
205
206        :param recipient_domains: The recipient_domains of this PlanInformation.  # noqa: E501
207        :type: list[RecipientDomain]
208        """
209
210        self._recipient_domains = recipient_domains
211
212    def to_dict(self):
213        """Returns the model properties as a dict"""
214        result = {}
215
216        for attr, _ in six.iteritems(self.swagger_types):
217            value = getattr(self, attr)
218            if isinstance(value, list):
219                result[attr] = list(map(
220                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
221                    value
222                ))
223            elif hasattr(value, "to_dict"):
224                result[attr] = value.to_dict()
225            elif isinstance(value, dict):
226                result[attr] = dict(map(
227                    lambda item: (item[0], item[1].to_dict())
228                    if hasattr(item[1], "to_dict") else item,
229                    value.items()
230                ))
231            else:
232                result[attr] = value
233        if issubclass(PlanInformation, dict):
234            for key, value in self.items():
235                result[key] = value
236
237        return result
238
239    def to_str(self):
240        """Returns the string representation of the model"""
241        return pprint.pformat(self.to_dict())
242
243    def __repr__(self):
244        """For `print` and `pprint`"""
245        return self.to_str()
246
247    def __eq__(self, other):
248        """Returns true if both objects are equal"""
249        if not isinstance(other, PlanInformation):
250            return False
251
252        return self.to_dict() == other.to_dict()
253
254    def __ne__(self, other):
255        """Returns true if both objects are not equal"""
256        if not isinstance(other, PlanInformation):
257            return True
258
259        return self.to_dict() != other.to_dict()
class PlanInformation:
 23class PlanInformation(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        'add_ons': 'list[AddOn]',
 38        'currency_code': 'str',
 39        'free_trial_days_override': 'str',
 40        'plan_feature_sets': 'list[FeatureSet]',
 41        'plan_id': 'str',
 42        'recipient_domains': 'list[RecipientDomain]'
 43    }
 44
 45    attribute_map = {
 46        'add_ons': 'addOns',
 47        'currency_code': 'currencyCode',
 48        'free_trial_days_override': 'freeTrialDaysOverride',
 49        'plan_feature_sets': 'planFeatureSets',
 50        'plan_id': 'planId',
 51        'recipient_domains': 'recipientDomains'
 52    }
 53
 54    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 55        """PlanInformation - a model defined in Swagger"""  # noqa: E501
 56        if _configuration is None:
 57            _configuration = Configuration()
 58        self._configuration = _configuration
 59
 60        self._add_ons = None
 61        self._currency_code = None
 62        self._free_trial_days_override = None
 63        self._plan_feature_sets = None
 64        self._plan_id = None
 65        self._recipient_domains = None
 66        self.discriminator = None
 67
 68        setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None))
 69        setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None))
 70        setattr(self, "_{}".format('free_trial_days_override'), kwargs.get('free_trial_days_override', None))
 71        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
 72        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
 73        setattr(self, "_{}".format('recipient_domains'), kwargs.get('recipient_domains', None))
 74
 75    @property
 76    def add_ons(self):
 77        """Gets the add_ons of this PlanInformation.  # noqa: E501
 78
 79        Reserved:  # noqa: E501
 80
 81        :return: The add_ons of this PlanInformation.  # noqa: E501
 82        :rtype: list[AddOn]
 83        """
 84        return self._add_ons
 85
 86    @add_ons.setter
 87    def add_ons(self, add_ons):
 88        """Sets the add_ons of this PlanInformation.
 89
 90        Reserved:  # noqa: E501
 91
 92        :param add_ons: The add_ons of this PlanInformation.  # noqa: E501
 93        :type: list[AddOn]
 94        """
 95
 96        self._add_ons = add_ons
 97
 98    @property
 99    def currency_code(self):
100        """Gets the currency_code of this PlanInformation.  # noqa: E501
101
102        Specifies the ISO currency code for the account.  # noqa: E501
103
104        :return: The currency_code of this PlanInformation.  # noqa: E501
105        :rtype: str
106        """
107        return self._currency_code
108
109    @currency_code.setter
110    def currency_code(self, currency_code):
111        """Sets the currency_code of this PlanInformation.
112
113        Specifies the ISO currency code for the account.  # noqa: E501
114
115        :param currency_code: The currency_code of this PlanInformation.  # noqa: E501
116        :type: str
117        """
118
119        self._currency_code = currency_code
120
121    @property
122    def free_trial_days_override(self):
123        """Gets the free_trial_days_override of this PlanInformation.  # noqa: E501
124
125        Reserved for DocuSign use only.  # noqa: E501
126
127        :return: The free_trial_days_override of this PlanInformation.  # noqa: E501
128        :rtype: str
129        """
130        return self._free_trial_days_override
131
132    @free_trial_days_override.setter
133    def free_trial_days_override(self, free_trial_days_override):
134        """Sets the free_trial_days_override of this PlanInformation.
135
136        Reserved for DocuSign use only.  # noqa: E501
137
138        :param free_trial_days_override: The free_trial_days_override of this PlanInformation.  # noqa: E501
139        :type: str
140        """
141
142        self._free_trial_days_override = free_trial_days_override
143
144    @property
145    def plan_feature_sets(self):
146        """Gets the plan_feature_sets of this PlanInformation.  # noqa: E501
147
148        A complex type that sets the feature sets for the account.  # noqa: E501
149
150        :return: The plan_feature_sets of this PlanInformation.  # noqa: E501
151        :rtype: list[FeatureSet]
152        """
153        return self._plan_feature_sets
154
155    @plan_feature_sets.setter
156    def plan_feature_sets(self, plan_feature_sets):
157        """Sets the plan_feature_sets of this PlanInformation.
158
159        A complex type that sets the feature sets for the account.  # noqa: E501
160
161        :param plan_feature_sets: The plan_feature_sets of this PlanInformation.  # noqa: E501
162        :type: list[FeatureSet]
163        """
164
165        self._plan_feature_sets = plan_feature_sets
166
167    @property
168    def plan_id(self):
169        """Gets the plan_id of this PlanInformation.  # noqa: E501
170
171        The DocuSign Plan ID for the account.  # noqa: E501
172
173        :return: The plan_id of this PlanInformation.  # noqa: E501
174        :rtype: str
175        """
176        return self._plan_id
177
178    @plan_id.setter
179    def plan_id(self, plan_id):
180        """Sets the plan_id of this PlanInformation.
181
182        The DocuSign Plan ID for the account.  # noqa: E501
183
184        :param plan_id: The plan_id of this PlanInformation.  # noqa: E501
185        :type: str
186        """
187
188        self._plan_id = plan_id
189
190    @property
191    def recipient_domains(self):
192        """Gets the recipient_domains of this PlanInformation.  # noqa: E501
193
194          # noqa: E501
195
196        :return: The recipient_domains of this PlanInformation.  # noqa: E501
197        :rtype: list[RecipientDomain]
198        """
199        return self._recipient_domains
200
201    @recipient_domains.setter
202    def recipient_domains(self, recipient_domains):
203        """Sets the recipient_domains of this PlanInformation.
204
205          # noqa: E501
206
207        :param recipient_domains: The recipient_domains of this PlanInformation.  # noqa: E501
208        :type: list[RecipientDomain]
209        """
210
211        self._recipient_domains = recipient_domains
212
213    def to_dict(self):
214        """Returns the model properties as a dict"""
215        result = {}
216
217        for attr, _ in six.iteritems(self.swagger_types):
218            value = getattr(self, attr)
219            if isinstance(value, list):
220                result[attr] = list(map(
221                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
222                    value
223                ))
224            elif hasattr(value, "to_dict"):
225                result[attr] = value.to_dict()
226            elif isinstance(value, dict):
227                result[attr] = dict(map(
228                    lambda item: (item[0], item[1].to_dict())
229                    if hasattr(item[1], "to_dict") else item,
230                    value.items()
231                ))
232            else:
233                result[attr] = value
234        if issubclass(PlanInformation, dict):
235            for key, value in self.items():
236                result[key] = value
237
238        return result
239
240    def to_str(self):
241        """Returns the string representation of the model"""
242        return pprint.pformat(self.to_dict())
243
244    def __repr__(self):
245        """For `print` and `pprint`"""
246        return self.to_str()
247
248    def __eq__(self, other):
249        """Returns true if both objects are equal"""
250        if not isinstance(other, PlanInformation):
251            return False
252
253        return self.to_dict() == other.to_dict()
254
255    def __ne__(self, other):
256        """Returns true if both objects are not equal"""
257        if not isinstance(other, PlanInformation):
258            return True
259
260        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.

PlanInformation(_configuration=None, **kwargs)
54    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
55        """PlanInformation - a model defined in Swagger"""  # noqa: E501
56        if _configuration is None:
57            _configuration = Configuration()
58        self._configuration = _configuration
59
60        self._add_ons = None
61        self._currency_code = None
62        self._free_trial_days_override = None
63        self._plan_feature_sets = None
64        self._plan_id = None
65        self._recipient_domains = None
66        self.discriminator = None
67
68        setattr(self, "_{}".format('add_ons'), kwargs.get('add_ons', None))
69        setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None))
70        setattr(self, "_{}".format('free_trial_days_override'), kwargs.get('free_trial_days_override', None))
71        setattr(self, "_{}".format('plan_feature_sets'), kwargs.get('plan_feature_sets', None))
72        setattr(self, "_{}".format('plan_id'), kwargs.get('plan_id', None))
73        setattr(self, "_{}".format('recipient_domains'), kwargs.get('recipient_domains', None))

PlanInformation - a model defined in Swagger

swagger_types = {'add_ons': 'list[AddOn]', 'currency_code': 'str', 'free_trial_days_override': 'str', 'plan_feature_sets': 'list[FeatureSet]', 'plan_id': 'str', 'recipient_domains': 'list[RecipientDomain]'}
attribute_map = {'add_ons': 'addOns', 'currency_code': 'currencyCode', 'free_trial_days_override': 'freeTrialDaysOverride', 'plan_feature_sets': 'planFeatureSets', 'plan_id': 'planId', 'recipient_domains': 'recipientDomains'}
add_ons

Gets the add_ons of this PlanInformation. # noqa: E501

Reserved: # noqa: E501

Returns

The add_ons of this PlanInformation. # noqa: E501

currency_code

Gets the currency_code of this PlanInformation. # noqa: E501

Specifies the ISO currency code for the account. # noqa: E501

Returns

The currency_code of this PlanInformation. # noqa: E501

free_trial_days_override

Gets the free_trial_days_override of this PlanInformation. # noqa: E501

Reserved for DocuSign use only. # noqa: E501

Returns

The free_trial_days_override of this PlanInformation. # noqa: E501

plan_feature_sets

Gets the plan_feature_sets of this PlanInformation. # noqa: E501

A complex type that sets the feature sets for the account. # noqa: E501

Returns

The plan_feature_sets of this PlanInformation. # noqa: E501

plan_id

Gets the plan_id of this PlanInformation. # noqa: E501

The DocuSign Plan ID for the account. # noqa: E501

Returns

The plan_id of this PlanInformation. # noqa: E501

recipient_domains

Gets the recipient_domains of this PlanInformation. # noqa: E501

# noqa: E501

Returns

The recipient_domains of this PlanInformation. # noqa: E501

def to_dict(self)
213    def to_dict(self):
214        """Returns the model properties as a dict"""
215        result = {}
216
217        for attr, _ in six.iteritems(self.swagger_types):
218            value = getattr(self, attr)
219            if isinstance(value, list):
220                result[attr] = list(map(
221                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
222                    value
223                ))
224            elif hasattr(value, "to_dict"):
225                result[attr] = value.to_dict()
226            elif isinstance(value, dict):
227                result[attr] = dict(map(
228                    lambda item: (item[0], item[1].to_dict())
229                    if hasattr(item[1], "to_dict") else item,
230                    value.items()
231                ))
232            else:
233                result[attr] = value
234        if issubclass(PlanInformation, dict):
235            for key, value in self.items():
236                result[key] = value
237
238        return result

Returns the model properties as a dict

def to_str(self)
240    def to_str(self):
241        """Returns the string representation of the model"""
242        return pprint.pformat(self.to_dict())

Returns the string representation of the model