Skip to content

Commit

Permalink
Merge pull request #332 from XeroAPI/update-to-XeroAPI-v2_36
Browse files Browse the repository at this point in the history 
update to OAS 2.36 and fix query param array format
  • Loading branch information
@rdemarco-xero
rdemarco-xero authored Feb 23, 2023
2 parents 5a247a2 + 0ba015a commit 5ee36ae
Show file tree
Hide file tree
Showing 26 changed files with 3,981 additions and 350 deletions.
2 changes: 1 addition & 1 deletion docs/v4/accounting/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6070,7 +6070,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>4.25.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.26.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/appstore/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1237,7 +1237,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>4.25.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>4.26.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/assets/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,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>4.25.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>4.26.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>
Expand Down
138 changes: 136 additions & 2 deletions docs/v4/files/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1129,7 +1129,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>4.25.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>4.26.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>
Expand All @@ -1149,6 +1149,9 @@
<li data-group="Files" data-name="getAssociationsByObject" class="">
<a href="#api-Files-getAssociationsByObject">getAssociationsByObject</a>
</li>
<li data-group="Files" data-name="getAssociationsCount" class="">
<a href="#api-Files-getAssociationsCount">getAssociationsCount</a>
</li>
<li data-group="Files" data-name="getFile" class="">
<a href="#api-Files-getFile">getFile</a>
</li>
Expand Down Expand Up @@ -1898,7 +1901,7 @@ <h1>getAssociationsByObject</h1>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">By passing in the appropriate options,</p>
<p class="marked">By passing in the appropriate options, you can retrieve an association</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/{ObjectId}</span></code></pre>
Expand Down Expand Up @@ -2015,6 +2018,137 @@ <h2>Parameters</h2>
</div>
</div>
</td>
</tr>

</table>
</article>
</div>
<hr>
<div id="api-Files-getAssociationsCount">
<article id="api-Files-getAssociationsCount-0" data-group="User" data-name="getAssociationsCount" data-version="0">
<div class="pull-left">
<h1>getAssociationsCount</h1>
<p>Retrieves a count of associations for a list of objects.</p>
</div>
<div class="pull-right"></div>
<div class="clearfix"></div>
<p></p>
<p class="marked">By passing in the appropriate options, you can retrieve the association count for objects</p>
<p></p>
<br />
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Associations/Count</span></code></pre>
<p>
<h3>Usage and SDK Samples</h3>
</p>
<ul class="nav nav-tabs nav-tabs-examples">
<li class=""><a href="#examples-Files-getAssociationsCount-0-java">Java</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane" id="examples-Files-getAssociationsCount-0-java">
<pre class="prettyprint"><code class="language-java">import org.openapitools.client.api.*;
import org.openapitools.client.api.client.FilesApi;
import org.openapitools.client.models.files.*;

import java.io.File;
import java.util.*;

public class FilesApiExample {
private FilesApi apiInstance;

public static void main(String[] args) {
String accessToken = "YOUR_ACCESS_TOKEN";
ApiClient defaultClient = new ApiClient();

apiInstance = AccountingApi.getInstance(defaultClient);
String xeroTenantId = 'YOUR_XERO_TENANT_ID';
array[UUID] objectIds = ;

try {
Object result = apiInstance.getAssociationsCount(accessToken, xeroTenantId, objectIds);
System.out.println(result);
} catch (XeroException e) {
System.err.println("Exception when calling FilesApi#getAssociationsCount");
e.printStackTrace();
}
}
}</code></pre>
</div>
</div>
<h2>Scopes</h2>
<table>

<tr>
<td>files</td>
<td>Grant read-write access to files and folders</td>
</tr>

<tr>
<td>files.read</td>
<td>Grant read-only access to files and folders</td>
</tr>

</table>
<h2>Parameters</h2>
<div class="methodsubtabletitle">Header parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">xero-tenant-id<span style="color:red;">*</span></td>
<td>


<div id="d2e199_getAssociationsCount_xeroTenantId">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
String
</span>

<div class="inner description marked">
Xero identifier for Tenant
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

</table>
<div class="methodsubtabletitle">Query parameters</div>
<table id="methodsubtable">
<tr>
<th width="150px">Name</th>
<th>Description</th>
</tr>
<tr><td style="width:150px;">ObjectIds<span style="color:red;">*</span></td>
<td>


<div id="d2e199_getAssociationsCount_objectIds">
<div class="json-schema-view">
<div class="primitive">
<span class="type">
array[UUID]
</span>
<span class="format">
(uuid)
</span>

<div class="inner description marked">
A comma-separated list of object ids
</div>
</div>
<div class="inner required">
Required
</div>
</div>
</div>
</td>
</tr>

</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/finance/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2730,7 +2730,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>4.25.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>4.26.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>
Expand Down
60 changes: 59 additions & 1 deletion docs/v4/payroll-au/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1604,6 +1604,9 @@
"description" : "The Description of the Leave",
"example" : "My leave"
},
"PayOutType" : {
"$ref" : "#/components/schemas/PayOutType"
},
"LeavePeriods" : {
"type" : "array",
"items" : {
Expand Down Expand Up @@ -1700,6 +1703,9 @@
"format" : "double",
"example" : 2.5,
"x-is-money" : true
},
"PayOutType" : {
"$ref" : "#/components/schemas/PayOutType"
}
},
"description" : ""
Expand Down Expand Up @@ -1929,6 +1935,52 @@
"items" : {
"$ref" : "#/components/schemas/LeaveLine"
}
},
"PaidLeaveEarningsLines" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PaidLeaveEarningsLine"
}
}
},
"description" : ""
};
defs["PaidLeaveEarningsLine"] = {
"title" : "",
"required" : [ "Amount", "LeaveTypeID" ],
"type" : "object",
"properties" : {
"LeaveTypeID" : {
"type" : "string",
"description" : "Xero leave type identifier",
"format" : "uuid",
"example" : "742998cb-7584-4ecf-aa88-d694f59c50f9"
},
"Amount" : {
"type" : "number",
"description" : "Paid leave amount",
"format" : "double",
"example" : 500.0,
"x-is-money" : true
},
"SGCAppliedLeaveLoadingAmount" : {
"type" : "number",
"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",
"format" : "double",
"example" : 50.0,
"x-is-money" : true
},
"SGCExemptedLeaveLoadingAmount" : {
"type" : "number",
"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",
"format" : "double",
"example" : 60.0,
"x-is-money" : true
},
"ResetSTPCategorisation" : {
"type" : "boolean",
"description" : "Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories",
"example" : true
}
},
"description" : ""
Expand Down Expand Up @@ -1974,6 +2026,12 @@
},
"description" : "",
"x-isObjectArray" : true
};
defs["PayOutType"] = {
"title" : "",
"type" : "string",
"description" : "How the requested leave will be paid out, e.g. cashed out.",
"enum" : [ "DEFAULT", "CASHED_OUT" ]
};
defs["PayRun"] = {
"title" : "",
Expand Down Expand Up @@ -3353,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>4.25.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>4.26.0</li>
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
<li data-group="PayrollAu" data-name="createEmployee" class="">
<a href="#api-PayrollAu-createEmployee">createEmployee</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/payroll-nz/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3834,7 +3834,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>4.25.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>4.26.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>
Expand Down
2 changes: 1 addition & 1 deletion docs/v4/payroll-uk/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3506,7 +3506,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>4.25.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>4.26.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>
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<artifactId>xero-java</artifactId>
<packaging>jar</packaging>
<name>xero-java</name>
<version>4.25.0</version>
<version>4.26.0</version>
<url>https://github.com/XeroAPI/Xero-Java</url>
<description>This is the official Java SDK for Xero API</description>
<licenses>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xero/api/XeroRateLimitException.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public Integer getMinuteLimitRemaining() {
/** get retry after seconds
* @return Long the number of seconds to wait before resuming API calls
*/
public long getRetryAfterSeconds() {
public Long getRetryAfterSeconds() {
return retryAfterSeconds;
}
}
Loading

0 comments on commit 5ee36ae

Please sign in to comment.