Skip to content

2.21.0 #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2023
Merged

2.21.0 #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0f442a
Generates Xero-PHP 2.21.0 from Xero-OpenAPI 2.36.0
pumpkinball Feb 16, 2023
9bfcfc3
Issue #308 Accounting Docs Type fix
pumpkinball Feb 16, 2023
2de89f9
generate missing docs updates
RettBehrens Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/v2/accounting/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6073,7 +6073,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>2.20.0</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>2.21.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/v2/appstore/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>2.20.0</li>
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>2.21.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/v2/assets/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>2.20.0</li>
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>2.21.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
133 changes: 131 additions & 2 deletions docs/v2/files/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1154,7 +1154,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>2.20.0</li>
<li class="nav-header" data-group="Files"><strong>VSN: </strong>2.21.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 @@ -1174,6 +1174,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 @@ -1896,7 +1899,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 @@ -2007,6 +2010,132 @@ <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">
<!-- *****REPLACE***** comment out the other languages <li> -->
<li class=""><a href="#examples-Files-getAssociationsCount-0-php">PHP</a></li>
</ul>
<div class="tab-content">
<!-- *****REPLACE***** comment out the other languages tab-pane -->
<div class="tab-pane" id="examples-Files-getAssociationsCount-0-php">
<pre class="prettyprint"><code class="language-php"><&#63;php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = XeroAPI\XeroPHP\Configuration::getDefaultConfiguration()->setAccessToken( 'YOUR_ACCESS_TOKEN' );

$apiInstance = new XeroAPI\XeroPHP\Api\FilesApi(
new GuzzleHttp\Client(),
$config
);
$xeroTenantId = "YOUR_XERO_TENANT_ID";
$objectIds = array()

try {
$result = $apiInstance->getAssociationsCount($xeroTenantId, $objectIds);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->getAssociationsCount: ', $e->getMessage(), PHP_EOL;
}
?>
</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/v2/finance/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2733,7 +2733,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>2.20.0</li>
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>2.21.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/v2/payroll_au/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1606,6 +1606,9 @@
"description" : "The Description of the Leave",
"example" : "My leave"
},
"PayOutType" : {
"$ref" : "#/components/schemas/PayOutType"
},
"LeavePeriods" : {
"type" : "array",
"items" : {
Expand Down Expand Up @@ -1702,6 +1705,9 @@
"format" : "double",
"example" : 2.5,
"x-is-money" : true
},
"PayOutType" : {
"$ref" : "#/components/schemas/PayOutType"
}
},
"description" : ""
Expand Down Expand Up @@ -1931,6 +1937,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 @@ -1976,6 +2028,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>2.20.0</li>
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>2.21.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/v2/payroll_nz/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3837,7 +3837,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>2.20.0</li>
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.21.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/v2/payroll_uk/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3509,7 +3509,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>2.20.0</li>
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>2.21.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 docs/v2/projects/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>2.20.0</li>
<li class="nav-header" data-group="Project"><strong>VSN: </strong>2.21.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>
Expand Down
2 changes: 1 addition & 1 deletion lib/Api/AccountingApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* OpenAPI spec version: 2.35.0
* OpenAPI spec version: 2.36.0
* Contact: [email protected]
* Generated by: https://openapi-generator.tech
* OpenAPI Generator version: 5.4.0
Expand Down
2 changes: 1 addition & 1 deletion lib/Api/AppStoreApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* These endpoints are for Xero Partners to interact with the App Store Billing platform
*
* OpenAPI spec version: 2.35.0
* OpenAPI spec version: 2.36.0
* Contact: [email protected]
* Generated by: https://openapi-generator.tech
* OpenAPI Generator version: 5.4.0
Expand Down
2 changes: 1 addition & 1 deletion lib/Api/AssetApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2.35.0
* OpenAPI spec version: 2.36.0
* Contact: [email protected]
* Generated by: https://openapi-generator.tech
* OpenAPI Generator version: 5.4.0
Expand Down
Loading