xero-python 4.0.0__tar.gz → 6.0.0__tar.gz

{xero_python-4.0.0 → xero_python-6.0.0}/PKG-INFO

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

{xero_python-4.0.0 → xero_python-6.0.0}/tests/accounting/api/test_accounting_api.py

@@ -94,11 +94,11 @@ def test_invoice_attachment_upload_and_download(
     """
 
     # 1. get first page of invoices
-    invoices = accounting_api.get_invoices(xero_tenant_id, page=1)
-    assert isinstance(invoices, Invoices)
-    assert len(invoices.invoices)
+    invoiceResponse = accounting_api.get_invoices(xero_tenant_id, page=1)
+    assert isinstance(invoiceResponse, Invoices)
+    assert len(invoiceResponse.invoices)
     # 2. choose first invoice
-    invoice = invoices.invoices[0]
+    invoice = invoiceResponse.invoices[0]
     assert isinstance(invoice, Invoice)
     # 3. upload test pdf file as invoice attachment
     include_online = True
@@ -473,7 +473,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                     2018, 11, 2, 16, 37, 28, 927000, tzinfo=tz.UTC
                 ),
             ),
-        ]
+        ],
     )
     assert result == expected
 

{xero_python-4.0.0 → xero_python-6.0.0}/xero_python/__init__.py

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

{xero_python-4.0.0 → xero_python-6.0.0}/xero_python/accounting/__init__.py

@@ -108,6 +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.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-4.0.0 → xero_python-6.0.0}/xero_python/accounting/api/accounting_api.py

@@ -10,7 +10,7 @@
 """
 
 """
-    OpenAPI spec version: 4.0.0
+    OpenAPI spec version: 6.0.0
 """
 
 import importlib
@@ -7331,6 +7331,7 @@ class AccountingApi(object):
         order=empty,
         page=empty,
         unitdp=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -7343,6 +7344,7 @@ class AccountingApi(object):
         :param str order: Order by an any element
         :param int page: Up to 100 bank transactions will be returned in a single API call with line items details
         :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
@@ -7373,6 +7375,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,
         }
@@ -9358,6 +9363,7 @@ class AccountingApi(object):
         include_archived=empty,
         summary_only=empty,
         search_term=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -9373,6 +9379,7 @@ class AccountingApi(object):
         :param bool include_archived: e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
         :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 str search_term: Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
+        :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
@@ -9414,6 +9421,9 @@ class AccountingApi(object):
         if search_term is not empty:
             query_params.append(("searchTerm", search_term))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -9968,6 +9978,7 @@ class AccountingApi(object):
         order=empty,
         page=empty,
         unitdp=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -9980,6 +9991,7 @@ class AccountingApi(object):
         :param str order: Order by an any element
         :param int page: e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note
         :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
@@ -10010,6 +10022,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,
         }
@@ -11099,6 +11114,8 @@ class AccountingApi(object):
         created_by_my_app=empty,
         unitdp=empty,
         summary_only=empty,
+        page_size=empty,
+        search_term=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -11118,6 +11135,8 @@ class AccountingApi(object):
         :param bool created_by_my_app: When set to true you'll only retrieve Invoices created by your app
         :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
@@ -11174,6 +11193,12 @@ class AccountingApi(object):
         if summary_only is not empty:
             query_params.append(("summaryOnly", summary_only))
 
+        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,
         }
@@ -12219,6 +12244,7 @@ class AccountingApi(object):
         where=empty,
         order=empty,
         page=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -12230,6 +12256,7 @@ class AccountingApi(object):
         :param str where: Filter by an any element
         :param str order: Order by an any element
         :param int page: e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment
+        :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
@@ -12257,6 +12284,9 @@ class AccountingApi(object):
         if page is not empty:
             query_params.append(("page", page))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -12820,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,
@@ -12832,6 +12863,7 @@ 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
@@ -12862,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,
         }
@@ -13128,6 +13163,7 @@ class AccountingApi(object):
         where=empty,
         order=empty,
         page=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -13139,6 +13175,7 @@ class AccountingApi(object):
         :param str where: Filter by an any element
         :param str order: Order by an any element
         :param int page: Up to 100 payments will be returned in a single API call
+        :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
@@ -13166,6 +13203,9 @@ class AccountingApi(object):
         if page is not empty:
             query_params.append(("page", page))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }
@@ -13367,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,
@@ -13379,6 +13420,7 @@ 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
@@ -13409,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,
         }
@@ -14039,6 +14084,7 @@ class AccountingApi(object):
         date_to=empty,
         order=empty,
         page=empty,
+        page_size=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -14052,6 +14098,7 @@ class AccountingApi(object):
         :param str date_to: Filter by purchase order date (e.g. GET https://.../PurchaseOrders?DateFrom=2015-12-01&DateTo=2015-12-31
         :param str order: Order by an any element
         :param int page: To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.
+        :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
@@ -14085,6 +14132,9 @@ class AccountingApi(object):
         if page is not empty:
             query_params.append(("page", page))
 
+        if page_size is not empty:
+            query_params.append(("pageSize", page_size))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }

{xero_python-4.0.0 → xero_python-6.0.0}/xero_python/accounting/models/__init__.py

@@ -103,6 +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.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-4.0.0 → xero_python-6.0.0}/xero_python/accounting/models/bank_transactions.py

@@ -29,19 +29,49 @@ class BankTransactions(BaseModel):
       attribute_map (dict): The key is attribute name
                             and the value is json key in definition.
     """
-    openapi_types = {"bank_transactions": "list[BankTransaction]"}
+    openapi_types = {
+        "pagination": "Pagination",
+        "bank_transactions": "list[BankTransaction]",
+    }
 
-    attribute_map = {"bank_transactions": "BankTransactions"}
+    attribute_map = {
+        "pagination": "pagination",
+        "bank_transactions": "BankTransactions",
+    }
 
-    def __init__(self, bank_transactions=None):  # noqa: E501
+    def __init__(self, pagination=None, bank_transactions=None):  # noqa: E501
         """BankTransactions - a model defined in OpenAPI"""  # noqa: E501
 
+        self._pagination = None
         self._bank_transactions = None
         self.discriminator = None
 
+        if pagination is not None:
+            self.pagination = pagination
         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 bank_transactions(self):
         """Gets the bank_transactions of this BankTransactions.  # noqa: E501

{xero_python-4.0.0 → xero_python-6.0.0}/xero_python/accounting/models/contacts.py

@@ -29,19 +29,43 @@ class Contacts(BaseModel):
       attribute_map (dict): The key is attribute name
                             and the value is json key in definition.
     """
-    openapi_types = {"contacts": "list[Contact]"}
+    openapi_types = {"pagination": "Pagination", "contacts": "list[Contact]"}
 
-    attribute_map = {"contacts": "Contacts"}
+    attribute_map = {"pagination": "pagination", "contacts": "Contacts"}
 
-    def __init__(self, contacts=None):  # noqa: E501
+    def __init__(self, pagination=None, contacts=None):  # noqa: E501
         """Contacts - a model defined in OpenAPI"""  # noqa: E501
 
+        self._pagination = None
         self._contacts = None
         self.discriminator = None
 
+        if pagination is not None:
+            self.pagination = pagination
         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 contacts(self):
         """Gets the contacts of this Contacts.  # noqa: E501

{xero_python-4.0.0 → xero_python-6.0.0}/xero_python/accounting/models/credit_notes.py

@@ -29,19 +29,43 @@ class CreditNotes(BaseModel):
       attribute_map (dict): The key is attribute name
                             and the value is json key in definition.
     """
-    openapi_types = {"credit_notes": "list[CreditNote]"}
+    openapi_types = {"pagination": "Pagination", "credit_notes": "list[CreditNote]"}
 
-    attribute_map = {"credit_notes": "CreditNotes"}
+    attribute_map = {"pagination": "pagination", "credit_notes": "CreditNotes"}
 
-    def __init__(self, credit_notes=None):  # noqa: E501
+    def __init__(self, pagination=None, credit_notes=None):  # noqa: E501
         """CreditNotes - a model defined in OpenAPI"""  # noqa: E501
 
+        self._pagination = None
         self._credit_notes = None
         self.discriminator = None
 
+        if pagination is not None:
+            self.pagination = pagination
         if credit_notes is not None:
             self.credit_notes = credit_notes
 
+    @property
+    def pagination(self):
+        """Gets the pagination of this CreditNotes.  # noqa: E501
+
+
+        :return: The pagination of this CreditNotes.  # noqa: E501
+        :rtype: Pagination
+        """
+        return self._pagination
+
+    @pagination.setter
+    def pagination(self, pagination):
+        """Sets the pagination of this CreditNotes.
+
+
+        :param pagination: The pagination of this CreditNotes.  # noqa: E501
+        :type: Pagination
+        """
+
+        self._pagination = pagination
+
     @property
     def credit_notes(self):
         """Gets the credit_notes of this CreditNotes.  # noqa: E501

xero_python-6.0.0/xero_python/accounting/models/get_bank_transactions_response.py

@@ -0,0 +1,206 @@
+# 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 GetBankTransactionsResponse(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 = {
+        "id": "str",
+        "status": "str",
+        "provider_name": "str",
+        "date_time_utc": "str",
+        "page_info": "PageInfo",
+        "bank_transactions": "list[BankTransaction]",
+    }
+
+    attribute_map = {
+        "id": "Id",
+        "status": "Status",
+        "provider_name": "ProviderName",
+        "date_time_utc": "DateTimeUTC",
+        "page_info": "PageInfo",
+        "bank_transactions": "BankTransactions",
+    }
+
+    def __init__(
+        self,
+        id=None,
+        status=None,
+        provider_name=None,
+        date_time_utc=None,
+        page_info=None,
+        bank_transactions=None,
+    ):  # noqa: E501
+        """GetBankTransactionsResponse - a model defined in OpenAPI"""  # noqa: E501
+
+        self._id = None
+        self._status = None
+        self._provider_name = None
+        self._date_time_utc = None
+        self._page_info = None
+        self._bank_transactions = None
+        self.discriminator = None
+
+        if id is not None:
+            self.id = id
+        if status is not None:
+            self.status = status
+        if provider_name is not None:
+            self.provider_name = provider_name
+        if date_time_utc is not None:
+            self.date_time_utc = date_time_utc
+        if page_info is not None:
+            self.page_info = page_info
+        if bank_transactions is not None:
+            self.bank_transactions = bank_transactions
+
+    @property
+    def id(self):
+        """Gets the id of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The id of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this GetBankTransactionsResponse.
+
+
+        :param id: The id of this GetBankTransactionsResponse.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+    @property
+    def status(self):
+        """Gets the status of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The status of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this GetBankTransactionsResponse.
+
+
+        :param status: The status of this GetBankTransactionsResponse.  # noqa: E501
+        :type: str
+        """
+
+        self._status = status
+
+    @property
+    def provider_name(self):
+        """Gets the provider_name of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The provider_name of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._provider_name
+
+    @provider_name.setter
+    def provider_name(self, provider_name):
+        """Sets the provider_name of this GetBankTransactionsResponse.
+
+
+        :param provider_name: The provider_name of this GetBankTransactionsResponse.  # noqa: E501
+        :type: str
+        """
+
+        self._provider_name = provider_name
+
+    @property
+    def date_time_utc(self):
+        """Gets the date_time_utc of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The date_time_utc of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: str
+        """
+        return self._date_time_utc
+
+    @date_time_utc.setter
+    def date_time_utc(self, date_time_utc):
+        """Sets the date_time_utc of this GetBankTransactionsResponse.
+
+
+        :param date_time_utc: The date_time_utc of this GetBankTransactionsResponse.  # noqa: E501
+        :type: str
+        """
+
+        self._date_time_utc = date_time_utc
+
+    @property
+    def page_info(self):
+        """Gets the page_info of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The page_info of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: PageInfo
+        """
+        return self._page_info
+
+    @page_info.setter
+    def page_info(self, page_info):
+        """Sets the page_info of this GetBankTransactionsResponse.
+
+
+        :param page_info: The page_info of this GetBankTransactionsResponse.  # noqa: E501
+        :type: PageInfo
+        """
+
+        self._page_info = page_info
+
+    @property
+    def bank_transactions(self):
+        """Gets the bank_transactions of this GetBankTransactionsResponse.  # noqa: E501
+
+
+        :return: The bank_transactions of this GetBankTransactionsResponse.  # noqa: E501
+        :rtype: list[BankTransaction]
+        """
+        return self._bank_transactions
+
+    @bank_transactions.setter
+    def bank_transactions(self, bank_transactions):
+        """Sets the bank_transactions of this GetBankTransactionsResponse.
+
+
+        :param bank_transactions: The bank_transactions of this GetBankTransactionsResponse.  # noqa: E501
+        :type: list[BankTransaction]
+        """
+
+        self._bank_transactions = bank_transactions