Skip to content

Commit 2d0450e

Browse files
committed
ci: regenerated with OpenAPI Doc 1.0, Speakeay CLI 1.29.2
1 parent 6a3da45 commit 2d0450e

20 files changed

Lines changed: 199 additions & 934 deletions

assess/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ if res.categorised_account is not None:
4242

4343
### [categories](docs/categories/README.md)
4444

45-
* [get_account_category](docs/categories/README.md#get_account_category) - Get suggested and/or confirmed category for a specific account
46-
* [list_accounts_categories](docs/categories/README.md#list_accounts_categories) - List suggested and confirmed account categories
47-
* [list_available_account_categories](docs/categories/README.md#list_available_account_categories) - List account categories
48-
* [update_account_category](docs/categories/README.md#update_account_category) - Patch account categories
49-
* [update_accounts_categories](docs/categories/README.md#update_accounts_categories) - Confirm categories for accounts
45+
* [~~get_account_category~~](docs/categories/README.md#get_account_category) - Get suggested and/or confirmed category for a specific account :warning: **Deprecated**
46+
* [~~list_accounts_categories~~](docs/categories/README.md#list_accounts_categories) - List suggested and confirmed account categories :warning: **Deprecated**
47+
* [~~list_available_account_categories~~](docs/categories/README.md#list_available_account_categories) - List account categories :warning: **Deprecated**
48+
* [~~update_account_category~~](docs/categories/README.md#update_account_category) - Patch account categories :warning: **Deprecated**
49+
* [~~update_accounts_categories~~](docs/categories/README.md#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated**
5050

5151
### [data_integrity](docs/dataintegrity/README.md)
5252

@@ -56,7 +56,7 @@ if res.categorised_account is not None:
5656

5757
### [excel_reports](docs/excelreports/README.md)
5858

59-
* [download_excel_report](docs/excelreports/README.md#download_excel_report) - Download generated excel report
59+
* [~~download_excel_report~~](docs/excelreports/README.md#download_excel_report) - Download generated excel report :warning: **Deprecated**
6060
* [generate_excel_report](docs/excelreports/README.md#generate_excel_report) - Generate an Excel report
6161
* [get_accounting_marketing_metrics](docs/excelreports/README.md#get_accounting_marketing_metrics) - Get the marketing metrics from an accounting source for a given company.
6262
* [get_excel_report](docs/excelreports/README.md#get_excel_report) - Download generated excel report
@@ -71,11 +71,11 @@ if res.categorised_account is not None:
7171
* [get_commerce_orders_metrics](docs/reports/README.md#get_commerce_orders_metrics) - Get order information for a specific company
7272
* [get_commerce_refunds_metrics](docs/reports/README.md#get_commerce_refunds_metrics) - Get the refunds information for a specific company
7373
* [get_commerce_revenue_metrics](docs/reports/README.md#get_commerce_revenue_metrics) - Commerce Revenue Metrics
74-
* [get_enhanced_balance_sheet](docs/reports/README.md#get_enhanced_balance_sheet) - Enhanced Balance Sheet
74+
* [~~get_enhanced_balance_sheet~~](docs/reports/README.md#get_enhanced_balance_sheet) - Enhanced Balance Sheet :warning: **Deprecated**
7575
* [get_enhanced_cash_flow_transactions](docs/reports/README.md#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report
76-
* [get_enhanced_financial_metrics](docs/reports/README.md#get_enhanced_financial_metrics) - List financial metrics
76+
* [~~get_enhanced_financial_metrics~~](docs/reports/README.md#get_enhanced_financial_metrics) - List financial metrics :warning: **Deprecated**
7777
* [get_enhanced_invoices_report](docs/reports/README.md#get_enhanced_invoices_report) - Enhanced Invoices Report
78-
* [get_enhanced_profit_and_loss](docs/reports/README.md#get_enhanced_profit_and_loss) - Enhanced Profit and Loss
78+
* [~~get_enhanced_profit_and_loss~~](docs/reports/README.md#get_enhanced_profit_and_loss) - Enhanced Profit and Loss :warning: **Deprecated**
7979
* [get_recurring_revenue_metrics](docs/reports/README.md#get_recurring_revenue_metrics) - Get key metrics for subscription revenue
8080
* [request_recurring_revenue_metrics](docs/reports/README.md#request_recurring_revenue_metrics) - Request production of key subscription revenue metrics
8181
<!-- End SDK Available Operations -->

assess/RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,4 +342,12 @@ Based on:
342342
- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
343343
- Speakeasy CLI 1.29.1 (2.26.1) https://github.com/speakeasy-api/speakeasy
344344
### Releases
345-
- [PyPI v0.16.1] https://pypi.org/project/codat-assess/0.16.1 - assess
345+
- [PyPI v0.16.1] https://pypi.org/project/codat-assess/0.16.1 - assess
346+
347+
## 2023-05-10 00:12:26
348+
### Changes
349+
Based on:
350+
- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
351+
- Speakeasy CLI 1.29.2 (2.26.2) https://github.com/speakeasy-api/speakeasy
352+
### Releases
353+
- [PyPI v0.16.2] https://pypi.org/project/codat-assess/0.16.2 - assess

assess/docs/categories/README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ Categorisation
66

77
### Available Operations
88

9-
* [get_account_category](#get_account_category) - Get suggested and/or confirmed category for a specific account
10-
* [list_accounts_categories](#list_accounts_categories) - List suggested and confirmed account categories
11-
* [list_available_account_categories](#list_available_account_categories) - List account categories
12-
* [update_account_category](#update_account_category) - Patch account categories
13-
* [update_accounts_categories](#update_accounts_categories) - Confirm categories for accounts
9+
* [~~get_account_category~~](#get_account_category) - Get suggested and/or confirmed category for a specific account :warning: **Deprecated**
10+
* [~~list_accounts_categories~~](#list_accounts_categories) - List suggested and confirmed account categories :warning: **Deprecated**
11+
* [~~list_available_account_categories~~](#list_available_account_categories) - List account categories :warning: **Deprecated**
12+
* [~~update_account_category~~](#update_account_category) - Patch account categories :warning: **Deprecated**
13+
* [~~update_accounts_categories~~](#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated**
1414

15-
## get_account_category
15+
## ~~get_account_category~~
1616

1717
Get category for specific nominal account.
1818

19+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
20+
1921
### Example Usage
2022

2123
```python
@@ -40,10 +42,12 @@ if res.categorised_account is not None:
4042
# handle response
4143
```
4244

43-
## list_accounts_categories
45+
## ~~list_accounts_categories~~
4446

4547
Lists suggested and confirmed chart of account categories for the given company and data connection.
4648

49+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
50+
4751
### Example Usage
4852

4953
```python
@@ -71,10 +75,12 @@ if res.categorised_accounts is not None:
7175
# handle response
7276
```
7377

74-
## list_available_account_categories
78+
## ~~list_available_account_categories~~
7579

7680
Lists available account categories Codat's categorisation engine can provide.
7781

82+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
83+
7884
### Example Usage
7985

8086
```python
@@ -94,10 +100,12 @@ if res.categories is not None:
94100
# handle response
95101
```
96102

97-
## update_account_category
103+
## ~~update_account_category~~
98104

99105
Update category for a specific nominal account
100106

107+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
108+
101109
### Example Usage
102110

103111
```python
@@ -129,10 +137,12 @@ if res.categorised_account is not None:
129137
# handle response
130138
```
131139

132-
## update_accounts_categories
140+
## ~~update_accounts_categories~~
133141

134142
Comfirms the categories for all or a batch of accounts for a specific connection.
135143

144+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
145+
136146
### Example Usage
137147

138148
```python

assess/docs/excelreports/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ Downloadable reports
66

77
### Available Operations
88

9-
* [download_excel_report](#download_excel_report) - Download generated excel report
9+
* [~~download_excel_report~~](#download_excel_report) - Download generated excel report :warning: **Deprecated**
1010
* [generate_excel_report](#generate_excel_report) - Generate an Excel report
1111
* [get_accounting_marketing_metrics](#get_accounting_marketing_metrics) - Get the marketing metrics from an accounting source for a given company.
1212
* [get_excel_report](#get_excel_report) - Download generated excel report
1313
* [get_excel_report_generation_status](#get_excel_report_generation_status) - Get status of Excel report
1414

15-
## download_excel_report
15+
## ~~download_excel_report~~
1616

1717
Download the previously generated Excel report to a local drive.
1818

19+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
20+
1921
### Example Usage
2022

2123
```python
@@ -30,7 +32,7 @@ s = codatassess.CodatAssess(
3032

3133
req = operations.DownloadExcelReportRequest(
3234
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
33-
report_type=shared.ExcelReportTypeEnum.AUDIT,
35+
report_type=shared.ExcelReportTypeEnum.ENHANCED_FINANCIALS,
3436
)
3537

3638
res = s.excel_reports.download_excel_report(req)
@@ -57,7 +59,7 @@ s = codatassess.CodatAssess(
5759

5860
req = operations.GenerateExcelReportRequest(
5961
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
60-
report_type=shared.ExcelReportTypeEnum.ASSESS,
62+
report_type=shared.ExcelReportTypeEnum.BANKING,
6163
)
6264

6365
res = s.excel_reports.generate_excel_report(req)
@@ -117,7 +119,7 @@ s = codatassess.CodatAssess(
117119

118120
req = operations.GetExcelReportRequest(
119121
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
120-
report_type=shared.ExcelReportTypeEnum.ASSESS,
122+
report_type=shared.ExcelReportTypeEnum.BANKING,
121123
)
122124

123125
res = s.excel_reports.get_excel_report(req)
@@ -144,7 +146,7 @@ s = codatassess.CodatAssess(
144146

145147
req = operations.GetExcelReportGenerationStatusRequest(
146148
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
147-
report_type=shared.ExcelReportTypeEnum.ASSESS,
149+
report_type=shared.ExcelReportTypeEnum.AUDIT,
148150
)
149151

150152
res = s.excel_reports.get_excel_report_generation_status(req)

assess/docs/reports/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ Data integrity is important
1313
* [get_commerce_orders_metrics](#get_commerce_orders_metrics) - Get order information for a specific company
1414
* [get_commerce_refunds_metrics](#get_commerce_refunds_metrics) - Get the refunds information for a specific company
1515
* [get_commerce_revenue_metrics](#get_commerce_revenue_metrics) - Commerce Revenue Metrics
16-
* [get_enhanced_balance_sheet](#get_enhanced_balance_sheet) - Enhanced Balance Sheet
16+
* [~~get_enhanced_balance_sheet~~](#get_enhanced_balance_sheet) - Enhanced Balance Sheet :warning: **Deprecated**
1717
* [get_enhanced_cash_flow_transactions](#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report
18-
* [get_enhanced_financial_metrics](#get_enhanced_financial_metrics) - List financial metrics
18+
* [~~get_enhanced_financial_metrics~~](#get_enhanced_financial_metrics) - List financial metrics :warning: **Deprecated**
1919
* [get_enhanced_invoices_report](#get_enhanced_invoices_report) - Enhanced Invoices Report
20-
* [get_enhanced_profit_and_loss](#get_enhanced_profit_and_loss) - Enhanced Profit and Loss
20+
* [~~get_enhanced_profit_and_loss~~](#get_enhanced_profit_and_loss) - Enhanced Profit and Loss :warning: **Deprecated**
2121
* [get_recurring_revenue_metrics](#get_recurring_revenue_metrics) - Get key metrics for subscription revenue
2222
* [request_recurring_revenue_metrics](#request_recurring_revenue_metrics) - Request production of key subscription revenue metrics
2323

@@ -241,10 +241,12 @@ if res.report is not None:
241241
# handle response
242242
```
243243

244-
## get_enhanced_balance_sheet
244+
## ~~get_enhanced_balance_sheet~~
245245

246246
Gets a fully categorized balance sheet statement for a given company, over one or more period(s).
247247

248+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
249+
248250
### Example Usage
249251

250252
```python
@@ -301,10 +303,12 @@ if res.enhanced_cash_flow_transactions is not None:
301303
# handle response
302304
```
303305

304-
## get_enhanced_financial_metrics
306+
## ~~get_enhanced_financial_metrics~~
305307

306308
Gets all the available financial metrics for a given company, over one or more periods.
307309

310+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
311+
308312
### Example Usage
309313

310314
```python
@@ -361,10 +365,12 @@ if res.enhanced_invoices_report is not None:
361365
# handle response
362366
```
363367

364-
## get_enhanced_profit_and_loss
368+
## ~~get_enhanced_profit_and_loss~~
365369

366370
Gets a fully categorized profit and loss statement for a given company, over one or more period(s).
367371

372+
> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
373+
368374
### Example Usage
369375

370376
```python

assess/files.gen

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ src/codatassess/models/shared/enhancedinvoicesreport.py
9191
src/codatassess/models/shared/enhancedinvoicereportitem.py
9292
src/codatassess/models/shared/invoicestatus_enum.py
9393
src/codatassess/models/shared/payment.py
94-
src/codatassess/models/shared/paymentline.py
95-
src/codatassess/models/shared/paymentlinelink.py
96-
src/codatassess/models/shared/paymentlinktype_enum.py
94+
src/codatassess/models/shared/bankingtransactionref.py
9795
src/codatassess/models/shared/customerref.py
9896
src/codatassess/models/shared/security.py
9997
src/codatassess/models/shared/accountcategoriesupdatedwebhook.py

assess/gen.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
configVersion: 1.0.0
22
management:
3-
docChecksum: 6e29598f4da8a8bfcd896e1d30e3c5f4
3+
docChecksum: 75f1da9a1f56d8c1c691b9ee82bfe784
44
docVersion: "1.0"
5-
speakeasyVersion: 1.29.1
6-
generationVersion: 2.26.1
5+
speakeasyVersion: 1.29.2
6+
generationVersion: 2.26.2
77
generation:
88
telemetryEnabled: false
99
sdkClassName: CodatAssess
1010
singleTagPerOp: false
1111
python:
12-
version: 0.16.1
12+
version: 0.16.2
1313
author: Speakeasy
1414
description: Python Client SDK Generated by Speakeasy
1515
maxMethodParams: 0

assess/setup.py

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

1111
setuptools.setup(
1212
name="codat-assess",
13-
version="0.16.1",
13+
version="0.16.2",
1414
author="Speakeasy",
1515
description="Python Client SDK Generated by Speakeasy",
1616
long_description=long_description,

assess/src/codatassess/categories.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ def __init__(self, client: requests_http.Session, security_client: requests_http
2626
def get_account_category(self, request: operations.GetAccountCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountCategoryResponse:
2727
r"""Get suggested and/or confirmed category for a specific account
2828
Get category for specific nominal account.
29+
30+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
2931
"""
3032
base_url = self._server_url
3133

@@ -63,6 +65,8 @@ def do_request():
6365
def list_accounts_categories(self, request: operations.ListAccountsCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountsCategoriesResponse:
6466
r"""List suggested and confirmed account categories
6567
Lists suggested and confirmed chart of account categories for the given company and data connection.
68+
69+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
6670
"""
6771
base_url = self._server_url
6872

@@ -101,6 +105,8 @@ def do_request():
101105
def list_available_account_categories(self, retries: Optional[utils.RetryConfig] = None) -> operations.ListAvailableAccountCategoriesResponse:
102106
r"""List account categories
103107
Lists available account categories Codat's categorisation engine can provide.
108+
109+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
104110
"""
105111
base_url = self._server_url
106112

@@ -138,6 +144,8 @@ def do_request():
138144
def update_account_category(self, request: operations.UpdateAccountCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateAccountCategoryResponse:
139145
r"""Patch account categories
140146
Update category for a specific nominal account
147+
148+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
141149
"""
142150
base_url = self._server_url
143151

@@ -179,6 +187,8 @@ def do_request():
179187
def update_accounts_categories(self, request: operations.UpdateAccountsCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateAccountsCategoriesResponse:
180188
r"""Confirm categories for accounts
181189
Comfirms the categories for all or a batch of accounts for a specific connection.
190+
191+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
182192
"""
183193
base_url = self._server_url
184194

assess/src/codatassess/excel_reports.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ def __init__(self, client: requests_http.Session, security_client: requests_http
2626
def download_excel_report(self, request: operations.DownloadExcelReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.DownloadExcelReportResponse:
2727
r"""Download generated excel report
2828
Download the previously generated Excel report to a local drive.
29+
30+
Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible
2931
"""
3032
base_url = self._server_url
3133

0 commit comments

Comments
 (0)