ci: regenerated with OpenAPI Doc 1.0, Speakeay CLI 1.13.0

Author: speakeasybot

assess/RELEASES.md

@@ -118,4 +118,12 @@ Based on:
 - OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
 - Speakeasy CLI 1.12.4 https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v0.5.3] https://pypi.org/project/codat-assess/0.5.3 - assess
+- [PyPI v0.5.3] https://pypi.org/project/codat-assess/0.5.3 - assess
+
+## 2023-03-22 00:11:05
+### Changes
+Based on:
+- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
+- Speakeasy CLI 1.13.0 https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v0.6.0] https://pypi.org/project/codat-assess/0.6.0 - assess

assess/gen.yaml

@@ -2,13 +2,13 @@ configVersion: 1.0.0
 management:
   docChecksum: ef07474bdf5c9e85370b2557c3764749
   docVersion: "1.0"
-  speakeasyVersion: 1.12.4
+  speakeasyVersion: 1.13.0
 generation:
   telemetryEnabled: false
   sdkClassName: codat
   sdkFlattening: true
 python:
-  version: 0.5.3
+  version: 0.6.0
   author: Speakeasy
   description: Python Client SDK Generated by Speakeasy
   packageName: codat-assess

assess/setup.py

@@ -1,3 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import setuptools
 
 try:
@@ -8,7 +10,7 @@
 
 setuptools.setup(
     name="codat-assess",
-    version="0.5.3",
+    version="0.6.0",
     author="Speakeasy",
     description="Python Client SDK Generated by Speakeasy",
     long_description=long_description,

assess/src/codat/__init__.py

@@ -1 +1,3 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 from .sdk import *

assess/src/codat/categories.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from codat.models import operations
 from typing import Optional
 
 class Categories:
+    r"""Categorisation"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -23,7 +26,6 @@ def get_account_category(self, request: operations.GetAccountCategoryRequest) ->
         r"""Get suggested and/or confirmed category for a specific account
         Get category for specific nominal account.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAccountCategoryRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories', request)
@@ -47,7 +49,6 @@ def list_accounts_categories(self, request: operations.ListAccountsCategoriesReq
         r"""List suggested and confirmed account categories
         Lists suggested and confirmed chart of account categories for the given company and data connection.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.ListAccountsCategoriesRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories', request)
@@ -72,7 +73,6 @@ def list_available_account_categories(self) -> operations.ListAvailableAccountCa
         r"""List account categories
         Lists available account categories Codat's categorisation engine can provide. 
         """
-        
         base_url = self._server_url
 
         url = base_url.removesuffix('/') + '/data/assess/accounts/categories'
@@ -96,7 +96,6 @@ def update_account_category(self, request: operations.UpdateAccountCategoryReque
         r"""Patch account categories
         Update category for a specific nominal account
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.UpdateAccountCategoryRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories', request)
@@ -124,7 +123,6 @@ def update_accounts_categories(self, request: operations.UpdateAccountsCategorie
         r"""Confirm categories for accounts
         Comfirms the categories for all or a batch of accounts for a specific connection.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.UpdateAccountsCategoriesRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories', request)

assess/src/codat/data_integrity.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from codat.models import operations
 from typing import Optional
 
 class DataIntegrity:
+    r"""Data integrity is important"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -23,7 +26,6 @@ def get_data_integrity_details(self, request: operations.GetDataIntegrityDetails
         r"""Lists data integrity details for date type
         Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetDataIntegrityDetailsRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details', request)
@@ -48,7 +50,6 @@ def get_data_integrity_status(self, request: operations.GetDataIntegrityStatusRe
         r"""Get data integrity status
         Gets match status for a given company and datatype.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetDataIntegrityStatusRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status', request)
@@ -72,7 +73,6 @@ def get_data_integrity_summaries(self, request: operations.GetDataIntegritySumma
         r"""Get data integrity summary
         Gets match summary for a given company and datatype, optionally restricted by a Codat query string.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetDataIntegritySummariesRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries', request)

assess/src/codat/excel_reports.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from codat.models import operations
 from typing import Optional
 
 class ExcelReports:
+    r"""Downloadable reports"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -23,7 +26,6 @@ def get_accounting_marketing_metrics(self, request: operations.GetAccountingMark
         r"""Get the marketing metrics from an accounting source for a given company.
         Request an Excel report for download.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAccountingMarketingMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing', request)
@@ -48,7 +50,6 @@ def get_excel_report(self, request: operations.GetExcelReportRequest) -> operati
         r"""Download generated excel report
         Download the Excel report to a local drive.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetExcelReportRequest, base_url, '/data/companies/{companyId}/assess/excel/download', request)
@@ -72,7 +73,6 @@ def make_request_to_download_excel_report(self, request: operations.MakeRequestT
         r"""Request an Excel report for download
         Returns the status of the latest report requested.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.MakeRequestToDownloadExcelReportRequest, base_url, '/data/companies/{companyId}/assess/excel', request)
@@ -97,7 +97,6 @@ def request_excel_report_for_download(self, request: operations.RequestExcelRepo
         r"""Request an Excel report for download
         Request an Excel report for download.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.RequestExcelReportForDownloadRequest, base_url, '/data/companies/{companyId}/assess/excel', request)

assess/src/codat/models/__init__.py

@@ -0,0 +1,2 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+

assess/src/codat/models/operations/__init__.py

@@ -1,3 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 from .get_account_category import *
 from .get_accounting_marketing_metrics import *
 from .get_accounts_for_enhanced_balance_sheet import *

assess/src/codat/models/operations/get_account_category.py

@@ -1,3 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 from __future__ import annotations
 import dataclasses
 import dateutil.parser
@@ -11,43 +13,55 @@
 
 @dataclasses.dataclass
 class GetAccountCategoryRequest:
+    
     account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', 'style': 'simple', 'explode': False }})
-    company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }})
-    connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }})
+    r"""Nominal account id"""  
+    company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }})  
+    connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }})  
 
 
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class GetAccountCategoryCategorisedAccountAccountRef:
-    r"""GetAccountCategoryCategorisedAccountAccountRef
-    An object containing account reference data.
-    """
+    r"""An object containing account reference data."""
 
     id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }})
+    r"""'id' from the Accounts data type."""  
     name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }})
+    r"""'name' from the Accounts data type."""  
 
 
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class GetAccountCategoryCategorisedAccountModifiedDate:
+    
     detail_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detailType'), 'exclude': lambda f: f is None }})
+    r"""Most granular chart of account type."""  
     modified_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }})
+    r"""The date on which this record was last modified in Codat."""  
     subtype: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subtype'), 'exclude': lambda f: f is None }})
+    r"""The account subtype."""  
     type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }})
+    r"""The top level account type."""  
 
 
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclasses.dataclass
 class GetAccountCategoryCategorisedAccount:
+    r"""OK"""
+    
     account_ref: Optional[GetAccountCategoryCategorisedAccountAccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }})
-    confirmed: Optional[GetAccountCategoryCategorisedAccountModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confirmed'), 'exclude': lambda f: f is None }})
-    suggested: Optional[GetAccountCategoryCategorisedAccountModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggested'), 'exclude': lambda f: f is None }})
+    r"""An object containing account reference data."""  
+    confirmed: Optional[GetAccountCategoryCategorisedAccountModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confirmed'), 'exclude': lambda f: f is None }})  
+    suggested: Optional[GetAccountCategoryCategorisedAccountModifiedDate] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggested'), 'exclude': lambda f: f is None }})  
 
 
 @dataclasses.dataclass
 class GetAccountCategoryResponse:
-    content_type: str = dataclasses.field()
-    status_code: int = dataclasses.field()
+    
+    content_type: str = dataclasses.field()  
+    status_code: int = dataclasses.field()  
     categorised_account: Optional[GetAccountCategoryCategorisedAccount] = dataclasses.field(default=None)
-    raw_response: Optional[requests_http.Response] = dataclasses.field(default=None)
+    r"""OK"""  
+    raw_response: Optional[requests_http.Response] = dataclasses.field(default=None)