xero-python 6.1.0__tar.gz → 6.3.0__tar.gz

{xero_python-6.1.0 → xero_python-6.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero_python
-Version: 6.1.0
+Version: 6.3.0
 Summary: Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
 Author: Xero Developer API
 Author-email: api@xero.com

{xero_python-6.1.0 → xero_python-6.3.0}/setup.cfg

@@ -3,6 +3,7 @@ universal = 1
 
 [flake8]
 max-line-length = 88
+ignore = E741, E501, F401, W503
 exclude = 
 	cassettes,
 extend-ignore = 

{xero_python-6.1.0 → xero_python-6.3.0}/setup.py

@@ -48,5 +48,5 @@ setup(
     keywords="xero python sdk API oAuth",
     name="xero_python",
     packages=find_packages(include=["xero_python", "xero_python.*"]),
-    version="6.1.0",
+    version="6.3.0",
 )

{xero_python-6.1.0 → xero_python-6.3.0}/tests/accounting/api/test_accounting_api.py

@@ -31,6 +31,7 @@ from xero_python.accounting import (
     Attachment,
 )
 from xero_python.api_client import ApiClient
+from xero_python.assets import Pagination
 from xero_python.rest import RESTClientObject
 
 
@@ -43,7 +44,7 @@ def accounting_api(api_client):
 def sandbox_accounting_api(api_client):
     return AccountingApi(
         api_client=api_client,
-        base_url="https://25faf04a-c71e-40e7-b7ce-f1fae0149465.mock.pstmn.io/api.xro/2.0",
+        base_url="http://127.0.0.1:4010",
     )
 
 
@@ -339,31 +340,27 @@ def test_get_account_attachments(sandbox_accounting_api: AccountingApi, xero_ten
 def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
     # Given sandbox API, tenant id, and hardcoded test invoices data
     # When getting all invoices
-    result = sandbox_accounting_api.get_invoices(xero_tenant_id)
+    result: Invoices = sandbox_accounting_api.get_invoices(xero_tenant_id)
     # Then expect correct invoices received
-    expected = Invoices(
+    expected = Invoices (
         invoices=[
             Invoice(
-                amount_credited=Decimal("0.00"),
-                amount_due=Decimal("0.00"),
-                amount_paid=Decimal("0.00"),
+                amount_credited = Decimal(0),
+                amount_due = Decimal(0),
+                amount_paid= Decimal(0),
                 contact=Contact(
+                    addresses=[],
+                    contact_groups=[],
                     contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
+                    contact_persons=[],
                     has_attachments=False,
                     has_validation_errors=False,
                     name="Barney Rubble-83203",
-                    addresses=[],
-                    contact_groups=[],
-                    contact_persons=[],
                     phones=[],
                 ),
                 credit_notes=[],
-                line_items=[],
-                overpayments=[],
-                payments=[],
-                prepayments=[],
                 currency_code=CurrencyCode.NZD,
-                currency_rate=Decimal("1.000000"),
+                currency_rate=Decimal(1),
                 date=datetime.date(2018, 10, 20),
                 due_date=datetime.date(2018, 12, 30),
                 has_attachments=False,
@@ -372,38 +369,37 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 invoice_number="INV-0001",
                 is_discounted=False,
                 line_amount_types=LineAmountTypes.EXCLUSIVE,
+                line_items=[],
+                overpayments=[],
+                payments=[],
+                prepayments=[],
                 reference="Red Fish, Blue Fish",
                 repeating_invoice_id="428c0d75-909f-4b04-8403-a48dc27283b0",
                 sent_to_contact=True,
                 status="VOIDED",
-                sub_total=Decimal("40.00"),
-                total=Decimal("40.00"),
-                total_tax=Decimal("0.00"),
+                sub_total=Decimal(40),
+                total=Decimal(40),
+                total_tax=Decimal(0),
                 type="ACCREC",
-                updated_date_utc=datetime.datetime(
-                    2018, 11, 2, 16, 31, 30, 160000, tzinfo=tz.UTC
-                ),
+                updated_date_utc=datetime.datetime(2018, 11, 2, 16, 31, 30, 160000, tzinfo=tz.UTC),
             ),
             Invoice(
-                amount_credited=Decimal("0.00"),
-                amount_due=Decimal("0.00"),
-                amount_paid=Decimal("46.00"),
+                amount_credited=Decimal(0),
+                amount_due=Decimal(0),
+                amount_paid=Decimal(46),
                 contact=Contact(
+                    addresses=[],
+                    contact_groups=[],
                     contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
+                    contact_persons=[],
                     has_attachments=False,
                     has_validation_errors=False,
                     name="Barney Rubble-83203",
-                    addresses=[],
-                    contact_groups=[],
-                    contact_persons=[],
                     phones=[],
                 ),
                 credit_notes=[],
-                line_items=[],
-                overpayments=[],
-                prepayments=[],
                 currency_code=CurrencyCode.NZD,
-                currency_rate=Decimal("1.000000"),
+                currency_rate=Decimal(1),
                 date=datetime.date(2018, 10, 20),
                 due_date=datetime.date(2018, 12, 30),
                 fully_paid_on_date=datetime.date(2018, 11, 29),
@@ -413,70 +409,75 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 invoice_number="INV-0002",
                 is_discounted=False,
                 line_amount_types=LineAmountTypes.EXCLUSIVE,
+                line_items=[],
+                overpayments=[],
                 payments=[
                     Payment(
-                        amount=Decimal("46.00"),
-                        currency_rate=Decimal("1.000000"),
+                        amount=Decimal(46),
+                        currency_rate=Decimal(1),
                         date=datetime.date(2018, 11, 29),
                         has_account=False,
                         has_validation_errors=False,
                         payment_id="99ea7f6b-c513-4066-bc27-b7c65dcd76c2",
                     )
-                ],
+                    ],
+                prepayments=[],
                 reference="Red Fish, Blue Fish",
+                #repeating_invoice_id="428c0d75-909f-4b04-8403-a48dc27283b0",
                 sent_to_contact=True,
                 status="PAID",
-                sub_total=Decimal("40.00"),
-                total=Decimal("46.00"),
-                total_tax=Decimal("6.00"),
+                sub_total=Decimal(40),
+                total=Decimal(46),
+                total_tax=Decimal(6),
                 type="ACCREC",
-                updated_date_utc=datetime.datetime(
-                    2018, 11, 2, 16, 36, 32, 690000, tzinfo=tz.UTC
-                ),
+                updated_date_utc=datetime.datetime(2018, 11, 2, 16, 36, 32, 690000, tzinfo=tz.UTC),
             ),
             Invoice(
-                amount_credited=Decimal("0.00"),
-                amount_due=Decimal("115.00"),
-                amount_paid=Decimal("0.00"),
+                amount_credited=Decimal(0),
+                amount_due=Decimal(115),
+                amount_paid=Decimal(0),
                 contact=Contact(
+                    addresses=[],
+                    contact_groups=[],
                     contact_id="a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
+                    contact_persons=[],
                     has_attachments=False,
                     has_validation_errors=False,
                     name="Barney Rubble-83203",
-                    addresses=[],
-                    contact_groups=[],
-                    contact_persons=[],
                     phones=[],
                 ),
                 credit_notes=[],
-                line_items=[],
-                overpayments=[],
-                payments=[],
-                prepayments=[],
                 currency_code=CurrencyCode.NZD,
-                currency_rate=Decimal("1.000000"),
+                currency_rate=Decimal(1),
                 date=datetime.date(2018, 11, 2),
                 due_date=datetime.date(2018, 11, 7),
                 has_attachments=False,
                 has_errors=False,
-                invoice_id="7ef31b20-de17-4312-8382-412f869b1510",
                 invoice_number="INV-0003",
+                invoice_id="7ef31b20-de17-4312-8382-412f869b1510",
                 is_discounted=False,
                 line_amount_types=LineAmountTypes.EXCLUSIVE,
+                line_items=[],
+                overpayments=[],
+                payments=[],
+                prepayments=[],
                 reference="",
                 status="AUTHORISED",
-                sub_total=Decimal("100.00"),
-                total=Decimal("115.00"),
-                total_tax=Decimal("15.00"),
+                sub_total=Decimal(100),
+                total=Decimal(115),
+                total_tax=Decimal(15),
                 type="ACCREC",
-                updated_date_utc=datetime.datetime(
-                    2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC
-                ),
-            ),
+                updated_date_utc=datetime.datetime(2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC)
+            )
         ],
+        pagination= Pagination(
+            item_count= 3,
+            page = 1,
+            page_count= 1,
+            page_size= 100
+        )
     )
-    assert result == expected
-
+    assert str(result) == str(expected)
 
 @pytest.mark.sandbox
 def test_get_invoice_history(sandbox_accounting_api: AccountingApi, xero_tenant_id):
@@ -485,7 +486,22 @@ def test_get_invoice_history(sandbox_accounting_api: AccountingApi, xero_tenant_
     # When getting invoice history
     result = sandbox_accounting_api.get_invoice_history(xero_tenant_id, invoice_id)
     # Then expect invoice history to be received
-    expected = HistoryRecords()  # todo confirm empty response from sandbox is correct
+    expected = HistoryRecords(
+        [
+            HistoryRecord(
+                changes="Attached a file",
+                date_utc= datetime.datetime(2018, 11, 8, 15, 1, 21, 470000, tzinfo=tz.UTC),
+                details= "Attached the file sample2.jpg through the Xero API using Xero API Partner",
+                user="System Generated",
+            ),
+            HistoryRecord(
+                changes="Credit Applied",
+                date_utc=datetime.datetime(2016, 10, 17, 20, 46, 1, 173000, tzinfo=tz.UTC),
+                details="Bank transfer from Business Wells Fargo to My Savings on November 12, 2016 for 20.00.",
+                user="System Generated",
+            )
+        ]
+    )
     assert result == expected
 
 
@@ -647,7 +663,12 @@ def test_create_invoice_history(sandbox_accounting_api: AccountingApi, xero_tena
         xero_tenant_id, invoice_id, history_records
     )
     # Then expect created invoice history records
-    expected = HistoryRecords()  # todo confirm empty response from sandbox is correct
+    expected = HistoryRecords(
+        [HistoryRecord(
+            date_utc=datetime.datetime(2019, 2, 23, 5, 23, 20, 362000, tzinfo=tz.UTC),
+            details="Hello World"
+        )]
+    )
     assert result == expected
 
 

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Xero Developer API"""
 __email__ = "api@xero.com"
-__version__ = "6.1.0"
+__version__ = "6.3.0"

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/accounting/__init__.py

@@ -85,6 +85,7 @@ from xero_python.accounting.models.import_summary_organisation import (
     ImportSummaryOrganisation,
 )
 from xero_python.accounting.models.invoice import Invoice
+from xero_python.accounting.models.invoice_address import InvoiceAddress
 from xero_python.accounting.models.invoice_reminder import InvoiceReminder
 from xero_python.accounting.models.invoice_reminders import InvoiceReminders
 from xero_python.accounting.models.invoices import Invoices
@@ -144,6 +145,7 @@ from xero_python.accounting.models.row_type import RowType
 from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory
 from xero_python.accounting.models.schedule import Schedule
 from xero_python.accounting.models.setup import Setup
+from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent
 from xero_python.accounting.models.tax_component import TaxComponent
 from xero_python.accounting.models.tax_rate import TaxRate
 from xero_python.accounting.models.tax_rates import TaxRates

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/accounting/api/accounting_api.py

@@ -1,5 +1,16 @@
 # coding: utf-8
 
+import importlib
+import re  # noqa: F401
+
+from xero_python import exceptions
+from xero_python.api_client import ApiClient, ModelFinder
+
+try:
+    from .exception_handler import translate_status_exception
+except ImportError:
+    translate_status_exception = exceptions.translate_status_exception
+
 """
     Xero Accounting API
 
@@ -10,20 +21,9 @@
 """
 
 """
-    OpenAPI spec version: 6.1.1
+    OpenAPI spec version: 6.3.0
 """
 
-import importlib
-import re  # noqa: F401
-
-from xero_python import exceptions
-from xero_python.api_client import ApiClient, ModelFinder
-
-try:
-    from .exception_handler import translate_status_exception
-except ImportError:
-    translate_status_exception = exceptions.translate_status_exception
-
 
 class empty:
     """empty object to mark optional parameter not set"""

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/accounting/models/__init__.py

@@ -80,6 +80,7 @@ from xero_python.accounting.models.import_summary_organisation import (
     ImportSummaryOrganisation,
 )
 from xero_python.accounting.models.invoice import Invoice
+from xero_python.accounting.models.invoice_address import InvoiceAddress
 from xero_python.accounting.models.invoice_reminder import InvoiceReminder
 from xero_python.accounting.models.invoice_reminders import InvoiceReminders
 from xero_python.accounting.models.invoices import Invoices
@@ -139,6 +140,7 @@ from xero_python.accounting.models.row_type import RowType
 from xero_python.accounting.models.sales_tracking_category import SalesTrackingCategory
 from xero_python.accounting.models.schedule import Schedule
 from xero_python.accounting.models.setup import Setup
+from xero_python.accounting.models.tax_breakdown_component import TaxBreakdownComponent
 from xero_python.accounting.models.tax_component import TaxComponent
 from xero_python.accounting.models.tax_rate import TaxRate
 from xero_python.accounting.models.tax_rates import TaxRates

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/accounting/models/credit_note.py

@@ -60,6 +60,7 @@ class CreditNote(BaseModel):
         "has_errors": "bool",
         "validation_errors": "list[ValidationError]",
         "warnings": "list[ValidationError]",
+        "invoice_addresses": "list[InvoiceAddress]",
     }
 
     attribute_map = {
@@ -93,6 +94,7 @@ class CreditNote(BaseModel):
         "has_errors": "HasErrors",
         "validation_errors": "ValidationErrors",
         "warnings": "Warnings",
+        "invoice_addresses": "InvoiceAddresses",
     }
 
     def __init__(
@@ -127,6 +129,7 @@ class CreditNote(BaseModel):
         has_errors=False,
         validation_errors=None,
         warnings=None,
+        invoice_addresses=None,
     ):  # noqa: E501
         """CreditNote - a model defined in OpenAPI"""  # noqa: E501
 
@@ -160,6 +163,7 @@ class CreditNote(BaseModel):
         self._has_errors = None
         self._validation_errors = None
         self._warnings = None
+        self._invoice_addresses = None
         self.discriminator = None
 
         if type is not None:
@@ -222,6 +226,8 @@ class CreditNote(BaseModel):
             self.validation_errors = validation_errors
         if warnings is not None:
             self.warnings = warnings
+        if invoice_addresses is not None:
+            self.invoice_addresses = invoice_addresses
 
     @property
     def type(self):
@@ -661,7 +667,7 @@ class CreditNote(BaseModel):
     def sent_to_contact(self):
         """Gets the sent_to_contact of this CreditNote.  # noqa: E501
 
-        boolean to indicate if a credit note has been sent to a contact via  the Xero app (currently read only)  # noqa: E501
+        Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved  # noqa: E501
 
         :return: The sent_to_contact of this CreditNote.  # noqa: E501
         :rtype: bool
@@ -672,7 +678,7 @@ class CreditNote(BaseModel):
     def sent_to_contact(self, sent_to_contact):
         """Sets the sent_to_contact of this CreditNote.
 
-        boolean to indicate if a credit note has been sent to a contact via  the Xero app (currently read only)  # noqa: E501
+        Boolean to set whether the credit note in the Xero app should be marked as “sent”. This can be set only on credit notes that have been approved  # noqa: E501
 
         :param sent_to_contact: The sent_to_contact of this CreditNote.  # noqa: E501
         :type: bool
@@ -932,3 +938,26 @@ class CreditNote(BaseModel):
         """
 
         self._warnings = warnings
+
+    @property
+    def invoice_addresses(self):
+        """Gets the invoice_addresses of this CreditNote.  # noqa: E501
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :return: The invoice_addresses of this CreditNote.  # noqa: E501
+        :rtype: list[InvoiceAddress]
+        """
+        return self._invoice_addresses
+
+    @invoice_addresses.setter
+    def invoice_addresses(self, invoice_addresses):
+        """Sets the invoice_addresses of this CreditNote.
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :param invoice_addresses: The invoice_addresses of this CreditNote.  # noqa: E501
+        :type: list[InvoiceAddress]
+        """
+
+        self._invoice_addresses = invoice_addresses

{xero_python-6.1.0 → xero_python-6.3.0}/xero_python/accounting/models/invoice.py

@@ -70,6 +70,7 @@ class Invoice(BaseModel):
         "status_attribute_string": "str",
         "validation_errors": "list[ValidationError]",
         "warnings": "list[ValidationError]",
+        "invoice_addresses": "list[InvoiceAddress]",
     }
 
     attribute_map = {
@@ -113,6 +114,7 @@ class Invoice(BaseModel):
         "status_attribute_string": "StatusAttributeString",
         "validation_errors": "ValidationErrors",
         "warnings": "Warnings",
+        "invoice_addresses": "InvoiceAddresses",
     }
 
     def __init__(
@@ -157,6 +159,7 @@ class Invoice(BaseModel):
         status_attribute_string=None,
         validation_errors=None,
         warnings=None,
+        invoice_addresses=None,
     ):  # noqa: E501
         """Invoice - a model defined in OpenAPI"""  # noqa: E501
 
@@ -200,6 +203,7 @@ class Invoice(BaseModel):
         self._status_attribute_string = None
         self._validation_errors = None
         self._warnings = None
+        self._invoice_addresses = None
         self.discriminator = None
 
         if type is not None:
@@ -282,6 +286,8 @@ class Invoice(BaseModel):
             self.validation_errors = validation_errors
         if warnings is not None:
             self.warnings = warnings
+        if invoice_addresses is not None:
+            self.invoice_addresses = invoice_addresses
 
     @property
     def type(self):
@@ -1237,3 +1243,26 @@ class Invoice(BaseModel):
         """
 
         self._warnings = warnings
+
+    @property
+    def invoice_addresses(self):
+        """Gets the invoice_addresses of this Invoice.  # noqa: E501
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :return: The invoice_addresses of this Invoice.  # noqa: E501
+        :rtype: list[InvoiceAddress]
+        """
+        return self._invoice_addresses
+
+    @invoice_addresses.setter
+    def invoice_addresses(self, invoice_addresses):
+        """Sets the invoice_addresses of this Invoice.
+
+        An array of addresses used to auto calculate sales tax  # noqa: E501
+
+        :param invoice_addresses: The invoice_addresses of this Invoice.  # noqa: E501
+        :type: list[InvoiceAddress]
+        """
+
+        self._invoice_addresses = invoice_addresses