xero-python 9.2.0__tar.gz → 9.3.0__tar.gz

{xero_python-9.2.0 → xero_python-9.3.0}/PKG-INFO

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

{xero_python-9.2.0 → xero_python-9.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="9.2.0",
+    version="9.3.0",
 )

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/__init__.py

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

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/accounting/api/accounting_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/appstore/api/app_store_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/assets/api/asset_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/file/api/files_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/finance/api/finance_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/identity/api/identity_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrollau/api/payroll_au_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrollnz/api/payroll_nz_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrolluk/__init__.py

@@ -25,11 +25,16 @@ from xero_python.payrolluk.models.benefit import Benefit
 from xero_python.payrolluk.models.benefit_line import BenefitLine
 from xero_python.payrolluk.models.benefit_object import BenefitObject
 from xero_python.payrolluk.models.benefits import Benefits
+from xero_python.payrolluk.models.contract_type import ContractType
+from xero_python.payrolluk.models.contracts import Contracts
 from xero_python.payrolluk.models.court_order_line import CourtOrderLine
 from xero_python.payrolluk.models.deduction import Deduction
 from xero_python.payrolluk.models.deduction_line import DeductionLine
 from xero_python.payrolluk.models.deduction_object import DeductionObject
 from xero_python.payrolluk.models.deductions import Deductions
+from xero_python.payrolluk.models.developmental_role_details import (
+    DevelopmentalRoleDetails,
+)
 from xero_python.payrolluk.models.earnings_line import EarningsLine
 from xero_python.payrolluk.models.earnings_order import EarningsOrder
 from xero_python.payrolluk.models.earnings_order_object import EarningsOrderObject
@@ -88,6 +93,7 @@ from xero_python.payrolluk.models.employee_tax_object import EmployeeTaxObject
 from xero_python.payrolluk.models.employees import Employees
 from xero_python.payrolluk.models.employment import Employment
 from xero_python.payrolluk.models.employment_object import EmploymentObject
+from xero_python.payrolluk.models.employment_status import EmploymentStatus
 from xero_python.payrolluk.models.invalid_field import InvalidField
 from xero_python.payrolluk.models.leave_accrual_line import LeaveAccrualLine
 from xero_python.payrolluk.models.leave_earnings_line import LeaveEarningsLine

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrolluk/api/payroll_uk_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 9.2.0
+    OpenAPI spec version: 9.3.0
 """
 
 

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrolluk/models/__init__.py

@@ -20,11 +20,16 @@ from xero_python.payrolluk.models.benefit import Benefit
 from xero_python.payrolluk.models.benefit_line import BenefitLine
 from xero_python.payrolluk.models.benefit_object import BenefitObject
 from xero_python.payrolluk.models.benefits import Benefits
+from xero_python.payrolluk.models.contract_type import ContractType
+from xero_python.payrolluk.models.contracts import Contracts
 from xero_python.payrolluk.models.court_order_line import CourtOrderLine
 from xero_python.payrolluk.models.deduction import Deduction
 from xero_python.payrolluk.models.deduction_line import DeductionLine
 from xero_python.payrolluk.models.deduction_object import DeductionObject
 from xero_python.payrolluk.models.deductions import Deductions
+from xero_python.payrolluk.models.developmental_role_details import (
+    DevelopmentalRoleDetails,
+)
 from xero_python.payrolluk.models.earnings_line import EarningsLine
 from xero_python.payrolluk.models.earnings_order import EarningsOrder
 from xero_python.payrolluk.models.earnings_order_object import EarningsOrderObject
@@ -83,6 +88,7 @@ from xero_python.payrolluk.models.employee_tax_object import EmployeeTaxObject
 from xero_python.payrolluk.models.employees import Employees
 from xero_python.payrolluk.models.employment import Employment
 from xero_python.payrolluk.models.employment_object import EmploymentObject
+from xero_python.payrolluk.models.employment_status import EmploymentStatus
 from xero_python.payrolluk.models.invalid_field import InvalidField
 from xero_python.payrolluk.models.leave_accrual_line import LeaveAccrualLine
 from xero_python.payrolluk.models.leave_earnings_line import LeaveEarningsLine

xero_python-9.3.0/xero_python/payrolluk/models/contract_type.py

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+"""
+Xero Payroll UK
+
+This is the Xero Payroll API for orgs in the UK region.  # noqa: E501
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+
+from enum import Enum
+
+
+class ContractType(Enum):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    allowed enum values
+    """
+
+    FULLTIME = "FullTime"
+    PARTTIME = "PartTime"
+    ZEROHOUR = "ZeroHour"
+    UNSPECIFIED = "Unspecified"

xero_python-9.3.0/xero_python/payrolluk/models/contracts.py

@@ -0,0 +1,250 @@
+# coding: utf-8
+
+"""
+Xero Payroll UK
+
+This is the Xero Payroll API for orgs in the UK region.  # noqa: E501
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+
+from xero_python.models import BaseModel
+
+
+class Contracts(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 = {
+        "start_date": "date",
+        "employment_status": "EmploymentStatus",
+        "contract_type": "ContractType",
+        "public_key": "str",
+        "is_fixed_term": "bool",
+        "fixed_term_end_date": "date",
+        "developmental_role_details": "DevelopmentalRoleDetails",
+    }
+
+    attribute_map = {
+        "start_date": "startDate",
+        "employment_status": "employmentStatus",
+        "contract_type": "contractType",
+        "public_key": "publicKey",
+        "is_fixed_term": "isFixedTerm",
+        "fixed_term_end_date": "fixedTermEndDate",
+        "developmental_role_details": "developmentalRoleDetails",
+    }
+
+    def __init__(
+        self,
+        start_date=None,
+        employment_status=None,
+        contract_type=None,
+        public_key=None,
+        is_fixed_term=None,
+        fixed_term_end_date=None,
+        developmental_role_details=None,
+    ):  # noqa: E501
+        """Contracts - a model defined in OpenAPI"""  # noqa: E501
+
+        self._start_date = None
+        self._employment_status = None
+        self._contract_type = None
+        self._public_key = None
+        self._is_fixed_term = None
+        self._fixed_term_end_date = None
+        self._developmental_role_details = None
+        self.discriminator = None
+
+        self.start_date = start_date
+        self.employment_status = employment_status
+        self.contract_type = contract_type
+        if public_key is not None:
+            self.public_key = public_key
+        if is_fixed_term is not None:
+            self.is_fixed_term = is_fixed_term
+        if fixed_term_end_date is not None:
+            self.fixed_term_end_date = fixed_term_end_date
+        if developmental_role_details is not None:
+            self.developmental_role_details = developmental_role_details
+
+    @property
+    def start_date(self):
+        """Gets the start_date of this Contracts.  # noqa: E501
+
+        The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD)  # noqa: E501
+
+        :return: The start_date of this Contracts.  # noqa: E501
+        :rtype: date
+        """
+        return self._start_date
+
+    @start_date.setter
+    def start_date(self, start_date):
+        """Sets the start_date of this Contracts.
+
+        The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD)  # noqa: E501
+
+        :param start_date: The start_date of this Contracts.  # noqa: E501
+        :type: date
+        """
+        if start_date is None:
+            raise ValueError(
+                "Invalid value for `start_date`, must not be `None`"
+            )  # noqa: E501
+
+        self._start_date = start_date
+
+    @property
+    def employment_status(self):
+        """Gets the employment_status of this Contracts.  # noqa: E501
+
+
+        :return: The employment_status of this Contracts.  # noqa: E501
+        :rtype: EmploymentStatus
+        """
+        return self._employment_status
+
+    @employment_status.setter
+    def employment_status(self, employment_status):
+        """Sets the employment_status of this Contracts.
+
+
+        :param employment_status: The employment_status of this Contracts.  # noqa: E501
+        :type: EmploymentStatus
+        """
+        if employment_status is None:
+            raise ValueError(
+                "Invalid value for `employment_status`, must not be `None`"
+            )  # noqa: E501
+
+        self._employment_status = employment_status
+
+    @property
+    def contract_type(self):
+        """Gets the contract_type of this Contracts.  # noqa: E501
+
+
+        :return: The contract_type of this Contracts.  # noqa: E501
+        :rtype: ContractType
+        """
+        return self._contract_type
+
+    @contract_type.setter
+    def contract_type(self, contract_type):
+        """Sets the contract_type of this Contracts.
+
+
+        :param contract_type: The contract_type of this Contracts.  # noqa: E501
+        :type: ContractType
+        """
+        if contract_type is None:
+            raise ValueError(
+                "Invalid value for `contract_type`, must not be `None`"
+            )  # noqa: E501
+
+        self._contract_type = contract_type
+
+    @property
+    def public_key(self):
+        """Gets the public_key of this Contracts.  # noqa: E501
+
+        The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created  # noqa: E501
+
+        :return: The public_key of this Contracts.  # noqa: E501
+        :rtype: str
+        """
+        return self._public_key
+
+    @public_key.setter
+    def public_key(self, public_key):
+        """Sets the public_key of this Contracts.
+
+        The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created  # noqa: E501
+
+        :param public_key: The public_key of this Contracts.  # noqa: E501
+        :type: str
+        """
+
+        self._public_key = public_key
+
+    @property
+    def is_fixed_term(self):
+        """Gets the is_fixed_term of this Contracts.  # noqa: E501
+
+        describes whether the contract is fixed term (required if trying to create Fixed term contract)  # noqa: E501
+
+        :return: The is_fixed_term of this Contracts.  # noqa: E501
+        :rtype: bool
+        """
+        return self._is_fixed_term
+
+    @is_fixed_term.setter
+    def is_fixed_term(self, is_fixed_term):
+        """Sets the is_fixed_term of this Contracts.
+
+        describes whether the contract is fixed term (required if trying to create Fixed term contract)  # noqa: E501
+
+        :param is_fixed_term: The is_fixed_term of this Contracts.  # noqa: E501
+        :type: bool
+        """
+
+        self._is_fixed_term = is_fixed_term
+
+    @property
+    def fixed_term_end_date(self):
+        """Gets the fixed_term_end_date of this Contracts.  # noqa: E501
+
+        The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract)  # noqa: E501
+
+        :return: The fixed_term_end_date of this Contracts.  # noqa: E501
+        :rtype: date
+        """
+        return self._fixed_term_end_date
+
+    @fixed_term_end_date.setter
+    def fixed_term_end_date(self, fixed_term_end_date):
+        """Sets the fixed_term_end_date of this Contracts.
+
+        The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract)  # noqa: E501
+
+        :param fixed_term_end_date: The fixed_term_end_date of this Contracts.  # noqa: E501
+        :type: date
+        """
+
+        self._fixed_term_end_date = fixed_term_end_date
+
+    @property
+    def developmental_role_details(self):
+        """Gets the developmental_role_details of this Contracts.  # noqa: E501
+
+
+        :return: The developmental_role_details of this Contracts.  # noqa: E501
+        :rtype: DevelopmentalRoleDetails
+        """
+        return self._developmental_role_details
+
+    @developmental_role_details.setter
+    def developmental_role_details(self, developmental_role_details):
+        """Sets the developmental_role_details of this Contracts.
+
+
+        :param developmental_role_details: The developmental_role_details of this Contracts.  # noqa: E501
+        :type: DevelopmentalRoleDetails
+        """
+
+        self._developmental_role_details = developmental_role_details

xero_python-9.3.0/xero_python/payrolluk/models/developmental_role_details.py

@@ -0,0 +1,165 @@
+# coding: utf-8
+
+"""
+Xero Payroll UK
+
+This is the Xero Payroll API for orgs in the UK region.  # noqa: E501
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+
+from xero_python.models import BaseModel
+
+
+class DevelopmentalRoleDetails(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 = {
+        "start_date": "date",
+        "end_date": "date",
+        "developmental_role": "str",
+        "public_key": "str",
+    }
+
+    attribute_map = {
+        "start_date": "startDate",
+        "end_date": "endDate",
+        "developmental_role": "developmentalRole",
+        "public_key": "publicKey",
+    }
+
+    def __init__(
+        self, start_date=None, end_date=None, developmental_role=None, public_key=None
+    ):  # noqa: E501
+        """DevelopmentalRoleDetails - a model defined in OpenAPI"""  # noqa: E501
+
+        self._start_date = None
+        self._end_date = None
+        self._developmental_role = None
+        self._public_key = None
+        self.discriminator = None
+
+        self.start_date = start_date
+        self.end_date = end_date
+        self.developmental_role = developmental_role
+        if public_key is not None:
+            self.public_key = public_key
+
+    @property
+    def start_date(self):
+        """Gets the start_date of this DevelopmentalRoleDetails.  # noqa: E501
+
+        The start date of the developmental role  # noqa: E501
+
+        :return: The start_date of this DevelopmentalRoleDetails.  # noqa: E501
+        :rtype: date
+        """
+        return self._start_date
+
+    @start_date.setter
+    def start_date(self, start_date):
+        """Sets the start_date of this DevelopmentalRoleDetails.
+
+        The start date of the developmental role  # noqa: E501
+
+        :param start_date: The start_date of this DevelopmentalRoleDetails.  # noqa: E501
+        :type: date
+        """
+        if start_date is None:
+            raise ValueError(
+                "Invalid value for `start_date`, must not be `None`"
+            )  # noqa: E501
+
+        self._start_date = start_date
+
+    @property
+    def end_date(self):
+        """Gets the end_date of this DevelopmentalRoleDetails.  # noqa: E501
+
+        The end date of the developmental role  # noqa: E501
+
+        :return: The end_date of this DevelopmentalRoleDetails.  # noqa: E501
+        :rtype: date
+        """
+        return self._end_date
+
+    @end_date.setter
+    def end_date(self, end_date):
+        """Sets the end_date of this DevelopmentalRoleDetails.
+
+        The end date of the developmental role  # noqa: E501
+
+        :param end_date: The end_date of this DevelopmentalRoleDetails.  # noqa: E501
+        :type: date
+        """
+        if end_date is None:
+            raise ValueError(
+                "Invalid value for `end_date`, must not be `None`"
+            )  # noqa: E501
+
+        self._end_date = end_date
+
+    @property
+    def developmental_role(self):
+        """Gets the developmental_role of this DevelopmentalRoleDetails.  # noqa: E501
+
+        The developmental role type - \"Apprentice\" is the only supported role currently  # noqa: E501
+
+        :return: The developmental_role of this DevelopmentalRoleDetails.  # noqa: E501
+        :rtype: str
+        """
+        return self._developmental_role
+
+    @developmental_role.setter
+    def developmental_role(self, developmental_role):
+        """Sets the developmental_role of this DevelopmentalRoleDetails.
+
+        The developmental role type - \"Apprentice\" is the only supported role currently  # noqa: E501
+
+        :param developmental_role: The developmental_role of this DevelopmentalRoleDetails.  # noqa: E501
+        :type: str
+        """
+        if developmental_role is None:
+            raise ValueError(
+                "Invalid value for `developmental_role`, must not be `None`"
+            )  # noqa: E501
+
+        self._developmental_role = developmental_role
+
+    @property
+    def public_key(self):
+        """Gets the public_key of this DevelopmentalRoleDetails.  # noqa: E501
+
+        The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created  # noqa: E501
+
+        :return: The public_key of this DevelopmentalRoleDetails.  # noqa: E501
+        :rtype: str
+        """
+        return self._public_key
+
+    @public_key.setter
+    def public_key(self, public_key):
+        """Sets the public_key of this DevelopmentalRoleDetails.
+
+        The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created  # noqa: E501
+
+        :param public_key: The public_key of this DevelopmentalRoleDetails.  # noqa: E501
+        :type: str
+        """
+
+        self._public_key = public_key

{xero_python-9.2.0 → xero_python-9.3.0}/xero_python/payrolluk/models/employee.py

@@ -48,6 +48,7 @@ class Employee(BaseModel):
         "ni_categories": "list[NICategory]",
         "national_insurance_number": "str",
         "is_off_payroll_worker": "bool",
+        "contracts": "list[Contracts]",
     }
 
     attribute_map = {
@@ -69,6 +70,7 @@ class Employee(BaseModel):
         "ni_categories": "niCategories",
         "national_insurance_number": "nationalInsuranceNumber",
         "is_off_payroll_worker": "isOffPayrollWorker",
+        "contracts": "contracts",
     }
 
     def __init__(
@@ -91,6 +93,7 @@ class Employee(BaseModel):
         ni_categories=None,
         national_insurance_number=None,
         is_off_payroll_worker=None,
+        contracts=None,
     ):  # noqa: E501
         """Employee - a model defined in OpenAPI"""  # noqa: E501
 
@@ -112,6 +115,7 @@ class Employee(BaseModel):
         self._ni_categories = None
         self._national_insurance_number = None
         self._is_off_payroll_worker = None
+        self._contracts = None
         self.discriminator = None
 
         if employee_id is not None:
@@ -144,6 +148,8 @@ class Employee(BaseModel):
             self.national_insurance_number = national_insurance_number
         if is_off_payroll_worker is not None:
             self.is_off_payroll_worker = is_off_payroll_worker
+        if contracts is not None:
+            self.contracts = contracts
 
     @property
     def employee_id(self):
@@ -587,3 +593,26 @@ class Employee(BaseModel):
         """
 
         self._is_off_payroll_worker = is_off_payroll_worker
+
+    @property
+    def contracts(self):
+        """Gets the contracts of this Employee.  # noqa: E501
+
+        The employee's contracts  # noqa: E501
+
+        :return: The contracts of this Employee.  # noqa: E501
+        :rtype: list[Contracts]
+        """
+        return self._contracts
+
+    @contracts.setter
+    def contracts(self, contracts):
+        """Sets the contracts of this Employee.
+
+        The employee's contracts  # noqa: E501
+
+        :param contracts: The contracts of this Employee.  # noqa: E501
+        :type: list[Contracts]
+        """
+
+        self._contracts = contracts