xero-python 13.0.0__tar.gz → 15.0.0__tar.gz

{xero_python-13.0.0 → xero_python-15.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero_python
-Version: 13.0.0
+Version: 15.0.0
 Summary: Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
 Home-page: UNKNOWN
 Author: Xero Developer API

{xero_python-13.0.0 → xero_python-15.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="13.0.0",
+    version="15.0.0",
 )

{xero_python-13.0.0 → xero_python-15.0.0}/tests/accounting/api/test_accounting_api.py

@@ -382,6 +382,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 total_tax=Decimal(0),
                 type="ACCREC",
                 updated_date_utc=datetime.datetime(2018, 11, 2, 16, 31, 30, 160000, tzinfo=tz.UTC),
+                updated_date_utc_string="2018-11-02T16:31:30Z",
             ),
             Invoice(
                 amount_credited=Decimal(0),
@@ -431,6 +432,7 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 total_tax=Decimal(6),
                 type="ACCREC",
                 updated_date_utc=datetime.datetime(2018, 11, 2, 16, 36, 32, 690000, tzinfo=tz.UTC),
+                updated_date_utc_string="2018-11-02T16:36:32Z",
             ),
             Invoice(
                 amount_credited=Decimal(0),
@@ -467,7 +469,8 @@ def test_get_invoices(sandbox_accounting_api: AccountingApi, xero_tenant_id):
                 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),
+                updated_date_utc_string="2018-11-02T16:37:28Z"
             )
         ],
         pagination= Pagination(
@@ -629,6 +632,7 @@ def test_update_or_create_invoices(
                 updated_date_utc=datetime.datetime(
                     2019, 3, 11, 17, 58, 46, 117000, tzinfo=tz.UTC
                 ),
+                updated_date_utc_string="2019-03-11T17:58:46Z",
             )
         ]
     )

{xero_python-13.0.0 → xero_python-15.0.0}/xero_python/__init__.py

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

{xero_python-13.0.0 → xero_python-15.0.0}/xero_python/accounting/__init__.py

@@ -37,7 +37,12 @@ from xero_python.accounting.models.balances import Balances
 from xero_python.accounting.models.bank_transaction import BankTransaction
 from xero_python.accounting.models.bank_transactions import BankTransactions
 from xero_python.accounting.models.bank_transfer import BankTransfer
+from xero_python.accounting.models.bank_transfer_delete import BankTransferDelete
+from xero_python.accounting.models.bank_transfer_delete_by_url_param import (
+    BankTransferDeleteByUrlParam,
+)
 from xero_python.accounting.models.bank_transfers import BankTransfers
+from xero_python.accounting.models.bank_transfers_delete import BankTransfersDelete
 from xero_python.accounting.models.batch_payment import BatchPayment
 from xero_python.accounting.models.batch_payment_delete import BatchPaymentDelete
 from xero_python.accounting.models.batch_payment_delete_by_url_param import (
@@ -156,6 +161,7 @@ from xero_python.accounting.models.tracking_categories import TrackingCategories
 from xero_python.accounting.models.tracking_category import TrackingCategory
 from xero_python.accounting.models.tracking_option import TrackingOption
 from xero_python.accounting.models.tracking_options import TrackingOptions
+from xero_python.accounting.models.tracking_reference import TrackingReference
 from xero_python.accounting.models.user import User
 from xero_python.accounting.models.users import Users
 from xero_python.accounting.models.validation_error import ValidationError

{xero_python-13.0.0 → xero_python-15.0.0}/xero_python/accounting/api/accounting_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 14.0.0
+    OpenAPI spec version: 16.1.0
 """
 
 
@@ -5343,6 +5343,189 @@ class AccountingApi(object):
         except exceptions.HTTPStatusException as error:
             raise translate_status_exception(error, self, "delete_account")
 
+    def delete_bank_transfer(
+        self,
+        xero_tenant_id,
+        bank_transfer_id,
+        bank_transfer_delete_by_url_param,
+        idempotency_key=empty,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Deletes a specific bank transfer  # noqa: E501
+        OAuth2 scope: accounting.transactions
+        :param str xero_tenant_id: Xero identifier for Tenant (required)
+        :param str bank_transfer_id: Xero generated unique identifier for a bank transfer (required)
+        :param BankTransferDeleteByUrlParam bank_transfer_delete_by_url_param: (required)
+        :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+        :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: BankTransfers
+        """
+
+        # verify the required parameter 'xero_tenant_id' is set
+        if xero_tenant_id is None:
+            raise ValueError(
+                "Missing the required parameter `xero_tenant_id` "
+                "when calling `delete_bank_transfer`"
+            )
+        # verify the required parameter 'bank_transfer_id' is set
+        if bank_transfer_id is None:
+            raise ValueError(
+                "Missing the required parameter `bank_transfer_id` "
+                "when calling `delete_bank_transfer`"
+            )
+        # verify the required parameter 'bank_transfer_delete_by_url_param' is set
+        if bank_transfer_delete_by_url_param is None:
+            raise ValueError(
+                "Missing the required parameter `bank_transfer_delete_by_url_param` "
+                "when calling `delete_bank_transfer`"
+            )
+
+        collection_formats = {}
+        path_params = {
+            "BankTransferID": bank_transfer_id,
+        }
+
+        query_params = []
+
+        header_params = {
+            "xero-tenant-id": xero_tenant_id,
+        }
+
+        if idempotency_key is not empty:
+            header_params["Idempotency-Key"] = idempotency_key
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = bank_transfer_delete_by_url_param
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )
+
+        # HTTP header `Content-Type`
+        header_params["Content-Type"] = self.api_client.select_header_content_type(
+            ["application/json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/BankTransfers/{BankTransferID}")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "POST",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="BankTransfers",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "delete_bank_transfer")
+
+    def delete_bank_transfers(
+        self,
+        xero_tenant_id,
+        bank_transfers_delete,
+        summarize_errors=empty,
+        idempotency_key=empty,
+        _return_http_data_only=True,
+        _preload_content=True,
+        _request_timeout=None,
+    ):
+        """Deletes one or more bank transfers  # noqa: E501
+        OAuth2 scope: accounting.transactions
+        :param str xero_tenant_id: Xero identifier for Tenant (required)
+        :param BankTransfersDelete bank_transfers_delete: BankTransfers with array of BankTransfer objects in request body (required)
+        :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors
+        :param str idempotency_key: This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
+        :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: BankTransfers
+        """
+
+        # verify the required parameter 'xero_tenant_id' is set
+        if xero_tenant_id is None:
+            raise ValueError(
+                "Missing the required parameter `xero_tenant_id` "
+                "when calling `delete_bank_transfers`"
+            )
+        # verify the required parameter 'bank_transfers_delete' is set
+        if bank_transfers_delete is None:
+            raise ValueError(
+                "Missing the required parameter `bank_transfers_delete` "
+                "when calling `delete_bank_transfers`"
+            )
+
+        collection_formats = {}
+        path_params = {}
+
+        query_params = []
+
+        if summarize_errors is not empty:
+            query_params.append(("summarizeErrors", summarize_errors))
+
+        header_params = {
+            "xero-tenant-id": xero_tenant_id,
+        }
+
+        if idempotency_key is not empty:
+            header_params["Idempotency-Key"] = idempotency_key
+
+        local_var_files = {}
+        form_params = []
+
+        body_params = bank_transfers_delete
+        # HTTP header `Accept`
+        header_params["Accept"] = self.api_client.select_header_accept(
+            ["application/json"]
+        )
+
+        # HTTP header `Content-Type`
+        header_params["Content-Type"] = self.api_client.select_header_content_type(
+            ["application/json"]
+        )
+
+        # Authentication setting
+        auth_settings = ["OAuth2"]
+        url = self.get_resource_url("/BankTransfers")
+
+        try:
+            return self.api_client.call_api(
+                url,
+                "POST",
+                path_params,
+                query_params,
+                header_params,
+                body=body_params,
+                post_params=form_params,
+                files=local_var_files,
+                response_type="BankTransfers",
+                response_model_finder=self.get_model_finder(),
+                auth_settings=auth_settings,
+                _return_http_data_only=_return_http_data_only,
+                _preload_content=_preload_content,
+                _request_timeout=_request_timeout,
+                collection_formats=collection_formats,
+            )
+        except exceptions.HTTPStatusException as error:
+            raise translate_status_exception(error, self, "delete_bank_transfers")
+
     def delete_batch_payment(
         self,
         xero_tenant_id,
@@ -7840,6 +8023,7 @@ class AccountingApi(object):
         if_modified_since=empty,
         where=empty,
         order=empty,
+        include_deleted=empty,
         _return_http_data_only=True,
         _preload_content=True,
         _request_timeout=None,
@@ -7850,6 +8034,7 @@ class AccountingApi(object):
         :param datetime if_modified_since: Only records created or modified since this timestamp will be returned
         :param str where: Filter by an any element
         :param str order: Order by an any element
+        :param bool include_deleted: e.g. includeDeleted=true - Bank transfers with a status of DELETED will be included in the response
         :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
@@ -7874,6 +8059,9 @@ class AccountingApi(object):
         if order is not empty:
             query_params.append(("order", order))
 
+        if include_deleted is not empty:
+            query_params.append(("includeDeleted", include_deleted))
+
         header_params = {
             "xero-tenant-id": xero_tenant_id,
         }

{xero_python-13.0.0 → xero_python-15.0.0}/xero_python/accounting/models/__init__.py

@@ -32,7 +32,12 @@ from xero_python.accounting.models.balances import Balances
 from xero_python.accounting.models.bank_transaction import BankTransaction
 from xero_python.accounting.models.bank_transactions import BankTransactions
 from xero_python.accounting.models.bank_transfer import BankTransfer
+from xero_python.accounting.models.bank_transfer_delete import BankTransferDelete
+from xero_python.accounting.models.bank_transfer_delete_by_url_param import (
+    BankTransferDeleteByUrlParam,
+)
 from xero_python.accounting.models.bank_transfers import BankTransfers
+from xero_python.accounting.models.bank_transfers_delete import BankTransfersDelete
 from xero_python.accounting.models.batch_payment import BatchPayment
 from xero_python.accounting.models.batch_payment_delete import BatchPaymentDelete
 from xero_python.accounting.models.batch_payment_delete_by_url_param import (
@@ -151,6 +156,7 @@ from xero_python.accounting.models.tracking_categories import TrackingCategories
 from xero_python.accounting.models.tracking_category import TrackingCategory
 from xero_python.accounting.models.tracking_option import TrackingOption
 from xero_python.accounting.models.tracking_options import TrackingOptions
+from xero_python.accounting.models.tracking_reference import TrackingReference
 from xero_python.accounting.models.user import User
 from xero_python.accounting.models.users import Users
 from xero_python.accounting.models.validation_error import ValidationError

{xero_python-13.0.0 → xero_python-15.0.0}/xero_python/accounting/models/bank_transfer.py

@@ -43,6 +43,9 @@ class BankTransfer(BaseModel):
         "reference": "str",
         "has_attachments": "bool",
         "created_date_utc": "datetime[ms-format]",
+        "status": "str",
+        "from_tracking": "list[TrackingReference]",
+        "to_tracking": "list[TrackingReference]",
         "validation_errors": "list[ValidationError]",
     }
 
@@ -60,6 +63,9 @@ class BankTransfer(BaseModel):
         "reference": "Reference",
         "has_attachments": "HasAttachments",
         "created_date_utc": "CreatedDateUTC",
+        "status": "Status",
+        "from_tracking": "FromTracking",
+        "to_tracking": "ToTracking",
         "validation_errors": "ValidationErrors",
     }
 
@@ -78,6 +84,9 @@ class BankTransfer(BaseModel):
         reference=None,
         has_attachments=False,
         created_date_utc=None,
+        status=None,
+        from_tracking=None,
+        to_tracking=None,
         validation_errors=None,
     ):  # noqa: E501
         """BankTransfer - a model defined in OpenAPI"""  # noqa: E501
@@ -95,6 +104,9 @@ class BankTransfer(BaseModel):
         self._reference = None
         self._has_attachments = None
         self._created_date_utc = None
+        self._status = None
+        self._from_tracking = None
+        self._to_tracking = None
         self._validation_errors = None
         self.discriminator = None
 
@@ -121,6 +133,12 @@ class BankTransfer(BaseModel):
             self.has_attachments = has_attachments
         if created_date_utc is not None:
             self.created_date_utc = created_date_utc
+        if status is not None:
+            self.status = status
+        if from_tracking is not None:
+            self.from_tracking = from_tracking
+        if to_tracking is not None:
+            self.to_tracking = to_tracking
         if validation_errors is not None:
             self.validation_errors = validation_errors
 
@@ -431,6 +449,84 @@ class BankTransfer(BaseModel):
 
         self._created_date_utc = created_date_utc
 
+    @property
+    def status(self):
+        """Gets the status of this BankTransfer.  # noqa: E501
+
+        AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED.  # noqa: E501
+
+        :return: The status of this BankTransfer.  # noqa: E501
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this BankTransfer.
+
+        AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED.  # noqa: E501
+
+        :param status: The status of this BankTransfer.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["AUTHORISED", "DELETED", "None"]  # noqa: E501
+
+        if status:
+            if status not in allowed_values:
+                raise ValueError(
+                    "Invalid value for `status` ({0}), must be one of {1}".format(  # noqa: E501
+                        status, allowed_values
+                    )
+                )
+
+        self._status = status
+
+    @property
+    def from_tracking(self):
+        """Gets the from_tracking of this BankTransfer.  # noqa: E501
+
+        Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.  # noqa: E501
+
+        :return: The from_tracking of this BankTransfer.  # noqa: E501
+        :rtype: list[TrackingReference]
+        """
+        return self._from_tracking
+
+    @from_tracking.setter
+    def from_tracking(self, from_tracking):
+        """Sets the from_tracking of this BankTransfer.
+
+        Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.  # noqa: E501
+
+        :param from_tracking: The from_tracking of this BankTransfer.  # noqa: E501
+        :type: list[TrackingReference]
+        """
+
+        self._from_tracking = from_tracking
+
+    @property
+    def to_tracking(self):
+        """Gets the to_tracking of this BankTransfer.  # noqa: E501
+
+        Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.  # noqa: E501
+
+        :return: The to_tracking of this BankTransfer.  # noqa: E501
+        :rtype: list[TrackingReference]
+        """
+        return self._to_tracking
+
+    @to_tracking.setter
+    def to_tracking(self, to_tracking):
+        """Sets the to_tracking of this BankTransfer.
+
+        Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.  # noqa: E501
+
+        :param to_tracking: The to_tracking of this BankTransfer.  # noqa: E501
+        :type: list[TrackingReference]
+        """
+
+        self._to_tracking = to_tracking
+
     @property
     def validation_errors(self):
         """Gets the validation_errors of this BankTransfer.  # noqa: E501

xero_python-15.0.0/xero_python/accounting/models/bank_transfer_delete.py

@@ -0,0 +1,98 @@
+# 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 BankTransferDelete(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 = {"bank_transfer_id": "str", "status": "str"}
+
+    attribute_map = {"bank_transfer_id": "BankTransferID", "status": "Status"}
+
+    def __init__(self, bank_transfer_id=None, status="DELETED"):  # noqa: E501
+        """BankTransferDelete - a model defined in OpenAPI"""  # noqa: E501
+
+        self._bank_transfer_id = None
+        self._status = None
+        self.discriminator = None
+
+        self.bank_transfer_id = bank_transfer_id
+        self.status = status
+
+    @property
+    def bank_transfer_id(self):
+        """Gets the bank_transfer_id of this BankTransferDelete.  # noqa: E501
+
+        The Xero identifier for a bank transfer  # noqa: E501
+
+        :return: The bank_transfer_id of this BankTransferDelete.  # noqa: E501
+        :rtype: str
+        """
+        return self._bank_transfer_id
+
+    @bank_transfer_id.setter
+    def bank_transfer_id(self, bank_transfer_id):
+        """Sets the bank_transfer_id of this BankTransferDelete.
+
+        The Xero identifier for a bank transfer  # noqa: E501
+
+        :param bank_transfer_id: The bank_transfer_id of this BankTransferDelete.  # noqa: E501
+        :type: str
+        """
+        if bank_transfer_id is None:
+            raise ValueError(
+                "Invalid value for `bank_transfer_id`, must not be `None`"
+            )  # noqa: E501
+
+        self._bank_transfer_id = bank_transfer_id
+
+    @property
+    def status(self):
+        """Gets the status of this BankTransferDelete.  # noqa: E501
+
+        The status of the bank transfer.  # noqa: E501
+
+        :return: The status of this BankTransferDelete.  # noqa: E501
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this BankTransferDelete.
+
+        The status of the bank transfer.  # noqa: E501
+
+        :param status: The status of this BankTransferDelete.  # noqa: E501
+        :type: str
+        """
+        if status is None:
+            raise ValueError(
+                "Invalid value for `status`, must not be `None`"
+            )  # noqa: E501
+
+        self._status = status

xero_python-15.0.0/xero_python/accounting/models/bank_transfer_delete_by_url_param.py

@@ -0,0 +1,69 @@
+# 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 BankTransferDeleteByUrlParam(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 = {"status": "str"}
+
+    attribute_map = {"status": "Status"}
+
+    def __init__(self, status="DELETED"):  # noqa: E501
+        """BankTransferDeleteByUrlParam - a model defined in OpenAPI"""  # noqa: E501
+
+        self._status = None
+        self.discriminator = None
+
+        self.status = status
+
+    @property
+    def status(self):
+        """Gets the status of this BankTransferDeleteByUrlParam.  # noqa: E501
+
+        The status of the bank transfer.  # noqa: E501
+
+        :return: The status of this BankTransferDeleteByUrlParam.  # noqa: E501
+        :rtype: str
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this BankTransferDeleteByUrlParam.
+
+        The status of the bank transfer.  # noqa: E501
+
+        :param status: The status of this BankTransferDeleteByUrlParam.  # noqa: E501
+        :type: str
+        """
+        if status is None:
+            raise ValueError(
+                "Invalid value for `status`, must not be `None`"
+            )  # noqa: E501
+
+        self._status = status