xero-python 8.3.0__tar.gz → 9.1.0__tar.gz

{xero_python-8.3.0 → xero_python-9.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero_python
-Version: 8.3.0
+Version: 9.1.0
 Summary: Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
 Home-page: UNKNOWN
 Author: Xero Developer API
@@ -26,6 +26,7 @@ Description: # xero-python
         - [Helper Methods](#helper-methods)
         - [Usage Examples](#usage-examples)
         - [SDK conventions](#sdk-conventions)
+        - [Running Test(s) in Local](#running-tests-in-local)
         - [Participating in Xero’s developer community](#participating-in-xeros-developer-community)
         - [Contributing](#contributing)
         
@@ -548,6 +549,18 @@ Description: # xero-python
         ---
         ## SDK conventions
         
+        
+        ---
+        ## Running Test(s) in Local
+        For Running Test cases PRISM Mock Server needs to be started in the local machine.
+        Steps to Run Test(s)
+        * Install PRISM from npm using the command:  **npm install -g @stoplight/prism-cli**
+        * Verify Installation: **prism --version**
+        * Navigate to **tests--> utils--> ** folder in the terminal
+        * Execute the script **./start-prism.sh**
+        * This will start the PRISM Server in Local
+        * Run **pytest** to run the Python test cases.
+        
         ### Querying & Filtering
         
         Describe the support for query options and filtering

{xero_python-8.3.0 → xero_python-9.1.0}/README.md

@@ -18,6 +18,7 @@ The xero-python SDK makes it easy for developers to access Xero's APIs in their
 - [Helper Methods](#helper-methods)
 - [Usage Examples](#usage-examples)
 - [SDK conventions](#sdk-conventions)
+- [Running Test(s) in Local](#running-tests-in-local)
 - [Participating in Xero’s developer community](#participating-in-xeros-developer-community)
 - [Contributing](#contributing)
 
@@ -540,6 +541,18 @@ created_invoice_attachments_by_file_name = accounting_api.create_invoice_attachm
 ---
 ## SDK conventions
 
+
+---
+## Running Test(s) in Local
+For Running Test cases PRISM Mock Server needs to be started in the local machine.
+Steps to Run Test(s)
+* Install PRISM from npm using the command:  **npm install -g @stoplight/prism-cli**
+* Verify Installation: **prism --version**
+* Navigate to **tests--> utils--> ** folder in the terminal
+* Execute the script **./start-prism.sh**
+* This will start the PRISM Server in Local
+* Run **pytest** to run the Python test cases.
+
 ### Querying & Filtering
 
 Describe the support for query options and filtering

{xero_python-8.3.0 → xero_python-9.1.0}/requirements.txt

@@ -2,3 +2,4 @@
 python-dateutil>=2.7
 urllib3
 certifi
+setuptools>=75.1.0

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

xero_python-9.1.0/tests/utils/start-prism.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+branchName=${1:-"master"}
+
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_accounting.yaml --host 127.0.0.1 --port 4010 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-app-store.yaml --host 127.0.0.1 --port 4011 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_assets.yaml --host 127.0.0.1 --port 4012 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero_bankfeeds.yaml --host 127.0.0.1 --port 4013 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-finance.yaml --host 127.0.0.1 --port 4014 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-uk.yaml --host 127.0.0.1 --port 4015 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-nz.yaml --host 127.0.0.1 --port 4016 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-payroll-au.yaml --host 127.0.0.1 --port 4017 &
+prism mock https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/refs/heads/$branchName/xero-projects.yaml --host 127.0.0.1 --port 4018

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/__init__.py

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

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/accounting/api/accounting_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 
@@ -2075,6 +2075,7 @@ class AccountingApi(object):
     ):
         """Creates new employees used in Xero payrun  # noqa: E501
         OAuth2 scope: accounting.settings
+        This endpoint is deprecated and will be removed April 28, 2026  # noqa: E501
         :param str xero_tenant_id: Xero identifier for Tenant (required)
         :param Employees employees: Employees with array of Employee object in body of request (required)
         :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors
@@ -10152,6 +10153,7 @@ class AccountingApi(object):
     ):
         """Retrieves a specific employee used in Xero payrun using a unique employee Id  # noqa: E501
         OAuth2 scope: accounting.settings, accounting.settings.read
+        This endpoint is deprecated and will be removed April 28, 2026  # noqa: E501
         :param str xero_tenant_id: Xero identifier for Tenant (required)
         :param str employee_id: Unique identifier for a Employee (required)
         :param bool _return_http_data_only: return received data only
@@ -10230,6 +10232,7 @@ class AccountingApi(object):
     ):
         """Retrieves employees used in Xero payrun  # noqa: E501
         OAuth2 scope: accounting.settings, accounting.settings.read
+        This endpoint is deprecated and will be removed April 28, 2026  # noqa: E501
         :param str xero_tenant_id: Xero identifier for Tenant (required)
         :param datetime if_modified_since: Only records created or modified since this timestamp will be returned
         :param str where: Filter by an any element
@@ -19266,6 +19269,7 @@ class AccountingApi(object):
     ):
         """Creates a single new employees used in Xero payrun  # noqa: E501
         OAuth2 scope: accounting.settings
+        This endpoint is deprecated and will be removed April 28, 2026  # noqa: E501
         :param str xero_tenant_id: Xero identifier for Tenant (required)
         :param Employees employees: Employees with array of Employee object in body of request (required)
         :param bool summarize_errors: If false return 200 OK and mix of successfully created objects and any with validation errors

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/appstore/api/app_store_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/assets/api/asset_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/file/api/files_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/finance/api/finance_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/identity/api/identity_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrollau/api/payroll_au_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrollnz/api/payroll_nz_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrollnz/models/employee.py

@@ -114,14 +114,10 @@ class Employee(BaseModel):
             self.employee_id = employee_id
         if title is not None:
             self.title = title
-        if first_name is not None:
-            self.first_name = first_name
-        if last_name is not None:
-            self.last_name = last_name
-        if date_of_birth is not None:
-            self.date_of_birth = date_of_birth
-        if address is not None:
-            self.address = address
+        self.first_name = first_name
+        self.last_name = last_name
+        self.date_of_birth = date_of_birth
+        self.address = address
         if email is not None:
             self.email = email
         if gender is not None:
@@ -211,6 +207,10 @@ class Employee(BaseModel):
         :param first_name: The first_name of this Employee.  # noqa: E501
         :type: str
         """
+        if first_name is None:
+            raise ValueError(
+                "Invalid value for `first_name`, must not be `None`"
+            )  # noqa: E501
 
         self._first_name = first_name
 
@@ -234,6 +234,10 @@ class Employee(BaseModel):
         :param last_name: The last_name of this Employee.  # noqa: E501
         :type: str
         """
+        if last_name is None:
+            raise ValueError(
+                "Invalid value for `last_name`, must not be `None`"
+            )  # noqa: E501
 
         self._last_name = last_name
 
@@ -257,6 +261,10 @@ class Employee(BaseModel):
         :param date_of_birth: The date_of_birth of this Employee.  # noqa: E501
         :type: date
         """
+        if date_of_birth is None:
+            raise ValueError(
+                "Invalid value for `date_of_birth`, must not be `None`"
+            )  # noqa: E501
 
         self._date_of_birth = date_of_birth
 
@@ -278,6 +286,10 @@ class Employee(BaseModel):
         :param address: The address of this Employee.  # noqa: E501
         :type: Address
         """
+        if address is None:
+            raise ValueError(
+                "Invalid value for `address`, must not be `None`"
+            )  # noqa: E501
 
         self._address = address
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrollnz/models/employment.py

@@ -62,14 +62,11 @@ class Employment(BaseModel):
         self._fixed_term_end_date = None
         self.discriminator = None
 
-        if payroll_calendar_id is not None:
-            self.payroll_calendar_id = payroll_calendar_id
+        self.payroll_calendar_id = payroll_calendar_id
         if pay_run_calendar_id is not None:
             self.pay_run_calendar_id = pay_run_calendar_id
-        if start_date is not None:
-            self.start_date = start_date
-        if engagement_type is not None:
-            self.engagement_type = engagement_type
+        self.start_date = start_date
+        self.engagement_type = engagement_type
         if fixed_term_end_date is not None:
             self.fixed_term_end_date = fixed_term_end_date
 
@@ -93,6 +90,10 @@ class Employment(BaseModel):
         :param payroll_calendar_id: The payroll_calendar_id of this Employment.  # noqa: E501
         :type: str
         """
+        if payroll_calendar_id is None:
+            raise ValueError(
+                "Invalid value for `payroll_calendar_id`, must not be `None`"
+            )  # noqa: E501
 
         self._payroll_calendar_id = payroll_calendar_id
 
@@ -139,6 +140,10 @@ class Employment(BaseModel):
         :param start_date: The start_date of this Employment.  # 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
 
@@ -162,6 +167,10 @@ class Employment(BaseModel):
         :param engagement_type: The engagement_type of this Employment.  # noqa: E501
         :type: str
         """
+        if engagement_type is None:
+            raise ValueError(
+                "Invalid value for `engagement_type`, must not be `None`"
+            )  # noqa: E501
 
         self._engagement_type = engagement_type
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrolluk/api/payroll_uk_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrolluk/models/employee.py

@@ -116,20 +116,14 @@ class Employee(BaseModel):
 
         if employee_id is not None:
             self.employee_id = employee_id
-        if title is not None:
-            self.title = title
-        if first_name is not None:
-            self.first_name = first_name
-        if last_name is not None:
-            self.last_name = last_name
-        if date_of_birth is not None:
-            self.date_of_birth = date_of_birth
-        if address is not None:
-            self.address = address
+        self.title = title
+        self.first_name = first_name
+        self.last_name = last_name
+        self.date_of_birth = date_of_birth
+        self.address = address
         if email is not None:
             self.email = email
-        if gender is not None:
-            self.gender = gender
+        self.gender = gender
         if phone_number is not None:
             self.phone_number = phone_number
         if start_date is not None:
@@ -194,6 +188,10 @@ class Employee(BaseModel):
         :param title: The title of this Employee.  # noqa: E501
         :type: str
         """
+        if title is None:
+            raise ValueError(
+                "Invalid value for `title`, must not be `None`"
+            )  # noqa: E501
 
         self._title = title
 
@@ -217,6 +215,10 @@ class Employee(BaseModel):
         :param first_name: The first_name of this Employee.  # noqa: E501
         :type: str
         """
+        if first_name is None:
+            raise ValueError(
+                "Invalid value for `first_name`, must not be `None`"
+            )  # noqa: E501
 
         self._first_name = first_name
 
@@ -240,6 +242,10 @@ class Employee(BaseModel):
         :param last_name: The last_name of this Employee.  # noqa: E501
         :type: str
         """
+        if last_name is None:
+            raise ValueError(
+                "Invalid value for `last_name`, must not be `None`"
+            )  # noqa: E501
 
         self._last_name = last_name
 
@@ -263,6 +269,10 @@ class Employee(BaseModel):
         :param date_of_birth: The date_of_birth of this Employee.  # noqa: E501
         :type: date
         """
+        if date_of_birth is None:
+            raise ValueError(
+                "Invalid value for `date_of_birth`, must not be `None`"
+            )  # noqa: E501
 
         self._date_of_birth = date_of_birth
 
@@ -284,6 +294,10 @@ class Employee(BaseModel):
         :param address: The address of this Employee.  # noqa: E501
         :type: Address
         """
+        if address is None:
+            raise ValueError(
+                "Invalid value for `address`, must not be `None`"
+            )  # noqa: E501
 
         self._address = address
 
@@ -330,6 +344,10 @@ class Employee(BaseModel):
         :param gender: The gender of this Employee.  # noqa: E501
         :type: str
         """
+        if gender is None:
+            raise ValueError(
+                "Invalid value for `gender`, must not be `None`"
+            )  # noqa: E501
         allowed_values = ["M", "F", "None"]  # noqa: E501
 
         if gender:

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/payrolluk/models/employment.py

@@ -62,16 +62,12 @@ class Employment(BaseModel):
         self._ni_categories = None
         self.discriminator = None
 
-        if payroll_calendar_id is not None:
-            self.payroll_calendar_id = payroll_calendar_id
-        if start_date is not None:
-            self.start_date = start_date
-        if employee_number is not None:
-            self.employee_number = employee_number
+        self.payroll_calendar_id = payroll_calendar_id
+        self.start_date = start_date
+        self.employee_number = employee_number
         if ni_category is not None:
             self.ni_category = ni_category
-        if ni_categories is not None:
-            self.ni_categories = ni_categories
+        self.ni_categories = ni_categories
 
     @property
     def payroll_calendar_id(self):
@@ -93,6 +89,10 @@ class Employment(BaseModel):
         :param payroll_calendar_id: The payroll_calendar_id of this Employment.  # noqa: E501
         :type: str
         """
+        if payroll_calendar_id is None:
+            raise ValueError(
+                "Invalid value for `payroll_calendar_id`, must not be `None`"
+            )  # noqa: E501
 
         self._payroll_calendar_id = payroll_calendar_id
 
@@ -116,6 +116,10 @@ class Employment(BaseModel):
         :param start_date: The start_date of this Employment.  # 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
 
@@ -139,6 +143,10 @@ class Employment(BaseModel):
         :param employee_number: The employee_number of this Employment.  # noqa: E501
         :type: str
         """
+        if employee_number is None:
+            raise ValueError(
+                "Invalid value for `employee_number`, must not be `None`"
+            )  # noqa: E501
 
         self._employee_number = employee_number
 
@@ -183,5 +191,9 @@ class Employment(BaseModel):
         :param ni_categories: The ni_categories of this Employment.  # noqa: E501
         :type: list[NICategory]
         """
+        if ni_categories is None:
+            raise ValueError(
+                "Invalid value for `ni_categories`, must not be `None`"
+            )  # noqa: E501
 
         self._ni_categories = ni_categories

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python/project/api/project_api.py

@@ -21,7 +21,7 @@ except ImportError:
 """
 
 """
-    OpenAPI spec version: 8.3.0
+    OpenAPI spec version: 9.1.0
 """
 
 

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xero-python
-Version: 8.3.0
+Version: 9.1.0
 Summary: Official Python sdk for Xero API generated by OpenAPI spec for oAuth2
 Home-page: UNKNOWN
 Author: Xero Developer API
@@ -26,6 +26,7 @@ Description: # xero-python
         - [Helper Methods](#helper-methods)
         - [Usage Examples](#usage-examples)
         - [SDK conventions](#sdk-conventions)
+        - [Running Test(s) in Local](#running-tests-in-local)
         - [Participating in Xero’s developer community](#participating-in-xeros-developer-community)
         - [Contributing](#contributing)
         
@@ -548,6 +549,18 @@ Description: # xero-python
         ---
         ## SDK conventions
         
+        
+        ---
+        ## Running Test(s) in Local
+        For Running Test cases PRISM Mock Server needs to be started in the local machine.
+        Steps to Run Test(s)
+        * Install PRISM from npm using the command:  **npm install -g @stoplight/prism-cli**
+        * Verify Installation: **prism --version**
+        * Navigate to **tests--> utils--> ** folder in the terminal
+        * Execute the script **./start-prism.sh**
+        * This will start the PRISM Server in Local
+        * Run **pytest** to run the Python test cases.
+        
         ### Querying & Filtering
         
         Describe the support for query options and filtering

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python.egg-info/SOURCES.txt

@@ -27,6 +27,7 @@ tests/test_api_client/test_oauth2.py
 tests/test_api_client/test_serializer.py
 tests/test_api_client/cassettes/test_call_api_get_organisations.yaml
 tests/test_api_client/cassettes/test_token_api_refresh_token.yaml
+tests/utils/start-prism.sh
 xero_python/__init__.py
 xero_python/models.py
 xero_python/rest.py

{xero_python-8.3.0 → xero_python-9.1.0}/xero_python.egg-info/requires.txt

@@ -1,3 +1,4 @@
 python-dateutil>=2.7
 urllib3
 certifi
+setuptools>=75.1.0