Skip to content

first crack at generating python docs #86

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 6 commits into from
Mar 25, 2022
Merged

first crack at generating python docs #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e7716a9
first crack at generating python docs
RettBehrens Mar 22, 2022
502eae1
adds assets docs
RettBehrens Mar 22, 2022
bcdbf1e
regenerated docs with latest changes to spec
RettBehrens Mar 23, 2022
9222910
regenerates files docs
RettBehrens Mar 23, 2022
d427a68
regenerates python docs
RettBehrens Mar 24, 2022
b3ac0db
can't get the argument in the sample call to snake case
RettBehrens Mar 25, 2022
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
38 changes: 23 additions & 15 deletions docs/v1/accounting/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5959,6 +5959,14 @@
<!-- *****REPLACE***** `xero-node` with the correct repo naming pattern + also add/delete api sets (ex. Ruby does not have Bankfeeds) -->
<option data-url="#">-API-</option>
<option data-url="https://xeroapi.github.io/xero-python/v1/accounting/index.html" value="Accounting">Accounting</option>
<option data-url="https://xeroapi.github.io/xero-python/appstore/index.html" value="AppStore">App Store</option>
<option data-url="https://xeroapi.github.io/xero-python/assets/index.html" value="Asset">Assets</option>
<option data-url="https://xeroapi.github.io/xero-python/files/index.html" value="Files">Files</option>
<option data-url="https://xeroapi.github.io/xero-python/finance/index.html" value="Finance">Finance</option>
<option data-url="https://xeroapi.github.io/xero-python/payroll-au/index.html" value="PayrollAu">Payroll (AU)</option>
<option data-url="https://xeroapi.github.io/xero-python/payroll-nz/index.html" value="PayrollNz">Payroll (NZ)</option>
<option data-url="https://xeroapi.github.io/xero-python/payroll-uk/index.html" value="PayrollUk">Payroll (UK)</option>
<option data-url="https://xeroapi.github.io/xero-python/projects/index.html" value="Project">Projects</option>
</select>
</fieldset>
<div class='api-set-wrapper'>
Expand Down Expand Up @@ -6000,7 +6008,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>1.13.1</li>
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.13.2</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 Expand Up @@ -9657,7 +9665,7 @@ <h3>Usage and SDK Samples</h3>
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
credit_note_id = '00000000-0000-0000-0000-000000000000'
file_name = 'xero-dev.jpg'
include_online = 'true'
include_online = 'True'

path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
open_file = open(path_to_upload, 'rb')
Expand Down Expand Up @@ -10844,7 +10852,7 @@ <h3>Usage and SDK Samples</h3>
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
invoice_id = '00000000-0000-0000-0000-000000000000'
file_name = 'xero-dev.jpg'
include_online = 'true'
include_online = 'True'

path_to_upload = Path(__file__).resolve().parent.joinpath(fileName)
open_file = open(path_to_upload, 'rb')
Expand Down Expand Up @@ -22382,8 +22390,8 @@ <h3>Usage and SDK Samples</h3>
where = 'ContactStatus==&quot;ACTIVE&quot;'
order = 'Name ASC'
ids = [&quot;00000000-0000-0000-0000-000000000000&quot;]
include_archived = 'true'
summary_only = 'true'
include_archived = 'True'
summary_only = 'True'
search_term = 'searchTerm=Joe Bloggs'

try:
Expand Down Expand Up @@ -25630,9 +25638,9 @@ <h3>Usage and SDK Samples</h3>
invoice_numbers = [&quot;INV-001&quot;, &quot;INV-002&quot;]
contact_ids = [&quot;00000000-0000-0000-0000-000000000000&quot;]
statuses = [&quot;DRAFT&quot;, &quot;SUBMITTED&quot;]
include_archived = 'true'
created_by_my_app = 'false'
summary_only = 'true'
include_archived = 'True'
created_by_my_app = 'False'
summary_only = 'True'

try:
api_response = api_instance.get_invoices(xero_tenant_id, if_modified_since, where, order, ids, invoice_numbers, contact_ids, statuses, page, include_archived, created_by_my_app, unitdp, summary_only)
Expand Down Expand Up @@ -26582,7 +26590,7 @@ <h3>Usage and SDK Samples</h3>
api_instance = AccountingApi(api_client)
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
if_modified_since = dateutil.parser.parse("2020-02-06T12:17:43.202-08:00")
payments_only = 'true'
payments_only = 'True'

try:
api_response = api_instance.get_journals(xero_tenant_id, if_modified_since, offset, payments_only)
Expand Down Expand Up @@ -34633,8 +34641,8 @@ <h3>Usage and SDK Samples</h3>
timeframe = 'MONTH'
tracking_option_id_1 = '00000000-0000-0000-0000-000000000000'
tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
standard_layout = 'true'
payments_only = 'false'
standard_layout = 'True'
payments_only = 'False'

try:
api_response = api_instance.get_report_balance_sheet(xero_tenant_id, date, periods, timeframe, tracking_option_id_1, tracking_option_id_2, standard_layout, payments_only)
Expand Down Expand Up @@ -35430,8 +35438,8 @@ <h3>Usage and SDK Samples</h3>
tracking_category_id_2 = '00000000-0000-0000-0000-000000000000'
tracking_option_id = '00000000-0000-0000-0000-000000000000'
tracking_option_id_2 = '00000000-0000-0000-0000-000000000000'
standard_layout = 'true'
payments_only = 'false'
standard_layout = 'True'
payments_only = 'False'

try:
api_response = api_instance.get_report_profit_and_loss(xero_tenant_id, from_date, to_date, periods, timeframe, tracking_category_id, tracking_category_id_2, tracking_option_id, tracking_option_id_2, standard_layout, payments_only)
Expand Down Expand Up @@ -35859,7 +35867,7 @@ <h3>Usage and SDK Samples</h3>
api_instance = AccountingApi(api_client)
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
date = dateutil.parser.parse("2019-10-31")
payments_only = 'true'
payments_only = 'True'

try:
api_response = api_instance.get_report_trial_balance(xero_tenant_id, date, payments_only)
Expand Down Expand Up @@ -36257,7 +36265,7 @@ <h3>Usage and SDK Samples</h3>
xero_tenant_id = 'YOUR_XERO_TENANT_ID'
where = 'Status=="ACTIVE"'
order = 'Name ASC'
include_archived = 'true'
include_archived = 'True'

try:
api_response = api_instance.get_tracking_categories(xero_tenant_id, where, order, include_archived)
Expand Down
3,007 changes: 3,007 additions & 0 deletions docs/v1/appstore/index.html
View file
Open in desktop

Large diffs are not rendered by default.

4,004 changes: 4,004 additions & 0 deletions docs/v1/assets/index.html
View file
Open in desktop

Large diffs are not rendered by default.

5,418 changes: 5,418 additions & 0 deletions docs/v1/files/index.html
View file
Open in desktop

Large diffs are not rendered by default.

6,334 changes: 6,334 additions & 0 deletions docs/v1/finance/index.html
View file
Open in desktop

Large diffs are not rendered by default.

9,575 changes: 9,575 additions & 0 deletions docs/v1/payroll-au/index.html
View file
Open in desktop

Large diffs are not rendered by default.

15,685 changes: 15,685 additions & 0 deletions docs/v1/payroll-nz/index.html
View file
Open in desktop

Large diffs are not rendered by default.

15,636 changes: 15,636 additions & 0 deletions docs/v1/payroll-uk/index.html
View file
Open in desktop

Large diffs are not rendered by default.

5,603 changes: 5,603 additions & 0 deletions docs/v1/projects/index.html
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ def read_file(filename):
keywords="xero python sdk API oAuth",
name="xero_python",
packages=find_packages(include=["xero_python", "xero_python.*"]),
version="1.13.1",
version="1.13.2",
)
2 changes: 1 addition & 1 deletion xero_python/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__author__ = """Xero Developer API"""
__email__ = "api@xero.com"
__version__ = "1.13.1"
__version__ = "1.13.2"
2 changes: 1 addition & 1 deletion xero_python/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ These endpoints are related to managing authentication tokens and identity for X
The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project:

- API version: 2.19.3
- Package version: 1.13.1
- Package version: 1.13.2
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://developer.xero.com](https://developer.xero.com)

Expand Down