Merge pull request #97 from codatio/speakeasy-sdk-regen-1682409665

chore: speakeasy sdk regeneration - Generate Assess SDK

Author: dcoplowe

assess/README.md

@@ -15,7 +15,7 @@ pip install codat-assess
 <!-- Start SDK Example Usage -->
 ```python
 import codatassess
-from codatassess.models import operations, shared
+from codatassess.models import operations
 
 s = codatassess.CodatAssess(
     security=shared.Security(
@@ -29,7 +29,7 @@ req = operations.GetAccountCategoryRequest(
     company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
     connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
 )
-    
+
 res = s.categories.get_account_category(req)
 
 if res.categorised_account is not None:
@@ -41,44 +41,44 @@ if res.categorised_account is not None:
 ## Available Resources and Operations
 
 
-### categories
-
-* `get_account_category` - Get suggested and/or confirmed category for a specific account
-* `list_accounts_categories` - List suggested and confirmed account categories
-* `list_available_account_categories` - List account categories
-* `update_account_category` - Patch account categories
-* `update_accounts_categories` - Confirm categories for accounts
-
-### data_integrity
-
-* `get_data_integrity_details` - Lists data integrity details for date type
-* `get_data_integrity_status` - Get data integrity status
-* `get_data_integrity_summaries` - Get data integrity summary
-
-### excel_reports
-
-* `download_excel_report` - Download generated excel report
-* `generate_excel_report` - Generate an Excel report
-* `get_accounting_marketing_metrics` - Get the marketing metrics from an accounting source for a given company.
-* `get_excel_report` - Download generated excel report
-* `get_excel_report_generation_status` - Get status of Excel report
-
-### reports
-
-* `get_accounts_for_enhanced_balance_sheet` - Enhanced Balance Sheet Accounts
-* `get_accounts_for_enhanced_profit_and_loss` - Enhanced Profit and Loss Accounts
-* `get_commerce_customer_retention_metrics` - Get the customer retention metrics for a specific company.
-* `get_commerce_lifetime_value_metrics` - Get the lifetime value metric for a specific company.
-* `get_commerce_orders_metrics` - Get order information for a specific company
-* `get_commerce_refunds_metrics` - Get the refunds information for a specific company
-* `get_commerce_revenue_metrics` - Commerce Revenue Metrics
-* `get_enhanced_balance_sheet` - Enhanced Balance Sheet
-* `get_enhanced_cash_flow_transactions` - Get enhanced cash flow report
-* `get_enhanced_financial_metrics` - List financial metrics
-* `get_enhanced_invoices_report` - Enhanced Invoices Report
-* `get_enhanced_profit_and_loss` - Enhanced Profit and Loss
-* `get_recurring_revenue_metrics` - Get key metrics for subscription revenue
-* `request_recurring_revenue_metrics` - Request production of key subscription revenue metrics
+### [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
+
+### [data_integrity](docs/dataintegrity/README.md)
+
+* [get_data_integrity_details](docs/dataintegrity/README.md#get_data_integrity_details) - Lists data integrity details for date type
+* [get_data_integrity_status](docs/dataintegrity/README.md#get_data_integrity_status) - Get data integrity status
+* [get_data_integrity_summaries](docs/dataintegrity/README.md#get_data_integrity_summaries) - Get data integrity summary
+
+### [excel_reports](docs/excelreports/README.md)
+
+* [download_excel_report](docs/excelreports/README.md#download_excel_report) - Download generated excel report
+* [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
+* [get_excel_report_generation_status](docs/excelreports/README.md#get_excel_report_generation_status) - Get status of Excel report
+
+### [reports](docs/reports/README.md)
+
+* [get_accounts_for_enhanced_balance_sheet](docs/reports/README.md#get_accounts_for_enhanced_balance_sheet) - Enhanced Balance Sheet Accounts
+* [get_accounts_for_enhanced_profit_and_loss](docs/reports/README.md#get_accounts_for_enhanced_profit_and_loss) - Enhanced Profit and Loss Accounts
+* [get_commerce_customer_retention_metrics](docs/reports/README.md#get_commerce_customer_retention_metrics) - Get the customer retention metrics for a specific company.
+* [get_commerce_lifetime_value_metrics](docs/reports/README.md#get_commerce_lifetime_value_metrics) - Get the lifetime value metric for a specific company.
+* [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_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_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_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 -->
 
 ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

assess/RELEASES.md

@@ -238,4 +238,36 @@ Based on:
 - OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
 - Speakeasy CLI 1.20.1 (2.18.1) https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.11.1] https://pypi.org/project/codat-assess/0.11.1 - assess
+- [PyPI v0.11.1] https://pypi.org/project/codat-assess/0.11.1 - assess
+
+## 2023-04-25 08:01:02
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.12.0] https://pypi.org/project/codat-assess/0.12.0 - assess
+
+## 2023-04-25 14:17:32
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.12.1] https://pypi.org/project/codat-assess/0.12.1 - assess
+
+## 2023-04-26 01:01:46
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.12.2] https://pypi.org/project/codat-assess/0.12.2 - assess
+
+## 2023-04-26 14:59:00
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.13.0] https://pypi.org/project/codat-assess/0.13.0 - assess

assess/USAGE.md

@@ -1,7 +1,7 @@
 <!-- Start SDK Example Usage -->
 ```python
 import codatassess
-from codatassess.models import operations, shared
+from codatassess.models import operations
 
 s = codatassess.CodatAssess(
     security=shared.Security(
@@ -15,7 +15,7 @@ req = operations.GetAccountCategoryRequest(
     company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
     connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
 )
-    
+
 res = s.categories.get_account_category(req)
 
 if res.categorised_account is not None:

assess/docs/categories/README.md

@@ -0,0 +1,205 @@
+# categories
+
+## Overview
+
+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 category for specific nominal account.
+
+### Example Usage
+
+```python
+import codatassess
+from codatassess.models import operations
+
+s = codatassess.CodatAssess(
+    security=shared.Security(
+        auth_header="YOUR_API_KEY_HERE",
+    ),
+)
+
+
+req = operations.GetAccountCategoryRequest(
+    account_id="provident",
+    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
+    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+)
+
+res = s.categories.get_account_category(req)
+
+if res.categorised_account is not None:
+    # handle response
+```
+
+## list_accounts_categories
+
+Lists suggested and confirmed chart of account categories for the given company and data connection.
+
+### Example Usage
+
+```python
+import codatassess
+from codatassess.models import operations
+
+s = codatassess.CodatAssess(
+    security=shared.Security(
+        auth_header="YOUR_API_KEY_HERE",
+    ),
+)
+
+
+req = operations.ListAccountsCategoriesRequest(
+    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
+    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+    order_by="-modifiedDate",
+    page=1,
+    page_size=100,
+    query="distinctio",
+)
+
+res = s.categories.list_accounts_categories(req)
+
+if res.categorised_accounts is not None:
+    # handle response
+```
+
+## list_available_account_categories
+
+Lists available account categories Codat's categorisation engine can provide. 
+
+### Example Usage
+
+```python
+import codatassess
+
+
+s = codatassess.CodatAssess(
+    security=shared.Security(
+        auth_header="YOUR_API_KEY_HERE",
+    ),
+)
+
+
+res = s.categories.list_available_account_categories()
+
+if res.categories is not None:
+    # handle response
+```
+
+## update_account_category
+
+Update category for a specific nominal account
+
+### Example Usage
+
+```python
+import codatassess
+from codatassess.models import operations, shared
+
+s = codatassess.CodatAssess(
+    security=shared.Security(
+        auth_header="YOUR_API_KEY_HERE",
+    ),
+)
+
+
+req = operations.UpdateAccountCategoryRequest(
+    confirm_category=shared.ConfirmCategory(
+        confirmed=shared.AccountCategory(
+            detail_type="quibusdam",
+            subtype="unde",
+            type="nulla",
+        ),
+    ),
+    account_id="corrupti",
+    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
+    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+)
+
+res = s.categories.update_account_category(req)
+
+if res.categorised_account is not None:
+    # handle response
+```
+
+## update_accounts_categories
+
+Comfirms the categories for all or a batch of accounts for a specific connection.
+
+### Example Usage
+
+```python
+import codatassess
+from codatassess.models import operations, shared
+
+s = codatassess.CodatAssess(
+    security=shared.Security(
+        auth_header="YOUR_API_KEY_HERE",
+    ),
+)
+
+
+req = operations.UpdateAccountsCategoriesRequest(
+    confirm_categories=shared.ConfirmCategories(
+        categories=[
+            shared.ConfirmCategoriesCategories(
+                account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
+                    id="69a674e0-f467-4cc8-b96e-d151a05dfc2d",
+                ),
+                confirmed=shared.AccountCategory(
+                    detail_type="at",
+                    subtype="maiores",
+                    type="molestiae",
+                ),
+            ),
+            shared.ConfirmCategoriesCategories(
+                account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
+                    id="cc78ca1b-a928-4fc8-9674-2cb739205929",
+                ),
+                confirmed=shared.AccountCategory(
+                    detail_type="dolor",
+                    subtype="natus",
+                    type="laboriosam",
+                ),
+            ),
+            shared.ConfirmCategoriesCategories(
+                account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
+                    id="fea7596e-b10f-4aaa-a352-c5955907aff1",
+                ),
+                confirmed=shared.AccountCategory(
+                    detail_type="mollitia",
+                    subtype="dolorem",
+                    type="culpa",
+                ),
+            ),
+            shared.ConfirmCategoriesCategories(
+                account_ref=shared.ConfirmCategoriesCategoriesAccountRef(
+                    id="2fa94677-3925-41aa-92c3-f5ad019da1ff",
+                ),
+                confirmed=shared.AccountCategory(
+                    detail_type="vero",
+                    subtype="nihil",
+                    type="praesentium",
+                ),
+            ),
+        ],
+    ),
+    company_id="8a210b68-6988-11ed-a1eb-0242ac120002",
+    connection_id="2e9d2c44-f675-40ba-8049-353bfcb5e171",
+)
+
+res = s.categories.update_accounts_categories(req)
+
+if res.categorised_accounts is not None:
+    # handle response
+```

assess/docs/codatassess/README.md

@@ -0,0 +1,12 @@
+# CodatAssess SDK
+
+## Overview
+
+Codat's Assess API enable you to make smarter credit decisions on your small business customers. Assess enriches your customer's accounting, commerce and banking data to surface actionable insights you didn't have before.
+
+[Read more...](https://www.codat.io/assess/)
+
+[See our OpenAPI spec](https://github.com/codatio/oas) 
+
+### Available Operations
+