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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero_python
-Version: 5.0.0
+Version: 6.1.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-5.0.0 → xero_python-6.1.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="5.0.0",
+    version="6.1.0",
 )

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

@@ -29,7 +29,6 @@ from xero_python.accounting import (
     LineItem,
     Attachments,
     Attachment,
-    GetInvoicesResponse
 )
 from xero_python.api_client import ApiClient
 from xero_python.rest import RESTClientObject
@@ -96,7 +95,7 @@ def test_invoice_attachment_upload_and_download(
 
     # 1. get first page of invoices
     invoiceResponse = accounting_api.get_invoices(xero_tenant_id, page=1)
-    assert isinstance(invoiceResponse, GetInvoicesResponse)
+    assert isinstance(invoiceResponse, Invoices)
     assert len(invoiceResponse.invoices)
     # 2. choose first invoice
     invoice = invoiceResponse.invoices[0]
@@ -342,7 +341,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
     # When getting all invoices
     result = sandbox_accounting_api.get_invoices(xero_tenant_id)
     # Then expect correct invoices received
-    expected = GetInvoicesResponse(
+    expected = Invoices(
         invoices=[
             Invoice(
                 amount_credited=Decimal("0.00"),
@@ -475,10 +474,6 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 ),
             ),
         ],
-    provider_name = 'Provider Name Example',
-    status = 'OK',
-    date_time_utc = '/Date(1552326816230)/',
-    id = '900c500b-e83c-4ce2-902a-b8ba04751748'
     )
     assert result == expected
 

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

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

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

@@ -76,27 +76,6 @@ from xero_python.accounting.models.error import Error
 from xero_python.accounting.models.expense_claim import ExpenseClaim
 from xero_python.accounting.models.expense_claims import ExpenseClaims
 from xero_python.accounting.models.external_link import ExternalLink
-from xero_python.accounting.models.get_bank_transactions_response import (
-    GetBankTransactionsResponse,
-)
-from xero_python.accounting.models.get_contacts_response import GetContactsResponse
-from xero_python.accounting.models.get_credit_notes_response import (
-    GetCreditNotesResponse,
-)
-from xero_python.accounting.models.get_invoices_response import GetInvoicesResponse
-from xero_python.accounting.models.get_manual_journals_response import (
-    GetManualJournalsResponse,
-)
-from xero_python.accounting.models.get_overpayments_response import (
-    GetOverpaymentsResponse,
-)
-from xero_python.accounting.models.get_payments_response import GetPaymentsResponse
-from xero_python.accounting.models.get_prepayments_response import (
-    GetPrepaymentsResponse,
-)
-from xero_python.accounting.models.get_purchase_orders_response import (
-    GetPurchaseOrdersResponse,
-)
 from xero_python.accounting.models.history_record import HistoryRecord
 from xero_python.accounting.models.history_records import HistoryRecords
 from xero_python.accounting.models.import_summary import ImportSummary
@@ -129,7 +108,7 @@ from xero_python.accounting.models.organisation import Organisation
 from xero_python.accounting.models.organisations import Organisations
 from xero_python.accounting.models.overpayment import Overpayment
 from xero_python.accounting.models.overpayments import Overpayments
-from xero_python.accounting.models.page_info import PageInfo
+from xero_python.accounting.models.pagination import Pagination
 from xero_python.accounting.models.payment import Payment
 from xero_python.accounting.models.payment_delete import PaymentDelete
 from xero_python.accounting.models.payment_service import PaymentService

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

@@ -10,7 +10,7 @@
 """
 
 """
-    OpenAPI spec version: 5.0.0
+    OpenAPI spec version: 6.1.1
 """
 
 import importlib
@@ -7348,7 +7348,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetBankTransactionsResponse
+        :return: BankTransactions
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -7408,7 +7408,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetBankTransactionsResponse",
+                response_type="BankTransactions",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -9383,7 +9383,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetContactsResponse
+        :return: Contacts
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -9454,7 +9454,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetContactsResponse",
+                response_type="Contacts",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -9995,7 +9995,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetCreditNotesResponse
+        :return: CreditNotes
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -10055,7 +10055,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetCreditNotesResponse",
+                response_type="CreditNotes",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -11115,6 +11115,7 @@ class AccountingApi(object):
         unitdp=empty,
         summary_only=empty,
         page_size=empty,
+        search_term=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -11135,10 +11136,11 @@ class AccountingApi(object):
         :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
         :param bool summary_only: Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
         :param int page_size: Number of records to retrieve per page
+        :param str search_term: Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference.
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetInvoicesResponse
+        :return: Invoices
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -11194,6 +11196,9 @@ class AccountingApi(object):
         if page_size is not empty:
             query_params.append(("pageSize", page_size))
 
+        if search_term is not empty:
+            query_params.append(("searchTerm", search_term))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -11224,7 +11229,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetInvoicesResponse",
+                response_type="Invoices",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -12255,7 +12260,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetManualJournalsResponse
+        :return: ManualJournals
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -12312,7 +12317,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetManualJournalsResponse",
+                response_type="ManualJournals",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -12845,6 +12850,7 @@ class AccountingApi(object):
         order=empty,
         page=empty,
         unitdp=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -12857,10 +12863,11 @@ class AccountingApi(object):
         :param str order: Order by an any element
         :param int page: e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment
         :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
+        :param int page_size: Number of records to retrieve per page
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetOverpaymentsResponse
+        :return: Overpayments
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -12887,6 +12894,9 @@ class AccountingApi(object):
         if unitdp is not empty:
             query_params.append(("unitdp", unitdp))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -12917,7 +12927,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetOverpaymentsResponse",
+                response_type="Overpayments",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -13169,7 +13179,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetPaymentsResponse
+        :return: Payments
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -13226,7 +13236,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetPaymentsResponse",
+                response_type="Payments",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -13397,6 +13407,7 @@ class AccountingApi(object):
         order=empty,
         page=empty,
         unitdp=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -13409,10 +13420,11 @@ class AccountingApi(object):
         :param str order: Order by an any element
         :param int page: e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment
         :param int unitdp: e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts
+        :param int page_size: Number of records to retrieve per page
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetPrepaymentsResponse
+        :return: Prepayments
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -13439,6 +13451,9 @@ class AccountingApi(object):
         if unitdp is not empty:
             query_params.append(("unitdp", unitdp))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -13469,7 +13484,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetPrepaymentsResponse",
+                response_type="Prepayments",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,
@@ -14087,7 +14102,7 @@ class AccountingApi(object):
         :param bool _return_http_data_only: return received data only
         :param bool _preload_content: load received data in models
         :param bool _request_timeout: maximum wait time for response
-        :return: GetPurchaseOrdersResponse
+        :return: PurchaseOrders
         """
 
         # verify the required parameter 'xero_tenant_id' is set
@@ -14150,7 +14165,7 @@ class AccountingApi(object):
                 body=body_params,
                 post_params=form_params,
                 files=local_var_files,
-                response_type="GetPurchaseOrdersResponse",
+                response_type="PurchaseOrders",
                 response_model_finder=self.get_model_finder(),
                 auth_settings=auth_settings,
                 _return_http_data_only=_return_http_data_only,

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

@@ -71,27 +71,6 @@ from xero_python.accounting.models.error import Error
 from xero_python.accounting.models.expense_claim import ExpenseClaim
 from xero_python.accounting.models.expense_claims import ExpenseClaims
 from xero_python.accounting.models.external_link import ExternalLink
-from xero_python.accounting.models.get_bank_transactions_response import (
-    GetBankTransactionsResponse,
-)
-from xero_python.accounting.models.get_contacts_response import GetContactsResponse
-from xero_python.accounting.models.get_credit_notes_response import (
-    GetCreditNotesResponse,
-)
-from xero_python.accounting.models.get_invoices_response import GetInvoicesResponse
-from xero_python.accounting.models.get_manual_journals_response import (
-    GetManualJournalsResponse,
-)
-from xero_python.accounting.models.get_overpayments_response import (
-    GetOverpaymentsResponse,
-)
-from xero_python.accounting.models.get_payments_response import GetPaymentsResponse
-from xero_python.accounting.models.get_prepayments_response import (
-    GetPrepaymentsResponse,
-)
-from xero_python.accounting.models.get_purchase_orders_response import (
-    GetPurchaseOrdersResponse,
-)
 from xero_python.accounting.models.history_record import HistoryRecord
 from xero_python.accounting.models.history_records import HistoryRecords
 from xero_python.accounting.models.import_summary import ImportSummary
@@ -124,7 +103,7 @@ from xero_python.accounting.models.organisation import Organisation
 from xero_python.accounting.models.organisations import Organisations
 from xero_python.accounting.models.overpayment import Overpayment
 from xero_python.accounting.models.overpayments import Overpayments
-from xero_python.accounting.models.page_info import PageInfo
+from xero_python.accounting.models.pagination import Pagination
 from xero_python.accounting.models.payment import Payment
 from xero_python.accounting.models.payment_delete import PaymentDelete
 from xero_python.accounting.models.payment_service import PaymentService

xero_python-6.1.0/xero_python/accounting/models/bank_transactions.py

@@ -0,0 +1,124 @@
+# coding: utf-8
+
+"""
+    Xero Accounting API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    Contact: api@xero.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+
+from xero_python.models import BaseModel
+
+
+class BankTransactions(BaseModel):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        "pagination": "Pagination",
+        "warnings": "list[ValidationError]",
+        "bank_transactions": "list[BankTransaction]",
+    }
+
+    attribute_map = {
+        "pagination": "pagination",
+        "warnings": "Warnings",
+        "bank_transactions": "BankTransactions",
+    }
+
+    def __init__(
+        self, pagination=None, warnings=None, bank_transactions=None
+    ):  # noqa: E501
+        """BankTransactions - a model defined in OpenAPI"""  # noqa: E501
+
+        self._pagination = None
+        self._warnings = None
+        self._bank_transactions = None
+        self.discriminator = None
+
+        if pagination is not None:
+            self.pagination = pagination
+        if warnings is not None:
+            self.warnings = warnings
+        if bank_transactions is not None:
+            self.bank_transactions = bank_transactions
+
+    @property
+    def pagination(self):
+        """Gets the pagination of this BankTransactions.  # noqa: E501
+
+
+        :return: The pagination of this BankTransactions.  # noqa: E501
+        :rtype: Pagination
+        """
+        return self._pagination
+
+    @pagination.setter
+    def pagination(self, pagination):
+        """Sets the pagination of this BankTransactions.
+
+
+        :param pagination: The pagination of this BankTransactions.  # noqa: E501
+        :type: Pagination
+        """
+
+        self._pagination = pagination
+
+    @property
+    def warnings(self):
+        """Gets the warnings of this BankTransactions.  # noqa: E501
+
+        Displays array of warning messages from the API  # noqa: E501
+
+        :return: The warnings of this BankTransactions.  # noqa: E501
+        :rtype: list[ValidationError]
+        """
+        return self._warnings
+
+    @warnings.setter
+    def warnings(self, warnings):
+        """Sets the warnings of this BankTransactions.
+
+        Displays array of warning messages from the API  # noqa: E501
+
+        :param warnings: The warnings of this BankTransactions.  # noqa: E501
+        :type: list[ValidationError]
+        """
+
+        self._warnings = warnings
+
+    @property
+    def bank_transactions(self):
+        """Gets the bank_transactions of this BankTransactions.  # noqa: E501
+
+
+        :return: The bank_transactions of this BankTransactions.  # noqa: E501
+        :rtype: list[BankTransaction]
+        """
+        return self._bank_transactions
+
+    @bank_transactions.setter
+    def bank_transactions(self, bank_transactions):
+        """Sets the bank_transactions of this BankTransactions.
+
+
+        :param bank_transactions: The bank_transactions of this BankTransactions.  # noqa: E501
+        :type: list[BankTransaction]
+        """
+
+        self._bank_transactions = bank_transactions

xero_python-6.1.0/xero_python/accounting/models/contacts.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Xero Accounting API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    Contact: api@xero.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+
+from xero_python.models import BaseModel
+
+
+class Contacts(BaseModel):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        "pagination": "Pagination",
+        "warnings": "list[ValidationError]",
+        "contacts": "list[Contact]",
+    }
+
+    attribute_map = {
+        "pagination": "pagination",
+        "warnings": "Warnings",
+        "contacts": "Contacts",
+    }
+
+    def __init__(self, pagination=None, warnings=None, contacts=None):  # noqa: E501
+        """Contacts - a model defined in OpenAPI"""  # noqa: E501
+
+        self._pagination = None
+        self._warnings = None
+        self._contacts = None
+        self.discriminator = None
+
+        if pagination is not None:
+            self.pagination = pagination
+        if warnings is not None:
+            self.warnings = warnings
+        if contacts is not None:
+            self.contacts = contacts
+
+    @property
+    def pagination(self):
+        """Gets the pagination of this Contacts.  # noqa: E501
+
+
+        :return: The pagination of this Contacts.  # noqa: E501
+        :rtype: Pagination
+        """
+        return self._pagination
+
+    @pagination.setter
+    def pagination(self, pagination):
+        """Sets the pagination of this Contacts.
+
+
+        :param pagination: The pagination of this Contacts.  # noqa: E501
+        :type: Pagination
+        """
+
+        self._pagination = pagination
+
+    @property
+    def warnings(self):
+        """Gets the warnings of this Contacts.  # noqa: E501
+
+        Displays array of warning messages from the API  # noqa: E501
+
+        :return: The warnings of this Contacts.  # noqa: E501
+        :rtype: list[ValidationError]
+        """
+        return self._warnings
+
+    @warnings.setter
+    def warnings(self, warnings):
+        """Sets the warnings of this Contacts.
+
+        Displays array of warning messages from the API  # noqa: E501
+
+        :param warnings: The warnings of this Contacts.  # noqa: E501
+        :type: list[ValidationError]
+        """
+
+        self._warnings = warnings
+
+    @property
+    def contacts(self):
+        """Gets the contacts of this Contacts.  # noqa: E501
+
+
+        :return: The contacts of this Contacts.  # noqa: E501
+        :rtype: list[Contact]
+        """
+        return self._contacts
+
+    @contacts.setter
+    def contacts(self, contacts):
+        """Sets the contacts of this Contacts.
+
+
+        :param contacts: The contacts of this Contacts.  # noqa: E501
+        :type: list[Contact]
+        """
+
+        self._contacts = contacts