docusign_esign.models.billing_invoice

  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 BillingInvoice(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        'balance': 'str',
 38        'due_date': 'str',
 39        'invoice_id': 'str',
 40        'invoice_items': 'list[BillingInvoiceItem]',
 41        'invoice_number': 'str',
 42        'invoice_uri': 'str',
 43        'non_taxable_amount': 'str',
 44        'pdf_available': 'str',
 45        'taxable_amount': 'str'
 46    }
 47
 48    attribute_map = {
 49        'amount': 'amount',
 50        'balance': 'balance',
 51        'due_date': 'dueDate',
 52        'invoice_id': 'invoiceId',
 53        'invoice_items': 'invoiceItems',
 54        'invoice_number': 'invoiceNumber',
 55        'invoice_uri': 'invoiceUri',
 56        'non_taxable_amount': 'nonTaxableAmount',
 57        'pdf_available': 'pdfAvailable',
 58        'taxable_amount': 'taxableAmount'
 59    }
 60
 61    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 62        """BillingInvoice - a model defined in Swagger"""  # noqa: E501
 63        if _configuration is None:
 64            _configuration = Configuration()
 65        self._configuration = _configuration
 66
 67        self._amount = None
 68        self._balance = None
 69        self._due_date = None
 70        self._invoice_id = None
 71        self._invoice_items = None
 72        self._invoice_number = None
 73        self._invoice_uri = None
 74        self._non_taxable_amount = None
 75        self._pdf_available = None
 76        self._taxable_amount = None
 77        self.discriminator = None
 78
 79        setattr(self, "_{}".format('amount'), kwargs.get('amount', None))
 80        setattr(self, "_{}".format('balance'), kwargs.get('balance', None))
 81        setattr(self, "_{}".format('due_date'), kwargs.get('due_date', None))
 82        setattr(self, "_{}".format('invoice_id'), kwargs.get('invoice_id', None))
 83        setattr(self, "_{}".format('invoice_items'), kwargs.get('invoice_items', None))
 84        setattr(self, "_{}".format('invoice_number'), kwargs.get('invoice_number', None))
 85        setattr(self, "_{}".format('invoice_uri'), kwargs.get('invoice_uri', None))
 86        setattr(self, "_{}".format('non_taxable_amount'), kwargs.get('non_taxable_amount', None))
 87        setattr(self, "_{}".format('pdf_available'), kwargs.get('pdf_available', None))
 88        setattr(self, "_{}".format('taxable_amount'), kwargs.get('taxable_amount', None))
 89
 90    @property
 91    def amount(self):
 92        """Gets the amount of this BillingInvoice.  # noqa: E501
 93
 94        Reserved: TBD  # noqa: E501
 95
 96        :return: The amount of this BillingInvoice.  # noqa: E501
 97        :rtype: str
 98        """
 99        return self._amount
100
101    @amount.setter
102    def amount(self, amount):
103        """Sets the amount of this BillingInvoice.
104
105        Reserved: TBD  # noqa: E501
106
107        :param amount: The amount of this BillingInvoice.  # noqa: E501
108        :type: str
109        """
110
111        self._amount = amount
112
113    @property
114    def balance(self):
115        """Gets the balance of this BillingInvoice.  # noqa: E501
116
117        Reserved: TBD  # noqa: E501
118
119        :return: The balance of this BillingInvoice.  # noqa: E501
120        :rtype: str
121        """
122        return self._balance
123
124    @balance.setter
125    def balance(self, balance):
126        """Sets the balance of this BillingInvoice.
127
128        Reserved: TBD  # noqa: E501
129
130        :param balance: The balance of this BillingInvoice.  # noqa: E501
131        :type: str
132        """
133
134        self._balance = balance
135
136    @property
137    def due_date(self):
138        """Gets the due_date of this BillingInvoice.  # noqa: E501
139
140        Reserved: TBD  # noqa: E501
141
142        :return: The due_date of this BillingInvoice.  # noqa: E501
143        :rtype: str
144        """
145        return self._due_date
146
147    @due_date.setter
148    def due_date(self, due_date):
149        """Sets the due_date of this BillingInvoice.
150
151        Reserved: TBD  # noqa: E501
152
153        :param due_date: The due_date of this BillingInvoice.  # noqa: E501
154        :type: str
155        """
156
157        self._due_date = due_date
158
159    @property
160    def invoice_id(self):
161        """Gets the invoice_id of this BillingInvoice.  # noqa: E501
162
163        Reserved: TBD  # noqa: E501
164
165        :return: The invoice_id of this BillingInvoice.  # noqa: E501
166        :rtype: str
167        """
168        return self._invoice_id
169
170    @invoice_id.setter
171    def invoice_id(self, invoice_id):
172        """Sets the invoice_id of this BillingInvoice.
173
174        Reserved: TBD  # noqa: E501
175
176        :param invoice_id: The invoice_id of this BillingInvoice.  # noqa: E501
177        :type: str
178        """
179
180        self._invoice_id = invoice_id
181
182    @property
183    def invoice_items(self):
184        """Gets the invoice_items of this BillingInvoice.  # noqa: E501
185
186        Reserved: TBD  # noqa: E501
187
188        :return: The invoice_items of this BillingInvoice.  # noqa: E501
189        :rtype: list[BillingInvoiceItem]
190        """
191        return self._invoice_items
192
193    @invoice_items.setter
194    def invoice_items(self, invoice_items):
195        """Sets the invoice_items of this BillingInvoice.
196
197        Reserved: TBD  # noqa: E501
198
199        :param invoice_items: The invoice_items of this BillingInvoice.  # noqa: E501
200        :type: list[BillingInvoiceItem]
201        """
202
203        self._invoice_items = invoice_items
204
205    @property
206    def invoice_number(self):
207        """Gets the invoice_number of this BillingInvoice.  # noqa: E501
208
209        Reserved: TBD  # noqa: E501
210
211        :return: The invoice_number of this BillingInvoice.  # noqa: E501
212        :rtype: str
213        """
214        return self._invoice_number
215
216    @invoice_number.setter
217    def invoice_number(self, invoice_number):
218        """Sets the invoice_number of this BillingInvoice.
219
220        Reserved: TBD  # noqa: E501
221
222        :param invoice_number: The invoice_number of this BillingInvoice.  # noqa: E501
223        :type: str
224        """
225
226        self._invoice_number = invoice_number
227
228    @property
229    def invoice_uri(self):
230        """Gets the invoice_uri of this BillingInvoice.  # noqa: E501
231
232        Contains a URI for an endpoint that you can use to retrieve invoice information.  # noqa: E501
233
234        :return: The invoice_uri of this BillingInvoice.  # noqa: E501
235        :rtype: str
236        """
237        return self._invoice_uri
238
239    @invoice_uri.setter
240    def invoice_uri(self, invoice_uri):
241        """Sets the invoice_uri of this BillingInvoice.
242
243        Contains a URI for an endpoint that you can use to retrieve invoice information.  # noqa: E501
244
245        :param invoice_uri: The invoice_uri of this BillingInvoice.  # noqa: E501
246        :type: str
247        """
248
249        self._invoice_uri = invoice_uri
250
251    @property
252    def non_taxable_amount(self):
253        """Gets the non_taxable_amount of this BillingInvoice.  # noqa: E501
254
255          # noqa: E501
256
257        :return: The non_taxable_amount of this BillingInvoice.  # noqa: E501
258        :rtype: str
259        """
260        return self._non_taxable_amount
261
262    @non_taxable_amount.setter
263    def non_taxable_amount(self, non_taxable_amount):
264        """Sets the non_taxable_amount of this BillingInvoice.
265
266          # noqa: E501
267
268        :param non_taxable_amount: The non_taxable_amount of this BillingInvoice.  # noqa: E501
269        :type: str
270        """
271
272        self._non_taxable_amount = non_taxable_amount
273
274    @property
275    def pdf_available(self):
276        """Gets the pdf_available of this BillingInvoice.  # noqa: E501
277
278          # noqa: E501
279
280        :return: The pdf_available of this BillingInvoice.  # noqa: E501
281        :rtype: str
282        """
283        return self._pdf_available
284
285    @pdf_available.setter
286    def pdf_available(self, pdf_available):
287        """Sets the pdf_available of this BillingInvoice.
288
289          # noqa: E501
290
291        :param pdf_available: The pdf_available of this BillingInvoice.  # noqa: E501
292        :type: str
293        """
294
295        self._pdf_available = pdf_available
296
297    @property
298    def taxable_amount(self):
299        """Gets the taxable_amount of this BillingInvoice.  # noqa: E501
300
301          # noqa: E501
302
303        :return: The taxable_amount of this BillingInvoice.  # noqa: E501
304        :rtype: str
305        """
306        return self._taxable_amount
307
308    @taxable_amount.setter
309    def taxable_amount(self, taxable_amount):
310        """Sets the taxable_amount of this BillingInvoice.
311
312          # noqa: E501
313
314        :param taxable_amount: The taxable_amount of this BillingInvoice.  # noqa: E501
315        :type: str
316        """
317
318        self._taxable_amount = taxable_amount
319
320    def to_dict(self):
321        """Returns the model properties as a dict"""
322        result = {}
323
324        for attr, _ in six.iteritems(self.swagger_types):
325            value = getattr(self, attr)
326            if isinstance(value, list):
327                result[attr] = list(map(
328                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
329                    value
330                ))
331            elif hasattr(value, "to_dict"):
332                result[attr] = value.to_dict()
333            elif isinstance(value, dict):
334                result[attr] = dict(map(
335                    lambda item: (item[0], item[1].to_dict())
336                    if hasattr(item[1], "to_dict") else item,
337                    value.items()
338                ))
339            else:
340                result[attr] = value
341        if issubclass(BillingInvoice, dict):
342            for key, value in self.items():
343                result[key] = value
344
345        return result
346
347    def to_str(self):
348        """Returns the string representation of the model"""
349        return pprint.pformat(self.to_dict())
350
351    def __repr__(self):
352        """For `print` and `pprint`"""
353        return self.to_str()
354
355    def __eq__(self, other):
356        """Returns true if both objects are equal"""
357        if not isinstance(other, BillingInvoice):
358            return False
359
360        return self.to_dict() == other.to_dict()
361
362    def __ne__(self, other):
363        """Returns true if both objects are not equal"""
364        if not isinstance(other, BillingInvoice):
365            return True
366
367        return self.to_dict() != other.to_dict()