-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #582 from XeroAPI/xero-node-4.20.0
first attempt using openapi-generator-cli:v5.4.0
- Loading branch information
Showing
27 changed files
with
355 additions
and
215 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4017,7 +4017,7 @@ | |
| "Class" : { | ||
| "type" : "string", | ||
| "description" : "Organisation Classes describe which plan the Xero organisation is on (e.g. DEMO, TRIAL, PREMIUM)", | ||
| "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK" ] | ||
| "enum" : [ "DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE" ] | ||
| }, | ||
| "Edition" : { | ||
| "type" : "string", | ||
|
|
@@ -6009,7 +6009,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.19.1</li> | ||
| <li class="nav-header" data-group="Accounting"><strong>VSN: </strong>4.20.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> | ||
|
|
@@ -6380,6 +6380,9 @@ | |
| <li data-group="Accounting" data-name="getJournal" class=""> | ||
| <a href="#api-Accounting-getJournal">getJournal</a> | ||
| </li> | ||
| <li data-group="Accounting" data-name="getJournalByNumber" class=""> | ||
| <a href="#api-Accounting-getJournalByNumber">getJournalByNumber</a> | ||
| </li> | ||
| <li data-group="Accounting" data-name="getJournals" class=""> | ||
| <a href="#api-Accounting-getJournals">getJournals</a> | ||
| </li> | ||
|
|
@@ -9261,7 +9264,7 @@ <h2>Parameters</h2> | |
| "schema" : { | ||
| "$ref" : "#/components/schemas/Contacts" | ||
| }, | ||
| "example" : "{ \"Id\": \"e997d6d7-6dad-4458-beb8-d9c1bf7f2edf\", \"Status\": \"OK\", \"ProviderName\": \"Xero API Partner\", \"DateTimeUTC\": \"/Date(1551399321121)/\", \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"[email protected]\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [], \"HasValidationErrors\": false } ] }" | ||
| "example" : "{ \"Contacts\": [ { \"ContactID\": \"3ff6d40c-af9a-40a3-89ce-3c1556a25591\", \"ContactStatus\": \"ACTIVE\", \"Name\": \"Foo9987\", \"EmailAddress\": \"[email protected]\", \"BankAccountDetails\": \"\", \"Addresses\": [ { \"AddressType\": \"STREET\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" }, { \"AddressType\": \"POBOX\", \"City\": \"\", \"Region\": \"\", \"PostalCode\": \"\", \"Country\": \"\" } ], \"Phones\": [ { \"PhoneType\": \"DEFAULT\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"DDI\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"FAX\", \"PhoneNumber\": \"\", \"PhoneAreaCode\": \"\", \"PhoneCountryCode\": \"\" }, { \"PhoneType\": \"MOBILE\", \"PhoneNumber\": \"555-1212\", \"PhoneAreaCode\": \"415\", \"PhoneCountryCode\": \"\" } ], \"UpdatedDateUTC\": \"/Date(1551399321043+0000)/\", \"ContactGroups\": [], \"IsSupplier\": false, \"IsCustomer\": false, \"SalesTrackingCategories\": [], \"PurchasesTrackingCategories\": [], \"PaymentTerms\": { \"Bills\": { \"Day\": 15, \"Type\": \"OFCURRENTMONTH\" }, \"Sales\": { \"Day\": 10, \"Type\": \"DAYSAFTERBILLMONTH\" } }, \"ContactPersons\": [] } ] }" | ||
| } | ||
| }, | ||
| "required" : true | ||
|
|
@@ -25374,6 +25377,116 @@ <h2>Parameters</h2> | |
| </div> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
|
|
||
| </table> | ||
| </article> | ||
| </div> | ||
| <hr> | ||
| <div id="api-Accounting-getJournalByNumber"> | ||
| <article id="api-Accounting-getJournalByNumber-0" data-group="User" data-name="getJournalByNumber" data-version="0"> | ||
| <div class="pull-left"> | ||
| <h1>getJournalByNumber</h1> | ||
| <p>Retrieves a specific journal using a unique journal number.</p> | ||
| </div> | ||
| <div class="pull-right"></div> | ||
| <div class="clearfix"></div> | ||
| <p></p> | ||
| <p class="marked"></p> | ||
| <p></p> | ||
| <br /> | ||
| <pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/Journals/{JournalNumber}</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-Accounting-getJournalByNumber-0-javascript">Node</a></li> | ||
| </ul> | ||
| <div class="tab-content"> | ||
| <!-- *****REPLACE***** comment out the other languages tab-pane --> | ||
| <div class="tab-pane" id="examples-Accounting-getJournalByNumber-0-javascript"> | ||
| <pre class="prettyprint"><code class="language-javascript">await xero.setTokenSet(tokenSet); | ||
|
|
||
| const xeroTenantId = 'YOUR_XERO_TENANT_ID'; | ||
| const journalNumber = 1000; | ||
|
|
||
| try { | ||
| const response = await xero.accountingApi.getJournalByNumber(xeroTenantId, journalNumber); | ||
| console.log(response.body || response.response.statusCode) | ||
| } catch (err) { | ||
| const error = JSON.stringify(err.response.body, null, 2) | ||
| console.log(`Status Code: ${err.response.statusCode} => ${error}`); | ||
| }</code></pre> | ||
| </div> | ||
| </div> | ||
| <h2>Scopes</h2> | ||
| <table> | ||
|
|
||
| <tr> | ||
| <td>accounting.journals.read</td> | ||
| <td>Grant read-only access to journals</td> | ||
| </tr> | ||
|
|
||
| </table> | ||
| <h2>Parameters</h2> | ||
| <div class="methodsubtabletitle">Path parameters</div> | ||
| <table id="methodsubtable"> | ||
| <tr> | ||
| <th width="150px">Name</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| <tr><td style="width:150px;">JournalNumber<span style="color:red;">*</span></td> | ||
| <td> | ||
|
|
||
|
|
||
| <div id="d2e199_getJournalByNumber_journalNumber"> | ||
| <div class="json-schema-view"> | ||
| <div class="primitive"> | ||
| <span class="type"> | ||
| Integer | ||
| </span> | ||
|
|
||
| <div class="inner description marked"> | ||
| Number of a Journal | ||
| </div> | ||
| </div> | ||
| <div class="inner required"> | ||
| Required | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
|
|
||
| </table> | ||
| <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_getJournalByNumber_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> | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.