Skip to content

Commit 3162bcf

Browse files
pumpkinballpumpkinball
authored
Merge pull request #314 from XeroAPI/xero-php-2.21.0
2.21.0
2 parents 82d24f1 + 2de89f9 commit 3162bcf

25 files changed

+1075
-33
lines changed

‎docs/v2/accounting/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6073,7 +6073,7 @@
60736073
<nav id="scrollingNav">
60746074
<ul class="sidenav nav nav-list">
60756075
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6076-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.20.0</li>
6076+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.21.0</li>
60776077
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60786078
<li data-group="Accounting" data-name="createAccount" class="">
60796079
<a href="#api-Accounting-createAccount">createAccount</a>

‎docs/v2/appstore/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1240,7 +1240,7 @@
12401240
<nav id="scrollingNav">
12411241
<ul class="sidenav nav nav-list">
12421242
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1243-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>2.20.0</li>
1243+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>2.21.0</li>
12441244
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12451245
<li data-group="AppStore" data-name="getSubscription" class="">
12461246
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v2/assets/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1391,7 +1391,7 @@
13911391
<nav id="scrollingNav">
13921392
<ul class="sidenav nav nav-list">
13931393
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1394-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.20.0</li>
1394+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.21.0</li>
13951395
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13961396
<li data-group="Asset" data-name="createAsset" class="">
13971397
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v2/files/index.html

Lines changed: 131 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1154,7 +1154,7 @@
11541154
<nav id="scrollingNav">
11551155
<ul class="sidenav nav nav-list">
11561156
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1157-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>2.20.0</li>
1157+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>2.21.0</li>
11581158
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11591159
<li data-group="Files" data-name="createFileAssociation" class="">
11601160
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
@@ -1174,6 +1174,9 @@
11741174
<li data-group="Files" data-name="getAssociationsByObject" class="">
11751175
<a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
11761176
</li>
1177+
<li data-group="Files" data-name="getAssociationsCount" class="">
1178+
<a href="#api-Files-getAssociationsCount">getAssociationsCount</a>
1179+
</li>
11771180
<li data-group="Files" data-name="getFile" class="">
11781181
<a href="#api-Files-getFile">getFile</a>
11791182
</li>
@@ -1896,7 +1899,7 @@ <h1>getAssociationsByObject</h1>
18961899
<div class="pull-right"></div>
18971900
<div class="clearfix"></div>
18981901
<p></p>
1899-
<p class="marked">By passing in the appropriate options,</p>
1902+
<p class="marked">By passing in the appropriate options, you can retrieve an association</p>
19001903
<p></p>
19011904
<br />
19021905
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
@@ -2007,6 +2010,132 @@ <h2>Parameters</h2>
20072010
</div>
20082011
</div>
20092012
</td>
2013+
</tr>
2014+
2015+
</table>
2016+
</article>
2017+
</div>
2018+
<hr>
2019+
<div id="api-Files-getAssociationsCount">
2020+
<article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0">
2021+
<div class="pull-left">
2022+
<h1>getAssociationsCount</h1>
2023+
<p>Retrieves a count of associations for a list of objects.</p>
2024+
</div>
2025+
<div class="pull-right"></div>
2026+
<div class="clearfix"></div>
2027+
<p></p>
2028+
<p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p>
2029+
<p></p>
2030+
<br />
2031+
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre>
2032+
<p>
2033+
<h3>Usage and SDK Samples</h3>
2034+
</p>
2035+
<ul class="nav nav-tabs nav-tabs-examples">
2036+
<!-- *****REPLACE***** comment out the other languages <li> -->
2037+
<li class=""><a href="#examples-Files-getAssociationsCount-0-php">PHP</a></li>
2038+
</ul>
2039+
<div class="tab-content">
2040+
<!-- *****REPLACE***** comment out the other languages tab-pane -->
2041+
<div class="tab-pane" id="examples-Files-getAssociationsCount-0-php">
2042+
<pre class="prettyprint"><code class="language-php"><&#63;php
2043+
require_once(__DIR__ . '/vendor/autoload.php');
2044+
2045+
// Configure OAuth2 access token for authorization: OAuth2
2046+
$config = XeroAPI\XeroPHP\Configuration::getDefaultConfiguration()->setAccessToken( 'YOUR_ACCESS_TOKEN' );
2047+
2048+
$apiInstance = new XeroAPI\XeroPHP\Api\FilesApi(
2049+
new GuzzleHttp\Client(),
2050+
$config
2051+
);
2052+
$xeroTenantId = "YOUR_XERO_TENANT_ID";
2053+
$objectIds = array()
2054+
2055+
try {
2056+
$result = $apiInstance->getAssociationsCount($xeroTenantId, $objectIds);
2057+
} catch (Exception $e) {
2058+
echo 'Exception when calling FilesApi->getAssociationsCount: ', $e->getMessage(), PHP_EOL;
2059+
}
2060+
?>
2061+
</code></pre>
2062+
</div>
2063+
</div>
2064+
<h2>Scopes</h2>
2065+
<table>
2066+
2067+
<tr>
2068+
<td>files</td>
2069+
<td>Grant read-write access to files and folders</td>
2070+
</tr>
2071+
2072+
<tr>
2073+
<td>files.read</td>
2074+
<td>Grant read-only access to files and folders</td>
2075+
</tr>
2076+
2077+
</table>
2078+
<h2>Parameters</h2>
2079+
<div class="methodsubtabletitle">Header parameters</div>
2080+
<table id="methodsubtable">
2081+
<tr>
2082+
<th width="150px">Name</th>
2083+
<th>Description</th>
2084+
</tr>
2085+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
2086+
<td>
2087+
2088+
2089+
<div id="d2e199_getAssociationsCount_xeroTenantId">
2090+
<div class="json-schema-view">
2091+
<div class="primitive">
2092+
<span class="type">
2093+
String
2094+
</span>
2095+
2096+
<div class="inner description marked">
2097+
Xero identifier for Tenant
2098+
</div>
2099+
</div>
2100+
<div class="inner required">
2101+
Required
2102+
</div>
2103+
</div>
2104+
</div>
2105+
</td>
2106+
</tr>
2107+
2108+
</table>
2109+
<div class="methodsubtabletitle">Query parameters</div>
2110+
<table id="methodsubtable">
2111+
<tr>
2112+
<th width="150px">Name</th>
2113+
<th>Description</th>
2114+
</tr>
2115+
<tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td>
2116+
<td>
2117+
2118+
2119+
<div id="d2e199_getAssociationsCount_objectIds">
2120+
<div class="json-schema-view">
2121+
<div class="primitive">
2122+
<span class="type">
2123+
array[UUID]
2124+
</span>
2125+
<span class="format">
2126+
(uuid)
2127+
</span>
2128+
2129+
<div class="inner description marked">
2130+
A comma-separated list of object ids
2131+
</div>
2132+
</div>
2133+
<div class="inner required">
2134+
Required
2135+
</div>
2136+
</div>
2137+
</div>
2138+
</td>
20102139
</tr>
20112140

20122141
</table>

‎docs/v2/finance/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2733,7 +2733,7 @@
27332733
<nav id="scrollingNav">
27342734
<ul class="sidenav nav nav-list">
27352735
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2736-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>2.20.0</li>
2736+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>2.21.0</li>
27372737
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27382738
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27392739
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v2/payroll_au/index.html

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1606,6 +1606,9 @@
16061606
"description" : "The Description of the Leave",
16071607
"example" : "My leave"
16081608
},
1609+
"PayOutType" : {
1610+
"$ref" : "#/components/schemas/PayOutType"
1611+
},
16091612
"LeavePeriods" : {
16101613
"type" : "array",
16111614
"items" : {
@@ -1702,6 +1705,9 @@
17021705
"format" : "double",
17031706
"example" : 2.5,
17041707
"x-is-money" : true
1708+
},
1709+
"PayOutType" : {
1710+
"$ref" : "#/components/schemas/PayOutType"
17051711
}
17061712
},
17071713
"description" : ""
@@ -1931,6 +1937,52 @@
19311937
"items" : {
19321938
"$ref" : "#/components/schemas/LeaveLine"
19331939
}
1940+
},
1941+
"PaidLeaveEarningsLines" : {
1942+
"type" : "array",
1943+
"items" : {
1944+
"$ref" : "#/components/schemas/PaidLeaveEarningsLine"
1945+
}
1946+
}
1947+
},
1948+
"description" : ""
1949+
};
1950+
defs["PaidLeaveEarningsLine"] = {
1951+
"title" : "",
1952+
"required" : [ "Amount", "LeaveTypeID" ],
1953+
"type" : "object",
1954+
"properties" : {
1955+
"LeaveTypeID" : {
1956+
"type" : "string",
1957+
"description" : "Xero leave type identifier",
1958+
"format" : "uuid",
1959+
"example" : "742998cb-7584-4ecf-aa88-d694f59c50f9"
1960+
},
1961+
"Amount" : {
1962+
"type" : "number",
1963+
"description" : "Paid leave amount",
1964+
"format" : "double",
1965+
"example" : 500.0,
1966+
"x-is-money" : true
1967+
},
1968+
"SGCAppliedLeaveLoadingAmount" : {
1969+
"type" : "number",
1970+
"description" : "The amount of leave loading applied for the leave type that is subject to Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories",
1971+
"format" : "double",
1972+
"example" : 50.0,
1973+
"x-is-money" : true
1974+
},
1975+
"SGCExemptedLeaveLoadingAmount" : {
1976+
"type" : "number",
1977+
"description" : "The amount of leave loading applied for the leave type that is exempt from Superannuation Guarantee Contributions. *Only applicable for Leave Types with Annual Leave Categories",
1978+
"format" : "double",
1979+
"example" : 60.0,
1980+
"x-is-money" : true
1981+
},
1982+
"ResetSTPCategorisation" : {
1983+
"type" : "boolean",
1984+
"description" : "Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories",
1985+
"example" : true
19341986
}
19351987
},
19361988
"description" : ""
@@ -1976,6 +2028,12 @@
19762028
},
19772029
"description" : "",
19782030
"x-isObjectArray" : true
2031+
};
2032+
defs["PayOutType"] = {
2033+
"title" : "",
2034+
"type" : "string",
2035+
"description" : "How the requested leave will be paid out, e.g. cashed out.",
2036+
"enum" : [ "DEFAULT", "CASHED_OUT" ]
19792037
};
19802038
defs["PayRun"] = {
19812039
"title" : "",
@@ -3353,7 +3411,7 @@
33533411
<nav id="scrollingNav">
33543412
<ul class="sidenav nav nav-list">
33553413
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3356-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>2.20.0</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>2.21.0</li>
33573415
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
33583416
<li data-group="PayrollAu" data-name="createEmployee" class="">
33593417
<a href="#api-PayrollAu-createEmployee">createEmployee</a>

‎docs/v2/payroll_nz/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3837,7 +3837,7 @@
38373837
<nav id="scrollingNav">
38383838
<ul class="sidenav nav nav-list">
38393839
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
3840-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.20.0</li>
3840+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.21.0</li>
38413841
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
38423842
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
38433843
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

‎docs/v2/payroll_uk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3509,7 +3509,7 @@
35093509
<nav id="scrollingNav">
35103510
<ul class="sidenav nav nav-list">
35113511
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3512-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>2.20.0</li>
3512+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>2.21.0</li>
35133513
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
35143514
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
35153515
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

‎docs/v2/projects/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1461,7 +1461,7 @@
14611461
<nav id="scrollingNav">
14621462
<ul class="sidenav nav nav-list">
14631463
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
1464-
<li class="nav-header" data-group="Project"><strong>VSN: </strong>2.20.0</li>
1464+
<li class="nav-header" data-group="Project"><strong>VSN: </strong>2.21.0</li>
14651465
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
14661466
<li data-group="Project" data-name="createProject" class="">
14671467
<a href="#api-Project-createProject">createProject</a>

‎lib/Api/AccountingApi.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
1616
*
17-
* OpenAPI spec version: 2.35.0
17+
* OpenAPI spec version: 2.36.0
1818
* Contact: [email protected]
1919
* Generated by: https://openapi-generator.tech
2020
* OpenAPI Generator version: 5.4.0

0 commit comments

Comments
 (0)