From 912e06ed42d1d09f7da60cb1c059705a8e9790f6 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 1 Sep 2023 16:59:14 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc 1.0, Speakeay CLI 1.77.1 --- previous-versions/assess/.gitattributes | 2 + previous-versions/assess/RELEASES.md | 12 +- previous-versions/assess/USAGE.md | 17 +- .../operations/generateexcelreportresponse.md | 4 +- .../operations/getaccountcategoryrequest.md | 10 - .../operations/getaccountcategoryresponse.md | 11 - .../getaccountingmarketingmetricsresponse.md | 4 +- ...accountsforenhancedbalancesheetresponse.md | 4 +- ...ccountsforenhancedprofitandlossresponse.md | 4 +- ...ommercecustomerretentionmetricsresponse.md | 4 +- ...getcommercelifetimevaluemetricsresponse.md | 4 +- .../getcommerceordersmetricsresponse.md | 4 +- .../getcommercerefundsmetricsresponse.md | 4 +- .../getcommercerevenuemetricsresponse.md | 4 +- .../getdataintegritystatusresponse.md | 4 +- .../getdataintegritysummariesresponse.md | 4 +- .../getenhancedbalancesheetrequest.md | 13 - .../getenhancedbalancesheetresponse.md | 12 - ...getenhancedcashflowtransactionsresponse.md | 4 +- .../getenhancedfinancialmetricsrequest.md | 13 - .../getenhancedfinancialmetricsresponse.md | 11 - .../getenhancedinvoicesreportresponse.md | 4 +- .../getenhancedprofitandlossrequest.md | 13 - .../getenhancedprofitandlossresponse.md | 12 - .../getexcelreportgenerationstatusresponse.md | 4 +- .../operations/getexcelreportresponse.md | 4 +- .../operations/getloansummaryresponse.md | 4 +- .../getrecurringrevenuemetricsresponse.md | 4 +- .../listaccountscategoriesrequest.md | 13 - .../listaccountscategoriesresponse.md | 11 - .../listavailableaccountcategoriesresponse.md | 11 - ...istdatatypedataintegritydetailsresponse.md | 4 +- .../listloantransactionsresponse.md | 4 +- .../requestrecurringrevenuemetricsresponse.md | 4 +- .../updateaccountcategoryrequest.md | 11 - .../updateaccountcategoryresponse.md | 11 - .../updateaccountscategoriesrequest.md | 10 - .../updateaccountscategoriesresponse.md | 11 - .../docs/models/shared/accountcategory.md | 10 - .../shared/accountcategorydeprecated.md | 11 - .../assess/docs/models/shared/accountref.md | 10 +- .../assess/docs/models/shared/categories.md | 13 - .../docs/models/shared/categorisedaccount.md | 12 - .../docs/models/shared/categorisedaccounts.md | 14 - .../models/shared/commercereportcomponent.md | 13 + .../models/shared/commercereportdimension.md | 11 + ...ems.md => commercereportdimensionitems.md} | 2 +- ...{reporterror.md => commercereporterror.md} | 2 +- ...ortmeasure.md => commercereportmeasure.md} | 2 +- .../docs/models/shared/confirmcategories.md | 8 - .../shared/confirmcategoriescategories.md | 9 - .../confirmcategoriescategoriesaccountref.md | 8 - .../docs/models/shared/confirmcategory.md | 8 - .../shared/enhancedcashflowtransaction.md | 2 + .../shared/enhancedcashflowtransactions.md | 6 +- .../shared/enhancedinvoicereportitem.md | 2 +- .../models/shared/enhancedinvoicesreport.md | 8 +- .../enhancedinvoicesreportreportitems.md | 8 - .../shared/{schema.md => errormessage.md} | 2 +- .../docs/models/shared/excelreporttypes.md | 13 + .../assess/docs/models/shared/excelstatus.md | 14 +- .../docs/models/shared/financialmetric.md | 12 - .../models/shared/financialmetricerror.md | 9 - .../models/shared/financialmetricerrors.md | 10 - .../shared/financialmetricerrorstype.md | 12 - .../models/shared/financialmetricerrortype.md | 11 - .../docs/models/shared/financialmetrickey.md | 28 -- .../shared/financialmetricmetricunit.md | 9 - .../models/shared/financialmetricperiods.md | 12 - .../shared/financialmetricperiodserrors.md | 10 - .../financialmetricperiodserrorstype.md | 11 - .../shared/financialmetricperiodsinputs.md | 9 - .../docs/models/shared/financialmetrics.md | 13 - .../shared/financialmetricsperiodunit.md | 10 - .../{customerref.md => lendingcustomerref.md} | 2 +- .../assess/docs/models/shared/loansummary.md | 2 +- ...ntype.md => loansummaryintegrationtype.md} | 2 +- .../models/shared/loansummaryrecordref.md | 11 + ...reftype.md => loansummaryrecordreftype.md} | 2 +- ...portitems1.md => loansummaryreportitem.md} | 13 +- .../docs/models/shared/loantransactions.md | 2 +- .../assess/docs/models/shared/recordref.md | 11 - .../assess/docs/models/shared/report.md | 57 ++-- .../docs/models/shared/reportcomponent.md | 13 - .../docs/models/shared/reportdimension.md | 11 - .../assess/docs/models/shared/reportitems.md | 11 +- .../assess/docs/models/shared/sourceref.md | 6 +- .../docs/models/shared/transactioncategory.md | 8 +- .../assess/docs/sdks/categories/README.md | 275 ------------------ .../assess/docs/sdks/codatassess/README.md | 4 +- .../assess/docs/sdks/dataintegrity/README.md | 78 ++--- .../assess/docs/sdks/excelreports/README.md | 10 +- .../assess/docs/sdks/reports/README.md | 193 ++---------- previous-versions/assess/files.gen | 135 +++------ previous-versions/assess/gen.yaml | 21 +- previous-versions/assess/pylintrc | 6 +- previous-versions/assess/setup.py | 8 +- .../assess/src/codatassess/categories.py | 217 -------------- .../assess/src/codatassess/data_integrity.py | 84 +++--- .../assess/src/codatassess/excel_reports.py | 54 +++- .../src/codatassess/models/errors/__init__.py | 4 + .../src/codatassess/models/errors/sdkerror.py | 24 ++ .../codatassess/models/operations/__init__.py | 10 +- .../operations/generate_excel_report.py | 6 +- .../models/operations/get_account_category.py | 30 -- .../get_accounting_marketing_metrics.py | 6 +- ...get_accounts_for_enhanced_balance_sheet.py | 6 +- ...t_accounts_for_enhanced_profit_and_loss.py | 6 +- ...get_commerce_customer_retention_metrics.py | 6 +- .../get_commerce_lifetime_value_metrics.py | 6 +- .../operations/get_commerce_orders_metrics.py | 6 +- .../get_commerce_refunds_metrics.py | 6 +- .../get_commerce_revenue_metrics.py | 6 +- .../operations/get_data_integrity_status.py | 6 +- .../get_data_integrity_summaries.py | 6 +- .../operations/get_enhanced_balance_sheet.py | 39 --- .../get_enhanced_cash_flow_transactions.py | 6 +- .../get_enhanced_financial_metrics.py | 36 --- .../get_enhanced_invoices_report.py | 6 +- .../get_enhanced_profit_and_loss.py | 39 --- .../models/operations/get_excel_report.py | 6 +- .../get_excel_report_generation_status.py | 6 +- .../models/operations/get_loan_summary.py | 6 +- .../get_recurring_revenue_metrics.py | 6 +- .../operations/list_accounts_categories.py | 36 --- .../list_available_account_categories.py | 19 -- .../list_data_type_data_integrity_details.py | 6 +- .../operations/list_loan_transactions.py | 6 +- .../request_recurring_revenue_metrics.py | 6 +- .../operations/update_account_category.py | 32 -- .../operations/update_accounts_categories.py | 30 -- .../src/codatassess/models/shared/__init__.py | 31 +- .../shared/accountcategoriesupdatedwebhook.py | 18 +- .../models/shared/accountcategory.py | 21 -- .../shared/accountcategorydeprecated.py | 22 -- .../codatassess/models/shared/accountref.py | 6 +- .../src/codatassess/models/shared/accounts.py | 6 +- .../models/shared/bankingtransactionref.py | 12 +- .../codatassess/models/shared/categories.py | 27 -- .../models/shared/categorisedaccount.py | 22 -- .../models/shared/categorisedaccounts.py | 24 -- ...omponent.py => commercereportcomponent.py} | 4 +- ...imension.py => commercereportdimension.py} | 6 +- ...{reporterror.py => commercereporterror.py} | 2 +- ...ortmeasure.py => commercereportmeasure.py} | 2 +- .../models/shared/confirmcategories.py | 38 --- .../models/shared/confirmcategory.py | 16 - .../models/shared/dataintegrityamounts.py | 6 +- .../models/shared/dataintegritybyamount.py | 6 +- .../models/shared/dataintegritydates.py | 48 +-- .../models/shared/dataintegritydetails.py | 18 +- .../models/shared/dataintegritymatch.py | 6 +- .../models/shared/dataintegritystatusinfo.py | 12 +- .../shared/enhancedcashflowtransaction.py | 17 +- .../shared/enhancedcashflowtransactions.py | 7 +- .../shared/enhancedinvoicereportitem.py | 48 +-- .../models/shared/enhancedinvoicesreport.py | 11 +- .../models/shared/enhancedreport.py | 12 +- .../models/shared/enhancedreportinfo.py | 18 +- .../shared/{schema.py => errormessage.py} | 2 +- .../models/shared/excelreporttypes.py | 11 + .../codatassess/models/shared/excelstatus.py | 22 +- .../models/shared/financialmetric.py | 121 -------- .../models/shared/financialmetricerror.py | 24 -- .../models/shared/financialmetrics.py | 37 --- .../models/shared/invoicestatus.py | 2 +- .../{customerref.py => lendingcustomerref.py} | 2 +- .../codatassess/models/shared/loansummary.py | 4 +- .../shared/loansummaryintegrationtype.py | 10 + .../{recordref.py => loansummaryrecordref.py} | 21 +- .../models/shared/loansummaryrecordreftype.py | 10 + .../models/shared/loansummaryreportinfo.py | 12 +- .../models/shared/loansummaryreportitem.py | 46 +++ .../models/shared/loantransactions.py | 4 +- .../shared/loantransactionsreportinfo.py | 12 +- .../src/codatassess/models/shared/payment.py | 34 +-- .../src/codatassess/models/shared/report.py | 71 +++-- .../codatassess/models/shared/reportitems.py | 38 +-- .../codatassess/models/shared/reportitems1.py | 50 ---- .../codatassess/models/shared/sourceref.py | 1 + .../models/shared/transactioncategory.py | 4 +- .../assess/src/codatassess/reports.py | 272 +++++++---------- .../assess/src/codatassess/sdk.py | 16 +- .../src/codatassess/sdkconfiguration.py | 4 +- .../assess/src/codatassess/utils/utils.py | 7 +- 185 files changed, 972 insertions(+), 2614 deletions(-) create mode 100755 previous-versions/assess/.gitattributes delete mode 100755 previous-versions/assess/docs/models/operations/getaccountcategoryrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/getaccountcategoryresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedbalancesheetrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedbalancesheetresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedprofitandlossrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/getenhancedprofitandlossresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/listaccountscategoriesrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/listaccountscategoriesresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/listavailableaccountcategoriesresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/updateaccountcategoryrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/updateaccountcategoryresponse.md delete mode 100755 previous-versions/assess/docs/models/operations/updateaccountscategoriesrequest.md delete mode 100755 previous-versions/assess/docs/models/operations/updateaccountscategoriesresponse.md delete mode 100755 previous-versions/assess/docs/models/shared/accountcategory.md delete mode 100755 previous-versions/assess/docs/models/shared/accountcategorydeprecated.md delete mode 100755 previous-versions/assess/docs/models/shared/categories.md delete mode 100755 previous-versions/assess/docs/models/shared/categorisedaccount.md delete mode 100755 previous-versions/assess/docs/models/shared/categorisedaccounts.md create mode 100755 previous-versions/assess/docs/models/shared/commercereportcomponent.md create mode 100755 previous-versions/assess/docs/models/shared/commercereportdimension.md rename previous-versions/assess/docs/models/shared/{reportdimensionitems.md => commercereportdimensionitems.md} (89%) rename previous-versions/assess/docs/models/shared/{reporterror.md => commercereporterror.md} (95%) rename previous-versions/assess/docs/models/shared/{reportmeasure.md => commercereportmeasure.md} (95%) delete mode 100755 previous-versions/assess/docs/models/shared/confirmcategories.md delete mode 100755 previous-versions/assess/docs/models/shared/confirmcategoriescategories.md delete mode 100755 previous-versions/assess/docs/models/shared/confirmcategoriescategoriesaccountref.md delete mode 100755 previous-versions/assess/docs/models/shared/confirmcategory.md delete mode 100755 previous-versions/assess/docs/models/shared/enhancedinvoicesreportreportitems.md rename previous-versions/assess/docs/models/shared/{schema.md => errormessage.md} (98%) create mode 100755 previous-versions/assess/docs/models/shared/excelreporttypes.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetric.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricerror.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricerrors.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricerrorstype.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricerrortype.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetrickey.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricmetricunit.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricperiods.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricperiodserrors.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricperiodserrorstype.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricperiodsinputs.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetrics.md delete mode 100755 previous-versions/assess/docs/models/shared/financialmetricsperiodunit.md rename previous-versions/assess/docs/models/shared/{customerref.md => lendingcustomerref.md} (97%) rename previous-versions/assess/docs/models/shared/{recordrefintegrationtype.md => loansummaryintegrationtype.md} (88%) create mode 100755 previous-versions/assess/docs/models/shared/loansummaryrecordref.md rename previous-versions/assess/docs/models/shared/{recordrefrecordreftype.md => loansummaryrecordreftype.md} (92%) rename previous-versions/assess/docs/models/shared/{reportitems1.md => loansummaryreportitem.md} (84%) delete mode 100755 previous-versions/assess/docs/models/shared/recordref.md delete mode 100755 previous-versions/assess/docs/models/shared/reportcomponent.md delete mode 100755 previous-versions/assess/docs/models/shared/reportdimension.md delete mode 100755 previous-versions/assess/docs/sdks/categories/README.md delete mode 100755 previous-versions/assess/src/codatassess/categories.py create mode 100755 previous-versions/assess/src/codatassess/models/errors/__init__.py create mode 100755 previous-versions/assess/src/codatassess/models/errors/sdkerror.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/get_account_category.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/get_enhanced_balance_sheet.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/get_enhanced_financial_metrics.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/get_enhanced_profit_and_loss.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/list_accounts_categories.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/list_available_account_categories.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/update_account_category.py delete mode 100755 previous-versions/assess/src/codatassess/models/operations/update_accounts_categories.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/accountcategory.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/accountcategorydeprecated.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/categories.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/categorisedaccount.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/categorisedaccounts.py rename previous-versions/assess/src/codatassess/models/shared/{reportcomponent.py => commercereportcomponent.py} (85%) rename previous-versions/assess/src/codatassess/models/shared/{reportdimension.py => commercereportdimension.py} (80%) rename previous-versions/assess/src/codatassess/models/shared/{reporterror.py => commercereporterror.py} (96%) rename previous-versions/assess/src/codatassess/models/shared/{reportmeasure.py => commercereportmeasure.py} (97%) delete mode 100755 previous-versions/assess/src/codatassess/models/shared/confirmcategories.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/confirmcategory.py rename previous-versions/assess/src/codatassess/models/shared/{schema.py => errormessage.py} (98%) create mode 100755 previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/financialmetric.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/financialmetricerror.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/financialmetrics.py rename previous-versions/assess/src/codatassess/models/shared/{customerref.py => lendingcustomerref.py} (96%) create mode 100755 previous-versions/assess/src/codatassess/models/shared/loansummaryintegrationtype.py rename previous-versions/assess/src/codatassess/models/shared/{recordref.py => loansummaryrecordref.py} (51%) create mode 100755 previous-versions/assess/src/codatassess/models/shared/loansummaryrecordreftype.py create mode 100755 previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py delete mode 100755 previous-versions/assess/src/codatassess/models/shared/reportitems1.py diff --git a/previous-versions/assess/.gitattributes b/previous-versions/assess/.gitattributes new file mode 100755 index 000000000..4d75d5900 --- /dev/null +++ b/previous-versions/assess/.gitattributes @@ -0,0 +1,2 @@ +# This allows generated code to be indexed correctly +*.py linguist-generated=false \ No newline at end of file diff --git a/previous-versions/assess/RELEASES.md b/previous-versions/assess/RELEASES.md index c838498c6..3a1c0f843 100644 --- a/previous-versions/assess/RELEASES.md +++ b/previous-versions/assess/RELEASES.md @@ -582,4 +582,14 @@ Based on: - OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml - Speakeasy CLI 1.53.0 (2.58.0) https://github.com/speakeasy-api/speakeasy ### Releases -- [PyPI v0.31.1] https://pypi.org/project/codat-assess/0.31.1 - assess \ No newline at end of file +- [PyPI v0.31.1] https://pypi.org/project/codat-assess/0.31.1 - assess + +## 2023-09-01 16:58:53 +### Changes +Based on: +- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml +- Speakeasy CLI 1.77.1 (2.91.4) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.1.0] previous-versions/assess +### Releases +- [PyPI v0.1.0] https://pypi.org/project/codat-assess/0.1.0 - previous-versions/assess \ No newline at end of file diff --git a/previous-versions/assess/USAGE.md b/previous-versions/assess/USAGE.md index 4a6c6c179..28a09e2bc 100755 --- a/previous-versions/assess/USAGE.md +++ b/previous-versions/assess/USAGE.md @@ -1,7 +1,9 @@ + + ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -9,15 +11,18 @@ s = codatassess.CodatAssess( ), ) -req = operations.GetAccountCategoryRequest( - account_id='corrupti', +req = operations.ListDataTypeDataIntegrityDetailsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', + data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, + order_by='-modifiedDate', + page=1, + page_size=100, + query='corrupti', ) -res = s.categories.get_account_category(req) +res = s.data_integrity.details(req) -if res.categorised_account is not None: +if res.details is not None: # handle response ``` \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md b/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md index 50e2338a5..30d67fe93 100755 --- a/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md +++ b/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountcategoryrequest.md b/previous-versions/assess/docs/models/operations/getaccountcategoryrequest.md deleted file mode 100755 index b63070b68..000000000 --- a/previous-versions/assess/docs/models/operations/getaccountcategoryrequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# GetAccountCategoryRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `account_id` | *str* | :heavy_check_mark: | Nominal account id | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountcategoryresponse.md b/previous-versions/assess/docs/models/operations/getaccountcategoryresponse.md deleted file mode 100755 index 2b2a4c9aa..000000000 --- a/previous-versions/assess/docs/models/operations/getaccountcategoryresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetAccountCategoryResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `categorised_account` | [Optional[shared.CategorisedAccount]](../../models/shared/categorisedaccount.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md b/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md index 679a133c3..22f090672 100755 --- a/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md index 1904eee88..80692f63e 100755 --- a/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | | `enhanced_report` | [Optional[shared.EnhancedReport]](../../models/shared/enhancedreport.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md index 9be93a843..cbfc1c4a4 100755 --- a/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | | `enhanced_report` | [Optional[shared.EnhancedReport]](../../models/shared/enhancedreport.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md index 24167b9a1..67f3155fd 100755 --- a/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md index 758559148..fa731c396 100755 --- a/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md index edf0b0b32..1c7985f41 100755 --- a/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md index 833a2f73a..b01923b17 100755 --- a/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md index 14210a9b1..ce8ea9351 100755 --- a/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md b/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md index 65593121c..37e332102 100755 --- a/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md +++ b/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status` | [Optional[shared.Status]](../../models/shared/status.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md b/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md index 343827839..a4f1ee71f 100755 --- a/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md +++ b/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | | `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `summaries` | [Optional[shared.Summaries]](../../models/shared/summaries.md) | :heavy_minus_sign: | OK | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `summaries` | [Optional[shared.Summaries]](../../models/shared/summaries.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedbalancesheetrequest.md b/previous-versions/assess/docs/models/operations/getenhancedbalancesheetrequest.md deleted file mode 100755 index c07dc7b78..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedbalancesheetrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# GetEnhancedBalanceSheetRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | -| `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | -| `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | -| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedbalancesheetresponse.md b/previous-versions/assess/docs/models/operations/getenhancedbalancesheetresponse.md deleted file mode 100755 index ba2552110..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedbalancesheetresponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# GetEnhancedBalanceSheetResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md b/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md index 9f8c446c8..c4cfb8d0e 100755 --- a/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md +++ b/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md @@ -7,6 +7,6 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | | `enhanced_cash_flow_transactions` | [Optional[shared.EnhancedCashFlowTransactions]](../../models/shared/enhancedcashflowtransactions.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsrequest.md b/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsrequest.md deleted file mode 100755 index 7b6a7de4a..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# GetEnhancedFinancialMetricsRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | -| `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | -| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | -| `show_metric_inputs` | *Optional[bool]* | :heavy_minus_sign: | If set to true, then the system includes the input values within the response. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsresponse.md b/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsresponse.md deleted file mode 100755 index d23ca28e3..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedfinancialmetricsresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetEnhancedFinancialMetricsResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `financial_metrics` | [Optional[shared.FinancialMetrics]](../../models/shared/financialmetrics.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md b/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md index d041ddf56..0bd526f65 100755 --- a/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md +++ b/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md @@ -7,6 +7,6 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | | `enhanced_invoices_report` | [Optional[shared.EnhancedInvoicesReport]](../../models/shared/enhancedinvoicesreport.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedprofitandlossrequest.md b/previous-versions/assess/docs/models/operations/getenhancedprofitandlossrequest.md deleted file mode 100755 index 6731542fd..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedprofitandlossrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# GetEnhancedProfitAndLossRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | -| `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | -| `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | -| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedprofitandlossresponse.md b/previous-versions/assess/docs/models/operations/getenhancedprofitandlossresponse.md deleted file mode 100755 index fd96d27a5..000000000 --- a/previous-versions/assess/docs/models/operations/getenhancedprofitandlossresponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# GetEnhancedProfitAndLossResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md b/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md index 70d1d0ab6..60768049a 100755 --- a/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md +++ b/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getexcelreportresponse.md b/previous-versions/assess/docs/models/operations/getexcelreportresponse.md index e3e0aa238..902fa61a4 100755 --- a/previous-versions/assess/docs/models/operations/getexcelreportresponse.md +++ b/previous-versions/assess/docs/models/operations/getexcelreportresponse.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `body` | *Optional[bytes]* | :heavy_minus_sign: | N/A | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getloansummaryresponse.md b/previous-versions/assess/docs/models/operations/getloansummaryresponse.md index fc5f8e7f4..5d06031f5 100755 --- a/previous-versions/assess/docs/models/operations/getloansummaryresponse.md +++ b/previous-versions/assess/docs/models/operations/getloansummaryresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `loan_summary` | [Optional[shared.LoanSummary]](../../models/shared/loansummary.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md index eb4192f95..196e334bb 100755 --- a/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listaccountscategoriesrequest.md b/previous-versions/assess/docs/models/operations/listaccountscategoriesrequest.md deleted file mode 100755 index 0d58f328c..000000000 --- a/previous-versions/assess/docs/models/operations/listaccountscategoriesrequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAccountsCategoriesRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `order_by` | *Optional[str]* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional[int]* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `page_size` | *Optional[int]* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional[str]* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listaccountscategoriesresponse.md b/previous-versions/assess/docs/models/operations/listaccountscategoriesresponse.md deleted file mode 100755 index 7a302448a..000000000 --- a/previous-versions/assess/docs/models/operations/listaccountscategoriesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListAccountsCategoriesResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `categorised_accounts` | [Optional[shared.CategorisedAccounts]](../../models/shared/categorisedaccounts.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listavailableaccountcategoriesresponse.md b/previous-versions/assess/docs/models/operations/listavailableaccountcategoriesresponse.md deleted file mode 100755 index 99aaddb46..000000000 --- a/previous-versions/assess/docs/models/operations/listavailableaccountcategoriesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListAvailableAccountCategoriesResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `categories` | list[[shared.Categories](../../models/shared/categories.md)] | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md b/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md index 7b6e9b4f6..d1df35b1c 100755 --- a/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md +++ b/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | | `details` | [Optional[shared.Details]](../../models/shared/details.md) | :heavy_minus_sign: | OK | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md b/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md index 86a89accf..8ee977bb7 100755 --- a/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md +++ b/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `loan_transactions` | [Optional[shared.LoanTransactions]](../../models/shared/loantransactions.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md index 3afef0a6e..390042501 100755 --- a/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | N/A | +| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `report` | [Optional[shared.Report]](../../models/shared/report.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | -| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | Your API request was not properly authorized. | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/updateaccountcategoryrequest.md b/previous-versions/assess/docs/models/operations/updateaccountcategoryrequest.md deleted file mode 100755 index 3f77ea4d2..000000000 --- a/previous-versions/assess/docs/models/operations/updateaccountcategoryrequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateAccountCategoryRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `confirm_category` | [Optional[shared.ConfirmCategory]](../../models/shared/confirmcategory.md) | :heavy_minus_sign: | N/A | | -| `account_id` | *str* | :heavy_check_mark: | Nominal account id | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/updateaccountcategoryresponse.md b/previous-versions/assess/docs/models/operations/updateaccountcategoryresponse.md deleted file mode 100755 index af039cdcb..000000000 --- a/previous-versions/assess/docs/models/operations/updateaccountcategoryresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateAccountCategoryResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `categorised_account` | [Optional[shared.CategorisedAccount]](../../models/shared/categorisedaccount.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/updateaccountscategoriesrequest.md b/previous-versions/assess/docs/models/operations/updateaccountscategoriesrequest.md deleted file mode 100755 index ac5c06a5f..000000000 --- a/previous-versions/assess/docs/models/operations/updateaccountscategoriesrequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# UpdateAccountsCategoriesRequest - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `confirm_categories` | [Optional[shared.ConfirmCategories]](../../models/shared/confirmcategories.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/updateaccountscategoriesresponse.md b/previous-versions/assess/docs/models/operations/updateaccountscategoriesresponse.md deleted file mode 100755 index 41a601757..000000000 --- a/previous-versions/assess/docs/models/operations/updateaccountscategoriesresponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdateAccountsCategoriesResponse - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `categorised_accounts` | list[[shared.CategorisedAccount](../../models/shared/categorisedaccount.md)] | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | N/A | -| `status_code` | *int* | :heavy_check_mark: | N/A | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/accountcategory.md b/previous-versions/assess/docs/models/shared/accountcategory.md deleted file mode 100755 index ea1d853e6..000000000 --- a/previous-versions/assess/docs/models/shared/accountcategory.md +++ /dev/null @@ -1,10 +0,0 @@ -# AccountCategory - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `detail_type` | *Optional[str]* | :heavy_minus_sign: | Most granular chart of account type. | -| `subtype` | *Optional[str]* | :heavy_minus_sign: | The account subtype. | -| `type` | *Optional[str]* | :heavy_minus_sign: | The top level account type. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/accountcategorydeprecated.md b/previous-versions/assess/docs/models/shared/accountcategorydeprecated.md deleted file mode 100755 index 2a860b765..000000000 --- a/previous-versions/assess/docs/models/shared/accountcategorydeprecated.md +++ /dev/null @@ -1,11 +0,0 @@ -# AccountCategoryDeprecated - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `detail_type` | *Optional[str]* | :heavy_minus_sign: | Most granular chart of account type. | | -| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `subtype` | *Optional[str]* | :heavy_minus_sign: | The account subtype. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The top level account type. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/accountref.md b/previous-versions/assess/docs/models/shared/accountref.md index 3ac11ae66..6ccbc7a1d 100755 --- a/previous-versions/assess/docs/models/shared/accountref.md +++ b/previous-versions/assess/docs/models/shared/accountref.md @@ -1,11 +1,11 @@ # AccountRef -An object containing account reference data. +An account reference containing the account id and name. ## Fields -| Field | Type | Required | Description | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `id` | *Optional[str]* | :heavy_minus_sign: | 'id' from the Accounts data type. | -| `name` | *Optional[str]* | :heavy_minus_sign: | 'name' from the Accounts data type. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the account. | +| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the account. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/categories.md b/previous-versions/assess/docs/models/shared/categories.md deleted file mode 100755 index 704046c02..000000000 --- a/previous-versions/assess/docs/models/shared/categories.md +++ /dev/null @@ -1,13 +0,0 @@ -# Categories - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `detail_type` | *Optional[str]* | :heavy_minus_sign: | Most granular chart of account type. | -| `detail_type_description` | *Optional[str]* | :heavy_minus_sign: | A description of the fully categorized (to detail type) account. | -| `detail_type_display_name` | *Optional[str]* | :heavy_minus_sign: | Human readable detailType display name. | -| `subtype` | *Optional[str]* | :heavy_minus_sign: | The account subtype. | -| `subtype_display_name` | *Optional[str]* | :heavy_minus_sign: | Human readable subtype display name. | -| `type` | *Optional[str]* | :heavy_minus_sign: | The top level account type. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/categorisedaccount.md b/previous-versions/assess/docs/models/shared/categorisedaccount.md deleted file mode 100755 index bd937c610..000000000 --- a/previous-versions/assess/docs/models/shared/categorisedaccount.md +++ /dev/null @@ -1,12 +0,0 @@ -# CategorisedAccount - -OK - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `account_ref` | [Optional[AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | An object containing account reference data. | -| `confirmed` | [Optional[AccountCategoryDeprecated]](../../models/shared/accountcategorydeprecated.md) | :heavy_minus_sign: | N/A | -| `suggested` | [Optional[AccountCategoryDeprecated]](../../models/shared/accountcategorydeprecated.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/categorisedaccounts.md b/previous-versions/assess/docs/models/shared/categorisedaccounts.md deleted file mode 100755 index 371aa7ce5..000000000 --- a/previous-versions/assess/docs/models/shared/categorisedaccounts.md +++ /dev/null @@ -1,14 +0,0 @@ -# CategorisedAccounts - -OK - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | N/A | -| `page_size` | *int* | :heavy_check_mark: | N/A | -| `results` | list[[CategorisedAccount](../../models/shared/categorisedaccount.md)] | :heavy_minus_sign: | A list confirmed and suggested account categories. | -| `total_results` | *int* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/commercereportcomponent.md b/previous-versions/assess/docs/models/shared/commercereportcomponent.md new file mode 100755 index 000000000..7c1074a2b --- /dev/null +++ b/previous-versions/assess/docs/models/shared/commercereportcomponent.md @@ -0,0 +1,13 @@ +# CommerceReportComponent + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `components` | list[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | +| `dimension` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `item` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `measures` | list[[ReportComponentMeasure](../../models/shared/reportcomponentmeasure.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/commercereportdimension.md b/previous-versions/assess/docs/models/shared/commercereportdimension.md new file mode 100755 index 000000000..16bd136eb --- /dev/null +++ b/previous-versions/assess/docs/models/shared/commercereportdimension.md @@ -0,0 +1,11 @@ +# CommerceReportDimension + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `items` | list[[CommerceReportDimensionItems](../../models/shared/commercereportdimensionitems.md)] | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/reportdimensionitems.md b/previous-versions/assess/docs/models/shared/commercereportdimensionitems.md similarity index 89% rename from previous-versions/assess/docs/models/shared/reportdimensionitems.md rename to previous-versions/assess/docs/models/shared/commercereportdimensionitems.md index 0ca7e8964..0bf2f60ef 100755 --- a/previous-versions/assess/docs/models/shared/reportdimensionitems.md +++ b/previous-versions/assess/docs/models/shared/commercereportdimensionitems.md @@ -1,4 +1,4 @@ -# ReportDimensionItems +# CommerceReportDimensionItems ## Fields diff --git a/previous-versions/assess/docs/models/shared/reporterror.md b/previous-versions/assess/docs/models/shared/commercereporterror.md similarity index 95% rename from previous-versions/assess/docs/models/shared/reporterror.md rename to previous-versions/assess/docs/models/shared/commercereporterror.md index e3a9ec25c..0ff78d8b4 100755 --- a/previous-versions/assess/docs/models/shared/reporterror.md +++ b/previous-versions/assess/docs/models/shared/commercereporterror.md @@ -1,4 +1,4 @@ -# ReportError +# CommerceReportError ## Fields diff --git a/previous-versions/assess/docs/models/shared/reportmeasure.md b/previous-versions/assess/docs/models/shared/commercereportmeasure.md similarity index 95% rename from previous-versions/assess/docs/models/shared/reportmeasure.md rename to previous-versions/assess/docs/models/shared/commercereportmeasure.md index ab23989f4..72e261fbb 100755 --- a/previous-versions/assess/docs/models/shared/reportmeasure.md +++ b/previous-versions/assess/docs/models/shared/commercereportmeasure.md @@ -1,4 +1,4 @@ -# ReportMeasure +# CommerceReportMeasure ## Fields diff --git a/previous-versions/assess/docs/models/shared/confirmcategories.md b/previous-versions/assess/docs/models/shared/confirmcategories.md deleted file mode 100755 index 454e4eb8d..000000000 --- a/previous-versions/assess/docs/models/shared/confirmcategories.md +++ /dev/null @@ -1,8 +0,0 @@ -# ConfirmCategories - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `categories` | list[[ConfirmCategoriesCategories](../../models/shared/confirmcategoriescategories.md)] | :heavy_minus_sign: | List of confirmed account categories set manually by the user. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/confirmcategoriescategories.md b/previous-versions/assess/docs/models/shared/confirmcategoriescategories.md deleted file mode 100755 index 3770b05c4..000000000 --- a/previous-versions/assess/docs/models/shared/confirmcategoriescategories.md +++ /dev/null @@ -1,9 +0,0 @@ -# ConfirmCategoriesCategories - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `account_ref` | [Optional[ConfirmCategoriesCategoriesAccountRef]](../../models/shared/confirmcategoriescategoriesaccountref.md) | :heavy_minus_sign: | N/A | -| `confirmed` | [Optional[AccountCategory]](../../models/shared/accountcategory.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/confirmcategoriescategoriesaccountref.md b/previous-versions/assess/docs/models/shared/confirmcategoriescategoriesaccountref.md deleted file mode 100755 index 75b906f27..000000000 --- a/previous-versions/assess/docs/models/shared/confirmcategoriescategoriesaccountref.md +++ /dev/null @@ -1,8 +0,0 @@ -# ConfirmCategoriesCategoriesAccountRef - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `id` | *str* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/confirmcategory.md b/previous-versions/assess/docs/models/shared/confirmcategory.md deleted file mode 100755 index cbd4bc82c..000000000 --- a/previous-versions/assess/docs/models/shared/confirmcategory.md +++ /dev/null @@ -1,8 +0,0 @@ -# ConfirmCategory - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `confirmed` | [AccountCategory](../../models/shared/accountcategory.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md b/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md index dd1971f8b..48eda2af4 100755 --- a/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md +++ b/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md @@ -5,10 +5,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `account_ref` | [Optional[AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | An account reference containing the account id and name. | | | `amount` | *Optional[float]* | :heavy_minus_sign: | The bank transaction amount. | | | `currency` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `description` | *Optional[str]* | :heavy_minus_sign: | The description of the bank transaction. | | | `id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier of the bank transaction. | | +| `platform_name` | *Optional[str]* | :heavy_minus_sign: | Returns the payment processor responsible for the transaction. | | | `source_ref` | [Optional[SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | | `transaction_category` | [Optional[TransactionCategory]](../../models/shared/transactioncategory.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md b/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md index bae668b27..ccaff4fb3 100755 --- a/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md +++ b/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md @@ -1,6 +1,10 @@ # EnhancedCashFlowTransactions -OK +> **Categorization engine** +> +> The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + +The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. ## Fields diff --git a/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md b/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md index cae9fd900..d46575165 100755 --- a/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md +++ b/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md @@ -7,7 +7,7 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount_due` | *Optional[float]* | :heavy_minus_sign: | N/A | | | `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `customer_ref` | [Optional[CustomerRef]](../../models/shared/customerref.md) | :heavy_minus_sign: | N/A | | +| `customer_ref` | [Optional[LendingCustomerRef]](../../models/shared/lendingcustomerref.md) | :heavy_minus_sign: | N/A | | | `due_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | | `id` | *Optional[str]* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting platdform | | | `invoice_number` | *Optional[str]* | :heavy_minus_sign: | N/A | | diff --git a/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md b/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md index 488ab258f..861e662b8 100755 --- a/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md +++ b/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md @@ -5,7 +5,7 @@ The enhanced invoices report takes the key elements of the Invoices report verif ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Assess reports | -| `report_items` | list[[EnhancedInvoicesReportReportItems](../../models/shared/enhancedinvoicesreportreportitems.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Assess reports | +| `report_items` | list[[EnhancedInvoiceReportItem](../../models/shared/enhancedinvoicereportitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedinvoicesreportreportitems.md b/previous-versions/assess/docs/models/shared/enhancedinvoicesreportreportitems.md deleted file mode 100755 index 3b7165bbb..000000000 --- a/previous-versions/assess/docs/models/shared/enhancedinvoicesreportreportitems.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnhancedInvoicesReportReportItems - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `invoices` | list[[EnhancedInvoiceReportItem](../../models/shared/enhancedinvoicereportitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/schema.md b/previous-versions/assess/docs/models/shared/errormessage.md similarity index 98% rename from previous-versions/assess/docs/models/shared/schema.md rename to previous-versions/assess/docs/models/shared/errormessage.md index 8ac076515..9d49473cf 100755 --- a/previous-versions/assess/docs/models/shared/schema.md +++ b/previous-versions/assess/docs/models/shared/errormessage.md @@ -1,4 +1,4 @@ -# Schema +# ErrorMessage Your API request was not properly authorized. diff --git a/previous-versions/assess/docs/models/shared/excelreporttypes.md b/previous-versions/assess/docs/models/shared/excelreporttypes.md new file mode 100755 index 000000000..a837f1262 --- /dev/null +++ b/previous-versions/assess/docs/models/shared/excelreporttypes.md @@ -0,0 +1,13 @@ +# ExcelReportTypes + +The type of the report requested in the query string. + + +## Values + +| Name | Value | +| --------------------- | --------------------- | +| `AUDIT` | audit | +| `ENHANCED_FINANCIALS` | enhancedFinancials | +| `ENHANCED_INVOICES` | enhancedInvoices | +| `ENHANCED_CASH_FLOW` | enhancedCashFlow | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/excelstatus.md b/previous-versions/assess/docs/models/shared/excelstatus.md index 17eda6e0e..c92642ef9 100755 --- a/previous-versions/assess/docs/models/shared/excelstatus.md +++ b/previous-versions/assess/docs/models/shared/excelstatus.md @@ -7,11 +7,11 @@ OK | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `file_size` | *Optional[int]* | :heavy_minus_sign: | N/A | | -| `in_progress` | *Optional[bool]* | :heavy_minus_sign: | N/A | | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | Error details in case the report generation request was unsuccessful. | | +| `file_size` | *Optional[int]* | :heavy_minus_sign: | The file size in Bytes is populated upon successful generation of the report. | | +| `in_progress` | *Optional[bool]* | :heavy_minus_sign: | When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated. | | | `last_generated` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `last_invocation_id` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `queued` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `report_type` | *Optional[str]* | :heavy_minus_sign: | N/A | | -| `success` | *Optional[bool]* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `last_invocation_id` | *Optional[str]* | :heavy_minus_sign: | A unique ID generated for this request. | | +| `queued` | *Optional[str]* | :heavy_minus_sign: | The date and time of when a successful request was queued for the most recent report. | | +| `report_type` | [Optional[ExcelReportTypes]](../../models/shared/excelreporttypes.md) | :heavy_minus_sign: | The type of the report requested in the query string. | | +| `success` | *Optional[bool]* | :heavy_minus_sign: | True if the requested report was successfully queued and false if the requested report was not able to be queued. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetric.md b/previous-versions/assess/docs/models/shared/financialmetric.md deleted file mode 100755 index 710c8f4cf..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetric.md +++ /dev/null @@ -1,12 +0,0 @@ -# FinancialMetric - - -## Fields - -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `errors` | list[[FinancialMetricErrors](../../models/shared/financialmetricerrors.md)] | :heavy_minus_sign: | N/A | -| `key` | [Optional[FinancialMetricKey]](../../models/shared/financialmetrickey.md) | :heavy_minus_sign: | N/A | -| `metric_unit` | [Optional[FinancialMetricMetricUnit]](../../models/shared/financialmetricmetricunit.md) | :heavy_minus_sign: | N/A | -| `name` | *Optional[str]* | :heavy_minus_sign: | Metric name. | -| `periods` | list[[FinancialMetricPeriods](../../models/shared/financialmetricperiods.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricerror.md b/previous-versions/assess/docs/models/shared/financialmetricerror.md deleted file mode 100755 index 3c64bee17..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricerror.md +++ /dev/null @@ -1,9 +0,0 @@ -# FinancialMetricError - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | Account categories data has not been synced | -| `type` | [Optional[FinancialMetricErrorType]](../../models/shared/financialmetricerrortype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricerrors.md b/previous-versions/assess/docs/models/shared/financialmetricerrors.md deleted file mode 100755 index 1597525d8..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricerrors.md +++ /dev/null @@ -1,10 +0,0 @@ -# FinancialMetricErrors - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `details` | dict[str, list[*str*]] | :heavy_minus_sign: | Dictionary list outlining the missing properties or allowed values. | | -| `message` | *Optional[str]* | :heavy_minus_sign: | Description of the error. | There are uncategorized accounts IDs, see details. | -| `type` | [Optional[FinancialMetricErrorsType]](../../models/shared/financialmetricerrorstype.md) | :heavy_minus_sign: | Metric level error. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricerrorstype.md b/previous-versions/assess/docs/models/shared/financialmetricerrorstype.md deleted file mode 100755 index b2e694d1b..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricerrorstype.md +++ /dev/null @@ -1,12 +0,0 @@ -# FinancialMetricErrorsType - -Metric level error. - - -## Values - -| Name | Value | -| ------------------------ | ------------------------ | -| `UNCATEGORIZED_ACCOUNTS` | UncategorizedAccounts | -| `MISSING_INPUT_DATA` | MissingInputData | -| `INPUT_DATA_ERROR` | InputDataError | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricerrortype.md b/previous-versions/assess/docs/models/shared/financialmetricerrortype.md deleted file mode 100755 index 46de8e28b..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricerrortype.md +++ /dev/null @@ -1,11 +0,0 @@ -# FinancialMetricErrorType - - -## Values - -| Name | Value | -| ----------------------- | ----------------------- | -| `DATA_NOT_SYNCED` | DataNotSynced | -| `DATA_NOT_SUPPORTED` | DataNotSupported | -| `DATA_SYNC_FAILED` | DataSyncFailed | -| `DATA_TYPE_NOT_ENABLED` | DataTypeNotEnabled | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetrickey.md b/previous-versions/assess/docs/models/shared/financialmetrickey.md deleted file mode 100755 index 0ff2292a0..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetrickey.md +++ /dev/null @@ -1,28 +0,0 @@ -# FinancialMetricKey - - -## Values - -| Name | Value | -| -------------------------------- | -------------------------------- | -| `UNKNOWN` | Unknown | -| `EBITDA` | EBITDA | -| `DEBT_SERVICE_COVERAGE_RATIO` | DebtServiceCoverageRatio | -| `CURRENT_RATIO_QUICK_RATIO` | CurrentRatio QuickRatio | -| `GROSS_PROFIT_MARGIN` | GrossProfitMargin | -| `FIXED_CHARGE_COVERAGE_RATIO` | FixedChargeCoverageRatio | -| `WORKING_CAPITAL` | WorkingCapital | -| `FREE_CASH_FLOW` | FreeCashFlow | -| `NET_PROFIT_MARGIN` | NetProfitMargin | -| `RETURN_ON_ASSETS_RATIO` | ReturnOnAssetsRatio | -| `RETURN_ON_EQUITY_RATIO` | ReturnOnEquityRatio | -| `OPERATING_PROFIT_MARGIN` | OperatingProfitMargin | -| `DEPT_TO_EQUITY` | DeptToEquity | -| `DEBT_TO_ASSETS` | DebtToAssets | -| `INTEREST_COVERAGE_RATIO` | InterestCoverageRatio | -| `CASH_RATIO` | CashRatio | -| `INVENTORY_TURNOVER_RATIO` | InventoryTurnoverRatio | -| `ASSET_TURNOVER_RATIO` | AssetTurnoverRatio | -| `WORKING_CAPITAL_TURNOVER_RATIO` | WorkingCapitalTurnoverRatio | -| `DAYS_SALES_OUTSTANDING` | DaysSalesOutstanding | -| `DAYS_PAYABLES_OUTSTANDING` | DaysPayablesOutstanding | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricmetricunit.md b/previous-versions/assess/docs/models/shared/financialmetricmetricunit.md deleted file mode 100755 index f0406dbae..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricmetricunit.md +++ /dev/null @@ -1,9 +0,0 @@ -# FinancialMetricMetricUnit - - -## Values - -| Name | Value | -| ------- | ------- | -| `RATIO` | Ratio | -| `MONEY` | Money | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricperiods.md b/previous-versions/assess/docs/models/shared/financialmetricperiods.md deleted file mode 100755 index 696f16f1f..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricperiods.md +++ /dev/null @@ -1,12 +0,0 @@ -# FinancialMetricPeriods - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `errors` | list[[FinancialMetricPeriodsErrors](../../models/shared/financialmetricperiodserrors.md)] | :heavy_minus_sign: | N/A | -| `from_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date from which the report starts. | -| `inputs` | list[[FinancialMetricPeriodsInputs](../../models/shared/financialmetricperiodsinputs.md)] | :heavy_minus_sign: | N/A | -| `to_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date on which the report ends (inclusive of day). | -| `value` | *Optional[float]* | :heavy_minus_sign: | The top level metric value that is calculated for the specified period.

If the system cannot calculate for that period, the value will be null. The system will still show the metric inputs. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricperiodserrors.md b/previous-versions/assess/docs/models/shared/financialmetricperiodserrors.md deleted file mode 100755 index b5da7fe5a..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricperiodserrors.md +++ /dev/null @@ -1,10 +0,0 @@ -# FinancialMetricPeriodsErrors - - -## Fields - -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `details` | dict[str, list[*str*]] | :heavy_minus_sign: | Dictionary list outlining the missing properties or allowed values. | | -| `massage` | *Optional[str]* | :heavy_minus_sign: | Description of the error. | Missing account data | -| `type` | [Optional[FinancialMetricPeriodsErrorsType]](../../models/shared/financialmetricperiodserrorstype.md) | :heavy_minus_sign: | Period error type. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricperiodserrorstype.md b/previous-versions/assess/docs/models/shared/financialmetricperiodserrorstype.md deleted file mode 100755 index 97ee1a25b..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricperiodserrorstype.md +++ /dev/null @@ -1,11 +0,0 @@ -# FinancialMetricPeriodsErrorsType - -Period error type. - - -## Values - -| Name | Value | -| ---------------------- | ---------------------- | -| `MISSING_ACCOUNT_DATA` | MissingAccountData | -| `DATES_OUT_OF_RANGE` | DatesOutOfRange | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricperiodsinputs.md b/previous-versions/assess/docs/models/shared/financialmetricperiodsinputs.md deleted file mode 100755 index da00069e1..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricperiodsinputs.md +++ /dev/null @@ -1,9 +0,0 @@ -# FinancialMetricPeriodsInputs - - -## Fields - -| Field | Type | Required | Description | -| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the metric input e.g. “Current Assets”, “Capital Expenditure”. | -| `value` | *Optional[float]* | :heavy_minus_sign: | The positive or negative number of the input value. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetrics.md b/previous-versions/assess/docs/models/shared/financialmetrics.md deleted file mode 100755 index f77926c09..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetrics.md +++ /dev/null @@ -1,13 +0,0 @@ -# FinancialMetrics - -OK - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `currency` | *Optional[str]* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `errors` | list[[FinancialMetricError](../../models/shared/financialmetricerror.md)] | :heavy_minus_sign: | If there are no errors, an empty array is returned. | | -| `metrics` | list[[FinancialMetric](../../models/shared/financialmetric.md)] | :heavy_minus_sign: | N/A | | -| `period_unit` | [Optional[FinancialMetricsPeriodUnit]](../../models/shared/financialmetricsperiodunit.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/financialmetricsperiodunit.md b/previous-versions/assess/docs/models/shared/financialmetricsperiodunit.md deleted file mode 100755 index b8a87e188..000000000 --- a/previous-versions/assess/docs/models/shared/financialmetricsperiodunit.md +++ /dev/null @@ -1,10 +0,0 @@ -# FinancialMetricsPeriodUnit - - -## Values - -| Name | Value | -| ------- | ------- | -| `MONTH` | Month | -| `WEEK` | Week | -| `DAY` | Day | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/customerref.md b/previous-versions/assess/docs/models/shared/lendingcustomerref.md similarity index 97% rename from previous-versions/assess/docs/models/shared/customerref.md rename to previous-versions/assess/docs/models/shared/lendingcustomerref.md index e1d349fc9..e49c19fe2 100755 --- a/previous-versions/assess/docs/models/shared/customerref.md +++ b/previous-versions/assess/docs/models/shared/lendingcustomerref.md @@ -1,4 +1,4 @@ -# CustomerRef +# LendingCustomerRef ## Fields diff --git a/previous-versions/assess/docs/models/shared/loansummary.md b/previous-versions/assess/docs/models/shared/loansummary.md index 0bfc77712..76462fbb1 100755 --- a/previous-versions/assess/docs/models/shared/loansummary.md +++ b/previous-versions/assess/docs/models/shared/loansummary.md @@ -8,4 +8,4 @@ OK | Field | Type | Required | Description | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | `report_info` | [Optional[LoanSummaryReportInfo]](../../models/shared/loansummaryreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | list[[ReportItems](../../models/shared/reportitems.md)] | :heavy_minus_sign: | Returns a summary of all loan activity for that integration type | \ No newline at end of file +| `report_items` | list[[LoanSummaryReportItem](../../models/shared/loansummaryreportitem.md)] | :heavy_minus_sign: | Returns a summary of all loan activity for that integration type | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/recordrefintegrationtype.md b/previous-versions/assess/docs/models/shared/loansummaryintegrationtype.md similarity index 88% rename from previous-versions/assess/docs/models/shared/recordrefintegrationtype.md rename to previous-versions/assess/docs/models/shared/loansummaryintegrationtype.md index 4cf12af10..9aeee4bed 100755 --- a/previous-versions/assess/docs/models/shared/recordrefintegrationtype.md +++ b/previous-versions/assess/docs/models/shared/loansummaryintegrationtype.md @@ -1,4 +1,4 @@ -# RecordRefIntegrationType +# LoanSummaryIntegrationType The integration type begin referred to. diff --git a/previous-versions/assess/docs/models/shared/loansummaryrecordref.md b/previous-versions/assess/docs/models/shared/loansummaryrecordref.md new file mode 100755 index 000000000..77889df21 --- /dev/null +++ b/previous-versions/assess/docs/models/shared/loansummaryrecordref.md @@ -0,0 +1,11 @@ +# LoanSummaryRecordRef + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The dataConnectionId the object being referred to is associated with. | +| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object being referred to. | +| `integration_type` | [Optional[LoanSummaryIntegrationType]](../../models/shared/loansummaryintegrationtype.md) | :heavy_minus_sign: | The integration type begin referred to. | +| `record_ref_type` | [Optional[LoanSummaryRecordRefType]](../../models/shared/loansummaryrecordreftype.md) | :heavy_minus_sign: | The datatype being referred to. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/recordrefrecordreftype.md b/previous-versions/assess/docs/models/shared/loansummaryrecordreftype.md similarity index 92% rename from previous-versions/assess/docs/models/shared/recordrefrecordreftype.md rename to previous-versions/assess/docs/models/shared/loansummaryrecordreftype.md index f27493dfc..22111945e 100755 --- a/previous-versions/assess/docs/models/shared/recordrefrecordreftype.md +++ b/previous-versions/assess/docs/models/shared/loansummaryrecordreftype.md @@ -1,4 +1,4 @@ -# RecordRefRecordRefType +# LoanSummaryRecordRefType The datatype being referred to. diff --git a/previous-versions/assess/docs/models/shared/reportitems1.md b/previous-versions/assess/docs/models/shared/loansummaryreportitem.md similarity index 84% rename from previous-versions/assess/docs/models/shared/reportitems1.md rename to previous-versions/assess/docs/models/shared/loansummaryreportitem.md index 420cb6ec0..5bda1243b 100755 --- a/previous-versions/assess/docs/models/shared/reportitems1.md +++ b/previous-versions/assess/docs/models/shared/loansummaryreportitem.md @@ -1,12 +1,13 @@ -# ReportItems1 +# LoanSummaryReportItem ## Fields | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount` | *Optional[float]* | :heavy_minus_sign: | The loan transaction amount. | | -| `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | N/A | | -| `loan_ref` | [Optional[LoanRef]](../../models/shared/loanref.md) | :heavy_minus_sign: | N/A | | -| `loan_transaction_type` | [Optional[ReportItemsLoanTransactionType]](../../models/shared/reportitemsloantransactiontype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `balance` | *Optional[float]* | :heavy_minus_sign: | The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. | | +| `description` | *Optional[str]* | :heavy_minus_sign: | The description of the object being referred to. E.g. the account. | | +| `record_ref` | [Optional[LoanSummaryRecordRef]](../../models/shared/loansummaryrecordref.md) | :heavy_minus_sign: | N/A | | +| `start_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `total_drawdowns` | *Optional[float]* | :heavy_minus_sign: | The total loan drawdowns. | | +| `total_repayments` | *Optional[float]* | :heavy_minus_sign: | The total loan repayments which includes capital plus any interest. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/loantransactions.md b/previous-versions/assess/docs/models/shared/loantransactions.md index 3540933c3..d1a24cd1d 100755 --- a/previous-versions/assess/docs/models/shared/loantransactions.md +++ b/previous-versions/assess/docs/models/shared/loantransactions.md @@ -9,4 +9,4 @@ OK | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `errors` | list[*Any*] | :heavy_minus_sign: | If there are no errors, an empty array is returned. | | `report_info` | [Optional[LoanTransactionsReportInfo]](../../models/shared/loantransactionsreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | list[[ReportItems1](../../models/shared/reportitems1.md)] | :heavy_minus_sign: | Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. | \ No newline at end of file +| `report_items` | list[[ReportItems](../../models/shared/reportitems.md)] | :heavy_minus_sign: | Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/recordref.md b/previous-versions/assess/docs/models/shared/recordref.md deleted file mode 100755 index d586a8440..000000000 --- a/previous-versions/assess/docs/models/shared/recordref.md +++ /dev/null @@ -1,11 +0,0 @@ -# RecordRef - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | The dataConnectionId the object being referred to is associated with. | -| `id` | *Optional[str]* | :heavy_minus_sign: | The id of the object being referred to. | -| `integration_type` | [Optional[RecordRefIntegrationType]](../../models/shared/recordrefintegrationtype.md) | :heavy_minus_sign: | The integration type begin referred to. | -| `record_ref_type` | [Optional[RecordRefRecordRefType]](../../models/shared/recordrefrecordreftype.md) | :heavy_minus_sign: | The datatype being referred to. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/report.md b/previous-versions/assess/docs/models/shared/report.md index 27be72c44..be831c5f2 100755 --- a/previous-versions/assess/docs/models/shared/report.md +++ b/previous-versions/assess/docs/models/shared/report.md @@ -1,19 +1,38 @@ # Report +## Structure + Assess reports follow a consistent structure. Reports contain four sections of information: -1. Report definition information such as: - a. The report info (e.g. enhanced_profit_and_loss). - b. The display name of the report (e.g. Enhanced Profit and Loss). -2. Information about the dimension contained in the reports such as: - a. The type of dimension (e.g. datetime, recordRef). - b. The display name of the dimension (e.g. Period, Category type, Category sub type). - c. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"..."). -3. Information about the measures contained in the report such as: - a. The display name of the measure (e.g. value of account, percentage change). - b. The type of the measure (e.g. currency, percentage). - c. The unit of the measure (e.g. %, GBP). -4. The data for the report. When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. +### 1. Report definition + +Information such as: + + 1. The report info (e.g. enhanced_profit_and_loss). + 2. The display name of the report (e.g. Enhanced Profit and Loss). + +### 2. Dimension info + +Information about the dimension contained in the reports such as: + + 1. The type of dimension (e.g. datetime, recordRef). + 2. The display name of the dimension (e.g. Period, Category type, Category sub type). + 3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"..."). + +### 3. Measure info + +Information about the measures contained in the report such as: + + 1. The display name of the measure (e.g. value of account, percentage change). + 2. The type of the measure (e.g. currency, percentage). + 3. The unit of the measure (e.g. %, GBP). + +### 4. The data for the report + +When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. + + +## Displaying the report Reports can be rendered as follows (ordering is implicit rather than explicit): @@ -26,10 +45,10 @@ Reports can be rendered as follows (ordering is implicit rather than explicit): ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dimensions` | list[[ReportDimension](../../models/shared/reportdimension.md)] | :heavy_minus_sign: | N/A | -| `errors` | list[[ReportError](../../models/shared/reporterror.md)] | :heavy_minus_sign: | N/A | -| `measures` | list[[ReportMeasure](../../models/shared/reportmeasure.md)] | :heavy_minus_sign: | N/A | -| `report_data` | list[[ReportComponent](../../models/shared/reportcomponent.md)] | :heavy_minus_sign: | N/A | -| `report_info` | dict[str, *str*] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `dimensions` | list[[CommerceReportDimension](../../models/shared/commercereportdimension.md)] | :heavy_minus_sign: | N/A | +| `errors` | list[[CommerceReportError](../../models/shared/commercereporterror.md)] | :heavy_minus_sign: | N/A | +| `measures` | list[[CommerceReportMeasure](../../models/shared/commercereportmeasure.md)] | :heavy_minus_sign: | N/A | +| `report_data` | list[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | +| `report_info` | dict[str, *str*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/reportcomponent.md b/previous-versions/assess/docs/models/shared/reportcomponent.md deleted file mode 100755 index 14ec42df1..000000000 --- a/previous-versions/assess/docs/models/shared/reportcomponent.md +++ /dev/null @@ -1,13 +0,0 @@ -# ReportComponent - - -## Fields - -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `components` | list[[ReportComponent](../../models/shared/reportcomponent.md)] | :heavy_minus_sign: | N/A | -| `dimension` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `item` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `measures` | list[[ReportComponentMeasure](../../models/shared/reportcomponentmeasure.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/reportdimension.md b/previous-versions/assess/docs/models/shared/reportdimension.md deleted file mode 100755 index 4d8a8e18f..000000000 --- a/previous-versions/assess/docs/models/shared/reportdimension.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReportDimension - - -## Fields - -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | -| `items` | list[[ReportDimensionItems](../../models/shared/reportdimensionitems.md)] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/reportitems.md b/previous-versions/assess/docs/models/shared/reportitems.md index 3297a28c3..95150aeeb 100755 --- a/previous-versions/assess/docs/models/shared/reportitems.md +++ b/previous-versions/assess/docs/models/shared/reportitems.md @@ -5,9 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `balance` | *Optional[float]* | :heavy_minus_sign: | The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. | | -| `description` | *Optional[str]* | :heavy_minus_sign: | The description of the object being referred to. E.g. the account. | | -| `record_ref` | [Optional[RecordRef]](../../models/shared/recordref.md) | :heavy_minus_sign: | N/A | | -| `start_date` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `total_drawdowns` | *Optional[float]* | :heavy_minus_sign: | The total loan drawdowns. | | -| `total_repayments` | *Optional[float]* | :heavy_minus_sign: | The total loan repayments which includes capital plus any interest. | | \ No newline at end of file +| `amount` | *Optional[float]* | :heavy_minus_sign: | The loan transaction amount. | | +| `date_` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `item_ref` | [Optional[ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | N/A | | +| `loan_ref` | [Optional[LoanRef]](../../models/shared/loanref.md) | :heavy_minus_sign: | N/A | | +| `loan_transaction_type` | [Optional[ReportItemsLoanTransactionType]](../../models/shared/reportitemsloantransactiontype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/sourceref.md b/previous-versions/assess/docs/models/shared/sourceref.md index 0e159ad84..c5af2a430 100755 --- a/previous-versions/assess/docs/models/shared/sourceref.md +++ b/previous-versions/assess/docs/models/shared/sourceref.md @@ -5,6 +5,6 @@ A source reference containing the `sourceType` object "Banking". ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `source_type` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `source_type` | *Optional[str]* | :heavy_minus_sign: | The data source type. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/transactioncategory.md b/previous-versions/assess/docs/models/shared/transactioncategory.md index 9ab28018a..642aa85fb 100755 --- a/previous-versions/assess/docs/models/shared/transactioncategory.md +++ b/previous-versions/assess/docs/models/shared/transactioncategory.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `confidence` | *Optional[float]* | :heavy_minus_sign: | Returns the confidence of the suggested category for the transaction. | -| `levels` | list[*str*] | :heavy_minus_sign: | An array of category levels against an individual transaction. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| `confidence` | *Optional[float]* | :heavy_minus_sign: | Returns the confidence of the suggested category for the transaction. The value is between 0 and 100. | +| `levels` | list[*str*] | :heavy_minus_sign: | The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). | \ No newline at end of file diff --git a/previous-versions/assess/docs/sdks/categories/README.md b/previous-versions/assess/docs/sdks/categories/README.md deleted file mode 100755 index 6eeacca8f..000000000 --- a/previous-versions/assess/docs/sdks/categories/README.md +++ /dev/null @@ -1,275 +0,0 @@ -# categories - -## Overview - -Categorisation - -### Available Operations - -* [~~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) - Update account categories :warning: **Deprecated** -* [~~update_accounts_categories~~](#update_accounts_categories) - Confirm categories for accounts :warning: **Deprecated** - -## ~~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 -import codatassess -from codatassess.models import operations - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -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 -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `request` | [operations.GetAccountCategoryRequest](../../models/operations/getaccountcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.GetAccountCategoryResponse](../../models/operations/getaccountcategoryresponse.md)** - - -## ~~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 -import codatassess -from codatassess.models import operations - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -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 -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `request` | [operations.ListAccountsCategoriesRequest](../../models/operations/listaccountscategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.ListAccountsCategoriesResponse](../../models/operations/listaccountscategoriesresponse.md)** - - -## ~~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 -import codatassess - - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - - -res = s.categories.list_available_account_categories() - -if res.categories is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.ListAvailableAccountCategoriesResponse](../../models/operations/listavailableaccountcategoriesresponse.md)** - - -## ~~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 -import codatassess -from codatassess.models import operations, shared - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -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 -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `request` | [operations.UpdateAccountCategoryRequest](../../models/operations/updateaccountcategoryrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.UpdateAccountCategoryResponse](../../models/operations/updateaccountcategoryresponse.md)** - - -## ~~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 -import codatassess -from codatassess.models import operations, shared - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.UpdateAccountsCategoriesRequest( - confirm_categories=shared.ConfirmCategories( - categories=[ - shared.ConfirmCategoriesCategories( - account_ref=shared.ConfirmCategoriesCategoriesAccountRef( - id='9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2', - ), - confirmed=shared.AccountCategory( - detail_type='error', - subtype='deserunt', - type='suscipit', - ), - ), - shared.ConfirmCategoriesCategories( - account_ref=shared.ConfirmCategoriesCategoriesAccountRef( - id='9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2', - ), - confirmed=shared.AccountCategory( - detail_type='magnam', - subtype='debitis', - type='ipsa', - ), - ), - shared.ConfirmCategoriesCategories( - account_ref=shared.ConfirmCategoriesCategoriesAccountRef( - id='EILBDVJVNUAGVKRQ', - ), - confirmed=shared.AccountCategory( - detail_type='tempora', - subtype='suscipit', - type='molestiae', - ), - ), - shared.ConfirmCategoriesCategories( - account_ref=shared.ConfirmCategoriesCategoriesAccountRef( - id='EILBDVJVNUAGVKRQ', - ), - confirmed=shared.AccountCategory( - detail_type='placeat', - subtype='voluptatum', - type='iusto', - ), - ), - ], - ), - 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 -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `request` | [operations.UpdateAccountsCategoriesRequest](../../models/operations/updateaccountscategoriesrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.UpdateAccountsCategoriesResponse](../../models/operations/updateaccountscategoriesresponse.md)** - diff --git a/previous-versions/assess/docs/sdks/codatassess/README.md b/previous-versions/assess/docs/sdks/codatassess/README.md index 0b4a82953..4bd2e8a69 100755 --- a/previous-versions/assess/docs/sdks/codatassess/README.md +++ b/previous-versions/assess/docs/sdks/codatassess/README.md @@ -2,9 +2,9 @@ ## 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. +Check that you have enabled the [data types required by Assess](https://docs.codat.io/assess/get-started#prerequisites) for all of its features to work. -[Read more...](https://www.codat.io/assess/) +[Read more...](https://www.docs.codat.io/assess/) [See our OpenAPI spec](https://github.com/codatio/oas) diff --git a/previous-versions/assess/docs/sdks/dataintegrity/README.md b/previous-versions/assess/docs/sdks/dataintegrity/README.md index 46d840395..9242b1f8f 100755 --- a/previous-versions/assess/docs/sdks/dataintegrity/README.md +++ b/previous-versions/assess/docs/sdks/dataintegrity/README.md @@ -2,17 +2,17 @@ ## Overview -Data integrity is important +Match mutable accounting data with immutable banking data to increase confidence in financial data ### Available Operations -* [get_data_integrity_status](#get_data_integrity_status) - Get data integrity status -* [get_data_integrity_summaries](#get_data_integrity_summaries) - Get data integrity summary -* [list_data_type_data_integrity_details](#list_data_type_data_integrity_details) - List data type data integrity +* [details](#details) - List data type data integrity +* [status](#status) - Get data integrity status +* [summary](#summary) - Get data integrity summary -## get_data_integrity_status +## details -Gets match status for a given company and datatype. +Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string. ### Example Usage @@ -26,33 +26,37 @@ s = codatassess.CodatAssess( ), ) -req = operations.GetDataIntegrityStatusRequest( +req = operations.ListDataTypeDataIntegrityDetailsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, + order_by='-modifiedDate', + page=1, + page_size=100, + query='provident', ) -res = s.data_integrity.get_data_integrity_status(req) +res = s.data_integrity.details(req) -if res.status is not None: +if res.details is not None: # handle response ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `request` | [operations.GetDataIntegrityStatusRequest](../../models/operations/getdataintegritystatusrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.ListDataTypeDataIntegrityDetailsRequest](../../models/operations/listdatatypedataintegritydetailsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[operations.GetDataIntegrityStatusResponse](../../models/operations/getdataintegritystatusresponse.md)** +**[operations.ListDataTypeDataIntegrityDetailsResponse](../../models/operations/listdatatypedataintegritydetailsresponse.md)** -## get_data_integrity_summaries +## status -Gets match summary for a given company and datatype, optionally restricted by a Codat query string. +Gets match status for a given company and datatype. ### Example Usage @@ -66,34 +70,33 @@ s = codatassess.CodatAssess( ), ) -req = operations.GetDataIntegritySummariesRequest( +req = operations.GetDataIntegrityStatusRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, - query='excepturi', ) -res = s.data_integrity.get_data_integrity_summaries(req) +res = s.data_integrity.status(req) -if res.summaries is not None: +if res.status is not None: # handle response ``` ### Parameters -| Parameter | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `request` | [operations.GetDataIntegritySummariesRequest](../../models/operations/getdataintegritysummariesrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetDataIntegrityStatusRequest](../../models/operations/getdataintegritystatusrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[operations.GetDataIntegritySummariesResponse](../../models/operations/getdataintegritysummariesresponse.md)** +**[operations.GetDataIntegrityStatusResponse](../../models/operations/getdataintegritystatusresponse.md)** -## list_data_type_data_integrity_details +## summary -Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string. +Gets match summary for a given company and datatype, optionally restricted by a Codat query string. ### Example Usage @@ -107,30 +110,27 @@ s = codatassess.CodatAssess( ), ) -req = operations.ListDataTypeDataIntegrityDetailsRequest( +req = operations.GetDataIntegritySummariesRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, - order_by='-modifiedDate', - page=1, - page_size=100, - query='nisi', + query='distinctio', ) -res = s.data_integrity.list_data_type_data_integrity_details(req) +res = s.data_integrity.summary(req) -if res.details is not None: +if res.summaries is not None: # handle response ``` ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListDataTypeDataIntegrityDetailsRequest](../../models/operations/listdatatypedataintegritydetailsrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `request` | [operations.GetDataIntegritySummariesRequest](../../models/operations/getdataintegritysummariesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | ### Response -**[operations.ListDataTypeDataIntegrityDetailsResponse](../../models/operations/listdatatypedataintegritydetailsresponse.md)** +**[operations.GetDataIntegritySummariesResponse](../../models/operations/getdataintegritysummariesresponse.md)** diff --git a/previous-versions/assess/docs/sdks/excelreports/README.md b/previous-versions/assess/docs/sdks/excelreports/README.md index 28e4628df..c6b2feb9f 100755 --- a/previous-versions/assess/docs/sdks/excelreports/README.md +++ b/previous-versions/assess/docs/sdks/excelreports/README.md @@ -73,9 +73,9 @@ req = operations.GetAccountingMarketingMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=836079, - period_length=71036, - period_unit=shared.PeriodUnit.WEEK, + number_of_periods=602763, + period_length=857946, + period_unit=shared.PeriodUnit.MONTH, report_date='29-09-2020', show_input_values=False, ) @@ -117,7 +117,7 @@ s = codatassess.CodatAssess( req = operations.GetExcelReportRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - report_type=shared.ExcelReportType.ASSESS, + report_type=shared.ExcelReportType.ENHANCED_CASH_FLOW, ) res = s.excel_reports.get_excel_report(req) @@ -157,7 +157,7 @@ s = codatassess.CodatAssess( req = operations.GetExcelReportGenerationStatusRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - report_type=shared.ExcelReportType.ENHANCED_INVOICES, + report_type=shared.ExcelReportType.ENHANCED_FINANCIALS, ) res = s.excel_reports.get_excel_report_generation_status(req) diff --git a/previous-versions/assess/docs/sdks/reports/README.md b/previous-versions/assess/docs/sdks/reports/README.md index 0d99ac179..e667bd7ff 100755 --- a/previous-versions/assess/docs/sdks/reports/README.md +++ b/previous-versions/assess/docs/sdks/reports/README.md @@ -2,7 +2,7 @@ ## Overview -Data integrity is important +Enriched reports and analyses of financial data ### Available Operations @@ -13,11 +13,8 @@ Data integrity is important * [get_commerce_orders_metrics](#get_commerce_orders_metrics) - Get orders report * [get_commerce_refunds_metrics](#get_commerce_refunds_metrics) - Get refunds report * [get_commerce_revenue_metrics](#get_commerce_revenue_metrics) - Get commerce revenue metrics -* [~~get_enhanced_balance_sheet~~](#get_enhanced_balance_sheet) - Get enhanced balance sheet report :warning: **Deprecated** * [get_enhanced_cash_flow_transactions](#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report -* [~~get_enhanced_financial_metrics~~](#get_enhanced_financial_metrics) - List financial metrics :warning: **Deprecated** * [get_enhanced_invoices_report](#get_enhanced_invoices_report) - Get enhanced invoices report -* [~~get_enhanced_profit_and_loss~~](#get_enhanced_profit_and_loss) - Get enhanced profit and loss report :warning: **Deprecated** * [get_loan_summary](#get_loan_summary) - Get enhanced loan summaries * [get_recurring_revenue_metrics](#get_recurring_revenue_metrics) - Get key subscription revenue metrics * [list_loan_transactions](#list_loan_transactions) - List enhanced loan transactions @@ -33,7 +30,7 @@ Codat suggests a category for each account automatically, but you can [change it ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -43,7 +40,7 @@ s = codatassess.CodatAssess( req = operations.GetAccountsForEnhancedBalanceSheetRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - number_of_periods=20218, + number_of_periods=623564, report_date='29-09-2020', ) @@ -76,7 +73,7 @@ Codat suggests a category for each account automatically, but you can [change it ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -86,7 +83,7 @@ s = codatassess.CodatAssess( req = operations.GetAccountsForEnhancedProfitAndLossRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - number_of_periods=368241, + number_of_periods=645894, report_date='29-09-2020', ) @@ -129,9 +126,9 @@ req = operations.GetCommerceCustomerRetentionMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=832620, - period_length=957156, - period_unit=shared.PeriodUnit.YEAR, + number_of_periods=384382, + period_length=437587, + period_unit=shared.PeriodUnit.WEEK, report_date='29-09-2020', ) @@ -174,8 +171,8 @@ req = operations.GetCommerceLifetimeValueMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=140350, - period_length=870013, + number_of_periods=891773, + period_length=56713, period_unit=shared.PeriodUnit.YEAR, report_date='29-09-2020', ) @@ -219,9 +216,9 @@ req = operations.GetCommerceOrdersMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=978619, - period_length=473608, - period_unit=shared.PeriodUnit.YEAR, + number_of_periods=272656, + period_length=383441, + period_unit=shared.PeriodUnit.WEEK, report_date='29-09-2020', ) @@ -264,8 +261,8 @@ req = operations.GetCommerceRefundsMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=800911, - period_length=461479, + number_of_periods=791725, + period_length=812169, period_unit=shared.PeriodUnit.MONTH, report_date='29-09-2020', ) @@ -309,9 +306,9 @@ req = operations.GetCommerceRevenueMetricsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', include_display_names=False, - number_of_periods=780529, - period_length=678880, - period_unit=shared.PeriodUnit.DAY, + number_of_periods=479977, + period_length=568045, + period_unit=shared.PeriodUnit.WEEK, report_date='29-09-2020', ) @@ -334,52 +331,6 @@ if res.report is not None: **[operations.GetCommerceRevenueMetricsResponse](../../models/operations/getcommercerevenuemetricsresponse.md)** -## ~~get_enhanced_balance_sheet~~ - -Gets a fully categorized balance sheet statement for a given company, over one or more period(s). - -> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible. - -### Example Usage - -```python -import codatassess -from codatassess.models import operations - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.GetEnhancedBalanceSheetRequest( - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=720633, - period_length=639921, - report_date='29-09-2020', -) - -res = s.reports.get_enhanced_balance_sheet(req) - -if res.report is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetEnhancedBalanceSheetRequest](../../models/operations/getenhancedbalancesheetrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.GetEnhancedBalanceSheetResponse](../../models/operations/getenhancedbalancesheetresponse.md)** - - ## get_enhanced_cash_flow_transactions > **Categorization engine** @@ -392,7 +343,7 @@ The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -404,7 +355,7 @@ req = operations.GetEnhancedCashFlowTransactionsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', page=1, page_size=100, - query='occaecati', + query='recusandae', ) res = s.reports.get_enhanced_cash_flow_transactions(req) @@ -426,52 +377,6 @@ if res.enhanced_cash_flow_transactions is not None: **[operations.GetEnhancedCashFlowTransactionsResponse](../../models/operations/getenhancedcashflowtransactionsresponse.md)** -## ~~get_enhanced_financial_metrics~~ - -Gets all the available financial metrics for a given company, over one or more periods. - -> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible. - -### Example Usage - -```python -import codatassess -from codatassess.models import operations - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.GetEnhancedFinancialMetricsRequest( - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - number_of_periods=143353, - period_length=537373, - report_date='29-09-2020', - show_metric_inputs=False, -) - -res = s.reports.get_enhanced_financial_metrics(req) - -if res.financial_metrics is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `request` | [operations.GetEnhancedFinancialMetricsRequest](../../models/operations/getenhancedfinancialmetricsrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.GetEnhancedFinancialMetricsResponse](../../models/operations/getenhancedfinancialmetricsresponse.md)** - - ## get_enhanced_invoices_report Gets a list of invoices linked to the corresponding banking transaction @@ -480,7 +385,7 @@ Gets a list of invoices linked to the corresponding banking transaction ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -492,7 +397,7 @@ req = operations.GetEnhancedInvoicesReportRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', page=1, page_size=100, - query='hic', + query='temporibus', ) res = s.reports.get_enhanced_invoices_report(req) @@ -514,52 +419,6 @@ if res.enhanced_invoices_report is not None: **[operations.GetEnhancedInvoicesReportResponse](../../models/operations/getenhancedinvoicesreportresponse.md)** -## ~~get_enhanced_profit_and_loss~~ - -Gets a fully categorized profit and loss statement for a given company, over one or more period(s). - -> :warning: **DEPRECATED**: this method will be removed in a future release, please migrate away from it as soon as possible. - -### Example Usage - -```python -import codatassess -from codatassess.models import operations - -s = codatassess.CodatAssess( - security=shared.Security( - auth_header="Basic BASE_64_ENCODED(API_KEY)", - ), -) - -req = operations.GetEnhancedProfitAndLossRequest( - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', - include_display_names=False, - number_of_periods=758616, - period_length=521848, - report_date='29-09-2020', -) - -res = s.reports.get_enhanced_profit_and_loss(req) - -if res.report is not None: - # handle response -``` - -### Parameters - -| Parameter | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `request` | [operations.GetEnhancedProfitAndLossRequest](../../models/operations/getenhancedprofitandlossrequest.md) | :heavy_check_mark: | The request object to use for the request. | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | - - -### Response - -**[operations.GetEnhancedProfitAndLossResponse](../../models/operations/getenhancedprofitandlossresponse.md)** - - ## get_loan_summary Get enhanced loan summaries @@ -568,7 +427,7 @@ Get enhanced loan summaries ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -607,7 +466,7 @@ Gets key metrics for subscription revenue. ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -647,7 +506,7 @@ List enhanced loan transactions ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( @@ -687,7 +546,7 @@ Requests production of key subscription revenue metrics. ```python import codatassess -from codatassess.models import operations +from codatassess.models import operations, shared s = codatassess.CodatAssess( security=shared.Security( diff --git a/previous-versions/assess/files.gen b/previous-versions/assess/files.gen index f38d1789a..617eb97d9 100755 --- a/previous-versions/assess/files.gen +++ b/previous-versions/assess/files.gen @@ -1,5 +1,4 @@ src/codatassess/sdkconfiguration.py -src/codatassess/categories.py src/codatassess/data_integrity.py src/codatassess/excel_reports.py src/codatassess/reports.py @@ -8,17 +7,13 @@ pylintrc setup.py src/codatassess/__init__.py src/codatassess/models/__init__.py +src/codatassess/models/errors/sdkerror.py src/codatassess/utils/__init__.py src/codatassess/utils/retries.py src/codatassess/utils/utils.py -src/codatassess/models/operations/get_account_category.py -src/codatassess/models/operations/list_accounts_categories.py -src/codatassess/models/operations/list_available_account_categories.py -src/codatassess/models/operations/update_account_category.py -src/codatassess/models/operations/update_accounts_categories.py +src/codatassess/models/operations/list_data_type_data_integrity_details.py src/codatassess/models/operations/get_data_integrity_status.py src/codatassess/models/operations/get_data_integrity_summaries.py -src/codatassess/models/operations/list_data_type_data_integrity_details.py src/codatassess/models/operations/generate_excel_report.py src/codatassess/models/operations/get_accounting_marketing_metrics.py src/codatassess/models/operations/get_excel_report.py @@ -30,27 +25,20 @@ src/codatassess/models/operations/get_commerce_lifetime_value_metrics.py src/codatassess/models/operations/get_commerce_orders_metrics.py src/codatassess/models/operations/get_commerce_refunds_metrics.py src/codatassess/models/operations/get_commerce_revenue_metrics.py -src/codatassess/models/operations/get_enhanced_balance_sheet.py src/codatassess/models/operations/get_enhanced_cash_flow_transactions.py -src/codatassess/models/operations/get_enhanced_financial_metrics.py src/codatassess/models/operations/get_enhanced_invoices_report.py -src/codatassess/models/operations/get_enhanced_profit_and_loss.py src/codatassess/models/operations/get_loan_summary.py src/codatassess/models/operations/get_recurring_revenue_metrics.py src/codatassess/models/operations/list_loan_transactions.py src/codatassess/models/operations/request_recurring_revenue_metrics.py src/codatassess/models/operations/__init__.py -src/codatassess/models/shared/categorisedaccount.py -src/codatassess/models/shared/accountcategorydeprecated.py -src/codatassess/models/shared/accountref.py -src/codatassess/models/shared/categorisedaccounts.py +src/codatassess/models/shared/errormessage.py +src/codatassess/models/shared/details.py +src/codatassess/models/shared/dataintegritydetails.py +src/codatassess/models/shared/dataintegritymatch.py src/codatassess/models/shared/links.py src/codatassess/models/shared/halref.py -src/codatassess/models/shared/categories.py -src/codatassess/models/shared/confirmcategory.py -src/codatassess/models/shared/accountcategory.py -src/codatassess/models/shared/confirmcategories.py -src/codatassess/models/shared/schema.py +src/codatassess/models/shared/dataintegritydatatype.py src/codatassess/models/shared/status.py src/codatassess/models/shared/dataintegritystatus.py src/codatassess/models/shared/dataintegritystatusinfo.py @@ -58,22 +46,19 @@ src/codatassess/models/shared/integritystatus.py src/codatassess/models/shared/dataintegritydates.py src/codatassess/models/shared/dataintegrityconnectionid.py src/codatassess/models/shared/dataintegrityamounts.py -src/codatassess/models/shared/dataintegritydatatype.py src/codatassess/models/shared/summaries.py src/codatassess/models/shared/dataintegritysummary.py src/codatassess/models/shared/dataintegritybycount.py src/codatassess/models/shared/dataintegritybyamount.py -src/codatassess/models/shared/details.py -src/codatassess/models/shared/dataintegritydetails.py -src/codatassess/models/shared/dataintegritymatch.py src/codatassess/models/shared/excelstatus.py +src/codatassess/models/shared/excelreporttypes.py src/codatassess/models/shared/excelreporttype.py src/codatassess/models/shared/report.py -src/codatassess/models/shared/reportcomponent.py +src/codatassess/models/shared/commercereportcomponent.py src/codatassess/models/shared/reportcomponentmeasure.py -src/codatassess/models/shared/reportmeasure.py -src/codatassess/models/shared/reporterror.py -src/codatassess/models/shared/reportdimension.py +src/codatassess/models/shared/commercereportmeasure.py +src/codatassess/models/shared/commercereporterror.py +src/codatassess/models/shared/commercereportdimension.py src/codatassess/models/shared/periodunit.py src/codatassess/models/shared/enhancedreport.py src/codatassess/models/shared/enhancedreportaccountcategory.py @@ -84,24 +69,24 @@ src/codatassess/models/shared/enhancedcashflowitem.py src/codatassess/models/shared/enhancedcashflowtransaction.py src/codatassess/models/shared/transactioncategory.py src/codatassess/models/shared/sourceref.py +src/codatassess/models/shared/accountref.py src/codatassess/models/shared/reportinfo.py src/codatassess/models/shared/datasource.py src/codatassess/models/shared/accounts.py -src/codatassess/models/shared/financialmetrics.py -src/codatassess/models/shared/financialmetric.py -src/codatassess/models/shared/financialmetricerror.py src/codatassess/models/shared/enhancedinvoicesreport.py src/codatassess/models/shared/enhancedinvoicereportitem.py src/codatassess/models/shared/invoicestatus.py src/codatassess/models/shared/payment.py src/codatassess/models/shared/bankingtransactionref.py -src/codatassess/models/shared/customerref.py +src/codatassess/models/shared/lendingcustomerref.py src/codatassess/models/shared/loansummary.py -src/codatassess/models/shared/reportitems.py -src/codatassess/models/shared/recordref.py +src/codatassess/models/shared/loansummaryreportitem.py +src/codatassess/models/shared/loansummaryrecordref.py +src/codatassess/models/shared/loansummaryrecordreftype.py +src/codatassess/models/shared/loansummaryintegrationtype.py src/codatassess/models/shared/loansummaryreportinfo.py src/codatassess/models/shared/loantransactions.py -src/codatassess/models/shared/reportitems1.py +src/codatassess/models/shared/reportitems.py src/codatassess/models/shared/loanref.py src/codatassess/models/shared/itemref.py src/codatassess/models/shared/loantransactionsreportinfo.py @@ -110,28 +95,19 @@ src/codatassess/models/shared/accountcategoriesupdatedwebhook.py src/codatassess/models/shared/__init__.py src/codatassess/models/webhooks/account_categories_updated.py src/codatassess/models/webhooks/__init__.py +src/codatassess/models/errors/__init__.py docs/sdks/codatassess/README.md docs/models/utils/retryconfig.md -docs/sdks/categories/README.md docs/sdks/dataintegrity/README.md docs/sdks/excelreports/README.md docs/sdks/reports/README.md USAGE.md -docs/models/operations/getaccountcategoryrequest.md -docs/models/operations/getaccountcategoryresponse.md -docs/models/operations/listaccountscategoriesrequest.md -docs/models/operations/listaccountscategoriesresponse.md -docs/models/operations/listavailableaccountcategoriesresponse.md -docs/models/operations/updateaccountcategoryrequest.md -docs/models/operations/updateaccountcategoryresponse.md -docs/models/operations/updateaccountscategoriesrequest.md -docs/models/operations/updateaccountscategoriesresponse.md +docs/models/operations/listdatatypedataintegritydetailsrequest.md +docs/models/operations/listdatatypedataintegritydetailsresponse.md docs/models/operations/getdataintegritystatusrequest.md docs/models/operations/getdataintegritystatusresponse.md docs/models/operations/getdataintegritysummariesrequest.md docs/models/operations/getdataintegritysummariesresponse.md -docs/models/operations/listdatatypedataintegritydetailsrequest.md -docs/models/operations/listdatatypedataintegritydetailsresponse.md docs/models/operations/generateexcelreportrequest.md docs/models/operations/generateexcelreportresponse.md docs/models/operations/getaccountingmarketingmetricsrequest.md @@ -155,16 +131,10 @@ docs/models/operations/getcommercerefundsmetricsrequest.md docs/models/operations/getcommercerefundsmetricsresponse.md docs/models/operations/getcommercerevenuemetricsrequest.md docs/models/operations/getcommercerevenuemetricsresponse.md -docs/models/operations/getenhancedbalancesheetrequest.md -docs/models/operations/getenhancedbalancesheetresponse.md docs/models/operations/getenhancedcashflowtransactionsrequest.md docs/models/operations/getenhancedcashflowtransactionsresponse.md -docs/models/operations/getenhancedfinancialmetricsrequest.md -docs/models/operations/getenhancedfinancialmetricsresponse.md docs/models/operations/getenhancedinvoicesreportrequest.md docs/models/operations/getenhancedinvoicesreportresponse.md -docs/models/operations/getenhancedprofitandlossrequest.md -docs/models/operations/getenhancedprofitandlossresponse.md docs/models/operations/getloansummaryrequest.md docs/models/operations/getloansummaryresponse.md docs/models/operations/getrecurringrevenuemetricsrequest.md @@ -174,19 +144,13 @@ docs/models/operations/listloantransactionsrequest.md docs/models/operations/listloantransactionsresponse.md docs/models/operations/requestrecurringrevenuemetricsrequest.md docs/models/operations/requestrecurringrevenuemetricsresponse.md -docs/models/shared/categorisedaccount.md -docs/models/shared/accountcategorydeprecated.md -docs/models/shared/accountref.md -docs/models/shared/categorisedaccounts.md +docs/models/shared/errormessage.md +docs/models/shared/details.md +docs/models/shared/dataintegritydetails.md +docs/models/shared/dataintegritymatch.md docs/models/shared/links.md docs/models/shared/halref.md -docs/models/shared/categories.md -docs/models/shared/confirmcategory.md -docs/models/shared/accountcategory.md -docs/models/shared/confirmcategoriescategoriesaccountref.md -docs/models/shared/confirmcategoriescategories.md -docs/models/shared/confirmcategories.md -docs/models/shared/schema.md +docs/models/shared/dataintegritydatatype.md docs/models/shared/status.md docs/models/shared/dataintegritystatus.md docs/models/shared/dataintegritystatusinfo.md @@ -194,23 +158,20 @@ docs/models/shared/integritystatus.md docs/models/shared/dataintegritydates.md docs/models/shared/dataintegrityconnectionid.md docs/models/shared/dataintegrityamounts.md -docs/models/shared/dataintegritydatatype.md docs/models/shared/summaries.md docs/models/shared/dataintegritysummary.md docs/models/shared/dataintegritybycount.md docs/models/shared/dataintegritybyamount.md -docs/models/shared/details.md -docs/models/shared/dataintegritydetails.md -docs/models/shared/dataintegritymatch.md docs/models/shared/excelstatus.md +docs/models/shared/excelreporttypes.md docs/models/shared/excelreporttype.md docs/models/shared/report.md -docs/models/shared/reportcomponent.md +docs/models/shared/commercereportcomponent.md docs/models/shared/reportcomponentmeasure.md -docs/models/shared/reportmeasure.md -docs/models/shared/reporterror.md -docs/models/shared/reportdimensionitems.md -docs/models/shared/reportdimension.md +docs/models/shared/commercereportmeasure.md +docs/models/shared/commercereporterror.md +docs/models/shared/commercereportdimensionitems.md +docs/models/shared/commercereportdimension.md docs/models/shared/periodunit.md docs/models/shared/enhancedreportreportitem.md docs/models/shared/enhancedreport.md @@ -222,42 +183,30 @@ docs/models/shared/enhancedcashflowitem.md docs/models/shared/enhancedcashflowtransaction.md docs/models/shared/transactioncategory.md docs/models/shared/sourceref.md +docs/models/shared/accountref.md docs/models/shared/reportinfo.md docs/models/shared/datasource.md docs/models/shared/accounts.md -docs/models/shared/financialmetricsperiodunit.md -docs/models/shared/financialmetrics.md -docs/models/shared/financialmetricerrorstype.md -docs/models/shared/financialmetricerrors.md -docs/models/shared/financialmetrickey.md -docs/models/shared/financialmetricmetricunit.md -docs/models/shared/financialmetricperiodserrorstype.md -docs/models/shared/financialmetricperiodserrors.md -docs/models/shared/financialmetricperiodsinputs.md -docs/models/shared/financialmetricperiods.md -docs/models/shared/financialmetric.md -docs/models/shared/financialmetricerrortype.md -docs/models/shared/financialmetricerror.md -docs/models/shared/enhancedinvoicesreportreportitems.md docs/models/shared/enhancedinvoicesreport.md docs/models/shared/enhancedinvoicereportitem.md docs/models/shared/invoicestatus.md docs/models/shared/payment.md docs/models/shared/bankingtransactionref.md -docs/models/shared/customerref.md +docs/models/shared/lendingcustomerref.md docs/models/shared/loansummary.md -docs/models/shared/reportitems.md -docs/models/shared/recordrefintegrationtype.md -docs/models/shared/recordrefrecordreftype.md -docs/models/shared/recordref.md +docs/models/shared/loansummaryreportitem.md +docs/models/shared/loansummaryrecordref.md +docs/models/shared/loansummaryrecordreftype.md +docs/models/shared/loansummaryintegrationtype.md docs/models/shared/loansummaryreportinfo.md docs/models/shared/loantransactions.md docs/models/shared/reportitemsloantransactiontype.md -docs/models/shared/reportitems1.md +docs/models/shared/reportitems.md docs/models/shared/loanref.md docs/models/shared/itemref.md docs/models/shared/loantransactionsreportinfo.md docs/models/shared/security.md docs/models/shared/accountcategoriesupdatedwebhookdata.md docs/models/shared/accountcategoriesupdatedwebhook.md -docs/models/webhooks/accountcategoriesupdatedresponse.md \ No newline at end of file +docs/models/webhooks/accountcategoriesupdatedresponse.md +.gitattributes \ No newline at end of file diff --git a/previous-versions/assess/gen.yaml b/previous-versions/assess/gen.yaml index 833fcd349..6958a8ca3 100644 --- a/previous-versions/assess/gen.yaml +++ b/previous-versions/assess/gen.yaml @@ -1,17 +1,24 @@ configVersion: 1.0.0 management: - docChecksum: 853aebc76021ec17db9b1abb7a33f340 - docVersion: 2.1.0 - speakeasyVersion: 1.53.0 - generationVersion: 2.58.0 + docChecksum: 3b895039f14fdd0cf5e07d404dd90706 + docVersion: "1.0" + speakeasyVersion: 1.77.1 + generationVersion: 2.91.4 generation: sdkClassName: CodatAssess singleTagPerOp: false telemetryEnabled: true +features: + python: + core: 2.85.1 + examples: 2.81.1 + globalSecurity: 2.81.1 + globalServerURLs: 2.82.0 + nameOverrides: 2.81.1 + retries: 2.81.1 python: - version: 0.0.0 + version: 0.1.0 author: Codat - description: Make credit decisions backed by enhanced financials, metrics, reports, - and data integrity features. + description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. maxMethodParams: 0 packageName: codat-assess diff --git a/previous-versions/assess/pylintrc b/previous-versions/assess/pylintrc index 1ce47d88d..ab6495dd6 100755 --- a/previous-versions/assess/pylintrc +++ b/previous-versions/assess/pylintrc @@ -438,7 +438,9 @@ disable=raw-checker-failed, using-constant-test, too-many-statements, cyclic-import, - too-many-nested-blocks + too-many-nested-blocks, + too-many-boolean-expressions, + no-else-raise # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -619,7 +621,7 @@ additional-builtins= allow-global-unused-variables=yes # List of names allowed to shadow builtins -allowed-redefined-builtins= +allowed-redefined-builtins=id,object # List of strings which can identify a callback function by name. A callback # name must start or end with one of those strings. diff --git a/previous-versions/assess/setup.py b/previous-versions/assess/setup.py index f92376394..100ab597c 100755 --- a/previous-versions/assess/setup.py +++ b/previous-versions/assess/setup.py @@ -10,16 +10,16 @@ setuptools.setup( name="codat-assess", - version="0.31.1", - author="Speakeasy", - description="Python Client SDK Generated by Speakeasy", + version="0.1.0", + author="Codat", + description="Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ "certifi>=2022.12.7", "charset-normalizer>=2.1.1", - "dataclasses-json-speakeasy>=0.5.8", + "dataclasses-json>=0.5.12", "idna>=3.3", "jsonpath-python>=1.0.6 ", "marshmallow>=3.17.1", diff --git a/previous-versions/assess/src/codatassess/categories.py b/previous-versions/assess/src/codatassess/categories.py deleted file mode 100755 index 1ead021d0..000000000 --- a/previous-versions/assess/src/codatassess/categories.py +++ /dev/null @@ -1,217 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from .sdkconfiguration import SDKConfiguration -from codatassess import utils -from codatassess.models import operations, shared -from typing import Optional - -class Categories: - r"""Categorisation""" - sdk_configuration: SDKConfiguration - - def __init__(self, sdk_config: SDKConfiguration) -> None: - self.sdk_configuration = sdk_config - - - def get_account_category(self, request: operations.GetAccountCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountCategoryResponse: - r"""Get suggested and/or confirmed category for a specific account - Get category for specific nominal account. - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetAccountCategoryRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories', request) - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetAccountCategoryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.CategorisedAccount]) - res.categorised_account = out - - return res - - - def list_accounts_categories(self, request: operations.ListAccountsCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListAccountsCategoriesResponse: - r"""List suggested and confirmed account categories - Lists suggested and confirmed chart of account categories for the given company and data connection. - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.ListAccountsCategoriesRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories', request) - headers = {} - query_params = utils.get_query_params(operations.ListAccountsCategoriesRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, params=query_params, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListAccountsCategoriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.CategorisedAccounts]) - res.categorised_accounts = out - - return res - - - def list_available_account_categories(self, retries: Optional[utils.RetryConfig] = None) -> operations.ListAvailableAccountCategoriesResponse: - r"""List account categories - Lists available account categories Codat's categorisation engine can provide. - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = base_url + '/data/assess/accounts/categories' - headers = {} - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.ListAvailableAccountCategoriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[shared.Categories]]) - res.categories = out - - return res - - - def update_account_category(self, request: operations.UpdateAccountCategoryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateAccountCategoryResponse: - r"""Update account categories - Update category for a specific nominal account - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.UpdateAccountCategoryRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/{accountId}/categories', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "confirm_category", 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('PATCH', url, data=data, files=form, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.UpdateAccountCategoryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.CategorisedAccount]) - res.categorised_account = out - - return res - - - def update_accounts_categories(self, request: operations.UpdateAccountsCategoriesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.UpdateAccountsCategoriesResponse: - r"""Confirm categories for accounts - Comfirms the categories for all or a batch of accounts for a specific connection. - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.UpdateAccountsCategoriesRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accounts/categories', request) - headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "confirm_categories", 'json') - if req_content_type not in ('multipart/form-data', 'multipart/mixed'): - headers['content-type'] = req_content_type - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('PATCH', url, data=data, files=form, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.UpdateAccountsCategoriesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[shared.CategorisedAccount]]) - res.categorised_accounts = out - - return res - - \ No newline at end of file diff --git a/previous-versions/assess/src/codatassess/data_integrity.py b/previous-versions/assess/src/codatassess/data_integrity.py index f29ca4a1d..d2f142b6f 100755 --- a/previous-versions/assess/src/codatassess/data_integrity.py +++ b/previous-versions/assess/src/codatassess/data_integrity.py @@ -2,26 +2,27 @@ from .sdkconfiguration import SDKConfiguration from codatassess import utils -from codatassess.models import operations, shared +from codatassess.models import errors, operations, shared from typing import Optional class DataIntegrity: - r"""Data integrity is important""" + r"""Match mutable accounting data with immutable banking data to increase confidence in financial data""" sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config - def get_data_integrity_status(self, request: operations.GetDataIntegrityStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegrityStatusResponse: - r"""Get data integrity status - Gets match status for a given company and datatype. + def details(self, request: operations.ListDataTypeDataIntegrityDetailsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListDataTypeDataIntegrityDetailsResponse: + r"""List data type data integrity + Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetDataIntegrityStatusRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status', request) + url = utils.generate_url(operations.ListDataTypeDataIntegrityDetailsRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details', request) headers = {} - headers['Accept'] = 'application/json;q=1, application/json;q=0' + query_params = utils.get_query_params(operations.ListDataTypeDataIntegrityDetailsRequest, request) + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -31,7 +32,7 @@ def get_data_integrity_status(self, request: operations.GetDataIntegrityStatusRe retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) def do_request(): - return client.request('GET', url, headers=headers) + return client.request('GET', url, params=query_params, headers=headers) http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', @@ -40,30 +41,33 @@ def do_request(): ])) content_type = http_res.headers.get('Content-Type') - res = operations.GetDataIntegrityStatusResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + res = operations.ListDataTypeDataIntegrityDetailsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Status]) - res.status = out + out = utils.unmarshal_json(http_res.text, Optional[shared.Details]) + res.details = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res - def get_data_integrity_summaries(self, request: operations.GetDataIntegritySummariesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegritySummariesResponse: - r"""Get data integrity summary - Gets match summary for a given company and datatype, optionally restricted by a Codat query string. + def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegrityStatusResponse: + r"""Get data integrity status + Gets match status for a given company and datatype. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetDataIntegritySummariesRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries', request) + url = utils.generate_url(operations.GetDataIntegrityStatusRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status', request) headers = {} - query_params = utils.get_query_params(operations.GetDataIntegritySummariesRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -73,7 +77,7 @@ def get_data_integrity_summaries(self, request: operations.GetDataIntegritySumma retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) def do_request(): - return client.request('GET', url, params=query_params, headers=headers) + return client.request('GET', url, headers=headers) http_res = utils.retry(do_request, utils.Retries(retry_config, [ '408', @@ -82,30 +86,34 @@ def do_request(): ])) content_type = http_res.headers.get('Content-Type') - res = operations.GetDataIntegritySummariesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + res = operations.GetDataIntegrityStatusResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Summaries]) - res.summaries = out + out = utils.unmarshal_json(http_res.text, Optional[shared.Status]) + res.status = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res - def list_data_type_data_integrity_details(self, request: operations.ListDataTypeDataIntegrityDetailsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListDataTypeDataIntegrityDetailsResponse: - r"""List data type data integrity - Gets record-by-record match results for a given company and datatype, optionally restricted by a Codat query string. + def summary(self, request: operations.GetDataIntegritySummariesRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetDataIntegritySummariesResponse: + r"""Get data integrity summary + Gets match summary for a given company and datatype, optionally restricted by a Codat query string. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.ListDataTypeDataIntegrityDetailsRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details', request) + url = utils.generate_url(operations.GetDataIntegritySummariesRequest, base_url, '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries', request) headers = {} - query_params = utils.get_query_params(operations.ListDataTypeDataIntegrityDetailsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + query_params = utils.get_query_params(operations.GetDataIntegritySummariesRequest, request) + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -124,16 +132,20 @@ def do_request(): ])) content_type = http_res.headers.get('Content-Type') - res = operations.ListDataTypeDataIntegrityDetailsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) + res = operations.GetDataIntegritySummariesResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Details]) - res.details = out + out = utils.unmarshal_json(http_res.text, Optional[shared.Summaries]) + res.summaries = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/previous-versions/assess/src/codatassess/excel_reports.py b/previous-versions/assess/src/codatassess/excel_reports.py index 97da1af90..8ed0b6477 100755 --- a/previous-versions/assess/src/codatassess/excel_reports.py +++ b/previous-versions/assess/src/codatassess/excel_reports.py @@ -2,9 +2,14 @@ from .sdkconfiguration import SDKConfiguration from codatassess import utils -from codatassess.models import operations, shared +from codatassess.models import errors, operations, shared +from enum import Enum from typing import Optional +class GetExcelReportAcceptEnum(str, Enum): + APPLICATION_JSON = "application/json" + APPLICATION_OCTET_STREAM = "application/octet-stream" + class ExcelReports: r"""Downloadable reports""" sdk_configuration: SDKConfiguration @@ -22,7 +27,7 @@ def generate_excel_report(self, request: operations.GenerateExcelReportRequest, url = utils.generate_url(operations.GenerateExcelReportRequest, base_url, '/data/companies/{companyId}/assess/excel', request) headers = {} query_params = utils.get_query_params(operations.GenerateExcelReportRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -47,10 +52,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ExcelStatus]) res.excel_status = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -58,7 +67,7 @@ def do_request(): def get_accounting_marketing_metrics(self, request: operations.GetAccountingMarketingMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountingMarketingMetricsResponse: r"""Get marketing metrics report Get the marketing metrics from an accounting source for a given company. - + Request an Excel report for download. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -66,7 +75,7 @@ def get_accounting_marketing_metrics(self, request: operations.GetAccountingMark url = utils.generate_url(operations.GetAccountingMarketingMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/accountingMetrics/marketing', request) headers = {} query_params = utils.get_query_params(operations.GetAccountingMarketingMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -91,15 +100,19 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res - def get_excel_report(self, request: operations.GetExcelReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetExcelReportResponse: + def get_excel_report(self, request: operations.GetExcelReportRequest, retries: Optional[utils.RetryConfig] = None, accept_header_override: Optional[GetExcelReportAcceptEnum] = None) -> operations.GetExcelReportResponse: r"""Download Excel report Download the previously generated Excel report to a local drive. """ @@ -108,7 +121,10 @@ def get_excel_report(self, request: operations.GetExcelReportRequest, retries: O url = utils.generate_url(operations.GetExcelReportRequest, base_url, '/data/companies/{companyId}/assess/excel/download', request) headers = {} query_params = utils.get_query_params(operations.GetExcelReportRequest, request) - headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' + if accept_header_override is not None: + headers['Accept'] = accept_header_override.value + else: + headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -132,10 +148,14 @@ def do_request(): if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/octet-stream'): res.body = http_res.content + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -149,7 +169,7 @@ def get_excel_report_generation_status(self, request: operations.GetExcelReportG url = utils.generate_url(operations.GetExcelReportGenerationStatusRequest, base_url, '/data/companies/{companyId}/assess/excel', request) headers = {} query_params = utils.get_query_params(operations.GetExcelReportGenerationStatusRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -174,10 +194,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.ExcelStatus]) res.excel_status = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/previous-versions/assess/src/codatassess/models/errors/__init__.py b/previous-versions/assess/src/codatassess/models/errors/__init__.py new file mode 100755 index 000000000..cfd848441 --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/errors/__init__.py @@ -0,0 +1,4 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkerror import SDKError +__all__ = ["SDKError"] diff --git a/previous-versions/assess/src/codatassess/models/errors/sdkerror.py b/previous-versions/assess/src/codatassess/models/errors/sdkerror.py new file mode 100755 index 000000000..6bb02bbd6 --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/errors/sdkerror.py @@ -0,0 +1,24 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http + + +class SDKError(Exception): + """Represents an error returned by the API.""" + message: str + status_code: int + body: str + raw_response: requests_http.Response + + def __init__(self, message: str, status_code: int, body: str, raw_response: requests_http.Response): + self.message = message + self.status_code = status_code + self.body = body + self.raw_response = raw_response + + def __str__(self): + body = '' + if len(self.body) > 0: + body = f'\n{self.body}' + + return f'{self.message}: Status {self.status_code}{body}' diff --git a/previous-versions/assess/src/codatassess/models/operations/__init__.py b/previous-versions/assess/src/codatassess/models/operations/__init__.py index 3b82ae80f..62cc42c3d 100755 --- a/previous-versions/assess/src/codatassess/models/operations/__init__.py +++ b/previous-versions/assess/src/codatassess/models/operations/__init__.py @@ -1,7 +1,6 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .generate_excel_report import * -from .get_account_category import * from .get_accounting_marketing_metrics import * from .get_accounts_for_enhanced_balance_sheet import * from .get_accounts_for_enhanced_profit_and_loss import * @@ -12,21 +11,14 @@ from .get_commerce_revenue_metrics import * from .get_data_integrity_status import * from .get_data_integrity_summaries import * -from .get_enhanced_balance_sheet import * from .get_enhanced_cash_flow_transactions import * -from .get_enhanced_financial_metrics import * from .get_enhanced_invoices_report import * -from .get_enhanced_profit_and_loss import * from .get_excel_report import * from .get_excel_report_generation_status import * from .get_loan_summary import * from .get_recurring_revenue_metrics import * -from .list_accounts_categories import * -from .list_available_account_categories import * from .list_data_type_data_integrity_details import * from .list_loan_transactions import * from .request_recurring_revenue_metrics import * -from .update_account_category import * -from .update_accounts_categories import * -__all__ = ["GenerateExcelReportRequest","GenerateExcelReportResponse","GetAccountCategoryRequest","GetAccountCategoryResponse","GetAccountingMarketingMetricsRequest","GetAccountingMarketingMetricsResponse","GetAccountsForEnhancedBalanceSheetRequest","GetAccountsForEnhancedBalanceSheetResponse","GetAccountsForEnhancedProfitAndLossRequest","GetAccountsForEnhancedProfitAndLossResponse","GetCommerceCustomerRetentionMetricsRequest","GetCommerceCustomerRetentionMetricsResponse","GetCommerceLifetimeValueMetricsRequest","GetCommerceLifetimeValueMetricsResponse","GetCommerceOrdersMetricsRequest","GetCommerceOrdersMetricsResponse","GetCommerceRefundsMetricsRequest","GetCommerceRefundsMetricsResponse","GetCommerceRevenueMetricsRequest","GetCommerceRevenueMetricsResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetEnhancedBalanceSheetRequest","GetEnhancedBalanceSheetResponse","GetEnhancedCashFlowTransactionsRequest","GetEnhancedCashFlowTransactionsResponse","GetEnhancedFinancialMetricsRequest","GetEnhancedFinancialMetricsResponse","GetEnhancedInvoicesReportRequest","GetEnhancedInvoicesReportResponse","GetEnhancedProfitAndLossRequest","GetEnhancedProfitAndLossResponse","GetExcelReport200ApplicationOctetStream","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetExcelReportRequest","GetExcelReportResponse","GetLoanSummaryRequest","GetLoanSummaryResponse","GetRecurringRevenueMetricsRequest","GetRecurringRevenueMetricsResponse","ListAccountsCategoriesRequest","ListAccountsCategoriesResponse","ListAvailableAccountCategoriesResponse","ListDataTypeDataIntegrityDetailsRequest","ListDataTypeDataIntegrityDetailsResponse","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListLoanTransactionsSourceType","RequestRecurringRevenueMetricsRequest","RequestRecurringRevenueMetricsResponse","UpdateAccountCategoryRequest","UpdateAccountCategoryResponse","UpdateAccountsCategoriesRequest","UpdateAccountsCategoriesResponse"] +__all__ = ["GenerateExcelReportRequest","GenerateExcelReportResponse","GetAccountingMarketingMetricsRequest","GetAccountingMarketingMetricsResponse","GetAccountsForEnhancedBalanceSheetRequest","GetAccountsForEnhancedBalanceSheetResponse","GetAccountsForEnhancedProfitAndLossRequest","GetAccountsForEnhancedProfitAndLossResponse","GetCommerceCustomerRetentionMetricsRequest","GetCommerceCustomerRetentionMetricsResponse","GetCommerceLifetimeValueMetricsRequest","GetCommerceLifetimeValueMetricsResponse","GetCommerceOrdersMetricsRequest","GetCommerceOrdersMetricsResponse","GetCommerceRefundsMetricsRequest","GetCommerceRefundsMetricsResponse","GetCommerceRevenueMetricsRequest","GetCommerceRevenueMetricsResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetEnhancedCashFlowTransactionsRequest","GetEnhancedCashFlowTransactionsResponse","GetEnhancedInvoicesReportRequest","GetEnhancedInvoicesReportResponse","GetExcelReport200ApplicationOctetStream","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetExcelReportRequest","GetExcelReportResponse","GetLoanSummaryRequest","GetLoanSummaryResponse","GetRecurringRevenueMetricsRequest","GetRecurringRevenueMetricsResponse","ListDataTypeDataIntegrityDetailsRequest","ListDataTypeDataIntegrityDetailsResponse","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListLoanTransactionsSourceType","RequestRecurringRevenueMetricsRequest","RequestRecurringRevenueMetricsResponse"] diff --git a/previous-versions/assess/src/codatassess/models/operations/generate_excel_report.py b/previous-versions/assess/src/codatassess/models/operations/generate_excel_report.py index 7ebdc9952..943d64765 100755 --- a/previous-versions/assess/src/codatassess/models/operations/generate_excel_report.py +++ b/previous-versions/assess/src/codatassess/models/operations/generate_excel_report.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import excelreporttype as shared_excelreporttype from ..shared import excelstatus as shared_excelstatus -from ..shared import schema as shared_schema from typing import Optional @@ -24,10 +24,10 @@ class GenerateExcelReportRequest: class GenerateExcelReportResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" excel_status: Optional[shared_excelstatus.ExcelStatus] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_account_category.py b/previous-versions/assess/src/codatassess/models/operations/get_account_category.py deleted file mode 100755 index 5e17105da..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/get_account_category.py +++ /dev/null @@ -1,30 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import categorisedaccount as shared_categorisedaccount -from typing import Optional - - - -@dataclasses.dataclass -class GetAccountCategoryRequest: - account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', '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 }}) - - - - - -@dataclasses.dataclass -class GetAccountCategoryResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - categorised_account: Optional[shared_categorisedaccount.CategorisedAccount] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/operations/get_accounting_marketing_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_accounting_marketing_metrics.py index d5aa94961..f259264a5 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_accounting_marketing_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_accounting_marketing_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -35,10 +35,10 @@ class GetAccountingMarketingMetricsRequest: class GetAccountingMarketingMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_balance_sheet.py b/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_balance_sheet.py index c594e6fed..0334b6a01 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_balance_sheet.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_balance_sheet.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import enhancedreport as shared_enhancedreport -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from typing import Optional @@ -27,8 +27,8 @@ class GetAccountsForEnhancedBalanceSheetResponse: status_code: int = dataclasses.field() enhanced_report: Optional[shared_enhancedreport.EnhancedReport] = dataclasses.field(default=None) r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_profit_and_loss.py b/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_profit_and_loss.py index db4b8143c..ad2c0c15d 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_profit_and_loss.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_accounts_for_enhanced_profit_and_loss.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import enhancedreport as shared_enhancedreport -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from typing import Optional @@ -27,8 +27,8 @@ class GetAccountsForEnhancedProfitAndLossResponse: status_code: int = dataclasses.field() enhanced_report: Optional[shared_enhancedreport.EnhancedReport] = dataclasses.field(default=None) r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/get_commerce_customer_retention_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_commerce_customer_retention_metrics.py index 7d4beb7bd..a3aca647b 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_commerce_customer_retention_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_commerce_customer_retention_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -33,10 +33,10 @@ class GetCommerceCustomerRetentionMetricsRequest: class GetCommerceCustomerRetentionMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_commerce_lifetime_value_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_commerce_lifetime_value_metrics.py index bc2800fa8..4d1cefa60 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_commerce_lifetime_value_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_commerce_lifetime_value_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -33,10 +33,10 @@ class GetCommerceLifetimeValueMetricsRequest: class GetCommerceLifetimeValueMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_commerce_orders_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_commerce_orders_metrics.py index 9d7434f42..72d5bb4b1 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_commerce_orders_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_commerce_orders_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -33,10 +33,10 @@ class GetCommerceOrdersMetricsRequest: class GetCommerceOrdersMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_commerce_refunds_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_commerce_refunds_metrics.py index 29eb7e18d..fd852a10a 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_commerce_refunds_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_commerce_refunds_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -33,10 +33,10 @@ class GetCommerceRefundsMetricsRequest: class GetCommerceRefundsMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_commerce_revenue_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_commerce_revenue_metrics.py index 77524ba3c..2ed0a20a2 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_commerce_revenue_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_commerce_revenue_metrics.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import periodunit as shared_periodunit from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -33,10 +33,10 @@ class GetCommerceRevenueMetricsRequest: class GetCommerceRevenueMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_status.py b/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_status.py index afca8529b..f2f8e3825 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_status.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_status.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from ..shared import status as shared_status from typing import Optional @@ -24,9 +24,9 @@ class GetDataIntegrityStatusRequest: class GetDataIntegrityStatusResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) status: Optional[shared_status.Status] = dataclasses.field(default=None) r"""OK""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_summaries.py b/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_summaries.py index 7c4bf689c..ef2d79f02 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_summaries.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_data_integrity_summaries.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from ..shared import summaries as shared_summaries from typing import Optional @@ -26,9 +26,9 @@ class GetDataIntegritySummariesRequest: class GetDataIntegritySummariesResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) summaries: Optional[shared_summaries.Summaries] = dataclasses.field(default=None) r"""OK""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_balance_sheet.py b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_balance_sheet.py deleted file mode 100755 index e10a66983..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_balance_sheet.py +++ /dev/null @@ -1,39 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import report as shared_report -from ..shared import schema as shared_schema -from typing import Optional - - - -@dataclasses.dataclass -class GetEnhancedBalanceSheetRequest: - 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 }}) - number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) - r"""The number of periods to return. There will be no pagination as a query parameter.""" - period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) - r"""The number of months per period. E.g. 2 = 2 months per period.""" - report_date: str = dataclasses.field(metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) - r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" - include_display_names: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'includeDisplayNames', 'style': 'form', 'explode': True }}) - r"""Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.""" - - - - - -@dataclasses.dataclass -class GetEnhancedBalanceSheetResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - report: Optional[shared_report.Report] = dataclasses.field(default=None) - r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" - - diff --git a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_cash_flow_transactions.py b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_cash_flow_transactions.py index 0a0114606..541c7d71c 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_cash_flow_transactions.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_cash_flow_transactions.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import enhancedcashflowtransactions as shared_enhancedcashflowtransactions -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from typing import Optional @@ -29,8 +29,8 @@ class GetEnhancedCashFlowTransactionsResponse: status_code: int = dataclasses.field() enhanced_cash_flow_transactions: Optional[shared_enhancedcashflowtransactions.EnhancedCashFlowTransactions] = dataclasses.field(default=None) r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_financial_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_financial_metrics.py deleted file mode 100755 index e193d4c8d..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_financial_metrics.py +++ /dev/null @@ -1,36 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import financialmetrics as shared_financialmetrics -from typing import Optional - - - -@dataclasses.dataclass -class GetEnhancedFinancialMetricsRequest: - 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 }}) - number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) - r"""The number of periods to return. There will be no pagination as a query parameter.""" - period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) - r"""The number of months per period. E.g. 2 = 2 months per period.""" - report_date: str = dataclasses.field(metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) - r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" - show_metric_inputs: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'showMetricInputs', 'style': 'form', 'explode': True }}) - r"""If set to true, then the system includes the input values within the response.""" - - - - - -@dataclasses.dataclass -class GetEnhancedFinancialMetricsResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - financial_metrics: Optional[shared_financialmetrics.FinancialMetrics] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_invoices_report.py b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_invoices_report.py index bf8f48ced..a3f31ed2f 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_invoices_report.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_invoices_report.py @@ -4,7 +4,7 @@ import dataclasses import requests as requests_http from ..shared import enhancedinvoicesreport as shared_enhancedinvoicesreport -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from typing import Optional @@ -29,8 +29,8 @@ class GetEnhancedInvoicesReportResponse: status_code: int = dataclasses.field() enhanced_invoices_report: Optional[shared_enhancedinvoicesreport.EnhancedInvoicesReport] = dataclasses.field(default=None) r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_profit_and_loss.py b/previous-versions/assess/src/codatassess/models/operations/get_enhanced_profit_and_loss.py deleted file mode 100755 index 7ddf93e05..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/get_enhanced_profit_and_loss.py +++ /dev/null @@ -1,39 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import report as shared_report -from ..shared import schema as shared_schema -from typing import Optional - - - -@dataclasses.dataclass -class GetEnhancedProfitAndLossRequest: - 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 }}) - number_of_periods: int = dataclasses.field(metadata={'query_param': { 'field_name': 'numberOfPeriods', 'style': 'form', 'explode': True }}) - r"""The number of periods to return. There will be no pagination as a query parameter.""" - period_length: int = dataclasses.field(metadata={'query_param': { 'field_name': 'periodLength', 'style': 'form', 'explode': True }}) - r"""The number of months per period. E.g. 2 = 2 months per period.""" - report_date: str = dataclasses.field(metadata={'query_param': { 'field_name': 'reportDate', 'style': 'form', 'explode': True }}) - r"""The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.""" - include_display_names: Optional[bool] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'includeDisplayNames', 'style': 'form', 'explode': True }}) - r"""Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable.""" - - - - - -@dataclasses.dataclass -class GetEnhancedProfitAndLossResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - report: Optional[shared_report.Report] = dataclasses.field(default=None) - r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" - - diff --git a/previous-versions/assess/src/codatassess/models/operations/get_excel_report.py b/previous-versions/assess/src/codatassess/models/operations/get_excel_report.py index c672671fc..6b4bc62e7 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_excel_report.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_excel_report.py @@ -3,8 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import excelreporttype as shared_excelreporttype -from ..shared import schema as shared_schema from typing import Optional @@ -32,8 +32,8 @@ class GetExcelReportResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() body: Optional[bytes] = dataclasses.field(default=None) - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/get_excel_report_generation_status.py b/previous-versions/assess/src/codatassess/models/operations/get_excel_report_generation_status.py index 32717f26c..efa2ffb1e 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_excel_report_generation_status.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_excel_report_generation_status.py @@ -3,9 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import excelreporttype as shared_excelreporttype from ..shared import excelstatus as shared_excelstatus -from ..shared import schema as shared_schema from typing import Optional @@ -24,10 +24,10 @@ class GetExcelReportGenerationStatusRequest: class GetExcelReportGenerationStatusResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" excel_status: Optional[shared_excelstatus.ExcelStatus] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_loan_summary.py b/previous-versions/assess/src/codatassess/models/operations/get_loan_summary.py index f61786a9b..d08c25650 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_loan_summary.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_loan_summary.py @@ -3,8 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import loansummary as shared_loansummary -from ..shared import schema as shared_schema from typing import Optional @@ -21,10 +21,10 @@ class GetLoanSummaryRequest: class GetLoanSummaryResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" loan_summary: Optional[shared_loansummary.LoanSummary] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/get_recurring_revenue_metrics.py b/previous-versions/assess/src/codatassess/models/operations/get_recurring_revenue_metrics.py index 2f7069de6..3c4bcd4fa 100755 --- a/previous-versions/assess/src/codatassess/models/operations/get_recurring_revenue_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/get_recurring_revenue_metrics.py @@ -3,8 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -22,10 +22,10 @@ class GetRecurringRevenueMetricsRequest: class GetRecurringRevenueMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/list_accounts_categories.py b/previous-versions/assess/src/codatassess/models/operations/list_accounts_categories.py deleted file mode 100755 index 49678ab11..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/list_accounts_categories.py +++ /dev/null @@ -1,36 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import categorisedaccounts as shared_categorisedaccounts -from typing import Optional - - - -@dataclasses.dataclass -class ListAccountsCategoriesRequest: - 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 }}) - order_by: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'orderBy', 'style': 'form', 'explode': True }}) - r"""Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).""" - page: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'page', 'style': 'form', 'explode': True }}) - r"""Page number. [Read more](https://docs.codat.io/using-the-api/paging).""" - page_size: Optional[int] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': True }}) - r"""Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging).""" - query: Optional[str] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'query', 'style': 'form', 'explode': True }}) - r"""Codat query string. [Read more](https://docs.codat.io/using-the-api/querying).""" - - - - - -@dataclasses.dataclass -class ListAccountsCategoriesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - categorised_accounts: Optional[shared_categorisedaccounts.CategorisedAccounts] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/operations/list_available_account_categories.py b/previous-versions/assess/src/codatassess/models/operations/list_available_account_categories.py deleted file mode 100755 index d11cf74c4..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/list_available_account_categories.py +++ /dev/null @@ -1,19 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import categories as shared_categories -from typing import Optional - - - -@dataclasses.dataclass -class ListAvailableAccountCategoriesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - categories: Optional[list[shared_categories.Categories]] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/operations/list_data_type_data_integrity_details.py b/previous-versions/assess/src/codatassess/models/operations/list_data_type_data_integrity_details.py index b12cd4e74..8f5a9320a 100755 --- a/previous-versions/assess/src/codatassess/models/operations/list_data_type_data_integrity_details.py +++ b/previous-versions/assess/src/codatassess/models/operations/list_data_type_data_integrity_details.py @@ -5,7 +5,7 @@ import requests as requests_http from ..shared import dataintegritydatatype as shared_dataintegritydatatype from ..shared import details as shared_details -from ..shared import schema as shared_schema +from ..shared import errormessage as shared_errormessage from typing import Optional @@ -34,8 +34,8 @@ class ListDataTypeDataIntegrityDetailsResponse: status_code: int = dataclasses.field() details: Optional[shared_details.Details] = dataclasses.field(default=None) r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Your API request was not properly authorized.""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) diff --git a/previous-versions/assess/src/codatassess/models/operations/list_loan_transactions.py b/previous-versions/assess/src/codatassess/models/operations/list_loan_transactions.py index 99866b805..2b6212e61 100755 --- a/previous-versions/assess/src/codatassess/models/operations/list_loan_transactions.py +++ b/previous-versions/assess/src/codatassess/models/operations/list_loan_transactions.py @@ -3,8 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import loantransactions as shared_loantransactions -from ..shared import schema as shared_schema from enum import Enum from typing import Optional @@ -30,10 +30,10 @@ class ListLoanTransactionsRequest: class ListLoanTransactionsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" loan_transactions: Optional[shared_loantransactions.LoanTransactions] = dataclasses.field(default=None) r"""OK""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/request_recurring_revenue_metrics.py b/previous-versions/assess/src/codatassess/models/operations/request_recurring_revenue_metrics.py index 392f512db..bc5b23958 100755 --- a/previous-versions/assess/src/codatassess/models/operations/request_recurring_revenue_metrics.py +++ b/previous-versions/assess/src/codatassess/models/operations/request_recurring_revenue_metrics.py @@ -3,8 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http +from ..shared import errormessage as shared_errormessage from ..shared import report as shared_report -from ..shared import schema as shared_schema from typing import Optional @@ -22,10 +22,10 @@ class RequestRecurringRevenueMetricsRequest: class RequestRecurringRevenueMetricsResponse: content_type: str = dataclasses.field() status_code: int = dataclasses.field() + error_message: Optional[shared_errormessage.ErrorMessage] = dataclasses.field(default=None) + r"""Your API request was not properly authorized.""" raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" - schema: Optional[shared_schema.Schema] = dataclasses.field(default=None) - r"""Your API request was not properly authorized.""" diff --git a/previous-versions/assess/src/codatassess/models/operations/update_account_category.py b/previous-versions/assess/src/codatassess/models/operations/update_account_category.py deleted file mode 100755 index f49def0e7..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/update_account_category.py +++ /dev/null @@ -1,32 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import categorisedaccount as shared_categorisedaccount -from ..shared import confirmcategory as shared_confirmcategory -from typing import Optional - - - -@dataclasses.dataclass -class UpdateAccountCategoryRequest: - account_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'accountId', '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 }}) - confirm_category: Optional[shared_confirmcategory.ConfirmCategory] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - - - - - -@dataclasses.dataclass -class UpdateAccountCategoryResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - categorised_account: Optional[shared_categorisedaccount.CategorisedAccount] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/operations/update_accounts_categories.py b/previous-versions/assess/src/codatassess/models/operations/update_accounts_categories.py deleted file mode 100755 index fc0d1e750..000000000 --- a/previous-versions/assess/src/codatassess/models/operations/update_accounts_categories.py +++ /dev/null @@ -1,30 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -import requests as requests_http -from ..shared import categorisedaccount as shared_categorisedaccount -from ..shared import confirmcategories as shared_confirmcategories -from typing import Optional - - - -@dataclasses.dataclass -class UpdateAccountsCategoriesRequest: - 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 }}) - confirm_categories: Optional[shared_confirmcategories.ConfirmCategories] = dataclasses.field(default=None, metadata={'request': { 'media_type': 'application/json' }}) - - - - - -@dataclasses.dataclass -class UpdateAccountsCategoriesResponse: - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - categorised_accounts: Optional[list[shared_categorisedaccount.CategorisedAccount]] = dataclasses.field(default=None) - r"""OK""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/__init__.py b/previous-versions/assess/src/codatassess/models/shared/__init__.py index f618f9c56..493b45a84 100755 --- a/previous-versions/assess/src/codatassess/models/shared/__init__.py +++ b/previous-versions/assess/src/codatassess/models/shared/__init__.py @@ -1,18 +1,14 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .accountcategoriesupdatedwebhook import * -from .accountcategory import * -from .accountcategorydeprecated import * from .accountcategorylevel import * from .accountref import * from .accounts import * from .bankingtransactionref import * -from .categories import * -from .categorisedaccount import * -from .categorisedaccounts import * -from .confirmcategories import * -from .confirmcategory import * -from .customerref import * +from .commercereportcomponent import * +from .commercereportdimension import * +from .commercereporterror import * +from .commercereportmeasure import * from .dataintegrityamounts import * from .dataintegritybyamount import * from .dataintegritybycount import * @@ -34,38 +30,35 @@ from .enhancedreport import * from .enhancedreportaccountcategory import * from .enhancedreportinfo import * +from .errormessage import * from .excelreporttype import * +from .excelreporttypes import * from .excelstatus import * -from .financialmetric import * -from .financialmetricerror import * -from .financialmetrics import * from .halref import * from .integritystatus import * from .invoicestatus import * from .itemref import * +from .lendingcustomerref import * from .links import * from .loanref import * from .loansummary import * +from .loansummaryintegrationtype import * +from .loansummaryrecordref import * +from .loansummaryrecordreftype import * from .loansummaryreportinfo import * +from .loansummaryreportitem import * from .loantransactions import * from .loantransactionsreportinfo import * from .payment import * from .periodunit import * -from .recordref import * from .report import * -from .reportcomponent import * from .reportcomponentmeasure import * -from .reportdimension import * -from .reporterror import * from .reportinfo import * from .reportitems import * -from .reportitems1 import * -from .reportmeasure import * -from .schema import * from .security import * from .sourceref import * from .status import * from .summaries import * from .transactioncategory import * -__all__ = ["AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategory","AccountCategoryDeprecated","AccountCategoryLevel","AccountRef","Accounts","BankingTransactionRef","Categories","CategorisedAccount","CategorisedAccounts","ConfirmCategories","ConfirmCategoriesCategories","ConfirmCategoriesCategoriesAccountRef","ConfirmCategory","CustomerRef","DataIntegrityAmounts","DataIntegrityByAmount","DataIntegrityByCount","DataIntegrityConnectionID","DataIntegrityDataType","DataIntegrityDates","DataIntegrityDetails","DataIntegrityMatch","DataIntegrityStatus","DataIntegrityStatusInfo","DataIntegritySummary","DataSource","Details","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedInvoicesReportReportItems","EnhancedReport","EnhancedReportAccountCategory","EnhancedReportInfo","EnhancedReportReportItem","ExcelReportType","ExcelStatus","FinancialMetric","FinancialMetricError","FinancialMetricErrorType","FinancialMetricErrors","FinancialMetricErrorsType","FinancialMetricKey","FinancialMetricMetricUnit","FinancialMetricPeriods","FinancialMetricPeriodsErrors","FinancialMetricPeriodsErrorsType","FinancialMetricPeriodsInputs","FinancialMetrics","FinancialMetricsPeriodUnit","HalRef","IntegrityStatus","InvoiceStatus","ItemRef","Links","LoanRef","LoanSummary","LoanSummaryReportInfo","LoanTransactions","LoanTransactionsReportInfo","Payment","PeriodUnit","RecordRef","RecordRefIntegrationType","RecordRefRecordRefType","Report","ReportComponent","ReportComponentMeasure","ReportDimension","ReportDimensionItems","ReportError","ReportInfo","ReportItems","ReportItems1","ReportItemsLoanTransactionType","ReportMeasure","Schema","Security","SourceRef","Status","Summaries","TransactionCategory"] +__all__ = ["AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategoryLevel","AccountRef","Accounts","BankingTransactionRef","CommerceReportComponent","CommerceReportDimension","CommerceReportDimensionItems","CommerceReportError","CommerceReportMeasure","DataIntegrityAmounts","DataIntegrityByAmount","DataIntegrityByCount","DataIntegrityConnectionID","DataIntegrityDataType","DataIntegrityDates","DataIntegrityDetails","DataIntegrityMatch","DataIntegrityStatus","DataIntegrityStatusInfo","DataIntegritySummary","DataSource","Details","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedReport","EnhancedReportAccountCategory","EnhancedReportInfo","EnhancedReportReportItem","ErrorMessage","ExcelReportType","ExcelReportTypes","ExcelStatus","HalRef","IntegrityStatus","InvoiceStatus","ItemRef","LendingCustomerRef","Links","LoanRef","LoanSummary","LoanSummaryIntegrationType","LoanSummaryRecordRef","LoanSummaryRecordRefType","LoanSummaryReportInfo","LoanSummaryReportItem","LoanTransactions","LoanTransactionsReportInfo","Payment","PeriodUnit","Report","ReportComponentMeasure","ReportInfo","ReportItems","ReportItemsLoanTransactionType","Security","SourceRef","Status","Summaries","TransactionCategory"] diff --git a/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py b/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py index 243d47ba5..0b1b3b0bb 100755 --- a/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py +++ b/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py @@ -22,22 +22,22 @@ class AccountCategoriesUpdatedWebhookData: @dataclasses.dataclass class AccountCategoriesUpdatedWebhook: r"""Webhook request body for account categories updated.""" - alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alertId'), 'exclude': lambda f: f is None }}) + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" - client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('clientId'), 'exclude': lambda f: f is None }}) + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your client in Codat.""" - client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('clientName'), 'exclude': lambda f: f is None }}) + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) r"""Name of your client in Codat.""" - company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId'), 'exclude': lambda f: f is None }}) + company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[AccountCategoriesUpdatedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data'), 'exclude': lambda f: f is None }}) - data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) + data: Optional[AccountCategoriesUpdatedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for a company's data connection.""" - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" - rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ruleId'), 'exclude': lambda f: f is None }}) + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) + 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 type of rule.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/accountcategory.py b/previous-versions/assess/src/codatassess/models/shared/accountcategory.py deleted file mode 100755 index 11d6ee5f9..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/accountcategory.py +++ /dev/null @@ -1,21 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class AccountCategory: - 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.""" - 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.""" - - diff --git a/previous-versions/assess/src/codatassess/models/shared/accountcategorydeprecated.py b/previous-versions/assess/src/codatassess/models/shared/accountcategorydeprecated.py deleted file mode 100755 index da4a39296..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/accountcategorydeprecated.py +++ /dev/null @@ -1,22 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class AccountCategoryDeprecated: - 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[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) - 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.""" - - diff --git a/previous-versions/assess/src/codatassess/models/shared/accountref.py b/previous-versions/assess/src/codatassess/models/shared/accountref.py index 7b8b9b551..0de1888b6 100755 --- a/previous-versions/assess/src/codatassess/models/shared/accountref.py +++ b/previous-versions/assess/src/codatassess/models/shared/accountref.py @@ -11,10 +11,10 @@ @dataclasses.dataclass class AccountRef: - r"""An object containing account reference data.""" + r"""An account reference containing the account id and name.""" 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.""" + r"""The id of the account.""" 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.""" + r"""The name of the account.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/accounts.py b/previous-versions/assess/src/codatassess/models/shared/accounts.py index 89296e241..500f2449f 100755 --- a/previous-versions/assess/src/codatassess/models/shared/accounts.py +++ b/previous-versions/assess/src/codatassess/models/shared/accounts.py @@ -20,11 +20,11 @@ class Accounts: r"""The type of banking account, e.g. credit or debit.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ current_balance: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentBalance'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py b/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py index 299b6a543..d65d629e7 100755 --- a/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py +++ b/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py @@ -17,20 +17,20 @@ class BankingTransactionRef: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/categories.py b/previous-versions/assess/src/codatassess/models/shared/categories.py deleted file mode 100755 index 4fb66f44a..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/categories.py +++ /dev/null @@ -1,27 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class Categories: - 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.""" - detail_type_description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detailTypeDescription'), 'exclude': lambda f: f is None }}) - r"""A description of the fully categorized (to detail type) account.""" - detail_type_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detailTypeDisplayName'), 'exclude': lambda f: f is None }}) - r"""Human readable detailType display name.""" - 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.""" - subtype_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subtypeDisplayName'), 'exclude': lambda f: f is None }}) - r"""Human readable subtype display name.""" - 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.""" - - diff --git a/previous-versions/assess/src/codatassess/models/shared/categorisedaccount.py b/previous-versions/assess/src/codatassess/models/shared/categorisedaccount.py deleted file mode 100755 index c73dda73f..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/categorisedaccount.py +++ /dev/null @@ -1,22 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import accountcategorydeprecated as shared_accountcategorydeprecated -from ..shared import accountref as shared_accountref -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class CategorisedAccount: - r"""OK""" - account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) - r"""An object containing account reference data.""" - confirmed: Optional[shared_accountcategorydeprecated.AccountCategoryDeprecated] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confirmed'), 'exclude': lambda f: f is None }}) - suggested: Optional[shared_accountcategorydeprecated.AccountCategoryDeprecated] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('suggested'), 'exclude': lambda f: f is None }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/categorisedaccounts.py b/previous-versions/assess/src/codatassess/models/shared/categorisedaccounts.py deleted file mode 100755 index c0b8c6c01..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/categorisedaccounts.py +++ /dev/null @@ -1,24 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import categorisedaccount as shared_categorisedaccount -from ..shared import links as shared_links -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class CategorisedAccounts: - r"""OK""" - links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) - page_number: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageNumber') }}) - page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) - total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) - results: Optional[list[shared_categorisedaccount.CategorisedAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) - r"""A list confirmed and suggested account categories.""" - - diff --git a/previous-versions/assess/src/codatassess/models/shared/reportcomponent.py b/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py similarity index 85% rename from previous-versions/assess/src/codatassess/models/shared/reportcomponent.py rename to previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py index dd5c50b05..8dfb77da1 100755 --- a/previous-versions/assess/src/codatassess/models/shared/reportcomponent.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py @@ -11,8 +11,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ReportComponent: - components: Optional[list[ReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('components'), 'exclude': lambda f: f is None }}) +class CommerceReportComponent: + components: Optional[list[CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('components'), 'exclude': lambda f: f is None }}) dimension: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimension'), 'exclude': lambda f: f is None }}) dimension_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensionDisplayName'), 'exclude': lambda f: f is None }}) item: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('item'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/reportdimension.py b/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py similarity index 80% rename from previous-versions/assess/src/codatassess/models/shared/reportdimension.py rename to previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py index e941a2a40..2cae797c6 100755 --- a/previous-versions/assess/src/codatassess/models/shared/reportdimension.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py @@ -10,7 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ReportDimensionItems: +class CommerceReportDimensionItems: index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) @@ -19,10 +19,10 @@ class ReportDimensionItems: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ReportDimension: +class CommerceReportDimension: display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) - items: Optional[list[ReportDimensionItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) + items: Optional[list[CommerceReportDimensionItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/reporterror.py b/previous-versions/assess/src/codatassess/models/shared/commercereporterror.py similarity index 96% rename from previous-versions/assess/src/codatassess/models/shared/reporterror.py rename to previous-versions/assess/src/codatassess/models/shared/commercereporterror.py index bd8d6e8a9..87dfa7c43 100755 --- a/previous-versions/assess/src/codatassess/models/shared/reporterror.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereporterror.py @@ -10,7 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ReportError: +class CommerceReportError: details: Optional[dict[str, list[str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/reportmeasure.py b/previous-versions/assess/src/codatassess/models/shared/commercereportmeasure.py similarity index 97% rename from previous-versions/assess/src/codatassess/models/shared/reportmeasure.py rename to previous-versions/assess/src/codatassess/models/shared/commercereportmeasure.py index 25afd22fb..d726d49d2 100755 --- a/previous-versions/assess/src/codatassess/models/shared/reportmeasure.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereportmeasure.py @@ -10,7 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class ReportMeasure: +class CommerceReportMeasure: display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName'), 'exclude': lambda f: f is None }}) index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/confirmcategories.py b/previous-versions/assess/src/codatassess/models/shared/confirmcategories.py deleted file mode 100755 index 5b21e747b..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/confirmcategories.py +++ /dev/null @@ -1,38 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import accountcategory as shared_accountcategory -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from typing import Optional - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class ConfirmCategoriesCategoriesAccountRef: - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) - r"""A unique, persistent identifier for this record""" - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class ConfirmCategoriesCategories: - account_ref: Optional[ConfirmCategoriesCategoriesAccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) - confirmed: Optional[shared_accountcategory.AccountCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confirmed'), 'exclude': lambda f: f is None }}) - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class ConfirmCategories: - categories: Optional[list[ConfirmCategoriesCategories]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('categories'), 'exclude': lambda f: f is None }}) - r"""List of confirmed account categories set manually by the user.""" - - diff --git a/previous-versions/assess/src/codatassess/models/shared/confirmcategory.py b/previous-versions/assess/src/codatassess/models/shared/confirmcategory.py deleted file mode 100755 index 4747802f0..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/confirmcategory.py +++ /dev/null @@ -1,16 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import accountcategory as shared_accountcategory -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class ConfirmCategory: - confirmed: shared_accountcategory.AccountCategory = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confirmed') }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py b/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py index 1a6def4b2..55a5f425c 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py @@ -14,11 +14,11 @@ class DataIntegrityAmounts: r"""Only returned for transactions. For accounts, there is nothing returned.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ max: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('max'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py index f94844141..6ccbe6c6a 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py @@ -13,11 +13,11 @@ class DataIntegrityByAmount: currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ matched: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matched'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py index a11ebddaa..c315411e9 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py @@ -14,20 +14,20 @@ class DataIntegrityDates: r"""Only returned for transactions. For accounts, there is nothing returned.""" max_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('maxDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -35,20 +35,20 @@ class DataIntegrityDates: """ max_overlapping_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('maxOverlappingDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -56,20 +56,20 @@ class DataIntegrityDates: """ min_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('minDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -77,20 +77,20 @@ class DataIntegrityDates: """ min_overlapping_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('minOverlappingDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py index 66163cd96..4f898606d 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py @@ -18,29 +18,29 @@ class DataIntegrityDetails: r"""ID GUID representing the connection of the accounting or banking platform.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py index e2ae66781..d8d204e73 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py @@ -17,11 +17,11 @@ class DataIntegrityMatch: r"""ID GUID representing the connection of the accounting or banking platform.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py index aabca901e..4fd6be89e 100755 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py @@ -16,20 +16,20 @@ class DataIntegrityStatusInfo: r"""The current status of the most recently run matching algorithm.""" last_matched: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastMatched'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py index 49d527d19..6dab8e7e8 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import accountref as shared_accountref from ..shared import sourceref as shared_sourceref from ..shared import transactioncategory as shared_transactioncategory from codatassess import utils @@ -13,25 +14,27 @@ @dataclasses.dataclass class EnhancedCashFlowTransaction: + account_ref: Optional[shared_accountref.AccountRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountRef'), 'exclude': lambda f: f is None }}) + r"""An account reference containing the account id and name.""" amount: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'exclude': lambda f: f is None }}) r"""The bank transaction amount.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -41,6 +44,8 @@ class EnhancedCashFlowTransaction: r"""The description of the bank transaction.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""The unique identifier of the bank transaction.""" + platform_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('platformName'), 'exclude': lambda f: f is None }}) + r"""Returns the payment processor responsible for the transaction.""" source_ref: Optional[shared_sourceref.SourceRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceRef'), 'exclude': lambda f: f is None }}) r"""A source reference containing the `sourceType` object \\"Banking\\".""" transaction_category: Optional[shared_transactioncategory.TransactionCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactionCategory'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py index 8077cd641..f1fab6283 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py @@ -14,7 +14,12 @@ @dataclasses.dataclass class EnhancedCashFlowTransactions: - r"""OK""" + r"""> **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + """ data_sources: Optional[list[shared_datasource.DataSource]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSources'), 'exclude': lambda f: f is None }}) report_info: Optional[shared_reportinfo.ReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) r"""Report additional information, which is specific to Assess reports""" diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py index b2fbd356c..154f82733 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import customerref as shared_customerref from ..shared import invoicestatus as shared_invoicestatus +from ..shared import lendingcustomerref as shared_lendingcustomerref from ..shared import payment as shared_payment from codatassess import utils from dataclasses_json import Undefined, dataclass_json @@ -17,30 +17,30 @@ class EnhancedInvoiceReportItem: amount_due: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amountDue'), 'exclude': lambda f: f is None }}) currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - customer_ref: Optional[shared_customerref.CustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) + customer_ref: Optional[shared_lendingcustomerref.LendingCustomerRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerRef'), 'exclude': lambda f: f is None }}) due_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -51,20 +51,20 @@ class EnhancedInvoiceReportItem: invoice_number: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoiceNumber'), 'exclude': lambda f: f is None }}) issue_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issueDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -73,20 +73,20 @@ class EnhancedInvoiceReportItem: modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('modifiedDate'), 'exclude': lambda f: f is None }}) paid_on_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('paidOnDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. @@ -96,7 +96,7 @@ class EnhancedInvoiceReportItem: source_modified_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is None }}) status: Optional[shared_invoicestatus.InvoiceStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Current state of the invoice: - + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount). - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount). diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py index b2abf53af..03f2ed2b6 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py @@ -9,15 +9,6 @@ from typing import Optional -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class EnhancedInvoicesReportReportItems: - invoices: Optional[list[shared_enhancedinvoicereportitem.EnhancedInvoiceReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('invoices'), 'exclude': lambda f: f is None }}) - - - - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -25,6 +16,6 @@ class EnhancedInvoicesReport: r"""The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting platform have actually been paid by matching with the bank statement.""" report_info: Optional[shared_reportinfo.ReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) r"""Report additional information, which is specific to Assess reports""" - report_items: Optional[list[EnhancedInvoicesReportReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[list[shared_enhancedinvoicereportitem.EnhancedInvoiceReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py b/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py index ac26c693f..a0bede4ad 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py @@ -22,20 +22,20 @@ class EnhancedReportReportItem: r"""Balance of the account as reported on the profit and loss or Balance sheet.""" date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py b/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py index 189ac6b44..fdd6c9c81 100755 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py @@ -15,29 +15,29 @@ class EnhancedReportInfo: r"""Name of the company queried.""" currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ generated_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generatedDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/schema.py b/previous-versions/assess/src/codatassess/models/shared/errormessage.py similarity index 98% rename from previous-versions/assess/src/codatassess/models/shared/schema.py rename to previous-versions/assess/src/codatassess/models/shared/errormessage.py index 4f75cf871..71be5b431 100755 --- a/previous-versions/assess/src/codatassess/models/shared/schema.py +++ b/previous-versions/assess/src/codatassess/models/shared/errormessage.py @@ -10,7 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class Schema: +class ErrorMessage: r"""Your API request was not properly authorized.""" can_be_retried: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('canBeRetried'), 'exclude': lambda f: f is None }}) correlation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('correlationId'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py b/previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py new file mode 100755 index 000000000..f307268c4 --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py @@ -0,0 +1,11 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + +class ExcelReportTypes(str, Enum): + r"""The type of the report requested in the query string.""" + AUDIT = 'audit' + ENHANCED_FINANCIALS = 'enhancedFinancials' + ENHANCED_INVOICES = 'enhancedInvoices' + ENHANCED_CASH_FLOW = 'enhancedCashFlow' diff --git a/previous-versions/assess/src/codatassess/models/shared/excelstatus.py b/previous-versions/assess/src/codatassess/models/shared/excelstatus.py index 494abff0c..79327efd0 100755 --- a/previous-versions/assess/src/codatassess/models/shared/excelstatus.py +++ b/previous-versions/assess/src/codatassess/models/shared/excelstatus.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import excelreporttypes as shared_excelreporttypes from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -13,32 +14,39 @@ class ExcelStatus: r"""OK""" error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) + r"""Error details in case the report generation request was unsuccessful.""" file_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fileSize'), 'exclude': lambda f: f is None }}) + r"""The file size in Bytes is populated upon successful generation of the report.""" in_progress: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inProgress'), 'exclude': lambda f: f is None }}) + r"""When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.""" last_generated: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastGenerated'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ last_invocation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lastInvocationId'), 'exclude': lambda f: f is None }}) + r"""A unique ID generated for this request.""" queued: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('queued'), 'exclude': lambda f: f is None }}) - report_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportType'), 'exclude': lambda f: f is None }}) + r"""The date and time of when a successful request was queued for the most recent report.""" + report_type: Optional[shared_excelreporttypes.ExcelReportTypes] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportType'), 'exclude': lambda f: f is None }}) + r"""The type of the report requested in the query string.""" success: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('success'), 'exclude': lambda f: f is None }}) + r"""True if the requested report was successfully queued and false if the requested report was not able to be queued.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/financialmetric.py b/previous-versions/assess/src/codatassess/models/shared/financialmetric.py deleted file mode 100755 index 58f631183..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/financialmetric.py +++ /dev/null @@ -1,121 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from datetime import date -from enum import Enum -from marshmallow import fields -from typing import Optional - -class FinancialMetricErrorsType(str, Enum): - r"""Metric level error.""" - UNCATEGORIZED_ACCOUNTS = 'UncategorizedAccounts' - MISSING_INPUT_DATA = 'MissingInputData' - INPUT_DATA_ERROR = 'InputDataError' - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetricErrors: - details: Optional[dict[str, list[str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) - r"""Dictionary list outlining the missing properties or allowed values.""" - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) - r"""Description of the error.""" - type: Optional[FinancialMetricErrorsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - r"""Metric level error.""" - - - -class FinancialMetricKey(str, Enum): - UNKNOWN = 'Unknown' - EBITDA = 'EBITDA' - DEBT_SERVICE_COVERAGE_RATIO = 'DebtServiceCoverageRatio' - CURRENT_RATIO_QUICK_RATIO = 'CurrentRatio QuickRatio' - GROSS_PROFIT_MARGIN = 'GrossProfitMargin' - FIXED_CHARGE_COVERAGE_RATIO = 'FixedChargeCoverageRatio' - WORKING_CAPITAL = 'WorkingCapital' - FREE_CASH_FLOW = 'FreeCashFlow' - NET_PROFIT_MARGIN = 'NetProfitMargin' - RETURN_ON_ASSETS_RATIO = 'ReturnOnAssetsRatio' - RETURN_ON_EQUITY_RATIO = 'ReturnOnEquityRatio' - OPERATING_PROFIT_MARGIN = 'OperatingProfitMargin' - DEPT_TO_EQUITY = 'DeptToEquity' - DEBT_TO_ASSETS = 'DebtToAssets' - INTEREST_COVERAGE_RATIO = 'InterestCoverageRatio' - CASH_RATIO = 'CashRatio' - INVENTORY_TURNOVER_RATIO = 'InventoryTurnoverRatio' - ASSET_TURNOVER_RATIO = 'AssetTurnoverRatio' - WORKING_CAPITAL_TURNOVER_RATIO = 'WorkingCapitalTurnoverRatio' - DAYS_SALES_OUTSTANDING = 'DaysSalesOutstanding' - DAYS_PAYABLES_OUTSTANDING = 'DaysPayablesOutstanding' - -class FinancialMetricMetricUnit(str, Enum): - RATIO = 'Ratio' - MONEY = 'Money' - -class FinancialMetricPeriodsErrorsType(str, Enum): - r"""Period error type.""" - MISSING_ACCOUNT_DATA = 'MissingAccountData' - DATES_OUT_OF_RANGE = 'DatesOutOfRange' - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetricPeriodsErrors: - details: Optional[dict[str, list[str]]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details'), 'exclude': lambda f: f is None }}) - r"""Dictionary list outlining the missing properties or allowed values.""" - massage: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('massage'), 'exclude': lambda f: f is None }}) - r"""Description of the error.""" - type: Optional[FinancialMetricPeriodsErrorsType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - r"""Period error type.""" - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetricPeriodsInputs: - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) - r"""The name of the metric input e.g. “Current Assets”, “Capital Expenditure”.""" - value: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value'), 'exclude': lambda f: f is None }}) - r"""The positive or negative number of the input value.""" - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetricPeriods: - errors: Optional[list[FinancialMetricPeriodsErrors]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - from_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('fromDate'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - r"""The date from which the report starts.""" - inputs: Optional[list[FinancialMetricPeriodsInputs]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('inputs'), 'exclude': lambda f: f is None }}) - to_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('toDate'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'mm_field': fields.DateTime(format='iso'), 'exclude': lambda f: f is None }}) - r"""The date on which the report ends (inclusive of day).""" - value: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value'), 'exclude': lambda f: f is None }}) - r"""The top level metric value that is calculated for the specified period. - - If the system cannot calculate for that period, the value will be null. The system will still show the metric inputs. - """ - - - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetric: - errors: Optional[list[FinancialMetricErrors]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - key: Optional[FinancialMetricKey] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('key'), 'exclude': lambda f: f is None }}) - metric_unit: Optional[FinancialMetricMetricUnit] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metricUnit'), 'exclude': lambda f: f is None }}) - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is None }}) - r"""Metric name.""" - periods: Optional[list[FinancialMetricPeriods]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('periods'), 'exclude': lambda f: f is None }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/financialmetricerror.py b/previous-versions/assess/src/codatassess/models/shared/financialmetricerror.py deleted file mode 100755 index 389c373ae..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/financialmetricerror.py +++ /dev/null @@ -1,24 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Optional - -class FinancialMetricErrorType(str, Enum): - DATA_NOT_SYNCED = 'DataNotSynced' - DATA_NOT_SUPPORTED = 'DataNotSupported' - DATA_SYNC_FAILED = 'DataSyncFailed' - DATA_TYPE_NOT_ENABLED = 'DataTypeNotEnabled' - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetricError: - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is None }}) - type: Optional[FinancialMetricErrorType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/financialmetrics.py b/previous-versions/assess/src/codatassess/models/shared/financialmetrics.py deleted file mode 100755 index de8b8c0ac..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/financialmetrics.py +++ /dev/null @@ -1,37 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import financialmetric as shared_financialmetric -from ..shared import financialmetricerror as shared_financialmetricerror -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Optional - -class FinancialMetricsPeriodUnit(str, Enum): - MONTH = 'Month' - WEEK = 'Week' - DAY = 'Day' - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class FinancialMetrics: - r"""OK""" - currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) - r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - - ## Unknown currencies - - In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - - There are only a very small number of edge cases where this currency code is returned by the Codat system. - """ - errors: Optional[list[shared_financialmetricerror.FinancialMetricError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - r"""If there are no errors, an empty array is returned.""" - metrics: Optional[list[shared_financialmetric.FinancialMetric]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metrics'), 'exclude': lambda f: f is None }}) - period_unit: Optional[FinancialMetricsPeriodUnit] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('periodUnit'), 'exclude': lambda f: f is None }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py b/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py index 1f7a92626..61e70027c 100755 --- a/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py +++ b/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py @@ -5,7 +5,7 @@ class InvoiceStatus(str, Enum): r"""Current state of the invoice: - + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it (amountDue == totalAmount). - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount (0 < amountDue < totalAmount). diff --git a/previous-versions/assess/src/codatassess/models/shared/customerref.py b/previous-versions/assess/src/codatassess/models/shared/lendingcustomerref.py similarity index 96% rename from previous-versions/assess/src/codatassess/models/shared/customerref.py rename to previous-versions/assess/src/codatassess/models/shared/lendingcustomerref.py index 5dcb924a7..14bd07e8f 100755 --- a/previous-versions/assess/src/codatassess/models/shared/customerref.py +++ b/previous-versions/assess/src/codatassess/models/shared/lendingcustomerref.py @@ -10,7 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class CustomerRef: +class LendingCustomerRef: customer_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('customerName'), 'exclude': lambda f: f is None }}) r"""`customerName` from the Customer data type""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummary.py b/previous-versions/assess/src/codatassess/models/shared/loansummary.py index 8f4bf3323..5174e71e5 100755 --- a/previous-versions/assess/src/codatassess/models/shared/loansummary.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummary.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from ..shared import loansummaryreportinfo as shared_loansummaryreportinfo -from ..shared import reportitems as shared_reportitems +from ..shared import loansummaryreportitem as shared_loansummaryreportitem from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -15,7 +15,7 @@ class LoanSummary: r"""OK""" report_info: Optional[shared_loansummaryreportinfo.LoanSummaryReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[list[shared_reportitems.ReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[list[shared_loansummaryreportitem.LoanSummaryReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""Returns a summary of all loan activity for that integration type""" diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryintegrationtype.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryintegrationtype.py new file mode 100755 index 000000000..c12750849 --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryintegrationtype.py @@ -0,0 +1,10 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + +class LoanSummaryIntegrationType(str, Enum): + r"""The integration type begin referred to.""" + ACCOUNTING = 'Accounting' + BANKING = 'Banking' + COMMERCE = 'Commerce' diff --git a/previous-versions/assess/src/codatassess/models/shared/recordref.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py similarity index 51% rename from previous-versions/assess/src/codatassess/models/shared/recordref.py rename to previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py index fad4681d7..bbec9645f 100755 --- a/previous-versions/assess/src/codatassess/models/shared/recordref.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py @@ -2,35 +2,24 @@ from __future__ import annotations import dataclasses +from ..shared import loansummaryintegrationtype as shared_loansummaryintegrationtype +from ..shared import loansummaryrecordreftype as shared_loansummaryrecordreftype from codatassess import utils from dataclasses_json import Undefined, dataclass_json -from enum import Enum from typing import Optional -class RecordRefIntegrationType(str, Enum): - r"""The integration type begin referred to.""" - ACCOUNTING = 'Accounting' - BANKING = 'Banking' - COMMERCE = 'Commerce' - -class RecordRefRecordRefType(str, Enum): - r"""The datatype being referred to.""" - ACCOUNTS = 'accounts' - BANKING_ACCOUNTS = 'banking-accounts' - COMMERCE_TRANSACTIONS = 'commerce-transactions' - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class RecordRef: +class LoanSummaryRecordRef: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) r"""The dataConnectionId the object being referred to is associated with.""" id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""The id of the object being referred to.""" - integration_type: Optional[RecordRefIntegrationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType'), 'exclude': lambda f: f is None }}) + integration_type: Optional[shared_loansummaryintegrationtype.LoanSummaryIntegrationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType'), 'exclude': lambda f: f is None }}) r"""The integration type begin referred to.""" - record_ref_type: Optional[RecordRefRecordRefType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefType'), 'exclude': lambda f: f is None }}) + record_ref_type: Optional[shared_loansummaryrecordreftype.LoanSummaryRecordRefType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefType'), 'exclude': lambda f: f is None }}) r"""The datatype being referred to.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordreftype.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordreftype.py new file mode 100755 index 000000000..a52edea4c --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordreftype.py @@ -0,0 +1,10 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + +class LoanSummaryRecordRefType(str, Enum): + r"""The datatype being referred to.""" + ACCOUNTS = 'accounts' + BANKING_ACCOUNTS = 'banking-accounts' + COMMERCE_TRANSACTIONS = 'commerce-transactions' diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py index 98b59e6e9..0d9f2ba4d 100755 --- a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py @@ -15,20 +15,20 @@ class LoanSummaryReportInfo: r"""Name of the company queried.""" generated_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generatedDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py new file mode 100755 index 000000000..e4a179f4a --- /dev/null +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py @@ -0,0 +1,46 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import loansummaryrecordref as shared_loansummaryrecordref +from codatassess import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class LoanSummaryReportItem: + balance: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'exclude': lambda f: f is None }}) + r"""The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued.""" + description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) + r"""The description of the object being referred to. E.g. the account.""" + record_ref: Optional[shared_loansummaryrecordref.LoanSummaryRecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) + start_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('startDate'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + total_drawdowns: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDrawdowns'), 'exclude': lambda f: f is None }}) + r"""The total loan drawdowns.""" + total_repayments: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalRepayments'), 'exclude': lambda f: f is None }}) + r"""The total loan repayments which includes capital plus any interest.""" + + diff --git a/previous-versions/assess/src/codatassess/models/shared/loantransactions.py b/previous-versions/assess/src/codatassess/models/shared/loantransactions.py index 77171e6fe..5716353dc 100755 --- a/previous-versions/assess/src/codatassess/models/shared/loantransactions.py +++ b/previous-versions/assess/src/codatassess/models/shared/loantransactions.py @@ -3,7 +3,7 @@ from __future__ import annotations import dataclasses from ..shared import loantransactionsreportinfo as shared_loantransactionsreportinfo -from ..shared import reportitems1 as shared_reportitems1 +from ..shared import reportitems as shared_reportitems from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Any, Optional @@ -17,7 +17,7 @@ class LoanTransactions: errors: Optional[list[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) r"""If there are no errors, an empty array is returned.""" report_info: Optional[shared_loantransactionsreportinfo.LoanTransactionsReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[list[shared_reportitems1.ReportItems1]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[list[shared_reportitems.ReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""Contains object of reporting properties. The loan ref will reference a different object depending on the integration type.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/loantransactionsreportinfo.py b/previous-versions/assess/src/codatassess/models/shared/loantransactionsreportinfo.py index 50567cbd8..14a13fd6f 100755 --- a/previous-versions/assess/src/codatassess/models/shared/loantransactionsreportinfo.py +++ b/previous-versions/assess/src/codatassess/models/shared/loantransactionsreportinfo.py @@ -15,20 +15,20 @@ class LoanTransactionsReportInfo: r"""Name of the company queried.""" generated_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('generatedDate'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/payment.py b/previous-versions/assess/src/codatassess/models/shared/payment.py index 71cb7c52b..fec1d0f35 100755 --- a/previous-versions/assess/src/codatassess/models/shared/payment.py +++ b/previous-versions/assess/src/codatassess/models/shared/payment.py @@ -16,34 +16,34 @@ class Payment: banking_transaction_refs: Optional[list[shared_bankingtransactionref.BankingTransactionRef]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bankingTransactionRefs'), 'exclude': lambda f: f is None }}) currency: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currency'), 'exclude': lambda f: f is None }}) r"""The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_. - + ## Unknown currencies - + In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. - + There are only a very small number of edge cases where this currency code is returned by the Codat system. """ currency_rate: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currencyRate'), 'exclude': lambda f: f is None }}) r"""Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. - + Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. - + It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR. - + Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). - + For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places. - + ## Examples with base currency of GBP - + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) | | :--------------- | :------------- | :------------ | :------------------------- | | **USD** | $20 | 0.781 | £15.62 | | **EUR** | €20 | 0.885 | £17.70 | | **RUB** | ₽20 | 0.011 | £0.22 | - + ## Examples with base currency of USD - + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) | | :--------------- | :------------- | :------------ | :------------------------- | | **GBP** | £20 | 1.277 | $25.54 | @@ -52,20 +52,20 @@ class Payment: """ date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. diff --git a/previous-versions/assess/src/codatassess/models/shared/report.py b/previous-versions/assess/src/codatassess/models/shared/report.py index 788bcb3e5..4356eeeaa 100755 --- a/previous-versions/assess/src/codatassess/models/shared/report.py +++ b/previous-versions/assess/src/codatassess/models/shared/report.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import reportcomponent as shared_reportcomponent -from ..shared import reportdimension as shared_reportdimension -from ..shared import reporterror as shared_reporterror -from ..shared import reportmeasure as shared_reportmeasure +from ..shared import commercereportcomponent as shared_commercereportcomponent +from ..shared import commercereportdimension as shared_commercereportdimension +from ..shared import commercereporterror as shared_commercereporterror +from ..shared import commercereportmeasure as shared_commercereportmeasure from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -15,33 +15,52 @@ @dataclasses.dataclass class Report: - r"""Assess reports follow a consistent structure. Reports contain four sections of information: - - 1. Report definition information such as: - a. The report info (e.g. enhanced_profit_and_loss). - b. The display name of the report (e.g. Enhanced Profit and Loss). - 2. Information about the dimension contained in the reports such as: - a. The type of dimension (e.g. datetime, recordRef). - b. The display name of the dimension (e.g. Period, Category type, Category sub type). - c. The details about each item within the dimension (e.g. displayName:\"Jan 2022\", start:\"...\", end:\"...\", id:\"...\", name:\"...\"). - 3. Information about the measures contained in the report such as: - a. The display name of the measure (e.g. value of account, percentage change). - b. The type of the measure (e.g. currency, percentage). - c. The unit of the measure (e.g. %, GBP). - 4. The data for the report. When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. - + r"""## Structure + + Assess reports follow a consistent structure. Reports contain four sections of information: + + ### 1. Report definition + + Information such as: + + 1. The report info (e.g. enhanced_profit_and_loss). + 2. The display name of the report (e.g. Enhanced Profit and Loss). + + ### 2. Dimension info + + Information about the dimension contained in the reports such as: + + 1. The type of dimension (e.g. datetime, recordRef). + 2. The display name of the dimension (e.g. Period, Category type, Category sub type). + 3. The details about each item within the dimension (e.g. displayName:\"Jan 2022\", start:\"...\", end:\"...\", id:\"...\", name:\"...\"). + + ### 3. Measure info + + Information about the measures contained in the report such as: + + 1. The display name of the measure (e.g. value of account, percentage change). + 2. The type of the measure (e.g. currency, percentage). + 3. The unit of the measure (e.g. %, GBP). + + ### 4. The data for the report + + When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. + + + ## Displaying the report + Reports can be rendered as follows (ordering is implicit rather than explicit): - + ![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png) - + # Data model - + ## Dimensions """ - dimensions: Optional[list[shared_reportdimension.ReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) - errors: Optional[list[shared_reporterror.ReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) - measures: Optional[list[shared_reportmeasure.ReportMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) - report_data: Optional[list[shared_reportcomponent.ReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportData'), 'exclude': lambda f: f is None }}) + dimensions: Optional[list[shared_commercereportdimension.CommerceReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) + errors: Optional[list[shared_commercereporterror.CommerceReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) + measures: Optional[list[shared_commercereportmeasure.CommerceReportMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) + report_data: Optional[list[shared_commercereportcomponent.CommerceReportComponent]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportData'), 'exclude': lambda f: f is None }}) report_info: Optional[dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/reportitems.py b/previous-versions/assess/src/codatassess/models/shared/reportitems.py index 246213e7a..508e74a1f 100755 --- a/previous-versions/assess/src/codatassess/models/shared/reportitems.py +++ b/previous-versions/assess/src/codatassess/models/shared/reportitems.py @@ -2,45 +2,49 @@ from __future__ import annotations import dataclasses -from ..shared import recordref as shared_recordref +from ..shared import itemref as shared_itemref +from ..shared import loanref as shared_loanref from codatassess import utils from dataclasses_json import Undefined, dataclass_json +from enum import Enum from typing import Optional +class ReportItemsLoanTransactionType(str, Enum): + INVESTMENT = 'Investment' + REPAYMENT = 'Repayment' + INTEREST = 'Interest' + ACCURED_INTEREST = 'AccuredInterest' + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class ReportItems: - balance: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('balance'), 'exclude': lambda f: f is None }}) - r"""The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued.""" - description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) - r"""The description of the object being referred to. E.g. the account.""" - record_ref: Optional[shared_recordref.RecordRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) - start_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('startDate'), 'exclude': lambda f: f is None }}) + amount: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'exclude': lambda f: f is None }}) + r"""The loan transaction amount.""" + date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - + ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` - - - + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` - + > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ - total_drawdowns: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalDrawdowns'), 'exclude': lambda f: f is None }}) - r"""The total loan drawdowns.""" - total_repayments: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalRepayments'), 'exclude': lambda f: f is None }}) - r"""The total loan repayments which includes capital plus any interest.""" + item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) + loan_ref: Optional[shared_loanref.LoanRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanRef'), 'exclude': lambda f: f is None }}) + loan_transaction_type: Optional[ReportItemsLoanTransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanTransactionType'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/reportitems1.py b/previous-versions/assess/src/codatassess/models/shared/reportitems1.py deleted file mode 100755 index bde797ab2..000000000 --- a/previous-versions/assess/src/codatassess/models/shared/reportitems1.py +++ /dev/null @@ -1,50 +0,0 @@ -"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" - -from __future__ import annotations -import dataclasses -from ..shared import itemref as shared_itemref -from ..shared import loanref as shared_loanref -from codatassess import utils -from dataclasses_json import Undefined, dataclass_json -from enum import Enum -from typing import Optional - -class ReportItemsLoanTransactionType(str, Enum): - INVESTMENT = 'Investment' - REPAYMENT = 'Repayment' - INTEREST = 'Interest' - ACCURED_INTEREST = 'AccuredInterest' - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class ReportItems1: - amount: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'exclude': lambda f: f is None }}) - r"""The loan transaction amount.""" - date_: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date'), 'exclude': lambda f: f is None }}) - r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: - - ``` - 2020-10-08T22:40:50Z - 2021-01-01T00:00:00 - ``` - - - - When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - - - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - - Unqualified local time: `2021-11-15T01:00:00` - - UTC time offsets: `2021-11-15T01:00:00-05:00` - - > Time zones - > - > Not all dates from Codat will contain information about time zones. - > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. - """ - item_ref: Optional[shared_itemref.ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) - loan_ref: Optional[shared_loanref.LoanRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanRef'), 'exclude': lambda f: f is None }}) - loan_transaction_type: Optional[ReportItemsLoanTransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanTransactionType'), 'exclude': lambda f: f is None }}) - - diff --git a/previous-versions/assess/src/codatassess/models/shared/sourceref.py b/previous-versions/assess/src/codatassess/models/shared/sourceref.py index aee917b8d..ebedbbd4a 100755 --- a/previous-versions/assess/src/codatassess/models/shared/sourceref.py +++ b/previous-versions/assess/src/codatassess/models/shared/sourceref.py @@ -13,5 +13,6 @@ class SourceRef: r"""A source reference containing the `sourceType` object \\"Banking\\".""" source_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType'), 'exclude': lambda f: f is None }}) + r"""The data source type.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py b/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py index 79093d821..659a8b861 100755 --- a/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py +++ b/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py @@ -12,8 +12,8 @@ @dataclasses.dataclass class TransactionCategory: confidence: Optional[float] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('confidence'), 'exclude': lambda f: f is None }}) - r"""Returns the confidence of the suggested category for the transaction.""" + r"""Returns the confidence of the suggested category for the transaction. The value is between 0 and 100.""" levels: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) - r"""An array of category levels against an individual transaction.""" + r"""The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level).""" diff --git a/previous-versions/assess/src/codatassess/reports.py b/previous-versions/assess/src/codatassess/reports.py index c3bc2ffd4..132391b61 100755 --- a/previous-versions/assess/src/codatassess/reports.py +++ b/previous-versions/assess/src/codatassess/reports.py @@ -2,11 +2,11 @@ from .sdkconfiguration import SDKConfiguration from codatassess import utils -from codatassess.models import operations, shared +from codatassess.models import errors, operations, shared from typing import Optional class Reports: - r"""Data integrity is important""" + r"""Enriched reports and analyses of financial data""" sdk_configuration: SDKConfiguration def __init__(self, sdk_config: SDKConfiguration) -> None: @@ -16,7 +16,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: def get_accounts_for_enhanced_balance_sheet(self, request: operations.GetAccountsForEnhancedBalanceSheetRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountsForEnhancedBalanceSheetResponse: r"""Get enhanced balance sheet accounts The Enhanced Balance Sheet Accounts endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. - + Codat suggests a category for each account automatically, but you can [change it](/docs/assess-categorizing-accounts-ecommerce-lending) to a more suitable one. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -24,7 +24,7 @@ def get_accounts_for_enhanced_balance_sheet(self, request: operations.GetAccount url = utils.generate_url(operations.GetAccountsForEnhancedBalanceSheetRequest, base_url, '/companies/{companyId}/reports/enhancedBalanceSheet/accounts', request) headers = {} query_params = utils.get_query_params(operations.GetAccountsForEnhancedBalanceSheetRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -49,10 +49,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EnhancedReport]) res.enhanced_report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -60,7 +64,7 @@ def do_request(): def get_accounts_for_enhanced_profit_and_loss(self, request: operations.GetAccountsForEnhancedProfitAndLossRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetAccountsForEnhancedProfitAndLossResponse: r"""Get enhanced profit and loss accounts The Enhanced Profit and Loss Accounts endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss. It also includes a balance per the financial statement date. - + Codat suggests a category for each account automatically, but you can [change it](/docs/assess-categorizing-accounts-ecommerce-lending) to a more suitable one. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -68,7 +72,7 @@ def get_accounts_for_enhanced_profit_and_loss(self, request: operations.GetAccou url = utils.generate_url(operations.GetAccountsForEnhancedProfitAndLossRequest, base_url, '/companies/{companyId}/reports/enhancedProfitAndLoss/accounts', request) headers = {} query_params = utils.get_query_params(operations.GetAccountsForEnhancedProfitAndLossRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -93,10 +97,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EnhancedReport]) res.enhanced_report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -110,7 +118,7 @@ def get_commerce_customer_retention_metrics(self, request: operations.GetCommerc url = utils.generate_url(operations.GetCommerceCustomerRetentionMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention', request) headers = {} query_params = utils.get_query_params(operations.GetCommerceCustomerRetentionMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -135,10 +143,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -152,7 +164,7 @@ def get_commerce_lifetime_value_metrics(self, request: operations.GetCommerceLif url = utils.generate_url(operations.GetCommerceLifetimeValueMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue', request) headers = {} query_params = utils.get_query_params(operations.GetCommerceLifetimeValueMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -177,10 +189,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -194,7 +210,7 @@ def get_commerce_orders_metrics(self, request: operations.GetCommerceOrdersMetri url = utils.generate_url(operations.GetCommerceOrdersMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders', request) headers = {} query_params = utils.get_query_params(operations.GetCommerceOrdersMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -219,10 +235,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -236,7 +256,7 @@ def get_commerce_refunds_metrics(self, request: operations.GetCommerceRefundsMet url = utils.generate_url(operations.GetCommerceRefundsMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds', request) headers = {} query_params = utils.get_query_params(operations.GetCommerceRefundsMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -261,10 +281,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -278,7 +302,7 @@ def get_commerce_revenue_metrics(self, request: operations.GetCommerceRevenueMet url = utils.generate_url(operations.GetCommerceRevenueMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue', request) headers = {} query_params = utils.get_query_params(operations.GetCommerceRevenueMetricsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -303,54 +327,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out - - return res - - - def get_enhanced_balance_sheet(self, request: operations.GetEnhancedBalanceSheetRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetEnhancedBalanceSheetResponse: - r"""Get enhanced balance sheet report - Gets a fully categorized balance sheet statement for a given company, over one or more period(s). - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetEnhancedBalanceSheetRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/enhancedBalanceSheet', request) - headers = {} - query_params = utils.get_query_params(operations.GetEnhancedBalanceSheetRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, params=query_params, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetEnhancedBalanceSheetResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) - res.report = out - elif http_res.status_code in [401, 404]: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -360,7 +344,7 @@ def get_enhanced_cash_flow_transactions(self, request: operations.GetEnhancedCas > **Categorization engine** > > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. - + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. """ base_url = utils.template_url(*self.sdk_configuration.get_server_details()) @@ -368,7 +352,7 @@ def get_enhanced_cash_flow_transactions(self, request: operations.GetEnhancedCas url = utils.generate_url(operations.GetEnhancedCashFlowTransactionsRequest, base_url, '/companies/{companyId}/reports/enhancedCashFlow/transactions', request) headers = {} query_params = utils.get_query_params(operations.GetEnhancedCashFlowTransactionsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -393,50 +377,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EnhancedCashFlowTransactions]) res.enhanced_cash_flow_transactions = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out - - return res - - - def get_enhanced_financial_metrics(self, request: operations.GetEnhancedFinancialMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetEnhancedFinancialMetricsResponse: - r"""List financial metrics - Gets all the available financial metrics for a given company, over one or more periods. - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetEnhancedFinancialMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/financialMetrics', request) - headers = {} - query_params = utils.get_query_params(operations.GetEnhancedFinancialMetricsRequest, request) - headers['Accept'] = 'application/json' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, params=query_params, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetEnhancedFinancialMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.FinancialMetrics]) - res.financial_metrics = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -450,7 +398,7 @@ def get_enhanced_invoices_report(self, request: operations.GetEnhancedInvoicesRe url = utils.generate_url(operations.GetEnhancedInvoicesReportRequest, base_url, '/companies/{companyId}/reports/enhancedInvoices', request) headers = {} query_params = utils.get_query_params(operations.GetEnhancedInvoicesReportRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -475,54 +423,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.EnhancedInvoicesReport]) res.enhanced_invoices_report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out - - return res - - - def get_enhanced_profit_and_loss(self, request: operations.GetEnhancedProfitAndLossRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetEnhancedProfitAndLossResponse: - r"""Get enhanced profit and loss report - Gets a fully categorized profit and loss statement for a given company, over one or more period(s). - - Deprecated: this method will be removed in a future release, please migrate away from it as soon as possible - """ - base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - - url = utils.generate_url(operations.GetEnhancedProfitAndLossRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/enhancedProfitAndLoss', request) - headers = {} - query_params = utils.get_query_params(operations.GetEnhancedProfitAndLossRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' - headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' - - client = self.sdk_configuration.security_client - - retry_config = retries - if retry_config is None: - retry_config = utils.RetryConfig('backoff', utils.BackoffStrategy(500, 60000, 1.5, 3600000), True) - - def do_request(): - return client.request('GET', url, params=query_params, headers=headers) - - http_res = utils.retry(do_request, utils.Retries(retry_config, [ - '408', - '429', - '5XX' - ])) - content_type = http_res.headers.get('Content-Type') - - res = operations.GetEnhancedProfitAndLossResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) - - if http_res.status_code == 200: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) - res.report = out - elif http_res.status_code in [401, 404]: - if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -531,9 +439,9 @@ def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: O r"""Get enhanced loan summaries""" base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.GetLoanSummaryRequest, base_url, '/data/companies/{companyId}/assess/reports/enhancedLiabilities/loan', request) + url = utils.generate_url(operations.GetLoanSummaryRequest, base_url, '/companies/{companyId}/reports/enhancedLiabilities/loan', request) headers = {} - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -558,10 +466,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.LoanSummary]) res.loan_summary = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -574,7 +486,7 @@ def get_recurring_revenue_metrics(self, request: operations.GetRecurringRevenueM url = utils.generate_url(operations.GetRecurringRevenueMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/mrr', request) headers = {} - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -599,10 +511,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -611,10 +527,10 @@ def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest r"""List enhanced loan transactions""" base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = utils.generate_url(operations.ListLoanTransactionsRequest, base_url, '/data/companies/{companyId}/assess/reports/enhancedLiabilities/loan/transactions', request) + url = utils.generate_url(operations.ListLoanTransactionsRequest, base_url, '/companies/{companyId}/reports/enhancedLiabilities/loan/transactions', request) headers = {} query_params = utils.get_query_params(operations.ListLoanTransactionsRequest, request) - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -639,10 +555,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.LoanTransactions]) res.loan_transactions = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res @@ -655,7 +575,7 @@ def request_recurring_revenue_metrics(self, request: operations.RequestRecurring url = utils.generate_url(operations.RequestRecurringRevenueMetricsRequest, base_url, '/data/companies/{companyId}/connections/{connectionId}/assess/subscriptions/process', request) headers = {} - headers['Accept'] = 'application/json;q=1, application/json;q=0' + headers['Accept'] = 'application/json' headers['user-agent'] = f'speakeasy-sdk/{self.sdk_configuration.language} {self.sdk_configuration.sdk_version} {self.sdk_configuration.gen_version} {self.sdk_configuration.openapi_doc_version}' client = self.sdk_configuration.security_client @@ -680,10 +600,14 @@ def do_request(): if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.Report]) res.report = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) elif http_res.status_code in [401, 404]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.Schema]) - res.schema = out + out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) + res.error_message = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/previous-versions/assess/src/codatassess/sdk.py b/previous-versions/assess/src/codatassess/sdk.py index 1e4ecfa6b..c205695bb 100755 --- a/previous-versions/assess/src/codatassess/sdk.py +++ b/previous-versions/assess/src/codatassess/sdk.py @@ -1,7 +1,6 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" import requests as requests_http -from .categories import Categories from .data_integrity import DataIntegrity from .excel_reports import ExcelReports from .reports import Reports @@ -11,20 +10,18 @@ class CodatAssess: r"""Assess API: Codat's financial insights API - 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/) - + Check that you have enabled the [data types required by Assess](https://docs.codat.io/assess/get-started#prerequisites) for all of its features to work. + + [Read more...](https://www.docs.codat.io/assess/) + [See our OpenAPI spec](https://github.com/codatio/oas) """ - categories: Categories - r"""Categorisation""" data_integrity: DataIntegrity - r"""Data integrity is important""" + r"""Match mutable accounting data with immutable banking data to increase confidence in financial data""" excel_reports: ExcelReports r"""Downloadable reports""" reports: Reports - r"""Data integrity is important""" + r"""Enriched reports and analyses of financial data""" sdk_configuration: SDKConfiguration @@ -62,7 +59,6 @@ def __init__(self, self._init_sdks() def _init_sdks(self): - self.categories = Categories(self.sdk_configuration) self.data_integrity = DataIntegrity(self.sdk_configuration) self.excel_reports = ExcelReports(self.sdk_configuration) self.reports = Reports(self.sdk_configuration) diff --git a/previous-versions/assess/src/codatassess/sdkconfiguration.py b/previous-versions/assess/src/codatassess/sdkconfiguration.py index 40ca75de8..3bd2d4167 100755 --- a/previous-versions/assess/src/codatassess/sdkconfiguration.py +++ b/previous-versions/assess/src/codatassess/sdkconfiguration.py @@ -18,8 +18,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0' - sdk_version: str = '0.31.1' - gen_version: str = '2.58.0' + sdk_version: str = '0.1.0' + gen_version: str = '2.91.4' def get_server_details(self) -> tuple[str, dict[str, str]]: if self.server_url: diff --git a/previous-versions/assess/src/codatassess/utils/utils.py b/previous-versions/assess/src/codatassess/utils/utils.py index 6b39ecf74..ea9792d0d 100755 --- a/previous-versions/assess/src/codatassess/utils/utils.py +++ b/previous-versions/assess/src/codatassess/utils/utils.py @@ -675,10 +675,13 @@ def _serialize_header(explode: bool, obj: any) -> str: def unmarshal_json(data, typ): - unmarhsal = make_dataclass('Unmarhsal', [('res', typ)], + unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) - out = unmarhsal.from_dict({"res": json_dict}) + try: + out = unmarshal.from_dict({"res": json_dict}) + except AttributeError as attr_err: + raise AttributeError(f'unable to unmarshal {data} as {typ}') from attr_err return out.res