Skip to content

Commit 822c8b3

Browse files
actions-useractions-user
committed
chore: release new SDK versions based on update OpenAPI Spec (#397)
1 parent 65994ef commit 822c8b3

File tree

23 files changed

+299
-995
lines changed

23 files changed

+299
-995
lines changed

‎docs/v2/accounting/index.html‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2104,6 +2104,11 @@
21042104
"type" : "string",
21052105
"description" : "Tax number of contact – this is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global) in the Xero UI depending on which regionalized version of Xero you are using (max length = 50)"
21062106
},
2107+
"TaxNumberType" : {
2108+
"type" : "string",
2109+
"description" : "Identifier of the regional type of tax number, such as US, UK, or other regional tax identifiers",
2110+
"enum" : [ "SSN", "EIN", "ITIN", "ATIN" ]
2111+
},
21072112
"AccountsReceivableTaxType" : {
21082113
"type" : "string",
21092114
"description" : "The tax type from TaxRates"
@@ -6338,7 +6343,7 @@
63386343
<nav id="scrollingNav">
63396344
<ul class="sidenav nav nav-list">
63406345
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6341-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>10.1.0</li>
6346+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>10.2.0</li>
63426347
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
63436348
<li data-group="Accounting" data-name="createAccount" class="">
63446349
<a href="#api-Accounting-createAccount">createAccount</a>
@@ -23727,7 +23732,7 @@ <h2>Scopes</h2>
2372723732

2372823733
<tr>
2372923734
<td>accounting.budgets.read</td>
23730-
<td></td>
23735+
<td>Grant read-only access to read budgets</td>
2373123736
</tr>
2373223737

2373323738
</table>
@@ -23903,7 +23908,7 @@ <h2>Scopes</h2>
2390323908

2390423909
<tr>
2390523910
<td>accounting.budgets.read</td>
23906-
<td></td>
23911+
<td>Grant read-only access to read budgets</td>
2390723912
</tr>
2390823913

2390923914
</table>

‎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>10.1.0</li>
1243+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>10.2.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: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1077,6 +1077,35 @@
10771077
"format" : "double",
10781078
"example" : 5.0,
10791079
"x-is-money" : true
1080+
},
1081+
"businessUseCapitalGain" : {
1082+
"type" : "number",
1083+
"description" : "(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its business use.",
1084+
"format" : "decimal",
1085+
"x-is-money" : true
1086+
},
1087+
"businessUseCurrentGainLoss" : {
1088+
"type" : "number",
1089+
"description" : "(New Zealand Orgs Only) Represents the gain or loss from the disposal of the business use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s business use.",
1090+
"format" : "decimal",
1091+
"x-is-money" : true
1092+
},
1093+
"privateUseCapitalGain" : {
1094+
"type" : "number",
1095+
"description" : "(New Zealand Orgs Only) The portion of capital gain realised from the disposal of a fixed asset that is attributable to its private (non-business) use.",
1096+
"format" : "decimal",
1097+
"x-is-money" : true
1098+
},
1099+
"privateUseCurrentGainLoss" : {
1100+
"type" : "number",
1101+
"description" : "(New Zealand Orgs Only) Represents the gain or loss from the disposal of the private use portion of a fixed asset. This value records the financial result (profit or loss) related specifically to the asset’s private use.",
1102+
"format" : "decimal",
1103+
"x-is-money" : true
1104+
},
1105+
"initialDeductionPercentage" : {
1106+
"type" : "number",
1107+
"description" : "(New Zealand Orgs Only) The Investment Boost deduction percentage.",
1108+
"format" : "decimal"
10801109
}
10811110
},
10821111
"description" : ""
@@ -1389,7 +1418,7 @@
13891418
<nav id="scrollingNav">
13901419
<ul class="sidenav nav nav-list">
13911420
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1392-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>10.1.0</li>
1421+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>10.2.0</li>
13931422
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13941423
<li data-group="Asset" data-name="createAsset" class="">
13951424
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v2/files/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1169,7 +1169,7 @@
11691169
<nav id="scrollingNav">
11701170
<ul class="sidenav nav nav-list">
11711171
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1172-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>10.1.0</li>
1172+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>10.2.0</li>
11731173
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11741174
<li data-group="Files" data-name="createFileAssociation" class="">
11751175
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/v2/finance/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2715,7 +2715,7 @@
27152715
<nav id="scrollingNav">
27162716
<ul class="sidenav nav nav-list">
27172717
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2718-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>10.1.0</li>
2718+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>10.2.0</li>
27192719
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27202720
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27212721
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v2/payroll_au/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3411,7 +3411,7 @@
34113411
<nav id="scrollingNav">
34123412
<ul class="sidenav nav nav-list">
34133413
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3414-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>10.1.0</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>10.2.0</li>
34153415
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
34163416
<li data-group="PayrollAu" data-name="approveLeaveApplication" class="">
34173417
<a href="#api-PayrollAu-approveLeaveApplication">approveLeaveApplication</a>

‎docs/v2/payroll_nz/index.html‎

Lines changed: 1 addition & 191 deletions
Original file line numberDiff line numberDiff line change
@@ -4086,7 +4086,7 @@
40864086
<nav id="scrollingNav">
40874087
<ul class="sidenav nav nav-list">
40884088
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
4089-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>10.1.0</li>
4089+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>10.2.0</li>
40904090
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
40914091
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
40924092
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>
@@ -4295,9 +4295,6 @@
42954295
<li data-group="PayrollNz" data-name="updateEmployeeTax" class="">
42964296
<a href="#api-PayrollNz-updateEmployeeTax">updateEmployeeTax</a>
42974297
</li>
4298-
<li data-group="PayrollNz" data-name="updatePayRun" class="">
4299-
<a href="#api-PayrollNz-updatePayRun">updatePayRun</a>
4300-
</li>
43014298
<li data-group="PayrollNz" data-name="updatePaySlipLineItems" class="">
43024299
<a href="#api-PayrollNz-updatePaySlipLineItems">updatePaySlipLineItems</a>
43034300
</li>
@@ -14821,193 +14818,6 @@ <h2>Parameters</h2>
1482114818
}
1482214819
},
1482314820
"required" : true
14824-
}
14825-
</script>
14826-
</table>
14827-
</article>
14828-
</div>
14829-
<hr>
14830-
<div id="api-PayrollNz-updatePayRun">
14831-
<article id="api-PayrollNz-updatePayRun-0" data-group="User" data-name="updatePayRun" data-version="0">
14832-
<div class="pull-left">
14833-
<h1>updatePayRun</h1>
14834-
<p>Updates a pay run</p>
14835-
</div>
14836-
<div class="pull-right"></div>
14837-
<div class="clearfix"></div>
14838-
<p></p>
14839-
<p class="marked"></p>
14840-
<p></p>
14841-
<br />
14842-
<pre class="prettyprint language-html prettyprinted" data-type="put"><code><span class="pln">/PayRuns/{PayRunID}</span></code></pre>
14843-
<p>
14844-
<h3>Usage and SDK Samples</h3>
14845-
</p>
14846-
<ul class="nav nav-tabs nav-tabs-examples">
14847-
<!-- *****REPLACE***** comment out the other languages <li> -->
14848-
<li class=""><a href="#examples-PayrollNz-updatePayRun-0-php">PHP</a></li>
14849-
</ul>
14850-
<div class="tab-content">
14851-
<!-- *****REPLACE***** comment out the other languages tab-pane -->
14852-
<div class="tab-pane" id="examples-PayrollNz-updatePayRun-0-php">
14853-
<pre class="prettyprint"><code class="language-php"><&#63;php
14854-
require_once(__DIR__ . '/vendor/autoload.php');
14855-
14856-
// Configure OAuth2 access token for authorization: OAuth2
14857-
$config = XeroAPI\XeroPHP\Configuration::getDefaultConfiguration()->setAccessToken( 'YOUR_ACCESS_TOKEN' );
14858-
14859-
$apiInstance = new XeroAPI\XeroPHP\Api\PayrollNzApi(
14860-
new GuzzleHttp\Client(),
14861-
$config
14862-
);
14863-
$xeroTenantId = "xeroTenantId_example";
14864-
$payRunID = "38400000-8cf0-11bd-b23e-10b96e4ef00d";
14865-
$idempotencyKey = "KEY_VALUE";
14866-
$startDate = new DateTime('2020-10-28');
14867-
$paymentDate = new DateTime('2020-10-30');
14868-
14869-
$payRunCalendar = new XeroAPI\XeroPHP\Models\PayrollNz\PayRunCalendar;
14870-
$payRunCalendar->setCalendarType(XeroAPI\XeroPHP\Models\PayrollNz\CalendarType.WEEKLY);
14871-
$payRunCalendar->setPeriodStartDate($startDate);
14872-
$payRunCalendar->setPaymentDate($paymentDate);
14873-
14874-
try {
14875-
$result = $apiInstance->updatePayRun($xeroTenantId, $payRunID, $payRun, $idempotencyKey);
14876-
} catch (Exception $e) {
14877-
echo 'Exception when calling PayrollNzApi->updatePayRun: ', $e->getMessage(), PHP_EOL;
14878-
}
14879-
?>
14880-
</code></pre>
14881-
</div>
14882-
</div>
14883-
<h2>Scopes</h2>
14884-
<table>
14885-
14886-
<tr>
14887-
<td>payroll.payruns</td>
14888-
<td>Grant read-write access to payroll payruns</td>
14889-
</tr>
14890-
14891-
</table>
14892-
<h2>Parameters</h2>
14893-
<div class="methodsubtabletitle">Path parameters</div>
14894-
<table id="methodsubtable">
14895-
<tr>
14896-
<th width="150px">Name</th>
14897-
<th>Description</th>
14898-
</tr>
14899-
<tr><td style="width:150px;">PayRunID<span style="color:red;">*</span></td>
14900-
<td>
14901-
14902-
14903-
<div id="d2e199_updatePayRun_payRunID">
14904-
<div class="json-schema-view">
14905-
<div class="primitive">
14906-
<span class="type">
14907-
UUID
14908-
</span>
14909-
<span class="format">
14910-
(uuid)
14911-
</span>
14912-
14913-
<div class="inner description marked">
14914-
Identifier for the pay run
14915-
</div>
14916-
</div>
14917-
<div class="inner required">
14918-
Required
14919-
</div>
14920-
</div>
14921-
</div>
14922-
</td>
14923-
</tr>
14924-
14925-
</table>
14926-
<div class="methodsubtabletitle">Header parameters</div>
14927-
<table id="methodsubtable">
14928-
<tr>
14929-
<th width="150px">Name</th>
14930-
<th>Description</th>
14931-
</tr>
14932-
<tr><td style="width:150px;">Xero-Tenant-Id<span style="color:red;">*</span></td>
14933-
<td>
14934-
14935-
14936-
<div id="d2e199_updatePayRun_xeroTenantId">
14937-
<div class="json-schema-view">
14938-
<div class="primitive">
14939-
<span class="type">
14940-
String
14941-
</span>
14942-
14943-
<div class="inner description marked">
14944-
Xero identifier for Tenant
14945-
</div>
14946-
</div>
14947-
<div class="inner required">
14948-
Required
14949-
</div>
14950-
</div>
14951-
</div>
14952-
</td>
14953-
</tr>
14954-
14955-
<tr><td style="width:150px;">Idempotency-Key</td>
14956-
<td>
14957-
14958-
14959-
<div id="d2e199_updatePayRun_idempotencyKey">
14960-
<div class="json-schema-view">
14961-
<div class="primitive">
14962-
<span class="type">
14963-
String
14964-
</span>
14965-
14966-
<div class="inner description marked">
14967-
This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
14968-
</div>
14969-
</div>
14970-
</div>
14971-
</div>
14972-
</td>
14973-
</tr>
14974-
14975-
</table>
14976-
<div class="methodsubtabletitle">Body parameters</div>
14977-
<table id="methodsubtable">
14978-
<tr>
14979-
<th width="150px">Name</th>
14980-
<th>Description</th>
14981-
</tr>
14982-
<tr>
14983-
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
14984-
<td>
14985-
<div class="json-schema-view">
14986-
<div class="primitive">
14987-
<span class="type">
14988-
PayRun
14989-
</span>
14990-
<div class="inner description marked">
14991-
14992-
</div>
14993-
</div>
14994-
<div class="inner required">
14995-
Required
14996-
</div>
14997-
</div>
14998-
<script type="application/ld+json">
14999-
{
15000-
"content" : {
15001-
"application/json" : {
15002-
"schema" : {
15003-
"$ref" : "#/components/schemas/PayRun"
15004-
},
15005-
"example" : {
15006-
"paymentDate" : "2019-07-01"
15007-
}
15008-
}
15009-
},
15010-
"required" : true
1501114821
}
1501214822
</script>
1501314823
</table>

0 commit comments

Comments
 (0)