docusign_esign.models.purchased_envelopes_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 PurchasedEnvelopesInformation(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        'amount': 'str',
 37        'app_name': 'str',
 38        'currency_code': 'str',
 39        'platform': 'str',
 40        'product_id': 'str',
 41        'quantity': 'str',
 42        'receipt_data': 'str',
 43        'store_name': 'str',
 44        'transaction_id': 'str'
 45    }
 46
 47    attribute_map = {
 48        'amount': 'amount',
 49        'app_name': 'appName',
 50        'currency_code': 'currencyCode',
 51        'platform': 'platform',
 52        'product_id': 'productId',
 53        'quantity': 'quantity',
 54        'receipt_data': 'receiptData',
 55        'store_name': 'storeName',
 56        'transaction_id': 'transactionId'
 57    }
 58
 59    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 60        """PurchasedEnvelopesInformation - a model defined in Swagger"""  # noqa: E501
 61        if _configuration is None:
 62            _configuration = Configuration()
 63        self._configuration = _configuration
 64
 65        self._amount = None
 66        self._app_name = None
 67        self._currency_code = None
 68        self._platform = None
 69        self._product_id = None
 70        self._quantity = None
 71        self._receipt_data = None
 72        self._store_name = None
 73        self._transaction_id = None
 74        self.discriminator = None
 75
 76        setattr(self, "_{}".format('amount'), kwargs.get('amount', None))
 77        setattr(self, "_{}".format('app_name'), kwargs.get('app_name', None))
 78        setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None))
 79        setattr(self, "_{}".format('platform'), kwargs.get('platform', None))
 80        setattr(self, "_{}".format('product_id'), kwargs.get('product_id', None))
 81        setattr(self, "_{}".format('quantity'), kwargs.get('quantity', None))
 82        setattr(self, "_{}".format('receipt_data'), kwargs.get('receipt_data', None))
 83        setattr(self, "_{}".format('store_name'), kwargs.get('store_name', None))
 84        setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None))
 85
 86    @property
 87    def amount(self):
 88        """Gets the amount of this PurchasedEnvelopesInformation.  # noqa: E501
 89
 90        The total amount of the purchase.  # noqa: E501
 91
 92        :return: The amount of this PurchasedEnvelopesInformation.  # noqa: E501
 93        :rtype: str
 94        """
 95        return self._amount
 96
 97    @amount.setter
 98    def amount(self, amount):
 99        """Sets the amount of this PurchasedEnvelopesInformation.
100
101        The total amount of the purchase.  # noqa: E501
102
103        :param amount: The amount of this PurchasedEnvelopesInformation.  # noqa: E501
104        :type: str
105        """
106
107        self._amount = amount
108
109    @property
110    def app_name(self):
111        """Gets the app_name of this PurchasedEnvelopesInformation.  # noqa: E501
112
113        The AppName of the client application.  # noqa: E501
114
115        :return: The app_name of this PurchasedEnvelopesInformation.  # noqa: E501
116        :rtype: str
117        """
118        return self._app_name
119
120    @app_name.setter
121    def app_name(self, app_name):
122        """Sets the app_name of this PurchasedEnvelopesInformation.
123
124        The AppName of the client application.  # noqa: E501
125
126        :param app_name: The app_name of this PurchasedEnvelopesInformation.  # noqa: E501
127        :type: str
128        """
129
130        self._app_name = app_name
131
132    @property
133    def currency_code(self):
134        """Gets the currency_code of this PurchasedEnvelopesInformation.  # noqa: E501
135
136        Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information.  # noqa: E501
137
138        :return: The currency_code of this PurchasedEnvelopesInformation.  # noqa: E501
139        :rtype: str
140        """
141        return self._currency_code
142
143    @currency_code.setter
144    def currency_code(self, currency_code):
145        """Sets the currency_code of this PurchasedEnvelopesInformation.
146
147        Specifies the ISO currency code of the purchase. This is based on the ISO 4217 currency code information.  # noqa: E501
148
149        :param currency_code: The currency_code of this PurchasedEnvelopesInformation.  # noqa: E501
150        :type: str
151        """
152
153        self._currency_code = currency_code
154
155    @property
156    def platform(self):
157        """Gets the platform of this PurchasedEnvelopesInformation.  # noqa: E501
158
159        The Platform of the client application  # noqa: E501
160
161        :return: The platform of this PurchasedEnvelopesInformation.  # noqa: E501
162        :rtype: str
163        """
164        return self._platform
165
166    @platform.setter
167    def platform(self, platform):
168        """Sets the platform of this PurchasedEnvelopesInformation.
169
170        The Platform of the client application  # noqa: E501
171
172        :param platform: The platform of this PurchasedEnvelopesInformation.  # noqa: E501
173        :type: str
174        """
175
176        self._platform = platform
177
178    @property
179    def product_id(self):
180        """Gets the product_id of this PurchasedEnvelopesInformation.  # noqa: E501
181
182        The Product ID from the AppStore.  # noqa: E501
183
184        :return: The product_id of this PurchasedEnvelopesInformation.  # noqa: E501
185        :rtype: str
186        """
187        return self._product_id
188
189    @product_id.setter
190    def product_id(self, product_id):
191        """Sets the product_id of this PurchasedEnvelopesInformation.
192
193        The Product ID from the AppStore.  # noqa: E501
194
195        :param product_id: The product_id of this PurchasedEnvelopesInformation.  # noqa: E501
196        :type: str
197        """
198
199        self._product_id = product_id
200
201    @property
202    def quantity(self):
203        """Gets the quantity of this PurchasedEnvelopesInformation.  # noqa: E501
204
205        The quantity of envelopes to add to the account.  # noqa: E501
206
207        :return: The quantity of this PurchasedEnvelopesInformation.  # noqa: E501
208        :rtype: str
209        """
210        return self._quantity
211
212    @quantity.setter
213    def quantity(self, quantity):
214        """Sets the quantity of this PurchasedEnvelopesInformation.
215
216        The quantity of envelopes to add to the account.  # noqa: E501
217
218        :param quantity: The quantity of this PurchasedEnvelopesInformation.  # noqa: E501
219        :type: str
220        """
221
222        self._quantity = quantity
223
224    @property
225    def receipt_data(self):
226        """Gets the receipt_data of this PurchasedEnvelopesInformation.  # noqa: E501
227
228        The encrypted Base64 encoded receipt data.  # noqa: E501
229
230        :return: The receipt_data of this PurchasedEnvelopesInformation.  # noqa: E501
231        :rtype: str
232        """
233        return self._receipt_data
234
235    @receipt_data.setter
236    def receipt_data(self, receipt_data):
237        """Sets the receipt_data of this PurchasedEnvelopesInformation.
238
239        The encrypted Base64 encoded receipt data.  # noqa: E501
240
241        :param receipt_data: The receipt_data of this PurchasedEnvelopesInformation.  # noqa: E501
242        :type: str
243        """
244
245        self._receipt_data = receipt_data
246
247    @property
248    def store_name(self):
249        """Gets the store_name of this PurchasedEnvelopesInformation.  # noqa: E501
250
251        The name of the AppStore.  # noqa: E501
252
253        :return: The store_name of this PurchasedEnvelopesInformation.  # noqa: E501
254        :rtype: str
255        """
256        return self._store_name
257
258    @store_name.setter
259    def store_name(self, store_name):
260        """Sets the store_name of this PurchasedEnvelopesInformation.
261
262        The name of the AppStore.  # noqa: E501
263
264        :param store_name: The store_name of this PurchasedEnvelopesInformation.  # noqa: E501
265        :type: str
266        """
267
268        self._store_name = store_name
269
270    @property
271    def transaction_id(self):
272        """Gets the transaction_id of this PurchasedEnvelopesInformation.  # noqa: E501
273
274        Specifies the Transaction ID from the AppStore.  # noqa: E501
275
276        :return: The transaction_id of this PurchasedEnvelopesInformation.  # noqa: E501
277        :rtype: str
278        """
279        return self._transaction_id
280
281    @transaction_id.setter
282    def transaction_id(self, transaction_id):
283        """Sets the transaction_id of this PurchasedEnvelopesInformation.
284
285        Specifies the Transaction ID from the AppStore.  # noqa: E501
286
287        :param transaction_id: The transaction_id of this PurchasedEnvelopesInformation.  # noqa: E501
288        :type: str
289        """
290
291        self._transaction_id = transaction_id
292
293    def to_dict(self):
294        """Returns the model properties as a dict"""
295        result = {}
296
297        for attr, _ in six.iteritems(self.swagger_types):
298            value = getattr(self, attr)
299            if isinstance(value, list):
300                result[attr] = list(map(
301                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
302                    value
303                ))
304            elif hasattr(value, "to_dict"):
305                result[attr] = value.to_dict()
306            elif isinstance(value, dict):
307                result[attr] = dict(map(
308                    lambda item: (item[0], item[1].to_dict())
309                    if hasattr(item[1], "to_dict") else item,
310                    value.items()
311                ))
312            else:
313                result[attr] = value
314        if issubclass(PurchasedEnvelopesInformation, dict):
315            for key, value in self.items():
316                result[key] = value
317
318        return result
319
320    def to_str(self):
321        """Returns the string representation of the model"""
322        return pprint.pformat(self.to_dict())
323
324    def __repr__(self):
325        """For `print` and `pprint`"""
326        return self.to_str()
327
328    def __eq__(self, other):
329        """Returns true if both objects are equal"""
330        if not isinstance(other, PurchasedEnvelopesInformation):
331            return False
332
333        return self.to_dict() == other.to_dict()
334
335    def __ne__(self, other):
336        """Returns true if both objects are not equal"""
337        if not isinstance(other, PurchasedEnvelopesInformation):
338            return True
339
340        return self.to_dict() != other.to_dict()