Merge pull request #123 from codatio/speakeasy-sdk-regen-1682643823

chore: speakeasy sdk regeneration - Generate Assess SDK

Author: dcoplowe

assess/README.md

@@ -23,11 +23,10 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.GetAccountCategoryRequest(
-    account_id="corrupti",
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    account_id='corrupti',
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
 )
 
 res = s.categories.get_account_category(req)
@@ -43,11 +42,11 @@ if res.categorised_account is not None:
 
 ### [categories](docs/categories/README.md)
 
-* [get_account_category](docs/categories/README.md#get_account_category) - Get suggested and/or confirmed category for a specific account
-* [list_accounts_categories](docs/categories/README.md#list_accounts_categories) - List suggested and confirmed account categories
-* [list_available_account_categories](docs/categories/README.md#list_available_account_categories) - List account categories
-* [update_account_category](docs/categories/README.md#update_account_category) - Patch account categories
-* [update_accounts_categories](docs/categories/README.md#update_accounts_categories) - Confirm categories for accounts
+* [~~get_account_category~~](docs/categories/README.md#get_account_category) - Get suggested and/or confirmed category for a specific account :warning: **Deprecated**
+* [~~list_accounts_categories~~](docs/categories/README.md#list_accounts_categories) - List suggested and confirmed account categories :warning: **Deprecated**
+* [~~list_available_account_categories~~](docs/categories/README.md#list_available_account_categories) - List account categories :warning: **Deprecated**
+* [~~update_account_category~~](docs/categories/README.md#update_account_category) - Patch account categories :warning: **Deprecated**
+* [~~update_accounts_categories~~](docs/categories/README.md#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated**
 
 ### [data_integrity](docs/dataintegrity/README.md)
 
@@ -57,7 +56,7 @@ if res.categorised_account is not None:
 
 ### [excel_reports](docs/excelreports/README.md)
 
-* [download_excel_report](docs/excelreports/README.md#download_excel_report) - Download generated excel report
+* [~~download_excel_report~~](docs/excelreports/README.md#download_excel_report) - Download generated excel report :warning: **Deprecated**
 * [generate_excel_report](docs/excelreports/README.md#generate_excel_report) - Generate an Excel report
 * [get_accounting_marketing_metrics](docs/excelreports/README.md#get_accounting_marketing_metrics) - Get the marketing metrics from an accounting source for a given company.
 * [get_excel_report](docs/excelreports/README.md#get_excel_report) - Download generated excel report
@@ -72,11 +71,11 @@ if res.categorised_account is not None:
 * [get_commerce_orders_metrics](docs/reports/README.md#get_commerce_orders_metrics) - Get order information for a specific company
 * [get_commerce_refunds_metrics](docs/reports/README.md#get_commerce_refunds_metrics) - Get the refunds information for a specific company
 * [get_commerce_revenue_metrics](docs/reports/README.md#get_commerce_revenue_metrics) - Commerce Revenue Metrics
-* [get_enhanced_balance_sheet](docs/reports/README.md#get_enhanced_balance_sheet) - Enhanced Balance Sheet
+* [~~get_enhanced_balance_sheet~~](docs/reports/README.md#get_enhanced_balance_sheet) - Enhanced Balance Sheet :warning: **Deprecated**
 * [get_enhanced_cash_flow_transactions](docs/reports/README.md#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report
-* [get_enhanced_financial_metrics](docs/reports/README.md#get_enhanced_financial_metrics) - List financial metrics
+* [~~get_enhanced_financial_metrics~~](docs/reports/README.md#get_enhanced_financial_metrics) - List financial metrics :warning: **Deprecated**
 * [get_enhanced_invoices_report](docs/reports/README.md#get_enhanced_invoices_report) - Enhanced Invoices Report
-* [get_enhanced_profit_and_loss](docs/reports/README.md#get_enhanced_profit_and_loss) - Enhanced Profit and Loss
+* [~~get_enhanced_profit_and_loss~~](docs/reports/README.md#get_enhanced_profit_and_loss) - Enhanced Profit and Loss :warning: **Deprecated**
 * [get_recurring_revenue_metrics](docs/reports/README.md#get_recurring_revenue_metrics) - Get key metrics for subscription revenue
 * [request_recurring_revenue_metrics](docs/reports/README.md#request_recurring_revenue_metrics) - Request production of key subscription revenue metrics
 <!-- End SDK Available Operations -->

assess/RELEASES.md

@@ -286,4 +286,76 @@ Based on:
 - OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
 - Speakeasy CLI 1.26.1 (2.23.1) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.14.1] https://pypi.org/project/codat-assess/0.14.1 - assess
+- [PyPI v0.14.1] https://pypi.org/project/codat-assess/0.14.1 - assess
+
+## 2023-04-28 01:03:41
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.26.2 (2.23.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.14.2] https://pypi.org/project/codat-assess/0.14.2 - assess
+
+## 2023-04-29 00:12:48
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.26.3 (2.23.3) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.14.3] https://pypi.org/project/codat-assess/0.14.3 - assess
+
+## 2023-04-30 00:13:45
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.26.4 (2.23.4) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.14.4] https://pypi.org/project/codat-assess/0.14.4 - assess
+
+## 2023-05-02 00:13:02
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.26.5 (2.23.6) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.14.5] https://pypi.org/project/codat-assess/0.14.5 - assess
+
+## 2023-05-03 00:12:16
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.27.0 (2.24.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.15.0] https://pypi.org/project/codat-assess/0.15.0 - assess
+
+## 2023-05-05 00:12:14
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.29.0 (2.26.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.16.0] https://pypi.org/project/codat-assess/0.16.0 - assess
+
+## 2023-05-06 00:12:05
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.29.1 (2.26.1) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.16.1] https://pypi.org/project/codat-assess/0.16.1 - assess
+
+## 2023-05-10 00:12:26
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.29.2 (2.26.2) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.16.2] https://pypi.org/project/codat-assess/0.16.2 - assess
+
+## 2023-05-11 00:12:27
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.30.0 (2.26.3) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.16.3] https://pypi.org/project/codat-assess/0.16.3 - assess

assess/USAGE.md

@@ -9,11 +9,10 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.GetAccountCategoryRequest(
-    account_id="corrupti",
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    account_id='corrupti',
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
 )
 
 res = s.categories.get_account_category(req)

assess/docs/categories/README.md

@@ -6,16 +6,18 @@ Categorisation
 
 ### Available Operations
 
-* [get_account_category](#get_account_category) - Get suggested and/or confirmed category for a specific account
-* [list_accounts_categories](#list_accounts_categories) - List suggested and confirmed account categories
-* [list_available_account_categories](#list_available_account_categories) - List account categories
-* [update_account_category](#update_account_category) - Patch account categories
-* [update_accounts_categories](#update_accounts_categories) - Confirm categories for accounts
+* [~~get_account_category~~](#get_account_category) - Get suggested and/or confirmed category for a specific account :warning: **Deprecated**
+* [~~list_accounts_categories~~](#list_accounts_categories) - List suggested and confirmed account categories :warning: **Deprecated**
+* [~~list_available_account_categories~~](#list_available_account_categories) - List account categories :warning: **Deprecated**
+* [~~update_account_category~~](#update_account_category) - Patch account categories :warning: **Deprecated**
+* [~~update_accounts_categories~~](#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated**
 
-## get_account_category
+## ~~get_account_category~~
 
 Get category for specific nominal account.
 
+> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```python
@@ -28,11 +30,10 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.GetAccountCategoryRequest(
-    account_id="provident",
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    account_id='provident',
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
 )
 
 res = s.categories.get_account_category(req)
@@ -41,10 +42,12 @@ if res.categorised_account is not None:
     # handle response
 ```
 
-## list_accounts_categories
+## ~~list_accounts_categories~~
 
 Lists suggested and confirmed chart of account categories for the given company and data connection.
 
+> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```python
@@ -57,14 +60,13 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.ListAccountsCategoriesRequest(
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
-    order_by="-modifiedDate",
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
+    order_by='-modifiedDate',
     page=1,
     page_size=100,
-    query="distinctio",
+    query='distinctio',
 )
 
 res = s.categories.list_accounts_categories(req)
@@ -73,10 +75,12 @@ if res.categorised_accounts is not None:
     # handle response
 ```
 
-## list_available_account_categories
+## ~~list_available_account_categories~~
 
 Lists available account categories Codat's categorisation engine can provide. 
 
+> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```python
@@ -96,10 +100,12 @@ if res.categories is not None:
     # handle response
 ```
 
-## update_account_category
+## ~~update_account_category~~
 
 Update category for a specific nominal account
 
+> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```python
@@ -112,18 +118,17 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.UpdateAccountCategoryRequest(
     confirm_category=shared.ConfirmCategory(
         confirmed=shared.AccountCategory(
-            detail_type="quibusdam",
-            subtype="unde",
-            type="nulla",
+            detail_type='quibusdam',
+            subtype='unde',
+            type='nulla',
         ),
     ),
-    account_id="corrupti",
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    account_id='corrupti',
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
 )
 
 res = s.categories.update_account_category(req)
@@ -132,10 +137,12 @@ if res.categorised_account is not None:
     # handle response
 ```
 
-## update_accounts_categories
+## ~~update_accounts_categories~~
 
 Comfirms the categories for all or a batch of accounts for a specific connection.
 
+> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible.
+
 ### Example Usage
 
 ```python
@@ -148,54 +155,53 @@ s = codatassess.CodatAssess(
     ),
 )
 
-
 req = operations.UpdateAccountsCategoriesRequest(
     confirm_categories=shared.ConfirmCategories(
         categories=[
             shared.ConfirmCategoriesCategories(
                 account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
-                    id="69a674e0-f467-4cc8-b96e-d151a05dfc2d",
+                    id='69a674e0-f467-4cc8-b96e-d151a05dfc2d',
                 ),
                 confirmed=shared.AccountCategory(
-                    detail_type="at",
-                    subtype="maiores",
-                    type="molestiae",
+                    detail_type='at',
+                    subtype='maiores',
+                    type='molestiae',
                 ),
             ),
             shared.ConfirmCategoriesCategories(
                 account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
-                    id="cc78ca1b-a928-4fc8-9674-2cb739205929",
+                    id='cc78ca1b-a928-4fc8-9674-2cb739205929',
                 ),
                 confirmed=shared.AccountCategory(
-                    detail_type="dolor",
-                    subtype="natus",
-                    type="laboriosam",
+                    detail_type='dolor',
+                    subtype='natus',
+                    type='laboriosam',
                 ),
             ),
             shared.ConfirmCategoriesCategories(
                 account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
-                    id="fea7596e-b10f-4aaa-a352-c5955907aff1",
+                    id='fea7596e-b10f-4aaa-a352-c5955907aff1',
                 ),
                 confirmed=shared.AccountCategory(
-                    detail_type="mollitia",
-                    subtype="dolorem",
-                    type="culpa",
+                    detail_type='mollitia',
+                    subtype='dolorem',
+                    type='culpa',
                 ),
             ),
             shared.ConfirmCategoriesCategories(
                 account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
-                    id="2fa94677-3925-41aa-92c3-f5ad019da1ff",
+                    id='2fa94677-3925-41aa-92c3-f5ad019da1ff',
                 ),
                 confirmed=shared.AccountCategory(
-                    detail_type="vero",
-                    subtype="nihil",
-                    type="praesentium",
+                    detail_type='vero',
+                    subtype='nihil',
+                    type='praesentium',
                 ),
             ),
         ],
     ),
-    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
-    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
+    connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
 )
 
 res = s.categories.update_accounts_categories(req)