Skip to content

Commit 5a643ef

Browse files
RettBehrensRettBehrens
committed
generates xero-python-1.15.0 from OAS 2.22.0
1 parent 8b2cffd commit 5a643ef

File tree

25 files changed

+226
-26
lines changed

25 files changed

+226
-26
lines changed

‎docs/v1/accounting/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6008,7 +6008,7 @@
60086008
<nav id="scrollingNav">
60096009
<ul class="sidenav nav nav-list">
60106010
<li class="nav-header" data-group="Accounting"><strong>SDK: </strong><span id='sdk-name'></span></li>
6011-
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.14.0</li>
6011+
<li class="nav-header" data-group="Accounting"><strong>VSN: </strong>1.15.0b1</li>
60126012
<li class="nav-header" data-group="Accounting"><a href="#api-Accounting">Methods</a></li>
60136013
<li data-group="Accounting" data-name="createAccount" class="">
60146014
<a href="#api-Accounting-createAccount">createAccount</a>

‎docs/v1/appstore/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1133,7 +1133,7 @@
11331133
<nav id="scrollingNav">
11341134
<ul class="sidenav nav nav-list">
11351135
<li class="nav-header" data-group="AppStore"><strong>SDK: </strong><span id='sdk-name'></span></li>
1136-
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>1.14.0</li>
1136+
<li class="nav-header" data-group="AppStore"><strong>VSN: </strong>1.15.0b1</li>
11371137
<li class="nav-header" data-group="AppStore"><a href="#api-AppStore">Methods</a></li>
11381138
<li data-group="AppStore" data-name="getSubscription" class="">
11391139
<a href="#api-AppStore-getSubscription">getSubscription</a>

‎docs/v1/assets/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1392,7 +1392,7 @@
13921392
<nav id="scrollingNav">
13931393
<ul class="sidenav nav nav-list">
13941394
<li class="nav-header" data-group="Asset"><strong>SDK: </strong><span id='sdk-name'></span></li>
1395-
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>1.14.0</li>
1395+
<li class="nav-header" data-group="Asset"><strong>VSN: </strong>1.15.0b1</li>
13961396
<li class="nav-header" data-group="Asset"><a href="#api-Asset">Methods</a></li>
13971397
<li data-group="Asset" data-name="createAsset" class="">
13981398
<a href="#api-Asset-createAsset">createAsset</a>

‎docs/v1/files/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1155,7 +1155,7 @@
11551155
<nav id="scrollingNav">
11561156
<ul class="sidenav nav nav-list">
11571157
<li class="nav-header" data-group="Files"><strong>SDK: </strong><span id='sdk-name'></span></li>
1158-
<li class="nav-header" data-group="Files"><strong>VSN: </strong>1.14.0</li>
1158+
<li class="nav-header" data-group="Files"><strong>VSN: </strong>1.15.0b1</li>
11591159
<li class="nav-header" data-group="Files"><a href="#api-Files">Methods</a></li>
11601160
<li data-group="Files" data-name="createFileAssociation" class="">
11611161
<a href="#api-Files-createFileAssociation">createFileAssociation</a>

‎docs/v1/finance/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2706,7 +2706,7 @@
27062706
<nav id="scrollingNav">
27072707
<ul class="sidenav nav nav-list">
27082708
<li class="nav-header" data-group="Finance"><strong>SDK: </strong><span id='sdk-name'></span></li>
2709-
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>1.14.0</li>
2709+
<li class="nav-header" data-group="Finance"><strong>VSN: </strong>1.15.0b1</li>
27102710
<li class="nav-header" data-group="Finance"><a href="#api-Finance">Methods</a></li>
27112711
<li data-group="Finance" data-name="getAccountingActivityAccountUsage" class="">
27122712
<a href="#api-Finance-getAccountingActivityAccountUsage">getAccountingActivityAccountUsage</a>

‎docs/v1/payroll-au/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3254,7 +3254,7 @@
32543254
<nav id="scrollingNav">
32553255
<ul class="sidenav nav nav-list">
32563256
<li class="nav-header" data-group="PayrollAu"><strong>SDK: </strong><span id='sdk-name'></span></li>
3257-
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>1.14.0</li>
3257+
<li class="nav-header" data-group="PayrollAu"><strong>VSN: </strong>1.15.0b1</li>
32583258
<li class="nav-header" data-group="PayrollAu"><a href="#api-PayrollAu">Methods</a></li>
32593259
<li data-group="PayrollAu" data-name="createEmployee" class="">
32603260
<a href="#api-PayrollAu-createEmployee">createEmployee</a>

‎docs/v1/payroll-nz/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3838,7 +3838,7 @@
38383838
<nav id="scrollingNav">
38393839
<ul class="sidenav nav nav-list">
38403840
<li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li>
3841-
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>1.14.0</li>
3841+
<li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>1.15.0b1</li>
38423842
<li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li>
38433843
<li data-group="PayrollNz" data-name="approveTimesheet" class="">
38443844
<a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a>

‎docs/v1/payroll-uk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3510,7 +3510,7 @@
35103510
<nav id="scrollingNav">
35113511
<ul class="sidenav nav nav-list">
35123512
<li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li>
3513-
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>1.14.0</li>
3513+
<li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>1.15.0b1</li>
35143514
<li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li>
35153515
<li data-group="PayrollUk" data-name="approveTimesheet" class="">
35163516
<a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a>

‎docs/v1/projects/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1468,7 +1468,7 @@
14681468
<nav id="scrollingNav">
14691469
<ul class="sidenav nav nav-list">
14701470
<li class="nav-header" data-group="Project"><strong>SDK: </strong><span id='sdk-name'></span></li>
1471-
<li class="nav-header" data-group="Project"><strong>VSN: </strong>1.14.0</li>
1471+
<li class="nav-header" data-group="Project"><strong>VSN: </strong>1.15.0b1</li>
14721472
<li class="nav-header" data-group="Project"><a href="#api-Project">Methods</a></li>
14731473
<li data-group="Project" data-name="createProject" class="">
14741474
<a href="#api-Project-createProject">createProject</a>

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,5 @@ def read_file(filename):
4848
keywords="xero python sdk API oAuth",
4949
name="xero_python",
5050
packages=find_packages(include=["xero_python", "xero_python.*"]),
51-
version="1.14.0",
51+
version="1.15.0b1",
5252
)

‎xero_python/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
__author__ = """Xero Developer API"""
44
__email__ = "api@xero.com"
5-
__version__ = "1.14.0"
5+
__version__ = "1.15.0b1"

‎xero_python/accounting/api/accounting_api.py

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212
"""
13-
OpenAPI spec version: 2.21.0
13+
OpenAPI spec version: 2.22.0
1414
"""
1515

1616
import importlib
@@ -10636,6 +10636,82 @@ def get_journal(
1063610636
except exceptions.HTTPStatusException as error:
1063710637
raise translate_status_exception(error, self, "get_journal")
1063810638

10639+
def get_journal_by_number(
10640+
self,
10641+
xero_tenant_id,
10642+
journal_number,
10643+
_return_http_data_only=True,
10644+
_preload_content=True,
10645+
_request_timeout=None,
10646+
):
10647+
"""Retrieves a specific journal using a unique journal number. # noqa: E501
10648+
OAuth2 scope: accounting.journals.read
10649+
:param str xero_tenant_id: Xero identifier for Tenant (required)
10650+
:param int journal_number: Number of a Journal (required)
10651+
:param bool _return_http_data_only: return received data only
10652+
:param bool _preload_content: load received data in models
10653+
:param bool _request_timeout: maximum wait time for response
10654+
:return: Journals
10655+
"""
10656+
10657+
# verify the required parameter 'xero_tenant_id' is set
10658+
if xero_tenant_id is None:
10659+
raise ValueError(
10660+
"Missing the required parameter `xero_tenant_id` "
10661+
"when calling `get_journal_by_number`"
10662+
)
10663+
# verify the required parameter 'journal_number' is set
10664+
if journal_number is None:
10665+
raise ValueError(
10666+
"Missing the required parameter `journal_number` "
10667+
"when calling `get_journal_by_number`"
10668+
)
10669+
10670+
collection_formats = {}
10671+
path_params = {
10672+
"JournalNumber": journal_number,
10673+
}
10674+
10675+
query_params = []
10676+
10677+
header_params = {
10678+
"xero-tenant-id": xero_tenant_id,
10679+
}
10680+
10681+
local_var_files = {}
10682+
form_params = []
10683+
10684+
body_params = None
10685+
# HTTP header `Accept`
10686+
header_params["Accept"] = self.api_client.select_header_accept(
10687+
["application/json"]
10688+
)
10689+
10690+
# Authentication setting
10691+
auth_settings = ["OAuth2"]
10692+
url = self.get_resource_url("/Journals/{JournalNumber}")
10693+
10694+
try:
10695+
return self.api_client.call_api(
10696+
url,
10697+
"GET",
10698+
path_params,
10699+
query_params,
10700+
header_params,
10701+
body=body_params,
10702+
post_params=form_params,
10703+
files=local_var_files,
10704+
response_type="Journals",
10705+
response_model_finder=self.get_model_finder(),
10706+
auth_settings=auth_settings,
10707+
_return_http_data_only=_return_http_data_only,
10708+
_preload_content=_preload_content,
10709+
_request_timeout=_request_timeout,
10710+
collection_formats=collection_formats,
10711+
)
10712+
except exceptions.HTTPStatusException as error:
10713+
raise translate_status_exception(error, self, "get_journal_by_number")
10714+
1063910715
def get_journals(
1064010716
self,
1064110717
xero_tenant_id,

‎xero_python/accounting/docs/AccountingApi.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ Method | HTTP request | Description
127127
[**get_item_history**](AccountingApi.md#get_item_history) | **GET** /Items/{ItemID}/History | Retrieves history for a specific item
128128
[**get_items**](AccountingApi.md#get_items) | **GET** /Items | Retrieves items
129129
[**get_journal**](AccountingApi.md#get_journal) | **GET** /Journals/{JournalID} | Retrieves a specific journal using a unique journal Id.
130+
[**get_journal_by_number**](AccountingApi.md#get_journal_by_number) | **GET** /Journals/{JournalNumber} | Retrieves a specific journal using a unique journal number.
130131
[**get_journals**](AccountingApi.md#get_journals) | **GET** /Journals | Retrieves journals
131132
[**get_linked_transaction**](AccountingApi.md#get_linked_transaction) | **GET** /LinkedTransactions/{LinkedTransactionID} | Retrieves a specific linked transaction (billable expenses) using a unique linked transaction Id
132133
[**get_linked_transactions**](AccountingApi.md#get_linked_transactions) | **GET** /LinkedTransactions | Retrieves linked transactions (billable expenses)
@@ -8254,6 +8255,69 @@ Name | Type | Description | Notes
82548255

82558256
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
82568257

8258+
# **get_journal_by_number**
8259+
> Journals get_journal_by_number(xero_tenant_id, journal_number)
8260+
8261+
Retrieves a specific journal using a unique journal number.
8262+
8263+
### Example
8264+
8265+
* OAuth Authentication (OAuth2):
8266+
```python
8267+
from xero_python.api_client import Configuration, ApiClient
8268+
from xero_python.api_client.oauth2 import OAuth2Token
8269+
from xero_python.exceptions import ApiException
8270+
from xero_python.accounting import AccountingApi
8271+
from pprint import pprint
8272+
8273+
# Configure OAuth2 access token for authorization: OAuth2
8274+
# simplified version, `xero_oauth2_token` represents permanent global token storage
8275+
xero_oauth2_token = {} # set to valid xero oauth2 token dictionary
8276+
# create client configuration with client id and client secret for automatic token refresh
8277+
api_config = Configuration(oauth2_token=OAuth2Token(
8278+
client_id="YOUR_API_CLIENT_ID", client_secret="YOUR_API_CLIENT_SECRET"
8279+
))
8280+
# configure xero-python sdk client
8281+
api_client = ApiClient(
8282+
api_config,
8283+
oauth2_token_saver=lambda x: xero_oauth2_token.update(x),
8284+
oauth2_token_getter=lambda : xero_oauth2_token
8285+
)
8286+
# create an instance of the API class
8287+
api_instance = AccountingApi(api_client)
8288+
8289+
xero_tenant_id = 'YOUR_XERO_TENANT_ID' # str | Xero identifier for Tenant
8290+
journal_number = 1000 # int | Number of a Journal
8291+
try:
8292+
# Retrieves a specific journal using a unique journal number.
8293+
api_response = api_instance.get_journal_by_number(xero_tenant_id, journal_number)
8294+
pprint(api_response)
8295+
except ApiException as e:
8296+
print("Exception when calling AccountingApi->get_journal_by_number: %s\n" % e)
8297+
```
8298+
8299+
### Parameters
8300+
8301+
Name | Type | Description | Notes
8302+
------------- | ------------- | ------------- | -------------
8303+
**xero_tenant_id** | **str**| Xero identifier for Tenant |
8304+
**journal_number** | **int**| Number of a Journal |
8305+
8306+
### Return type
8307+
8308+
[**Journals**](Journals.md)
8309+
8310+
### Authorization
8311+
8312+
[OAuth2](../README.md#OAuth2)
8313+
8314+
### HTTP request headers
8315+
8316+
- **Content-Type**: Not defined
8317+
- **Accept**: application/json
8318+
8319+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
8320+
82578321
# **get_journals**
82588322
> Journals get_journals(xero_tenant_id, if_modified_since=if_modified_since, offset=offset, payments_only=payments_only)
82598323

‎xero_python/appstore/api/app_store_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212
"""
13-
OpenAPI spec version: 2.21.0
13+
OpenAPI spec version: 2.22.0
1414
"""
1515

1616
import importlib

‎xero_python/assets/api/asset_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212
"""
13-
OpenAPI spec version: 2.21.0
13+
OpenAPI spec version: 2.22.0
1414
"""
1515

1616
import importlib

‎xero_python/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ These endpoints are related to managing authentication tokens and identity for X
33

44
The `xero_python` package is automatically generated by the [XeroAPI SDK 2.0 Codegen](https://github.com/xero-github/xeroapi-sdk-codegen) project:
55

6-
- API version: 2.21.0
7-
- Package version: 1.14.0
6+
- API version: 2.22.0
7+
- Package version: 1.15.0b1
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99
For more information, please visit [https://developer.xero.com](https://developer.xero.com)
1010

‎xero_python/file/api/files_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212
"""
13-
OpenAPI spec version: 2.21.0
13+
OpenAPI spec version: 2.22.0
1414
"""
1515

1616
import importlib

‎xero_python/finance/api/finance_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"""
1111

1212
"""
13-
OpenAPI spec version: 2.21.0
13+
OpenAPI spec version: 2.22.0
1414
"""
1515

1616
import importlib

‎xero_python/finance/docs/StatementResponse.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Name | Type | Description | Notes
77
**start_date** | **date** | Start date of statement | [optional]
88
**end_date** | **date** | End date of statement | [optional]
99
**imported_date_time_utc** | **datetime** | Utc date time of when the statement was imported in Xero | [optional]
10-
**import_source** | **str** | Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi) | [optional]
10+
**import_source** | **str** | Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution. | [optional]
11+
**start_balance** | **float** | Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. | [optional]
12+
**end_balance** | **float** | Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. | [optional]
1113
**statement_lines** | [**list[StatementLineResponse]**](StatementLineResponse.md) | List of statement lines | [optional]
1214

1315
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)