Skip to content

Commit 5ee36ae

Browse files
rdemarco-xerordemarco-xero
authored
Merge pull request #332 from XeroAPI/update-to-XeroAPI-v2_36
update to OAS 2.36 and fix query param array format
2 parents 5a247a2 + 0ba015a commit 5ee36ae

26 files changed

+3981
-350
lines changed

‎docs/v4/accounting/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -6070,7 +6070,7 @@
60706070
<nav id="scrollingNav">
60716071
<ul class="sidenav nav nav-list">
60726072
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6073-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.25.0</li>
6073+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.26.0</li>
60746074
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60756075
<li data-group="Accounting" data-name="createAccount" class="">
60766076
<a href="#api-Accounting-createAccount">createAccount</a>

‎docs/v4/appstore/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1237,7 +1237,7 @@
12371237
<nav id="scrollingNav">
12381238
<ul class="sidenav nav nav-list">
12391239
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1240-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.25.0</li>
1240+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.26.0</li>
12411241
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
12421242
<li data-group="AppStore" data-name="getSubscription" class="">
12431243
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v4/assets/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1388,7 +1388,7 @@
13881388
<nav id="scrollingNav">
13891389
<ul class="sidenav nav nav-list">
13901390
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1391-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.25.0</li>
1391+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.26.0</li>
13921392
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13931393
<li data-group="Asset" data-name="createAsset" class="">
13941394
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v4/files/index.html

+136-2
Original file line numberDiff line numberDiff line change
@@ -1129,7 +1129,7 @@
11291129
<nav id="scrollingNav">
11301130
<ul class="sidenav nav nav-list">
11311131
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1132-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.25.0</li>
1132+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.26.0</li>
11331133
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11341134
<li data-group="Files" data-name="createFileAssociation" class="">
11351135
<a href="#api-Files-createFileAssociation">createFileAssociation</a>
@@ -1149,6 +1149,9 @@
11491149
<li data-group="Files" data-name="getAssociationsByObject" class="">
11501150
<a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
11511151
</li>
1152+
<li data-group="Files" data-name="getAssociationsCount" class="">
1153+
<a href="#api-Files-getAssociationsCount">getAssociationsCount</a>
1154+
</li>
11521155
<li data-group="Files" data-name="getFile" class="">
11531156
<a href="#api-Files-getFile">getFile</a>
11541157
</li>
@@ -1898,7 +1901,7 @@ <h1>getAssociationsByObject</h1>
18981901
<div class="pull-right"></div>
18991902
<div class="clearfix"></div>
19001903
<p></p>
1901-
<p class="marked">By passing in the appropriate options,</p>
1904+
<p class="marked">By passing in the appropriate options, you can retrieve an association</p>
19021905
<p></p>
19031906
<br />
19041907
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
@@ -2015,6 +2018,137 @@ <h2>Parameters</h2>
20152018
</div>
20162019
</div>
20172020
</td>
2021+
</tr>
2022+
2023+
</table>
2024+
</article>
2025+
</div>
2026+
<hr>
2027+
<div id="api-Files-getAssociationsCount">
2028+
<article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0">
2029+
<div class="pull-left">
2030+
<h1>getAssociationsCount</h1>
2031+
<p>Retrieves a count of associations for a list of objects.</p>
2032+
</div>
2033+
<div class="pull-right"></div>
2034+
<div class="clearfix"></div>
2035+
<p></p>
2036+
<p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p>
2037+
<p></p>
2038+
<br />
2039+
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre>
2040+
<p>
2041+
<h3>Usage and SDK Samples</h3>
2042+
</p>
2043+
<ul class="nav nav-tabs nav-tabs-examples">
2044+
<li class=""><a href="#examples-Files-getAssociationsCount-0-java">Java</a></li>
2045+
</ul>
2046+
<div class="tab-content">
2047+
<div class="tab-pane" id="examples-Files-getAssociationsCount-0-java">
2048+
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
2049+
import org.openapitools.client.api.client.FilesApi;
2050+
import org.openapitools.client.models.files.*;
2051+
2052+
import java.io.File;
2053+
import java.util.*;
2054+
2055+
public class FilesApiExample {
2056+
private FilesApi apiInstance;
2057+
2058+
public static void main(String[] args) {
2059+
String accessToken = "YOUR_ACCESS_TOKEN";
2060+
ApiClient defaultClient = new ApiClient();
2061+
2062+
apiInstance = AccountingApi.getInstance(defaultClient);
2063+
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
2064+
array[UUID] objectIds = ;
2065+
2066+
try {
2067+
Object result = apiInstance.getAssociationsCount(accessToken, xeroTenantId, objectIds);
2068+
System.out.println(result);
2069+
} catch (XeroException e) {
2070+
System.err.println("Exception when calling FilesApi#getAssociationsCount");
2071+
e.printStackTrace();
2072+
}
2073+
}
2074+
}</code></pre>
2075+
</div>
2076+
</div>
2077+
<h2>Scopes</h2>
2078+
<table>
2079+
2080+
<tr>
2081+
<td>files</td>
2082+
<td>Grant read-write access to files and folders</td>
2083+
</tr>
2084+
2085+
<tr>
2086+
<td>files.read</td>
2087+
<td>Grant read-only access to files and folders</td>
2088+
</tr>
2089+
2090+
</table>
2091+
<h2>Parameters</h2>
2092+
<div class="methodsubtabletitle">Header parameters</div>
2093+
<table id="methodsubtable">
2094+
<tr>
2095+
<th width="150px">Name</th>
2096+
<th>Description</th>
2097+
</tr>
2098+
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
2099+
<td>
2100+
2101+
2102+
<div id="d2e199_getAssociationsCount_xeroTenantId">
2103+
<div class="json-schema-view">
2104+
<div class="primitive">
2105+
<span class="type">
2106+
String
2107+
</span>
2108+
2109+
<div class="inner description marked">
2110+
Xero identifier for Tenant
2111+
</div>
2112+
</div>
2113+
<div class="inner required">
2114+
Required
2115+
</div>
2116+
</div>
2117+
</div>
2118+
</td>
2119+
</tr>
2120+
2121+
</table>
2122+
<div class="methodsubtabletitle">Query parameters</div>
2123+
<table id="methodsubtable">
2124+
<tr>
2125+
<th width="150px">Name</th>
2126+
<th>Description</th>
2127+
</tr>
2128+
<tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td>
2129+
<td>
2130+
2131+
2132+
<div id="d2e199_getAssociationsCount_objectIds">
2133+
<div class="json-schema-view">
2134+
<div class="primitive">
2135+
<span class="type">
2136+
array[UUID]
2137+
</span>
2138+
<span class="format">
2139+
(uuid)
2140+
</span>
2141+
2142+
<div class="inner description marked">
2143+
A comma-separated list of object ids
2144+
</div>
2145+
</div>
2146+
<div class="inner required">
2147+
Required
2148+
</div>
2149+
</div>
2150+
</div>
2151+
</td>
20182152
</tr>
20192153

20202154
</table>

‎docs/v4/finance/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2730,7 +2730,7 @@
27302730
<nav id="scrollingNav">
27312731
<ul class="sidenav nav nav-list">
27322732
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2733-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.25.0</li>
2733+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.26.0</li>
27342734
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27352735
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27362736
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v4/payroll-au/index.html

+59-1
Original file line numberDiff line numberDiff line change
@@ -1604,6 +1604,9 @@
16041604
"description" : "The Description of the Leave",
16051605
"example" : "My leave"
16061606
},
1607+
"PayOutType" : {
1608+
"$ref" : "#/components/schemas/PayOutType"
1609+
},
16071610
"LeavePeriods" : {
16081611
"type" : "array",
16091612
"items" : {
@@ -1700,6 +1703,9 @@
17001703
"format" : "double",
17011704
"example" : 2.5,
17021705
"x-is-money" : true
1706+
},
1707+
"PayOutType" : {
1708+
"$ref" : "#/components/schemas/PayOutType"
17031709
}
17041710
},
17051711
"description" : ""
@@ -1929,6 +1935,52 @@
19291935
"items" : {
19301936
"$ref" : "#/components/schemas/LeaveLine"
19311937
}
1938+
},
1939+
"PaidLeaveEarningsLines" : {
1940+
"type" : "array",
1941+
"items" : {
1942+
"$ref" : "#/components/schemas/PaidLeaveEarningsLine"
1943+
}
1944+
}
1945+
},
1946+
"description" : ""
1947+
};
1948+
defs["PaidLeaveEarningsLine"] = {
1949+
"title" : "",
1950+
"required" : [ "Amount", "LeaveTypeID" ],
1951+
"type" : "object",
1952+
"properties" : {
1953+
"LeaveTypeID" : {
1954+
"type" : "string",
1955+
"description" : "Xero leave type identifier",
1956+
"format" : "uuid",
1957+
"example" : "742998cb-7584-4ecf-aa88-d694f59c50f9"
1958+
},
1959+
"Amount" : {
1960+
"type" : "number",
1961+
"description" : "Paid leave amount",
1962+
"format" : "double",
1963+
"example" : 500.0,
1964+
"x-is-money" : true
1965+
},
1966+
"SGCAppliedLeaveLoadingAmount" : {
1967+
"type" : "number",
1968+
"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",
1969+
"format" : "double",
1970+
"example" : 50.0,
1971+
"x-is-money" : true
1972+
},
1973+
"SGCExemptedLeaveLoadingAmount" : {
1974+
"type" : "number",
1975+
"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",
1976+
"format" : "double",
1977+
"example" : 60.0,
1978+
"x-is-money" : true
1979+
},
1980+
"ResetSTPCategorisation" : {
1981+
"type" : "boolean",
1982+
"description" : "Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories",
1983+
"example" : true
19321984
}
19331985
},
19341986
"description" : ""
@@ -1974,6 +2026,12 @@
19742026
},
19752027
"description" : "",
19762028
"x-isObjectArray" : true
2029+
};
2030+
defs["PayOutType"] = {
2031+
"title" : "",
2032+
"type" : "string",
2033+
"description" : "How the requested leave will be paid out, e.g. cashed out.",
2034+
"enum" : [ "DEFAULT", "CASHED_OUT" ]
19772035
};
19782036
defs["PayRun"] = {
19792037
"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>4.25.0</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.26.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/v4/payroll-nz/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3834,7 +3834,7 @@
38343834
<nav id="scrollingNav">
38353835
<ul class="sidenav nav nav-list">
38363836
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
3837-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.25.0</li>
3837+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.26.0</li>
38383838
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
38393839
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
38403840
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

‎docs/v4/payroll-uk/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3506,7 +3506,7 @@
35063506
<nav id="scrollingNav">
35073507
<ul class="sidenav nav nav-list">
35083508
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3509-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.25.0</li>
3509+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.26.0</li>
35103510
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
35113511
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
35123512
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

‎pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>xero-java</artifactId>
66
<packaging>jar</packaging>
77
<name>xero-java</name>
8-
<version>4.25.0</version>
8+
<version>4.26.0</version>
99
<url>https://github.com/XeroAPI/Xero-Java</url>
1010
<description>This is the official Java SDK for Xero API</description>
1111
<licenses>

‎src/main/java/com/xero/api/XeroRateLimitException.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public Integer getMinuteLimitRemaining() {
8989
/** get retry after seconds
9090
* @return Long the number of seconds to wait before resuming API calls
9191
*/
92-
public long getRetryAfterSeconds() {
92+
public Long getRetryAfterSeconds() {
9393
return retryAfterSeconds;
9494
}
9595
}

0 commit comments

Comments
 (0)