Merge pull request #383 from XeroAPI/v8.0.0

Build from OAS 7.0.0
XeroAPI · Jan 31, 2025 · f0635a7 · f0635a7
2 parents 98e082b + 6e6f136
commit f0635a7
Show file tree

Hide file tree

Showing 26 changed files with 470 additions and 169 deletions.
diff --git a/docs/v2/accounting/index.html b/docs/v2/accounting/index.html
@@ -6338,7 +6338,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
               <li data-group="Accounting" data-name="createAccount" class="">
                 <a href="#api-Accounting-createAccount">createAccount</a>

diff --git a/docs/v2/appstore/index.html b/docs/v2/appstore/index.html
@@ -1240,7 +1240,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="AppStore"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
               <li data-group="AppStore" data-name="getSubscription" class="">
                 <a href="#api-AppStore-getSubscription">getSubscription</a>

diff --git a/docs/v2/assets/index.html b/docs/v2/assets/index.html
@@ -1391,7 +1391,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="Asset"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
               <li data-group="Asset" data-name="createAsset" class="">
                 <a href="#api-Asset-createAsset">createAsset</a>

diff --git a/docs/v2/files/index.html b/docs/v2/files/index.html
@@ -1169,7 +1169,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Files"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="Files"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
               <li data-group="Files" data-name="createFileAssociation" class="">
                 <a href="#api-Files-createFileAssociation">createFileAssociation</a>

diff --git a/docs/v2/finance/index.html b/docs/v2/finance/index.html
@@ -1517,7 +1517,7 @@
     },
     "importSourceType" : {
       "type" : "string",
-      "description" : "Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying)."
+      "description" : "Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying)."
     }
   },
   "additionalProperties" : false,
@@ -1533,13 +1533,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeed" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUpload" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.",
@@ -1558,13 +1551,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeedPos" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUploadPos" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.",
@@ -1583,13 +1569,6 @@
       "format" : "double",
       "x-is-money" : true
     },
-    "indirectBankFeedNeg" : {
-      "type" : "number",
-      "description" : "No longer in use.",
-      "format" : "double",
-      "deprecated" : true,
-      "x-is-money" : true
-    },
     "fileUploadNeg" : {
       "type" : "number",
       "description" : "Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.",
@@ -2736,7 +2715,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="Finance"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
               <li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
                 <a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

diff --git a/docs/v2/payroll_au/index.html b/docs/v2/payroll_au/index.html
@@ -3411,7 +3411,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
               <li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
                 <a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

diff --git a/docs/v2/payroll_nz/index.html b/docs/v2/payroll_nz/index.html
@@ -1684,14 +1684,28 @@
     },
     "sickLeaveHoursToAccrueAnnually" : {
       "type" : "number",
-      "description" : "Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day",
+      "description" : "Deprecated use SickLeaveToAccrueAnnually",
       "format" : "double",
       "example" : 100.5,
       "x-is-money" : true
     },
     "sickLeaveMaximumHoursToAccrue" : {
       "type" : "number",
-      "description" : "Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day",
+      "description" : "Deprecated use SickLeaveMaximumToAccrue",
+      "format" : "double",
+      "example" : 200.5,
+      "x-is-money" : true
+    },
+    "SickLeaveToAccrueAnnually" : {
+      "type" : "number",
+      "description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type",
+      "format" : "double",
+      "example" : 100.5,
+      "x-is-money" : true
+    },
+    "SickLeaveMaximumToAccrue" : {
+      "type" : "number",
+      "description" : "Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type",
       "format" : "double",
       "example" : 200.5,
       "x-is-money" : true
@@ -1710,7 +1724,14 @@
     },
     "SickLeaveAnniversaryDate" : {
       "type" : "string",
-      "description" : "If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave",
+      "description" : "If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date",
+      "format" : "date",
+      "example" : "2020-01-19",
+      "x-is-date" : true
+    },
+    "AnnualLeaveAnniversaryDate" : {
+      "type" : "string",
+      "description" : "The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date",
       "format" : "date",
       "example" : "2020-01-19",
       "x-is-date" : true
@@ -1750,22 +1771,36 @@
     },
     "hoursAccruedAnnually" : {
       "type" : "number",
-      "description" : "The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\"",
+      "description" : "Deprecated use UnitsAccruedAnnually",
       "format" : "double",
       "x-is-money" : true
     },
+    "UnitsAccruedAnnually" : {
+      "type" : "number",
+      "description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"",
+      "format" : "double",
+      "x-is-money" : true
+    },
+    "typeOfUnitsToAccrue" : {
+      "type" : "string",
+      "description" : "The type of units accrued for the leave annually"
+    },
     "maximumToAccrue" : {
       "type" : "number",
-      "description" : "The maximum number of hours that can be accrued for the leave",
+      "description" : "The maximum number of units that can be accrued for the leave",
       "format" : "double",
       "x-is-money" : true
     },
     "openingBalance" : {
       "type" : "number",
-      "description" : "The initial number of hours assigned when the leave was added to the employee",
+      "description" : "The initial number of units assigned when the leave was added to the employee",
       "format" : "double",
       "x-is-money" : true
     },
+    "openingBalanceTypeOfUnits" : {
+      "type" : "string",
+      "description" : "The type of units for the opening balance"
+    },
     "rateAccruedHourly" : {
       "type" : "number",
       "description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"",
@@ -2609,10 +2644,23 @@
       "format" : "double",
       "x-is-money" : true
     },
+    "numberOfUnitsTaken" : {
+      "type" : "number",
+      "description" : "The number of units taken for the leave",
+      "format" : "double"
+    },
+    "typeOfUnits" : {
+      "type" : "string",
+      "description" : "The type of units paid for the leave"
+    },
+    "typeOfUnitsTaken" : {
+      "type" : "string",
+      "description" : "The type of units taken for the leave"
+    },
     "periodStatus" : {
       "type" : "string",
-      "description" : "Period Status",
-      "enum" : [ "Approved", "Completed" ]
+      "description" : "Status of leave",
+      "enum" : [ "Approved", "Completed", "Estimated" ]
     }
   },
   "description" : ""
@@ -2667,6 +2715,14 @@
     "isActive" : {
       "type" : "boolean",
       "description" : "Shows whether the leave type is active or not"
+    },
+    "typeOfUnits" : {
+      "type" : "string",
+      "description" : "The type of units to be paid for the leave type"
+    },
+    "typeOfUnitsToAccrue" : {
+      "type" : "string",
+      "description" : "The type of units to be accrued for the leave type"
     }
   },
   "description" : ""
@@ -4030,7 +4086,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
               <li data-group="PayrollNz" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

diff --git a/docs/v2/payroll_uk/index.html b/docs/v2/payroll_uk/index.html
@@ -3516,7 +3516,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
               <li data-group="PayrollUk" data-name="approveTimesheet" class="">
                 <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

diff --git a/docs/v2/projects/index.html b/docs/v2/projects/index.html
@@ -1461,7 +1461,7 @@
           <nav id="scrollingNav">
             <ul class="sidenav nav nav-list">
               <li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
-              <li class="nav-header" data-group="Project"><strong>VSN: </strong>7.3.0</li>
+              <li class="nav-header" data-group="Project"><strong>VSN: </strong>8.0.0</li>
               <li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
               <li data-group="Project" data-name="createProject" class="">
                 <a href="#api-Project-createProject">createProject</a>

diff --git a/lib/Api/AccountingApi.php b/lib/Api/AccountingApi.php
@@ -14,7 +14,7 @@
  *
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/AppStoreApi.php b/lib/Api/AppStoreApi.php
@@ -14,7 +14,7 @@
  *
  * These endpoints are for Xero Partners to interact with the App Store Billing platform
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/AssetApi.php b/lib/Api/AssetApi.php
@@ -14,7 +14,7 @@
  *
  * The Assets API exposes fixed asset related functions of the Xero Accounting application and can be used for a variety of purposes such as creating assets, retrieving asset valuations etc.
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/FilesApi.php b/lib/Api/FilesApi.php
@@ -14,7 +14,7 @@
  *
  * These endpoints are specific to Xero Files API
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/FinanceApi.php b/lib/Api/FinanceApi.php
@@ -14,7 +14,7 @@
  *
  * The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/IdentityApi.php b/lib/Api/IdentityApi.php
@@ -14,7 +14,7 @@
  *
  * These endpoints are related to managing authentication tokens and identity for Xero API
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/PayrollAuApi.php b/lib/Api/PayrollAuApi.php
@@ -14,7 +14,7 @@
  *
  * This is the Xero Payroll API for orgs in Australia region.
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/PayrollNzApi.php b/lib/Api/PayrollNzApi.php
@@ -14,7 +14,7 @@
  *
  * This is the Xero Payroll API for orgs in the NZ region.
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/PayrollUkApi.php b/lib/Api/PayrollUkApi.php
@@ -14,7 +14,7 @@
  *
  * This is the Xero Payroll API for orgs in the UK region.
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Api/ProjectApi.php b/lib/Api/ProjectApi.php
@@ -14,7 +14,7 @@
  *
  * This is the Xero Projects API
  *
- * OpenAPI spec version: 6.3.0
+ * OpenAPI spec version: 7.0.0
  * Contact: [email protected]
  * Generated by: https://openapi-generator.tech
  * OpenAPI Generator version: 5.4.0

diff --git a/lib/Configuration.php b/lib/Configuration.php
@@ -157,7 +157,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = '[xero-php-oauth2 (7.2.0)]';
+    protected $userAgent = '[xero-php-oauth2 (8.0.0)]';
 
     /**
      * Debug switch (default set to false)
@@ -696,8 +696,8 @@ public static function toDebugReport()
         $report  = 'PHP SDK (XeroAPI\XeroPHP) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
-        $report .= '    OpenAPI Spec Version: 6.3.0' . PHP_EOL;
-        $report .= '    SDK Package Version: 7.3.0' . PHP_EOL;
+        $report .= '    OpenAPI Spec Version: 7.0.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 8.0.0' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

diff --git a/lib/Models/Finance/CurrentStatementResponse.php b/lib/Models/Finance/CurrentStatementResponse.php
@@ -383,7 +383,7 @@ public function getImportSourceType()
     /**
      * Sets import_source_type
      *
-     * @param string|null $import_source_type Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, indirect bank feed, file upload, or manual keying).
+     * @param string|null $import_source_type Looking at the most recent bank statement, this field indicates the source of the data (direct bank feed, file upload, or manual keying).
      *
      * @return $this
      */