Skip to content

Commit 35ba26e

Browse files
authored
Merge pull request #346 from XeroAPI/xero-php-3.0.0
Build from OpenAPI v3.0.0
2 parents 34b3cfb + b02cab8 commit 35ba26e

File tree

20 files changed

+777
-687
lines changed

20 files changed

+777
-687
lines changed

docs/v2/accounting/index.html

Lines changed: 65 additions & 65 deletions
Large diffs are not rendered by default.

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.23.3</li>
1243+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>3.0.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: 8 additions & 4 deletions
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.23.3</li>
1394+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>3.0.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>
@@ -1629,7 +1629,7 @@ <h3>Usage and SDK Samples</h3>
16291629
$assetType->setBookDepreciationSetting($bookDepreciationSetting);
16301630

16311631
try {
1632-
$result = $apiInstance->createAssetType($xeroTenantId, $idempotencyKey, $assetType);
1632+
$result = $apiInstance->createAssetType($xeroTenantId, $assetType, $idempotencyKey);
16331633
} catch (Exception $e) {
16341634
echo 'Exception when calling AssetApi->createAssetType: ', $e->getMessage(), PHP_EOL;
16351635
}
@@ -1704,7 +1704,7 @@ <h2>Parameters</h2>
17041704
<th>Description</th>
17051705
</tr>
17061706
<tr>
1707-
<td style="width:150px;">assetType </td>
1707+
<td style="width:150px;">assetType <span style="color:red;">*</span></td>
17081708
<td>
17091709
<div class="json-schema-view">
17101710
<div class="primitive">
@@ -1715,6 +1715,9 @@ <h2>Parameters</h2>
17151715
Asset type to add
17161716
</div>
17171717
</div>
1718+
<div class="inner required">
1719+
Required
1720+
</div>
17181721
</div>
17191722
<script type="application/ld+json">
17201723
{
@@ -1726,7 +1729,8 @@ <h2>Parameters</h2>
17261729
},
17271730
"example" : "{ \"assetTypeName\":\"Machinery11004\", \"fixedAssetAccountId\":\"3d8d063a-c148-4bb8-8b3c-a5e2ad3b1e82\", \"depreciationExpenseAccountId\":\"d1602f69-f900-4616-8d34-90af393fa368\", \"accumulatedDepreciationAccountId\":\"9195cadd-8645-41e6-9f67-7bcd421defe8\", \"bookDepreciationSetting\":{ \"depreciationMethod\":\"DiminishingValue100\", \"averagingMethod\":\"ActualDays\", \"depreciationRate\":0.05, \"depreciationCalculationMethod\":\"None\" } }"
17281731
}
1729-
}
1732+
},
1733+
"required" : true
17301734
}
17311735
</script>
17321736
</table>

docs/v2/files/index.html

Lines changed: 22 additions & 10 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.23.3</li>
1157+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>3.0.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>
@@ -1266,7 +1266,7 @@ <h3>Usage and SDK Samples</h3>
12661266
$idempotencyKey = "KEY_VALUE";
12671267

12681268
try {
1269-
$result = $apiInstance->createFileAssociation($xeroTenantId, $fileId, $idempotencyKey, $association);
1269+
$result = $apiInstance->createFileAssociation($xeroTenantId, $fileId, $association, $idempotencyKey);
12701270
} catch (Exception $e) {
12711271
echo 'Exception when calling FilesApi->createFileAssociation: ', $e->getMessage(), PHP_EOL;
12721272
}
@@ -1374,7 +1374,7 @@ <h2>Parameters</h2>
13741374
<th>Description</th>
13751375
</tr>
13761376
<tr>
1377-
<td style="width:150px;">association </td>
1377+
<td style="width:150px;">association <span style="color:red;">*</span></td>
13781378
<td>
13791379
<div class="json-schema-view">
13801380
<div class="primitive">
@@ -1385,6 +1385,9 @@ <h2>Parameters</h2>
13851385

13861386
</div>
13871387
</div>
1388+
<div class="inner required">
1389+
Required
1390+
</div>
13881391
</div>
13891392
<script type="application/ld+json">
13901393
{
@@ -1395,7 +1398,8 @@ <h2>Parameters</h2>
13951398
},
13961399
"example" : "{ \"ObjectId\": \"1270bf7c-5d18-473a-9231-1e36c4bd33ed\", \"ObjectGroup\": \"Contact\", \"ObjectType\": \"Business\" }"
13971400
}
1398-
}
1401+
},
1402+
"required" : true
13991403
}
14001404
</script>
14011405
</table>
@@ -1439,7 +1443,7 @@ <h3>Usage and SDK Samples</h3>
14391443
$idempotencyKey = "KEY_VALUE";
14401444

14411445
try {
1442-
$result = $apiInstance->createFolder($xeroTenantId, $idempotencyKey, $folder);
1446+
$result = $apiInstance->createFolder($xeroTenantId, $folder, $idempotencyKey);
14431447
} catch (Exception $e) {
14441448
echo 'Exception when calling FilesApi->createFolder: ', $e->getMessage(), PHP_EOL;
14451449
}
@@ -1514,7 +1518,7 @@ <h2>Parameters</h2>
15141518
<th>Description</th>
15151519
</tr>
15161520
<tr>
1517-
<td style="width:150px;">folder </td>
1521+
<td style="width:150px;">folder <span style="color:red;">*</span></td>
15181522
<td>
15191523
<div class="json-schema-view">
15201524
<div class="primitive">
@@ -1525,6 +1529,9 @@ <h2>Parameters</h2>
15251529

15261530
</div>
15271531
</div>
1532+
<div class="inner required">
1533+
Required
1534+
</div>
15281535
</div>
15291536
<script type="application/ld+json">
15301537
{
@@ -1535,7 +1542,8 @@ <h2>Parameters</h2>
15351542
},
15361543
"example" : "{ \"Name\": \"My Docs\" }"
15371544
}
1538-
}
1545+
},
1546+
"required" : true
15391547
}
15401548
</script>
15411549
</table>
@@ -3191,7 +3199,7 @@ <h3>Usage and SDK Samples</h3>
31913199
$idempotencyKey = "KEY_VALUE";
31923200

31933201
try {
3194-
$result = $apiInstance->updateFile($xeroTenantId, $fileId, $idempotencyKey, $fileObject);
3202+
$result = $apiInstance->updateFile($xeroTenantId, $fileId, $fileObject, $idempotencyKey);
31953203
} catch (Exception $e) {
31963204
echo 'Exception when calling FilesApi->updateFile: ', $e->getMessage(), PHP_EOL;
31973205
}
@@ -3299,7 +3307,7 @@ <h2>Parameters</h2>
32993307
<th>Description</th>
33003308
</tr>
33013309
<tr>
3302-
<td style="width:150px;">fileObject </td>
3310+
<td style="width:150px;">fileObject <span style="color:red;">*</span></td>
33033311
<td>
33043312
<div class="json-schema-view">
33053313
<div class="primitive">
@@ -3310,6 +3318,9 @@ <h2>Parameters</h2>
33103318

33113319
</div>
33123320
</div>
3321+
<div class="inner required">
3322+
Required
3323+
</div>
33133324
</div>
33143325
<script type="application/ld+json">
33153326
{
@@ -3320,7 +3331,8 @@ <h2>Parameters</h2>
33203331
},
33213332
"example" : "{ \"FolderId\": \"bf924975-7097-46f2-a143-1ecfbab3c8c3\" }"
33223333
}
3323-
}
3334+
},
3335+
"required" : true
33243336
}
33253337
</script>
33263338
</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.23.3</li>
2736+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>3.0.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: 36 additions & 16 deletions
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>2.23.3</li>
3414+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>3.0.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>
@@ -7575,7 +7575,7 @@ <h3>Usage and SDK Samples</h3>
75757575
$employee->setHomeAddress($homeAddress);
75767576

75777577
try {
7578-
$result = $apiInstance->updateEmployee($xeroTenantId, $employeeID, $idempotencyKey, $employee);
7578+
$result = $apiInstance->updateEmployee($xeroTenantId, $employeeID, $employee, $idempotencyKey);
75797579
} catch (Exception $e) {
75807580
echo 'Exception when calling PayrollAuApi->updateEmployee: ', $e->getMessage(), PHP_EOL;
75817581
}
@@ -7683,7 +7683,7 @@ <h2>Parameters</h2>
76837683
<th>Description</th>
76847684
</tr>
76857685
<tr>
7686-
<td style="width:150px;">employee </td>
7686+
<td style="width:150px;">employee <span style="color:red;">*</span></td>
76877687
<td>
76887688
<div class="json-schema-view">
76897689
<div class="primitive">
@@ -7694,6 +7694,9 @@ <h2>Parameters</h2>
76947694

76957695
</div>
76967696
</div>
7697+
<div class="inner required">
7698+
Required
7699+
</div>
76977700
</div>
76987701
<script type="application/ld+json">
76997702
{
@@ -7707,7 +7710,8 @@ <h2>Parameters</h2>
77077710
},
77087711
"example" : "[ { \"MiddleNames\": \"Frank\" } ]"
77097712
}
7710-
}
7713+
},
7714+
"required" : true
77117715
}
77127716
</script>
77137717
</table>
@@ -7945,7 +7949,7 @@ <h3>Usage and SDK Samples</h3>
79457949
$payRun->setPayrollCalendarID('00000000-0000-0000-0000-000000000000');
79467950

79477951
try {
7948-
$result = $apiInstance->updatePayRun($xeroTenantId, $payRunID, $idempotencyKey, $payRun);
7952+
$result = $apiInstance->updatePayRun($xeroTenantId, $payRunID, $payRun, $idempotencyKey);
79497953
} catch (Exception $e) {
79507954
echo 'Exception when calling PayrollAuApi->updatePayRun: ', $e->getMessage(), PHP_EOL;
79517955
}
@@ -8053,7 +8057,7 @@ <h2>Parameters</h2>
80538057
<th>Description</th>
80548058
</tr>
80558059
<tr>
8056-
<td style="width:150px;">payRun </td>
8060+
<td style="width:150px;">payRun <span style="color:red;">*</span></td>
80578061
<td>
80588062
<div class="json-schema-view">
80598063
<div class="primitive">
@@ -8064,6 +8068,9 @@ <h2>Parameters</h2>
80648068

80658069
</div>
80668070
</div>
8071+
<div class="inner required">
8072+
Required
8073+
</div>
80678074
</div>
80688075
<script type="application/ld+json">
80698076
{
@@ -8077,7 +8084,8 @@ <h2>Parameters</h2>
80778084
}
80788085
}
80798086
}
8080-
}
8087+
},
8088+
"required" : true
80818089
}
80828090
</script>
80838091
</table>
@@ -8134,7 +8142,7 @@ <h3>Usage and SDK Samples</h3>
81348142
array_push($payslipLines, $payslipLine);
81358143

81368144
try {
8137-
$result = $apiInstance->updatePayslip($xeroTenantId, $payslipID, $idempotencyKey, $payslipLines);
8145+
$result = $apiInstance->updatePayslip($xeroTenantId, $payslipID, $payslipLines, $idempotencyKey);
81388146
} catch (Exception $e) {
81398147
echo 'Exception when calling PayrollAuApi->updatePayslip: ', $e->getMessage(), PHP_EOL;
81408148
}
@@ -8242,7 +8250,7 @@ <h2>Parameters</h2>
82428250
<th>Description</th>
82438251
</tr>
82448252
<tr>
8245-
<td style="width:150px;">payslipLines </td>
8253+
<td style="width:150px;">payslipLines <span style="color:red;">*</span></td>
82468254
<td>
82478255
<div class="json-schema-view">
82488256
<div class="primitive">
@@ -8253,6 +8261,9 @@ <h2>Parameters</h2>
82538261

82548262
</div>
82558263
</div>
8264+
<div class="inner required">
8265+
Required
8266+
</div>
82568267
</div>
82578268
<script type="application/ld+json">
82588269
{
@@ -8266,7 +8277,8 @@ <h2>Parameters</h2>
82668277
},
82678278
"example" : "{ \"Payslip\": { \"EmployeeID\": \"cdfb8371-0b21-4b8a-8903-1024df6c391e\", \"DeductionLines\": [ { \"DeductionTypeID\": \"727af5e8-b347-4ae7-85fc-9b82266d0aec\", \"CalculationType\": \"FIXEDAMOUNT\", \"NumberOfUnits\": 10 } ] } }"
82688279
}
8269-
}
8280+
},
8281+
"required" : true
82708282
}
82718283
</script>
82728284
</table>
@@ -8315,7 +8327,7 @@ <h3>Usage and SDK Samples</h3>
83158327
$superfund->setUSI('40022701955002');
83168328

83178329
try {
8318-
$result = $apiInstance->updateSuperfund($xeroTenantId, $superFundID, $idempotencyKey, $superFund);
8330+
$result = $apiInstance->updateSuperfund($xeroTenantId, $superFundID, $superFund, $idempotencyKey);
83198331
} catch (Exception $e) {
83208332
echo 'Exception when calling PayrollAuApi->updateSuperfund: ', $e->getMessage(), PHP_EOL;
83218333
}
@@ -8423,7 +8435,7 @@ <h2>Parameters</h2>
84238435
<th>Description</th>
84248436
</tr>
84258437
<tr>
8426-
<td style="width:150px;">superFund </td>
8438+
<td style="width:150px;">superFund <span style="color:red;">*</span></td>
84278439
<td>
84288440
<div class="json-schema-view">
84298441
<div class="primitive">
@@ -8434,6 +8446,9 @@ <h2>Parameters</h2>
84348446

84358447
</div>
84368448
</div>
8449+
<div class="inner required">
8450+
Required
8451+
</div>
84378452
</div>
84388453
<script type="application/ld+json">
84398454
{
@@ -8447,7 +8462,8 @@ <h2>Parameters</h2>
84478462
},
84488463
"example" : " [ { \"Type\":\"REGULATED\", \"Name\":\"Nice23534\" } ]"
84498464
}
8450-
}
8465+
},
8466+
"required" : true
84518467
}
84528468
</script>
84538469
</table>
@@ -8500,7 +8516,7 @@ <h3>Usage and SDK Samples</h3>
85008516
$timesheet->setStatus(XeroAPI\XeroPHP\Models\PayrollAu\TimesheetStatus::DRAFT);
85018517

85028518
try {
8503-
$result = $apiInstance->updateTimesheet($xeroTenantId, $timesheetID, $idempotencyKey, $timesheet);
8519+
$result = $apiInstance->updateTimesheet($xeroTenantId, $timesheetID, $timesheet, $idempotencyKey);
85048520
} catch (Exception $e) {
85058521
echo 'Exception when calling PayrollAuApi->updateTimesheet: ', $e->getMessage(), PHP_EOL;
85068522
}
@@ -8608,7 +8624,7 @@ <h2>Parameters</h2>
86088624
<th>Description</th>
86098625
</tr>
86108626
<tr>
8611-
<td style="width:150px;">timesheet </td>
8627+
<td style="width:150px;">timesheet <span style="color:red;">*</span></td>
86128628
<td>
86138629
<div class="json-schema-view">
86148630
<div class="primitive">
@@ -8619,6 +8635,9 @@ <h2>Parameters</h2>
86198635

86208636
</div>
86218637
</div>
8638+
<div class="inner required">
8639+
Required
8640+
</div>
86228641
</div>
86238642
<script type="application/ld+json">
86248643
{
@@ -8632,7 +8651,8 @@ <h2>Parameters</h2>
86328651
},
86338652
"example" : "[ { \"EmployeeID\":\"b34e89ff-770d-4099-b7e5-f968767118bc\", \"StartDate\":\"/Date(1573171200000+0000)/\", \"EndDate\":\"/Date(1573689600000+0000)/\", \"Status\":\"APPROVED\", \"Hours\":22.0, \"TimesheetID\":\"a7eb0a79-8511-4ee7-b473-3a25f28abcb9\", \"TimesheetLines\":[ { \"EarningsRateID\":\"ab874dfb-ab09-4c91-954e-43acf6fc23b4\", \"TrackingItemID\":\"af5e9ce2-2349-4136-be99-3561b189f473\", \"NumberOfUnits\":[ 2.0, 10.0, 0.0, 0.0, 5.0, 0.0, 5.0 ], \"UpdatedDateUTC\":\"/Date(1573516185127+0000)/\" } ] } ]"
86348653
}
8635-
}
8654+
},
8655+
"required" : true
86368656
}
86378657
</script>
86388658
</table>

docs/v2/payroll_nz/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3842,7 +3842,7 @@
38423842
<nav id="scrollingNav">
38433843
<ul class="sidenav nav nav-list">
38443844
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
3845-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>2.23.3</li>
3845+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>3.0.0</li>
38463846
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
38473847
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
38483848
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

0 commit comments

Comments
 (0)