diff --git a/previous-versions/assess/.gitattributes b/previous-versions/assess/.gitattributes old mode 100755 new mode 100644 diff --git a/previous-versions/assess/README.md b/previous-versions/assess/README.md index d496550f5..c03aeaa7a 100644 --- a/previous-versions/assess/README.md +++ b/previous-versions/assess/README.md @@ -7,57 +7,44 @@ You can use that data for automating decisioning and surfacing new insights on t Assess helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from the operating systems they are already using. You can use that data for automating decisioning and surfacing new insights on the customer, all via one API. - + ## SDK Installation ```bash pip install codat-assess ``` - + ## Example Usage - + +## SDK Example Usage + +### Example + ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", ) -req = operations.ListDataTypeDataIntegrityDetailsRequest( +req = operations.GenerateLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, - order_by='-modifiedDate', - page=1, - page_size=100, + source_type=operations.SourceType.ACCOUNTING, ) -res = s.data_integrity.details(req) +res = s.reports.generate_loan_summary(req) -if res.details is not None: +if res.status_code == 200: # handle response pass ``` - + - + ## Available Resources and Operations - -### [data_integrity](docs/sdks/dataintegrity/README.md) - -* [details](docs/sdks/dataintegrity/README.md#details) - List data type data integrity -* [status](docs/sdks/dataintegrity/README.md#status) - Get data integrity status -* [summary](docs/sdks/dataintegrity/README.md#summary) - Get data integrity summary - -### [excel_reports](docs/sdks/excelreports/README.md) - -* [generate_excel_report](docs/sdks/excelreports/README.md#generate_excel_report) - Generate Excel report -* [get_accounting_marketing_metrics](docs/sdks/excelreports/README.md#get_accounting_marketing_metrics) - Get marketing metrics report -* [get_excel_report](docs/sdks/excelreports/README.md#get_excel_report) - Download Excel report -* [get_excel_report_generation_status](docs/sdks/excelreports/README.md#get_excel_report_generation_status) - Get Excel report status - ### [reports](docs/sdks/reports/README.md) * [generate_loan_summary](docs/sdks/reports/README.md#generate_loan_summary) - Generate loan summaries report @@ -75,15 +62,224 @@ if res.details is not None: * [get_recurring_revenue_metrics](docs/sdks/reports/README.md#get_recurring_revenue_metrics) - Get key subscription revenue metrics * [list_loan_transactions](docs/sdks/reports/README.md#list_loan_transactions) - List loan transactions * [request_recurring_revenue_metrics](docs/sdks/reports/README.md#request_recurring_revenue_metrics) - Generate key subscription revenue metrics - +### [data_integrity](docs/sdks/dataintegrity/README.md) + +* [details](docs/sdks/dataintegrity/README.md#details) - List data type data integrity +* [status](docs/sdks/dataintegrity/README.md#status) - Get data integrity status +* [summary](docs/sdks/dataintegrity/README.md#summary) - Get data integrity summary + +### [excel_reports](docs/sdks/excelreports/README.md) + +* [generate_excel_report](docs/sdks/excelreports/README.md#generate_excel_report) - Generate Excel report +* [get_accounting_marketing_metrics](docs/sdks/excelreports/README.md#get_accounting_marketing_metrics) - Get marketing metrics report +* [get_excel_report](docs/sdks/excelreports/README.md#get_excel_report) - Download Excel report +* [get_excel_report_generation_status](docs/sdks/excelreports/README.md#get_excel_report_generation_status) - Get Excel report status + + + + + +## Retries + +Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. + +To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: +```python +import codatassess +from codatassess.models import operations +from codatassess.utils import BackoffStrategy, RetryConfig + +s = codatassess.CodatAssess( + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) + +res = s.reports.generate_loan_summary(req, + RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)) + +if res.status_code == 200: + # handle response + pass +``` - +If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: +```python +import codatassess +from codatassess.models import operations +from codatassess.utils import BackoffStrategy, RetryConfig +s = codatassess.CodatAssess( + retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False) + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) - +res = s.reports.generate_loan_summary(req) + +if res.status_code == 200: + # handle response + pass +``` + + + +## Error Handling + +Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type. + +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | + +### Example + +```python +import codatassess +from codatassess.models import operations + +s = codatassess.CodatAssess( + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) + +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) + +res = None +try: + res = s.reports.generate_loan_summary(req) +except errors.ErrorMessage as e: + print(e) # handle exception + raise(e) +except errors.SDKError as e: + print(e) # handle exception + raise(e) + +if res.status_code == 200: + # handle response + pass +``` + + + +## Server Selection + +### Select Server by Index + +You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: + +| # | Server | Variables | +| - | ------ | --------- | +| 0 | `https://api.codat.io` | None | + +#### Example + +```python +import codatassess +from codatassess.models import operations + +s = codatassess.CodatAssess( + server_idx=0, + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) + +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) + +res = s.reports.generate_loan_summary(req) + +if res.status_code == 200: + # handle response + pass +``` + + +### Override Server URL Per-Client + +The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: +```python +import codatassess +from codatassess.models import operations + +s = codatassess.CodatAssess( + server_url="https://api.codat.io", + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) + +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) + +res = s.reports.generate_loan_summary(req) + +if res.status_code == 200: + # handle response + pass +``` + + + +## Custom HTTP Client + +The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. + +For example, you could specify a header for every request that this sdk makes as follows: +```python +import codatassess +import requests + +http_client = requests.Session() +http_client.headers.update({'x-custom-header': 'someValue'}) +s = codatassess.CodatAssess(client: http_client) +``` + + + +## Authentication + +### Per-Client Security Schemes + +This SDK supports the following security scheme globally: + +| Name | Type | Scheme | +| ------------- | ------------- | ------------- | +| `auth_header` | apiKey | API key | + +To authenticate with the API the `auth_header` parameter must be set when initializing the SDK client instance. For example: +```python +import codatassess +from codatassess.models import operations + +s = codatassess.CodatAssess( + auth_header="Basic BASE_64_ENCODED(API_KEY)", +) + +req = operations.GenerateLoanSummaryRequest( + company_id='8a210b68-6988-11ed-a1eb-0242ac120002', + source_type=operations.SourceType.ACCOUNTING, +) + +res = s.reports.generate_loan_summary(req) + +if res.status_code == 200: + # handle response + pass +``` + diff --git a/previous-versions/assess/RELEASES.md b/previous-versions/assess/RELEASES.md index 62564aa54..4cc140cdd 100644 --- a/previous-versions/assess/RELEASES.md +++ b/previous-versions/assess/RELEASES.md @@ -8,4 +8,14 @@ Based on: ### Generated - [python v0.32.0] previous-versions/assess ### Releases -- [PyPI v0.32.0] https://pypi.org/project/codat-assess/0.32.0 - previous-versions/assess \ No newline at end of file +- [PyPI v0.32.0] https://pypi.org/project/codat-assess/0.32.0 - previous-versions/assess + +## 2023-12-14 14:07:06 +### Changes +Based on: +- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml +- Speakeasy CLI 1.126.3 (2.214.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.33.0] previous-versions/assess +### Releases +- [PyPI v0.33.0] https://pypi.org/project/codat-assess/0.33.0 - previous-versions/assess \ No newline at end of file diff --git a/previous-versions/assess/USAGE.md b/previous-versions/assess/USAGE.md old mode 100755 new mode 100644 index ef762c1db..c6bd74f61 --- a/previous-versions/assess/USAGE.md +++ b/previous-versions/assess/USAGE.md @@ -1,26 +1,21 @@ - - - + ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", ) -req = operations.ListDataTypeDataIntegrityDetailsRequest( +req = operations.GenerateLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS, - order_by='-modifiedDate', - page=1, - page_size=100, + source_type=operations.SourceType.ACCOUNTING, ) -res = s.data_integrity.details(req) +res = s.reports.generate_loan_summary(req) -if res.details is not None: +if res.status_code == 200: # handle response pass ``` - \ No newline at end of file + \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/errormessage.md b/previous-versions/assess/docs/models/errors/errormessage.md old mode 100755 new mode 100644 similarity index 98% rename from previous-versions/assess/docs/models/shared/errormessage.md rename to previous-versions/assess/docs/models/errors/errormessage.md index 2d1289c0d..fb7116941 --- a/previous-versions/assess/docs/models/shared/errormessage.md +++ b/previous-versions/assess/docs/models/errors/errormessage.md @@ -1,5 +1,7 @@ # ErrorMessage +Your `query` parameter was not correctly formed + ## Fields diff --git a/previous-versions/assess/docs/models/operations/generateexcelreportrequest.md b/previous-versions/assess/docs/models/operations/generateexcelreportrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md b/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md old mode 100755 new mode 100644 index 0d700555e..09b9c1a14 --- a/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md +++ b/previous-versions/assess/docs/models/operations/generateexcelreportresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateloansummaryrequest.md b/previous-versions/assess/docs/models/operations/generateloansummaryrequest.md old mode 100755 new mode 100644 index c5ce041fe..ba321529b --- a/previous-versions/assess/docs/models/operations/generateloansummaryrequest.md +++ b/previous-versions/assess/docs/models/operations/generateloansummaryrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `source_type` | [GenerateLoanSummarySourceType](../../models/operations/generateloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.SourceType](../../models/operations/sourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateloansummaryresponse.md b/previous-versions/assess/docs/models/operations/generateloansummaryresponse.md old mode 100755 new mode 100644 index fa984829f..d379473ef --- a/previous-versions/assess/docs/models/operations/generateloansummaryresponse.md +++ b/previous-versions/assess/docs/models/operations/generateloansummaryresponse.md @@ -6,6 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md b/previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md old mode 100755 new mode 100644 index 0dd5363c6..8272d16a7 --- a/previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md +++ b/previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `source_type` | [GenerateLoanTransactionsSourceType](../../models/operations/generateloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.QueryParamSourceType](../../models/operations/queryparamsourcetype.md) | :heavy_check_mark: | Data source type | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateloantransactionsresponse.md b/previous-versions/assess/docs/models/operations/generateloantransactionsresponse.md old mode 100755 new mode 100644 index 7c9dc16a4..f6fd0707c --- a/previous-versions/assess/docs/models/operations/generateloantransactionsresponse.md +++ b/previous-versions/assess/docs/models/operations/generateloantransactionsresponse.md @@ -6,6 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsrequest.md b/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md b/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md old mode 100755 new mode 100644 index c3461bc2e..ed54ce887 --- a/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountingmarketingmetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetrequest.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md old mode 100755 new mode 100644 index a112ff8bf..34e8e8ae8 --- a/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountsforenhancedbalancesheetresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossrequest.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md b/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md old mode 100755 new mode 100644 index 4fb2075e4..bd80b0e61 --- a/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md +++ b/previous-versions/assess/docs/models/operations/getaccountsforenhancedprofitandlossresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsrequest.md b/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md old mode 100755 new mode 100644 index d00974730..09c6bc879 --- a/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercecustomerretentionmetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsrequest.md b/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md old mode 100755 new mode 100644 index 16c7194ce..14f979ea9 --- a/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercelifetimevaluemetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommerceordersmetricsrequest.md b/previous-versions/assess/docs/models/operations/getcommerceordersmetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md old mode 100755 new mode 100644 index be378eff2..e9e3541f8 --- a/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommerceordersmetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsrequest.md b/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md old mode 100755 new mode 100644 index 77f11e1ba..71162895e --- a/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercerefundsmetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsrequest.md b/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md old mode 100755 new mode 100644 index a9649ac1b..b1cc8e33a --- a/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getcommercerevenuemetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getdataintegritystatusrequest.md b/previous-versions/assess/docs/models/operations/getdataintegritystatusrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md b/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md old mode 100755 new mode 100644 index a58789938..a2f89bda8 --- a/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md +++ b/previous-versions/assess/docs/models/operations/getdataintegritystatusresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getdataintegritysummariesrequest.md b/previous-versions/assess/docs/models/operations/getdataintegritysummariesrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md b/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md old mode 100755 new mode 100644 index 6a14571b7..cc2d15189 --- a/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md +++ b/previous-versions/assess/docs/models/operations/getdataintegritysummariesresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | `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/getenhancedcashflowtransactionsrequest.md b/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md b/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md old mode 100755 new mode 100644 index 51f918be7..eb1a62e99 --- a/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md +++ b/previous-versions/assess/docs/models/operations/getenhancedcashflowtransactionsresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportrequest.md b/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md b/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md old mode 100755 new mode 100644 index 60144b257..b2d9319ae --- a/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md +++ b/previous-versions/assess/docs/models/operations/getenhancedinvoicesreportresponse.md @@ -7,6 +7,5 @@ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusrequest.md b/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md b/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md old mode 100755 new mode 100644 index ba144607b..de9e6035a --- a/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md +++ b/previous-versions/assess/docs/models/operations/getexcelreportgenerationstatusresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getexcelreportrequest.md b/previous-versions/assess/docs/models/operations/getexcelreportrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getexcelreportresponse.md b/previous-versions/assess/docs/models/operations/getexcelreportresponse.md old mode 100755 new mode 100644 index 32ffdaff8..bace37363 --- a/previous-versions/assess/docs/models/operations/getexcelreportresponse.md +++ b/previous-versions/assess/docs/models/operations/getexcelreportresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `body` | *Optional[bytes]* | :heavy_minus_sign: | N/A | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getexcelreport200applicationoctetstream.md b/previous-versions/assess/docs/models/operations/getexcelreportresponsebody.md old mode 100755 new mode 100644 similarity index 75% rename from previous-versions/assess/docs/models/operations/getexcelreport200applicationoctetstream.md rename to previous-versions/assess/docs/models/operations/getexcelreportresponsebody.md index a47e5b05c..207011a2b --- a/previous-versions/assess/docs/models/operations/getexcelreport200applicationoctetstream.md +++ b/previous-versions/assess/docs/models/operations/getexcelreportresponsebody.md @@ -1,4 +1,4 @@ -# GetExcelReport200ApplicationOctetStream +# GetExcelReportResponseBody OK diff --git a/previous-versions/assess/docs/models/operations/generateloansummarysourcetype.md b/previous-versions/assess/docs/models/operations/getloansummaryqueryparamsourcetype.md old mode 100755 new mode 100644 similarity index 83% rename from previous-versions/assess/docs/models/operations/generateloansummarysourcetype.md rename to previous-versions/assess/docs/models/operations/getloansummaryqueryparamsourcetype.md index 1fb8dfad0..812ff102e --- a/previous-versions/assess/docs/models/operations/generateloansummarysourcetype.md +++ b/previous-versions/assess/docs/models/operations/getloansummaryqueryparamsourcetype.md @@ -1,4 +1,4 @@ -# GenerateLoanSummarySourceType +# GetLoanSummaryQueryParamSourceType Data source type. diff --git a/previous-versions/assess/docs/models/operations/getloansummaryrequest.md b/previous-versions/assess/docs/models/operations/getloansummaryrequest.md old mode 100755 new mode 100644 index 655f0cca8..b2624e65c --- a/previous-versions/assess/docs/models/operations/getloansummaryrequest.md +++ b/previous-versions/assess/docs/models/operations/getloansummaryrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `source_type` | [GetLoanSummarySourceType](../../models/operations/getloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.GetLoanSummaryQueryParamSourceType](../../models/operations/getloansummaryqueryparamsourcetype.md) | :heavy_check_mark: | Data source type. | | \ 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 old mode 100755 new mode 100644 index b007d1c19..73ef54be6 --- a/previous-versions/assess/docs/models/operations/getloansummaryresponse.md +++ b/previous-versions/assess/docs/models/operations/getloansummaryresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsrequest.md b/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md old mode 100755 new mode 100644 index 8daee3e2b..98a860013 --- a/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/getrecurringrevenuemetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsrequest.md b/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md b/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md old mode 100755 new mode 100644 index 775f0d033..61b681f79 --- a/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md +++ b/previous-versions/assess/docs/models/operations/listdatatypedataintegritydetailsresponse.md @@ -7,6 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/generateloantransactionssourcetype.md b/previous-versions/assess/docs/models/operations/listloantransactionsqueryparamsourcetype.md old mode 100755 new mode 100644 similarity index 81% rename from previous-versions/assess/docs/models/operations/generateloantransactionssourcetype.md rename to previous-versions/assess/docs/models/operations/listloantransactionsqueryparamsourcetype.md index c9709caf0..85944dc61 --- a/previous-versions/assess/docs/models/operations/generateloantransactionssourcetype.md +++ b/previous-versions/assess/docs/models/operations/listloantransactionsqueryparamsourcetype.md @@ -1,4 +1,4 @@ -# GenerateLoanTransactionsSourceType +# ListLoanTransactionsQueryParamSourceType Data source type diff --git a/previous-versions/assess/docs/models/operations/listloantransactionsrequest.md b/previous-versions/assess/docs/models/operations/listloantransactionsrequest.md old mode 100755 new mode 100644 index aadeb390d..c02241632 --- a/previous-versions/assess/docs/models/operations/listloantransactionsrequest.md +++ b/previous-versions/assess/docs/models/operations/listloantransactionsrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `source_type` | [ListLoanTransactionsSourceType](../../models/operations/listloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `source_type` | [operations.ListLoanTransactionsQueryParamSourceType](../../models/operations/listloantransactionsqueryparamsourcetype.md) | :heavy_check_mark: | Data source type | | \ 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 old mode 100755 new mode 100644 index bf5515d58..9038ca435 --- a/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md +++ b/previous-versions/assess/docs/models/operations/listloantransactionsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/listloantransactionssourcetype.md b/previous-versions/assess/docs/models/operations/queryparamsourcetype.md old mode 100755 new mode 100644 similarity index 85% rename from previous-versions/assess/docs/models/operations/listloantransactionssourcetype.md rename to previous-versions/assess/docs/models/operations/queryparamsourcetype.md index 031dcbfc8..3443ab528 --- a/previous-versions/assess/docs/models/operations/listloantransactionssourcetype.md +++ b/previous-versions/assess/docs/models/operations/queryparamsourcetype.md @@ -1,4 +1,4 @@ -# ListLoanTransactionsSourceType +# QueryParamSourceType Data source type diff --git a/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsrequest.md b/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsrequest.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md b/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md old mode 100755 new mode 100644 index 504535eba..75b5fb3f0 --- a/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md +++ b/previous-versions/assess/docs/models/operations/requestrecurringrevenuemetricsresponse.md @@ -6,7 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `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: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/operations/getloansummarysourcetype.md b/previous-versions/assess/docs/models/operations/sourcetype.md old mode 100755 new mode 100644 similarity index 87% rename from previous-versions/assess/docs/models/operations/getloansummarysourcetype.md rename to previous-versions/assess/docs/models/operations/sourcetype.md index f6681e59c..4e702956a --- a/previous-versions/assess/docs/models/operations/getloansummarysourcetype.md +++ b/previous-versions/assess/docs/models/operations/sourcetype.md @@ -1,4 +1,4 @@ -# GetLoanSummarySourceType +# SourceType Data source type. diff --git a/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhook.md b/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhook.md old mode 100755 new mode 100644 index bbc4a17d3..b08fb3db5 --- a/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhook.md +++ b/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhook.md @@ -5,14 +5,14 @@ Webhook request body for account categories updated. ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[AccountCategoriesUpdatedWebhookData]](../../models/shared/accountcategoriesupdatedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[shared.AccountCategoriesUpdatedWebhookData]](../../models/shared/accountcategoriesupdatedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhookdata.md b/previous-versions/assess/docs/models/shared/accountcategoriesupdatedwebhookdata.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/accountcategorylevel.md b/previous-versions/assess/docs/models/shared/accountcategorylevel.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/accountref.md b/previous-versions/assess/docs/models/shared/accountref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/accounts.md b/previous-versions/assess/docs/models/shared/accounts.md old mode 100755 new mode 100644 index 3eff08838..a222ec456 --- a/previous-versions/assess/docs/models/shared/accounts.md +++ b/previous-versions/assess/docs/models/shared/accounts.md @@ -11,4 +11,4 @@ | `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 | | `current_balance` | *Optional[Decimal]* | :heavy_minus_sign: | The balance of the bank account. | | | `platform_name` | *Optional[str]* | :heavy_minus_sign: | Name of the banking data source, e.g. "Plaid". | | -| `source_ref` | [Optional[SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | \ No newline at end of file +| `source_ref` | [Optional[shared.SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/bankingtransactionref.md b/previous-versions/assess/docs/models/shared/bankingtransactionref.md old mode 100755 new mode 100644 index e721f86c1..fe0f26cf2 --- a/previous-versions/assess/docs/models/shared/bankingtransactionref.md +++ b/previous-versions/assess/docs/models/shared/bankingtransactionref.md @@ -9,6 +9,6 @@ | `account_name` | *Optional[str]* | :heavy_minus_sign: | Name given to account. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Bank transaction amount. | | | `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the bank transaction's connection. | | -| `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 | +| `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-23 00:00:00 +0000 UTC | | `description` | *Optional[str]* | :heavy_minus_sign: | Description given to bank transaction. | | | `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the bank transaction. | | \ 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 old mode 100755 new mode 100644 index bfdb6a8aa..847e22aab --- a/previous-versions/assess/docs/models/shared/commercereportcomponent.md +++ b/previous-versions/assess/docs/models/shared/commercereportcomponent.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `components` | List[[CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | -| `dimension` | *Optional[int]* | :heavy_minus_sign: | The component's dimension. | -| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's display name. | -| `item` | *Optional[int]* | :heavy_minus_sign: | The component's item number. | -| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's item display name. | -| `measures` | List[[ReportComponentMeasure](../../models/shared/reportcomponentmeasure.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `components` | List[[shared.CommerceReportComponent](../../models/shared/commercereportcomponent.md)] | :heavy_minus_sign: | N/A | +| `dimension` | *Optional[int]* | :heavy_minus_sign: | The component's dimension. | +| `dimension_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's display name. | +| `item` | *Optional[int]* | :heavy_minus_sign: | The component's item number. | +| `item_display_name` | *Optional[str]* | :heavy_minus_sign: | The component's item display name. | +| `measures` | List[[shared.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 old mode 100755 new mode 100644 index d97101c1d..40850b049 --- a/previous-versions/assess/docs/models/shared/commercereportdimension.md +++ b/previous-versions/assess/docs/models/shared/commercereportdimension.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `display_name` | *Optional[str]* | :heavy_minus_sign: | The dimension's display name. | -| `index` | *Optional[int]* | :heavy_minus_sign: | The dimension's index. | -| `items` | List[[CommerceReportDimensionItems](../../models/shared/commercereportdimensionitems.md)] | :heavy_minus_sign: | N/A | -| `type` | *Optional[str]* | :heavy_minus_sign: | The dimension's type. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | +| `display_name` | *Optional[str]* | :heavy_minus_sign: | The dimension's display name. | +| `index` | *Optional[int]* | :heavy_minus_sign: | The dimension's index. | +| `items` | List[[shared.Items](../../models/shared/items.md)] | :heavy_minus_sign: | N/A | +| `type` | *Optional[str]* | :heavy_minus_sign: | The dimension's type. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/commercereporterror.md b/previous-versions/assess/docs/models/shared/commercereporterror.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/commercereportmeasure.md b/previous-versions/assess/docs/models/shared/commercereportmeasure.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegrityamounts.md b/previous-versions/assess/docs/models/shared/dataintegrityamounts.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegritybyamount.md b/previous-versions/assess/docs/models/shared/dataintegritybyamount.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegritybycount.md b/previous-versions/assess/docs/models/shared/dataintegritybycount.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegrityconnectionid.md b/previous-versions/assess/docs/models/shared/dataintegrityconnectionid.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegritydatatype.md b/previous-versions/assess/docs/models/shared/dataintegritydatatype.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegritydates.md b/previous-versions/assess/docs/models/shared/dataintegritydates.md old mode 100755 new mode 100644 index a01a6f471..d5482018e --- a/previous-versions/assess/docs/models/shared/dataintegritydates.md +++ b/previous-versions/assess/docs/models/shared/dataintegritydates.md @@ -7,7 +7,7 @@ Only returned for transactions. For accounts, there is nothing returned. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `max_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 | -| `max_overlapping_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 | -| `min_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 | -| `min_overlapping_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 | \ No newline at end of file +| `max_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-23 00:00:00 +0000 UTC | +| `max_overlapping_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-23 00:00:00 +0000 UTC | +| `min_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-23 00:00:00 +0000 UTC | +| `min_overlapping_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-23 00:00:00 +0000 UTC | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/dataintegritydetails.md b/previous-versions/assess/docs/models/shared/dataintegritydetails.md old mode 100755 new mode 100644 index 2c4a109f8..17c620549 --- a/previous-versions/assess/docs/models/shared/dataintegritydetails.md +++ b/previous-versions/assess/docs/models/shared/dataintegritydetails.md @@ -8,8 +8,8 @@ | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The transaction value. | | | `connection_id` | *Optional[str]* | :heavy_minus_sign: | ID GUID representing the connection of the accounting or banking platform. | | | `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 | -| `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 | +| `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-23 00:00:00 +0000 UTC | | `description` | *Optional[str]* | :heavy_minus_sign: | The transaction description. | | | `id` | *Optional[str]* | :heavy_minus_sign: | ID GUID of the transaction. | | -| `matches` | List[[DataIntegrityMatch](../../models/shared/dataintegritymatch.md)] | :heavy_minus_sign: | N/A | | +| `matches` | List[[shared.DataIntegrityMatch](../../models/shared/dataintegritymatch.md)] | :heavy_minus_sign: | N/A | | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type of the record. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/dataintegritymatch.md b/previous-versions/assess/docs/models/shared/dataintegritymatch.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/dataintegritystatus.md b/previous-versions/assess/docs/models/shared/dataintegritystatus.md old mode 100755 new mode 100644 index befbf1600..6ac4104dc --- a/previous-versions/assess/docs/models/shared/dataintegritystatus.md +++ b/previous-versions/assess/docs/models/shared/dataintegritystatus.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amounts` | [Optional[DataIntegrityAmounts]](../../models/shared/dataintegrityamounts.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | -| `connection_ids` | [Optional[DataIntegrityConnectionID]](../../models/shared/dataintegrityconnectionid.md) | :heavy_minus_sign: | N/A | -| `dates` | [Optional[DataIntegrityDates]](../../models/shared/dataintegritydates.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | -| `status_info` | [Optional[DataIntegrityStatusInfo]](../../models/shared/dataintegritystatusinfo.md) | :heavy_minus_sign: | N/A | +| `amounts` | [Optional[shared.DataIntegrityAmounts]](../../models/shared/dataintegrityamounts.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | +| `connection_ids` | [Optional[shared.DataIntegrityConnectionID]](../../models/shared/dataintegrityconnectionid.md) | :heavy_minus_sign: | N/A | +| `dates` | [Optional[shared.DataIntegrityDates]](../../models/shared/dataintegritydates.md) | :heavy_minus_sign: | Only returned for transactions. For accounts, there is nothing returned. | +| `status_info` | [Optional[shared.DataIntegrityStatusInfo]](../../models/shared/dataintegritystatusinfo.md) | :heavy_minus_sign: | N/A | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/dataintegritystatusinfo.md b/previous-versions/assess/docs/models/shared/dataintegritystatusinfo.md old mode 100755 new mode 100644 index 45084df5f..5bbfa7862 --- a/previous-versions/assess/docs/models/shared/dataintegritystatusinfo.md +++ b/previous-versions/assess/docs/models/shared/dataintegritystatusinfo.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `current_status` | [Optional[IntegrityStatus]](../../models/shared/integritystatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | | -| `last_matched` | *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 | +| `current_status` | [Optional[shared.IntegrityStatus]](../../models/shared/integritystatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | | +| `last_matched` | *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-23 00:00:00 +0000 UTC | | `status_message` | *Optional[str]* | :heavy_minus_sign: | Detailed explanation supporting the status value. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/dataintegritysummary.md b/previous-versions/assess/docs/models/shared/dataintegritysummary.md old mode 100755 new mode 100644 index 7a27de5f7..6f8af88d8 --- a/previous-versions/assess/docs/models/shared/dataintegritysummary.md +++ b/previous-versions/assess/docs/models/shared/dataintegritysummary.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `by_amount` | [Optional[DataIntegrityByAmount]](../../models/shared/dataintegritybyamount.md) | :heavy_minus_sign: | N/A | -| `by_count` | [Optional[DataIntegrityByCount]](../../models/shared/dataintegritybycount.md) | :heavy_minus_sign: | N/A | +| `by_amount` | [Optional[shared.DataIntegrityByAmount]](../../models/shared/dataintegritybyamount.md) | :heavy_minus_sign: | N/A | +| `by_count` | [Optional[shared.DataIntegrityByCount]](../../models/shared/dataintegritybycount.md) | :heavy_minus_sign: | N/A | | `type` | *Optional[str]* | :heavy_minus_sign: | The data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/datasource.md b/previous-versions/assess/docs/models/shared/datasource.md old mode 100755 new mode 100644 index 2152d333c..95ec7dc64 --- a/previous-versions/assess/docs/models/shared/datasource.md +++ b/previous-versions/assess/docs/models/shared/datasource.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accounts` | List[[Accounts](../../models/shared/accounts.md)] | :heavy_minus_sign: | An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`. | \ No newline at end of file +| `accounts` | List[[shared.Accounts](../../models/shared/accounts.md)] | :heavy_minus_sign: | An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/details.md b/previous-versions/assess/docs/models/shared/details.md old mode 100755 new mode 100644 index e01c446a0..58410df04 --- a/previous-versions/assess/docs/models/shared/details.md +++ b/previous-versions/assess/docs/models/shared/details.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `links` | [Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[DataIntegrityDetails](../../models/shared/dataintegritydetails.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | +| `results` | List[[shared.DataIntegrityDetails](../../models/shared/dataintegritydetails.md)] | :heavy_minus_sign: | N/A | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedcashflowitem.md b/previous-versions/assess/docs/models/shared/enhancedcashflowitem.md old mode 100755 new mode 100644 index 99b05b723..ca307dde4 --- a/previous-versions/assess/docs/models/shared/enhancedcashflowitem.md +++ b/previous-versions/assess/docs/models/shared/enhancedcashflowitem.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `transactions` | List[[EnhancedCashFlowTransaction](../../models/shared/enhancedcashflowtransaction.md)] | :heavy_minus_sign: | An array of transaction data. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `transactions` | List[[shared.EnhancedCashFlowTransaction](../../models/shared/enhancedcashflowtransaction.md)] | :heavy_minus_sign: | An array of transaction data. | \ 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 old mode 100755 new mode 100644 index 11af4ff6e..0df2556ac --- a/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md +++ b/previous-versions/assess/docs/models/shared/enhancedcashflowtransaction.md @@ -5,12 +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. | | +| `account_ref` | [Optional[shared.AccountRef]](../../models/shared/accountref.md) | :heavy_minus_sign: | An account reference containing the account id and name. | | | `amount` | *Optional[Decimal]* | :heavy_minus_sign: | The bank transaction amount. | | | `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 | -| `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 | +| `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-23 00:00:00 +0000 UTC | | `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 +| `source_ref` | [Optional[shared.SourceRef]](../../models/shared/sourceref.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | | +| `transaction_category` | [Optional[shared.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 old mode 100755 new mode 100644 index 05a5a3682..bbc462ff4 --- a/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md +++ b/previous-versions/assess/docs/models/shared/enhancedcashflowtransactions.md @@ -9,8 +9,8 @@ The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `data_sources` | List[[DataSource](../../models/shared/datasource.md)] | :heavy_minus_sign: | N/A | -| `report_info` | [Optional[ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | -| `report_items` | List[[EnhancedCashFlowItem](../../models/shared/enhancedcashflowitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `data_sources` | List[[shared.DataSource](../../models/shared/datasource.md)] | :heavy_minus_sign: | N/A | +| `report_info` | [Optional[shared.ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[shared.EnhancedCashFlowItem](../../models/shared/enhancedcashflowitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md b/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md old mode 100755 new mode 100644 index 3047eea69..1774d62eb --- a/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md +++ b/previous-versions/assess/docs/models/shared/enhancedinvoicereportitem.md @@ -7,14 +7,14 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount_due` | *Optional[Decimal]* | :heavy_minus_sign: | Invoice's total amount due. | | | `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[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 | +| `customer_ref` | [Optional[shared.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-23 00:00:00 +0000 UTC | | `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 platform. | | | `invoice_number` | *Optional[str]* | :heavy_minus_sign: | Invoice number. | | -| `issue_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 | -| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `paid_on_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 | -| `payments` | List[[Payment](../../models/shared/payment.md)] | :heavy_minus_sign: | N/A | | -| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z | -| `status` | [Optional[InvoiceStatus]](../../models/shared/invoicestatus.md) | :heavy_minus_sign: | 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).
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | +| `issue_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-23 00:00:00 +0000 UTC | +| `modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `paid_on_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-23 00:00:00 +0000 UTC | +| `payments` | List[[shared.Payment](../../models/shared/payment.md)] | :heavy_minus_sign: | N/A | | +| `source_modified_date` | *Optional[str]* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional[shared.InvoiceStatus]](../../models/shared/invoicestatus.md) | :heavy_minus_sign: | 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).
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid (amountDue == 0).
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | | `total_amount` | *Optional[Decimal]* | :heavy_minus_sign: | Invoice's total amount. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md b/previous-versions/assess/docs/models/shared/enhancedinvoicesreport.md old mode 100755 new mode 100644 index e64964c88..24bdd5935 --- 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 Lending API reports. | -| `report_items` | List[[EnhancedInvoiceReportItem](../../models/shared/enhancedinvoicereportitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `report_info` | [Optional[shared.ReportInfo]](../../models/shared/reportinfo.md) | :heavy_minus_sign: | Report additional information, which is specific to Lending API reports. | +| `report_items` | List[[shared.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/enhancedreport.md b/previous-versions/assess/docs/models/shared/enhancedreport.md old mode 100755 new mode 100644 index b1433184d..4e1b796fe --- a/previous-versions/assess/docs/models/shared/enhancedreport.md +++ b/previous-versions/assess/docs/models/shared/enhancedreport.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `report_info` | [Optional[EnhancedReportInfo]](../../models/shared/enhancedreportinfo.md) | :heavy_minus_sign: | N/A | -| `report_items` | List[[EnhancedReportReportItem](../../models/shared/enhancedreportreportitem.md)] | :heavy_minus_sign: | An array of report items. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `report_info` | [Optional[shared.EnhancedReportInfo]](../../models/shared/enhancedreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.ReportItem](../../models/shared/reportitem.md)] | :heavy_minus_sign: | An array of report items. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedreportaccountcategory.md b/previous-versions/assess/docs/models/shared/enhancedreportaccountcategory.md old mode 100755 new mode 100644 index 5655c1db2..270b6bfa5 --- a/previous-versions/assess/docs/models/shared/enhancedreportaccountcategory.md +++ b/previous-versions/assess/docs/models/shared/enhancedreportaccountcategory.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `levels` | List[[AccountCategoryLevel](../../models/shared/accountcategorylevel.md)] | :heavy_minus_sign: | N/A | +| `levels` | List[[shared.AccountCategoryLevel](../../models/shared/accountcategorylevel.md)] | :heavy_minus_sign: | N/A | | `status` | *Optional[str]* | :heavy_minus_sign: | Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned. | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/enhancedreportinfo.md b/previous-versions/assess/docs/models/shared/enhancedreportinfo.md old mode 100755 new mode 100644 index 7b89d4b0d..df77e8564 --- a/previous-versions/assess/docs/models/shared/enhancedreportinfo.md +++ b/previous-versions/assess/docs/models/shared/enhancedreportinfo.md @@ -7,5 +7,5 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `company_name` | *Optional[str]* | :heavy_minus_sign: | Name of the company queried. | | | `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 | -| `generated_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 | +| `generated_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-23 00:00:00 +0000 UTC | | `report_name` | *Optional[str]* | :heavy_minus_sign: | The name of the report. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/excelreporttype.md b/previous-versions/assess/docs/models/shared/excelreporttype.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/excelreporttypes.md b/previous-versions/assess/docs/models/shared/excelreporttypes.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/excelstatus.md b/previous-versions/assess/docs/models/shared/excelstatus.md old mode 100755 new mode 100644 index c8486102d..ca42d6de8 --- a/previous-versions/assess/docs/models/shared/excelstatus.md +++ b/previous-versions/assess/docs/models/shared/excelstatus.md @@ -8,8 +8,8 @@ | `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_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-23 00:00:00 +0000 UTC | | `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. | | +| `report_type` | [Optional[shared.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/halref.md b/previous-versions/assess/docs/models/shared/halref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/integritystatus.md b/previous-versions/assess/docs/models/shared/integritystatus.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/invoicestatus.md b/previous-versions/assess/docs/models/shared/invoicestatus.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/itemref.md b/previous-versions/assess/docs/models/shared/itemref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/commercereportdimensionitems.md b/previous-versions/assess/docs/models/shared/items.md old mode 100755 new mode 100644 similarity index 92% rename from previous-versions/assess/docs/models/shared/commercereportdimensionitems.md rename to previous-versions/assess/docs/models/shared/items.md index 6dd2d2f97..b3d6e4714 --- a/previous-versions/assess/docs/models/shared/commercereportdimensionitems.md +++ b/previous-versions/assess/docs/models/shared/items.md @@ -1,4 +1,4 @@ -# CommerceReportDimensionItems +# Items ## Fields diff --git a/previous-versions/assess/docs/models/shared/lendingcustomerref.md b/previous-versions/assess/docs/models/shared/lendingcustomerref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/links.md b/previous-versions/assess/docs/models/shared/links.md old mode 100755 new mode 100644 index 7aad1ea5d..5f80d2652 --- a/previous-versions/assess/docs/models/shared/links.md +++ b/previous-versions/assess/docs/models/shared/links.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `current` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | -| `next` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional[HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `self_` | [HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | +| `current` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | +| `next` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `previous` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | +| `self_` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/loanref.md b/previous-versions/assess/docs/models/shared/loanref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/loansummary.md b/previous-versions/assess/docs/models/shared/loansummary.md old mode 100755 new mode 100644 index 2095b55b2..c3d0060af --- a/previous-versions/assess/docs/models/shared/loansummary.md +++ b/previous-versions/assess/docs/models/shared/loansummary.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `report_info` | [Optional[LoanSummaryReportInfo]](../../models/shared/loansummaryreportinfo.md) | :heavy_minus_sign: | N/A | -| `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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `report_info` | [Optional[shared.LoanSummaryReportInfo]](../../models/shared/loansummaryreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.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/loansummaryintegrationtype.md b/previous-versions/assess/docs/models/shared/loansummaryintegrationtype.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/loansummaryrecordref.md b/previous-versions/assess/docs/models/shared/loansummaryrecordref.md old mode 100755 new mode 100644 index 77889df21..7c201e554 --- a/previous-versions/assess/docs/models/shared/loansummaryrecordref.md +++ b/previous-versions/assess/docs/models/shared/loansummaryrecordref.md @@ -3,9 +3,9 @@ ## 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 +| 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[shared.LoanSummaryIntegrationType]](../../models/shared/loansummaryintegrationtype.md) | :heavy_minus_sign: | The integration type begin referred to. | +| `record_ref_type` | [Optional[shared.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/loansummaryrecordreftype.md b/previous-versions/assess/docs/models/shared/loansummaryrecordreftype.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/loansummaryreportinfo.md b/previous-versions/assess/docs/models/shared/loansummaryreportinfo.md old mode 100755 new mode 100644 index 5c8713ec6..4d4d4b613 --- a/previous-versions/assess/docs/models/shared/loansummaryreportinfo.md +++ b/previous-versions/assess/docs/models/shared/loansummaryreportinfo.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `company_name` | *Optional[str]* | :heavy_minus_sign: | Name of the company queried. | | -| `generated_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 | +| `generated_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-23 00:00:00 +0000 UTC | | `report_name` | *Optional[str]* | :heavy_minus_sign: | The name of the report. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/loansummaryreportitem.md b/previous-versions/assess/docs/models/shared/loansummaryreportitem.md old mode 100755 new mode 100644 index 7330021b3..af276739e --- a/previous-versions/assess/docs/models/shared/loansummaryreportitem.md +++ b/previous-versions/assess/docs/models/shared/loansummaryreportitem.md @@ -8,7 +8,7 @@ | `balance` | *Optional[Decimal]* | :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. | | | `lender_name` | *Optional[str]* | :heavy_minus_sign: | The name of lender providing the loan. | | -| `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 | +| `record_ref` | [Optional[shared.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-23 00:00:00 +0000 UTC | | `total_drawdowns` | *Optional[Decimal]* | :heavy_minus_sign: | The total loan drawdowns. | | | `total_repayments` | *Optional[Decimal]* | :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 old mode 100755 new mode 100644 index 866b23b34..d5ee58a06 --- a/previous-versions/assess/docs/models/shared/loantransactions.md +++ b/previous-versions/assess/docs/models/shared/loantransactions.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `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[[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 +| `report_info` | [Optional[shared.LoanTransactionsReportInfo]](../../models/shared/loantransactionsreportinfo.md) | :heavy_minus_sign: | N/A | +| `report_items` | List[[shared.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/loantransactionsreportinfo.md b/previous-versions/assess/docs/models/shared/loantransactionsreportinfo.md old mode 100755 new mode 100644 index cf153162f..d1e996791 --- a/previous-versions/assess/docs/models/shared/loantransactionsreportinfo.md +++ b/previous-versions/assess/docs/models/shared/loantransactionsreportinfo.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `company_name` | *Optional[str]* | :heavy_minus_sign: | Name of the company queried. | | -| `generated_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 | +| `generated_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-23 00:00:00 +0000 UTC | | `page_number` | *Optional[int]* | :heavy_minus_sign: | The page number. | | | `page_size` | *Optional[int]* | :heavy_minus_sign: | Queried page size. | | | `report_name` | *Optional[str]* | :heavy_minus_sign: | The name of the report. | | diff --git a/previous-versions/assess/docs/models/shared/reportitemsloantransactiontype.md b/previous-versions/assess/docs/models/shared/loantransactiontype.md old mode 100755 new mode 100644 similarity index 90% rename from previous-versions/assess/docs/models/shared/reportitemsloantransactiontype.md rename to previous-versions/assess/docs/models/shared/loantransactiontype.md index 548c10b9a..ed339ded5 --- a/previous-versions/assess/docs/models/shared/reportitemsloantransactiontype.md +++ b/previous-versions/assess/docs/models/shared/loantransactiontype.md @@ -1,4 +1,4 @@ -# ReportItemsLoanTransactionType +# LoanTransactionType The type of loan transaction. diff --git a/previous-versions/assess/docs/models/shared/payment.md b/previous-versions/assess/docs/models/shared/payment.md old mode 100755 new mode 100644 index b1d90f1c1..1b733d39c --- a/previous-versions/assess/docs/models/shared/payment.md +++ b/previous-versions/assess/docs/models/shared/payment.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Payment amount. | | -| `banking_transaction_refs` | List[[BankingTransactionRef](../../models/shared/bankingtransactionref.md)] | :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 | -| `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | 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 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | | -| `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 platform. | | -| `payment_type` | *Optional[str]* | :heavy_minus_sign: | The type of payment. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `amount` | *Optional[Decimal]* | :heavy_minus_sign: | Payment amount. | | +| `banking_transaction_refs` | List[[shared.BankingTransactionRef](../../models/shared/bankingtransactionref.md)] | :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 | +| `currency_rate` | *Optional[Decimal]* | :heavy_minus_sign: | 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 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. \| | | +| `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-23 00:00:00 +0000 UTC | +| `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 platform. | | +| `payment_type` | *Optional[str]* | :heavy_minus_sign: | The type of payment. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/periodunit.md b/previous-versions/assess/docs/models/shared/periodunit.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/report.md b/previous-versions/assess/docs/models/shared/report.md old mode 100755 new mode 100644 index b7647ffed..a2de73f1b --- a/previous-versions/assess/docs/models/shared/report.md +++ b/previous-versions/assess/docs/models/shared/report.md @@ -45,10 +45,10 @@ Reports can be rendered as follows (ordering is implicit rather than explicit): ## Fields -| 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 +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `dimensions` | List[[shared.CommerceReportDimension](../../models/shared/commercereportdimension.md)] | :heavy_minus_sign: | N/A | +| `errors` | List[[shared.CommerceReportError](../../models/shared/commercereporterror.md)] | :heavy_minus_sign: | N/A | +| `measures` | List[[shared.CommerceReportMeasure](../../models/shared/commercereportmeasure.md)] | :heavy_minus_sign: | N/A | +| `report_data` | List[[shared.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/reportcomponentmeasure.md b/previous-versions/assess/docs/models/shared/reportcomponentmeasure.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/reportinfo.md b/previous-versions/assess/docs/models/shared/reportinfo.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/enhancedreportreportitem.md b/previous-versions/assess/docs/models/shared/reportitem.md old mode 100755 new mode 100644 similarity index 99% rename from previous-versions/assess/docs/models/shared/enhancedreportreportitem.md rename to previous-versions/assess/docs/models/shared/reportitem.md index 7cbbb3144..76deb98dc --- a/previous-versions/assess/docs/models/shared/enhancedreportreportitem.md +++ b/previous-versions/assess/docs/models/shared/reportitem.md @@ -1,12 +1,12 @@ -# EnhancedReportReportItem +# ReportItem ## Fields | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `account_category` | [Optional[EnhancedReportAccountCategory]](../../models/shared/enhancedreportaccountcategory.md) | :heavy_minus_sign: | N/A | | +| `account_category` | [Optional[shared.EnhancedReportAccountCategory]](../../models/shared/enhancedreportaccountcategory.md) | :heavy_minus_sign: | N/A | | | `account_id` | *Optional[str]* | :heavy_minus_sign: | The unique account ID. | | | `account_name` | *Optional[str]* | :heavy_minus_sign: | Name of the account. | | | `balance` | *Optional[Decimal]* | :heavy_minus_sign: | Balance of the account as reported on the profit and loss or Balance sheet. | | -| `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 | \ No newline at end of file +| `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-23 00:00:00 +0000 UTC | \ 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 old mode 100755 new mode 100644 index ea6488ef7..bc3b5a3ad --- a/previous-versions/assess/docs/models/shared/reportitems.md +++ b/previous-versions/assess/docs/models/shared/reportitems.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | *Optional[Decimal]* | :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 | | +| `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-23 00:00:00 +0000 UTC | +| `item_ref` | [Optional[shared.ItemRef]](../../models/shared/itemref.md) | :heavy_minus_sign: | N/A | | | `lender_name` | *Optional[str]* | :heavy_minus_sign: | The name of lender providing the loan. | | -| `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: | The type of loan transaction. | | \ No newline at end of file +| `loan_ref` | [Optional[shared.LoanRef]](../../models/shared/loanref.md) | :heavy_minus_sign: | N/A | | +| `loan_transaction_type` | [Optional[shared.LoanTransactionType]](../../models/shared/loantransactiontype.md) | :heavy_minus_sign: | The type of loan transaction. | | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/security.md b/previous-versions/assess/docs/models/shared/security.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/sourceref.md b/previous-versions/assess/docs/models/shared/sourceref.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/shared/status.md b/previous-versions/assess/docs/models/shared/status.md old mode 100755 new mode 100644 index 7754df434..26e2b0dd3 --- a/previous-versions/assess/docs/models/shared/status.md +++ b/previous-versions/assess/docs/models/shared/status.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `metadata` | List[[DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `metadata` | List[[shared.DataIntegrityStatus](../../models/shared/dataintegritystatus.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/previous-versions/assess/docs/models/shared/summaries.md b/previous-versions/assess/docs/models/shared/summaries.md old mode 100755 new mode 100644 index bd534e529..3abaa5890 --- a/previous-versions/assess/docs/models/shared/summaries.md +++ b/previous-versions/assess/docs/models/shared/summaries.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `summaries` | List[[DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| `summaries` | List[[shared.DataIntegritySummary](../../models/shared/dataintegritysummary.md)] | :heavy_minus_sign: | N/A | \ 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 old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/utils/retryconfig.md b/previous-versions/assess/docs/models/utils/retryconfig.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/models/webhooks/accountcategoriesupdatedresponse.md b/previous-versions/assess/docs/models/webhooks/accountcategoriesupdatedresponse.md old mode 100755 new mode 100644 index 4f66e0321..0890e04a8 --- a/previous-versions/assess/docs/models/webhooks/accountcategoriesupdatedresponse.md +++ b/previous-versions/assess/docs/models/webhooks/accountcategoriesupdatedresponse.md @@ -7,4 +7,4 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/previous-versions/assess/docs/sdks/codatassess/README.md b/previous-versions/assess/docs/sdks/codatassess/README.md old mode 100755 new mode 100644 diff --git a/previous-versions/assess/docs/sdks/dataintegrity/README.md b/previous-versions/assess/docs/sdks/dataintegrity/README.md old mode 100755 new mode 100644 index 9d97729d8..62d3f6a1e --- a/previous-versions/assess/docs/sdks/dataintegrity/README.md +++ b/previous-versions/assess/docs/sdks/dataintegrity/README.md @@ -51,7 +51,12 @@ if res.details is not None: ### Response **[operations.ListDataTypeDataIntegrityDetailsResponse](../../models/operations/listdatatypedataintegritydetailsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## status @@ -90,7 +95,12 @@ if res.status is not None: ### Response **[operations.GetDataIntegrityStatusResponse](../../models/operations/getdataintegritystatusresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## summary @@ -129,4 +139,9 @@ if res.summaries is not None: ### Response **[operations.GetDataIntegritySummariesResponse](../../models/operations/getdataintegritysummariesresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/previous-versions/assess/docs/sdks/excelreports/README.md b/previous-versions/assess/docs/sdks/excelreports/README.md old mode 100755 new mode 100644 index 19652e4f1..92fdee102 --- a/previous-versions/assess/docs/sdks/excelreports/README.md +++ b/previous-versions/assess/docs/sdks/excelreports/README.md @@ -49,7 +49,12 @@ if res.excel_status is not None: ### Response **[operations.GenerateExcelReportResponse](../../models/operations/generateexcelreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_accounting_marketing_metrics @@ -94,7 +99,12 @@ if res.report is not None: ### Response **[operations.GetAccountingMarketingMetricsResponse](../../models/operations/getaccountingmarketingmetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_excel_report @@ -133,7 +143,12 @@ if res.body is not None: ### Response **[operations.GetExcelReportResponse](../../models/operations/getexcelreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_excel_report_generation_status @@ -172,4 +187,9 @@ if res.excel_status is not None: ### Response **[operations.GetExcelReportGenerationStatusResponse](../../models/operations/getexcelreportgenerationstatusresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/previous-versions/assess/docs/sdks/reports/README.md b/previous-versions/assess/docs/sdks/reports/README.md old mode 100755 new mode 100644 index a4022e929..c1b5372f2 --- a/previous-versions/assess/docs/sdks/reports/README.md +++ b/previous-versions/assess/docs/sdks/reports/README.md @@ -36,7 +36,7 @@ Make sure you have [synced a company](https://docs.codat.io/codat-api#/operation ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -44,7 +44,7 @@ s = codatassess.CodatAssess( req = operations.GenerateLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GenerateLoanSummarySourceType.ACCOUNTING, + source_type=operations.SourceType.ACCOUNTING, ) res = s.reports.generate_loan_summary(req) @@ -65,7 +65,12 @@ if res.status_code == 200: ### Response **[operations.GenerateLoanSummaryResponse](../../models/operations/generateloansummaryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## generate_loan_transactions @@ -80,7 +85,7 @@ Make sure you have [synced a company](https://docs.codat.io/codat-api#/operation ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -88,7 +93,7 @@ s = codatassess.CodatAssess( req = operations.GenerateLoanTransactionsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GenerateLoanTransactionsSourceType.ACCOUNTING, + source_type=operations.QueryParamSourceType.ACCOUNTING, ) res = s.reports.generate_loan_transactions(req) @@ -109,7 +114,12 @@ if res.status_code == 200: ### Response **[operations.GenerateLoanTransactionsResponse](../../models/operations/generateloantransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_accounts_for_enhanced_balance_sheet @@ -121,7 +131,7 @@ Codat suggests a category for each account automatically, but you can [change it ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -150,7 +160,12 @@ if res.enhanced_report is not None: ### Response **[operations.GetAccountsForEnhancedBalanceSheetResponse](../../models/operations/getaccountsforenhancedbalancesheetresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_accounts_for_enhanced_profit_and_loss @@ -162,7 +177,7 @@ Codat suggests a category for each account automatically, but you can [change it ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -191,7 +206,12 @@ if res.enhanced_report is not None: ### Response **[operations.GetAccountsForEnhancedProfitAndLossResponse](../../models/operations/getaccountsforenhancedprofitandlossresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_customer_retention_metrics @@ -234,7 +254,12 @@ if res.report is not None: ### Response **[operations.GetCommerceCustomerRetentionMetricsResponse](../../models/operations/getcommercecustomerretentionmetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_lifetime_value_metrics @@ -277,7 +302,12 @@ if res.report is not None: ### Response **[operations.GetCommerceLifetimeValueMetricsResponse](../../models/operations/getcommercelifetimevaluemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_orders_metrics @@ -320,7 +350,12 @@ if res.report is not None: ### Response **[operations.GetCommerceOrdersMetricsResponse](../../models/operations/getcommerceordersmetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_refunds_metrics @@ -363,7 +398,12 @@ if res.report is not None: ### Response **[operations.GetCommerceRefundsMetricsResponse](../../models/operations/getcommercerefundsmetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_commerce_revenue_metrics @@ -406,7 +446,12 @@ if res.report is not None: ### Response **[operations.GetCommerceRevenueMetricsResponse](../../models/operations/getcommercerevenuemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_enhanced_cash_flow_transactions @@ -420,7 +465,7 @@ The Enhanced Cash Flow Transactions endpoint provides a fully categorized list o ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -450,7 +495,12 @@ if res.enhanced_cash_flow_transactions is not None: ### Response **[operations.GetEnhancedCashFlowTransactionsResponse](../../models/operations/getenhancedcashflowtransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_enhanced_invoices_report @@ -460,7 +510,7 @@ Gets a list of invoices linked to the corresponding banking transaction ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -490,7 +540,12 @@ if res.enhanced_invoices_report is not None: ### Response **[operations.GetEnhancedInvoicesReportResponse](../../models/operations/getenhancedinvoicesreportresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_loan_summary @@ -505,7 +560,7 @@ Make sure you have [synced a company](https://docs.codat.io/codat-api#/operation ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -513,7 +568,7 @@ s = codatassess.CodatAssess( req = operations.GetLoanSummaryRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.GetLoanSummarySourceType.BANKING, + source_type=operations.GetLoanSummaryQueryParamSourceType.BANKING, ) res = s.reports.get_loan_summary(req) @@ -534,7 +589,12 @@ if res.loan_summary is not None: ### Response **[operations.GetLoanSummaryResponse](../../models/operations/getloansummaryresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## get_recurring_revenue_metrics @@ -544,7 +604,7 @@ Gets key metrics for subscription revenue. ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -573,7 +633,12 @@ if res.report is not None: ### Response **[operations.GetRecurringRevenueMetricsResponse](../../models/operations/getrecurringrevenuemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## list_loan_transactions @@ -588,7 +653,7 @@ Make sure you have [synced a company](https://docs.codat.io/codat-api#/operation ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -596,7 +661,7 @@ s = codatassess.CodatAssess( req = operations.ListLoanTransactionsRequest( company_id='8a210b68-6988-11ed-a1eb-0242ac120002', - source_type=operations.ListLoanTransactionsSourceType.COMMERCE, + source_type=operations.ListLoanTransactionsQueryParamSourceType.COMMERCE, ) res = s.reports.list_loan_transactions(req) @@ -617,7 +682,12 @@ if res.loan_transactions is not None: ### Response **[operations.ListLoanTransactionsResponse](../../models/operations/listloantransactionsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| ------------------------------- | ------------------------------- | ------------------------------- | +| errors.ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | ## request_recurring_revenue_metrics @@ -627,7 +697,7 @@ Requests production of key subscription revenue metrics. ```python import codatassess -from codatassess.models import operations, shared +from codatassess.models import operations s = codatassess.CodatAssess( auth_header="Basic BASE_64_ENCODED(API_KEY)", @@ -656,4 +726,9 @@ if res.report is not None: ### Response **[operations.RequestRecurringRevenueMetricsResponse](../../models/operations/requestrecurringrevenuemetricsresponse.md)** +### Errors +| Error Object | Status Code | Content Type | +| --------------------------- | --------------------------- | --------------------------- | +| errors.ErrorMessage | 401,402,403,404,429,500,503 | application/json | +| errors.SDKError | 400-600 | */* | diff --git a/previous-versions/assess/files.gen b/previous-versions/assess/files.gen index f238955a8..98eab6410 100755 --- a/previous-versions/assess/files.gen +++ b/previous-versions/assess/files.gen @@ -1,23 +1,16 @@ src/codatassess/sdkconfiguration.py +src/codatassess/reports.py src/codatassess/data_integrity.py src/codatassess/excel_reports.py -src/codatassess/reports.py src/codatassess/sdk.py 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/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/generate_excel_report.py -src/codatassess/models/operations/get_accounting_marketing_metrics.py -src/codatassess/models/operations/get_excel_report.py -src/codatassess/models/operations/get_excel_report_generation_status.py +src/codatassess/models/errors/sdkerror.py +tests/helpers.py src/codatassess/models/operations/generate_loan_summary.py src/codatassess/models/operations/generate_loan_transactions.py src/codatassess/models/operations/get_accounts_for_enhanced_balance_sheet.py @@ -33,28 +26,18 @@ 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/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/dataintegritydatatype.py -src/codatassess/models/shared/status.py -src/codatassess/models/shared/dataintegritystatus.py -src/codatassess/models/shared/dataintegritystatusinfo.py -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/summaries.py -src/codatassess/models/shared/dataintegritysummary.py -src/codatassess/models/shared/dataintegritybycount.py -src/codatassess/models/shared/dataintegritybyamount.py -src/codatassess/models/shared/excelstatus.py -src/codatassess/models/shared/excelreporttypes.py -src/codatassess/models/shared/excelreporttype.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/generate_excel_report.py +src/codatassess/models/operations/get_accounting_marketing_metrics.py +src/codatassess/models/operations/get_excel_report.py +src/codatassess/models/operations/get_excel_report_generation_status.py +src/codatassess/models/errors/errormessage.py +src/codatassess/models/shared/enhancedreport.py +src/codatassess/models/shared/enhancedreportaccountcategory.py +src/codatassess/models/shared/accountcategorylevel.py +src/codatassess/models/shared/enhancedreportinfo.py src/codatassess/models/shared/report.py src/codatassess/models/shared/commercereportcomponent.py src/codatassess/models/shared/reportcomponentmeasure.py @@ -62,10 +45,6 @@ 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 -src/codatassess/models/shared/accountcategorylevel.py -src/codatassess/models/shared/enhancedreportinfo.py src/codatassess/models/shared/enhancedcashflowtransactions.py src/codatassess/models/shared/enhancedcashflowitem.py src/codatassess/models/shared/enhancedcashflowtransaction.py @@ -92,33 +71,39 @@ src/codatassess/models/shared/reportitems.py src/codatassess/models/shared/loanref.py src/codatassess/models/shared/itemref.py src/codatassess/models/shared/loantransactionsreportinfo.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/dataintegritydatatype.py +src/codatassess/models/shared/status.py +src/codatassess/models/shared/dataintegritystatus.py +src/codatassess/models/shared/dataintegritystatusinfo.py +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/summaries.py +src/codatassess/models/shared/dataintegritysummary.py +src/codatassess/models/shared/dataintegritybycount.py +src/codatassess/models/shared/dataintegritybyamount.py +src/codatassess/models/shared/excelstatus.py +src/codatassess/models/shared/excelreporttypes.py +src/codatassess/models/shared/excelreporttype.py src/codatassess/models/shared/security.py src/codatassess/models/shared/accountcategoriesupdatedwebhook.py src/codatassess/models/shared/accountcategoriesupdatedwebhookdata.py -src/codatassess/models/shared/__init__.py src/codatassess/models/webhooks/account_categories_updated.py -src/codatassess/models/webhooks/__init__.py +src/codatassess/models/__init__.py src/codatassess/models/errors/__init__.py -USAGE.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/generateexcelreportrequest.md -docs/models/operations/generateexcelreportresponse.md -docs/models/operations/getaccountingmarketingmetricsrequest.md -docs/models/operations/getaccountingmarketingmetricsresponse.md -docs/models/operations/getexcelreportrequest.md -docs/models/operations/getexcelreport200applicationoctetstream.md -docs/models/operations/getexcelreportresponse.md -docs/models/operations/getexcelreportgenerationstatusrequest.md -docs/models/operations/getexcelreportgenerationstatusresponse.md -docs/models/operations/generateloansummarysourcetype.md +src/codatassess/models/operations/__init__.py +src/codatassess/models/shared/__init__.py +src/codatassess/models/webhooks/__init__.py +docs/models/operations/sourcetype.md docs/models/operations/generateloansummaryrequest.md docs/models/operations/generateloansummaryresponse.md -docs/models/operations/generateloantransactionssourcetype.md +docs/models/operations/queryparamsourcetype.md docs/models/operations/generateloantransactionsrequest.md docs/models/operations/generateloantransactionsresponse.md docs/models/operations/getaccountsforenhancedbalancesheetrequest.md @@ -139,50 +124,45 @@ docs/models/operations/getenhancedcashflowtransactionsrequest.md docs/models/operations/getenhancedcashflowtransactionsresponse.md docs/models/operations/getenhancedinvoicesreportrequest.md docs/models/operations/getenhancedinvoicesreportresponse.md -docs/models/operations/getloansummarysourcetype.md +docs/models/operations/getloansummaryqueryparamsourcetype.md docs/models/operations/getloansummaryrequest.md docs/models/operations/getloansummaryresponse.md docs/models/operations/getrecurringrevenuemetricsrequest.md docs/models/operations/getrecurringrevenuemetricsresponse.md -docs/models/operations/listloantransactionssourcetype.md +docs/models/operations/listloantransactionsqueryparamsourcetype.md docs/models/operations/listloantransactionsrequest.md docs/models/operations/listloantransactionsresponse.md docs/models/operations/requestrecurringrevenuemetricsrequest.md docs/models/operations/requestrecurringrevenuemetricsresponse.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/dataintegritydatatype.md -docs/models/shared/status.md -docs/models/shared/dataintegritystatus.md -docs/models/shared/dataintegritystatusinfo.md -docs/models/shared/integritystatus.md -docs/models/shared/dataintegritydates.md -docs/models/shared/dataintegrityconnectionid.md -docs/models/shared/dataintegrityamounts.md -docs/models/shared/summaries.md -docs/models/shared/dataintegritysummary.md -docs/models/shared/dataintegritybycount.md -docs/models/shared/dataintegritybyamount.md -docs/models/shared/excelstatus.md -docs/models/shared/excelreporttypes.md -docs/models/shared/excelreporttype.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/generateexcelreportrequest.md +docs/models/operations/generateexcelreportresponse.md +docs/models/operations/getaccountingmarketingmetricsrequest.md +docs/models/operations/getaccountingmarketingmetricsresponse.md +docs/models/operations/getexcelreportrequest.md +docs/models/operations/getexcelreportresponsebody.md +docs/models/operations/getexcelreportresponse.md +docs/models/operations/getexcelreportgenerationstatusrequest.md +docs/models/operations/getexcelreportgenerationstatusresponse.md +docs/models/errors/errormessage.md +docs/models/shared/reportitem.md +docs/models/shared/enhancedreport.md +docs/models/shared/enhancedreportaccountcategory.md +docs/models/shared/accountcategorylevel.md +docs/models/shared/enhancedreportinfo.md docs/models/shared/report.md docs/models/shared/commercereportcomponent.md docs/models/shared/reportcomponentmeasure.md docs/models/shared/commercereportmeasure.md docs/models/shared/commercereporterror.md -docs/models/shared/commercereportdimensionitems.md +docs/models/shared/items.md docs/models/shared/commercereportdimension.md docs/models/shared/periodunit.md -docs/models/shared/enhancedreportreportitem.md -docs/models/shared/enhancedreport.md -docs/models/shared/enhancedreportaccountcategory.md -docs/models/shared/accountcategorylevel.md -docs/models/shared/enhancedreportinfo.md docs/models/shared/enhancedcashflowtransactions.md docs/models/shared/enhancedcashflowitem.md docs/models/shared/enhancedcashflowtransaction.md @@ -205,18 +185,39 @@ 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/loantransactiontype.md docs/models/shared/reportitems.md docs/models/shared/loanref.md docs/models/shared/itemref.md docs/models/shared/loantransactionsreportinfo.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/dataintegritydatatype.md +docs/models/shared/status.md +docs/models/shared/dataintegritystatus.md +docs/models/shared/dataintegritystatusinfo.md +docs/models/shared/integritystatus.md +docs/models/shared/dataintegritydates.md +docs/models/shared/dataintegrityconnectionid.md +docs/models/shared/dataintegrityamounts.md +docs/models/shared/summaries.md +docs/models/shared/dataintegritysummary.md +docs/models/shared/dataintegritybycount.md +docs/models/shared/dataintegritybyamount.md +docs/models/shared/excelstatus.md +docs/models/shared/excelreporttypes.md +docs/models/shared/excelreporttype.md docs/models/shared/security.md docs/models/shared/accountcategoriesupdatedwebhook.md docs/models/shared/accountcategoriesupdatedwebhookdata.md docs/models/webhooks/accountcategoriesupdatedresponse.md docs/sdks/codatassess/README.md docs/models/utils/retryconfig.md +docs/sdks/reports/README.md docs/sdks/dataintegrity/README.md docs/sdks/excelreports/README.md -docs/sdks/reports/README.md +USAGE.md .gitattributes \ No newline at end of file diff --git a/previous-versions/assess/gen.yaml b/previous-versions/assess/gen.yaml index b219fd6cf..5f41acc01 100644 --- a/previous-versions/assess/gen.yaml +++ b/previous-versions/assess/gen.yaml @@ -1,26 +1,43 @@ configVersion: 1.0.0 management: - docChecksum: 40d7558a56416b3de4f8a937420dd470 - docVersion: '1.0' - speakeasyVersion: 1.100.2 - generationVersion: 2.159.2 + docChecksum: cb22dac8fdd8b0115a43bf705ca74371 + docVersion: "1.0" + speakeasyVersion: 1.126.3 + generationVersion: 2.214.3 generation: + comments: {} sdkClassName: CodatAssess - singleTagPerOp: false + repoURL: https://github.com/codatio/client-sdk-python.git + usageSnippets: + optionalPropertyRendering: withExample telemetryEnabled: true features: python: - core: 3.0.2 - examples: 2.81.2 - globalSecurity: 2.82.0 - globalServerURLs: 2.82.0 + core: 4.3.0 + examples: 2.81.3 + globalSecurity: 2.83.1 + globalServerURLs: 2.82.1 + inputOutputModels: 2.82.0 nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 0.32.0 + version: 0.33.0 author: Codat - description: Make credit decisions backed by enhanced financials, metrics, reports, - and data integrity features. + clientServerStatusCodesAsErrors: true + description: Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. flattenGlobalSecurity: true + imports: + option: openapi + paths: + callbacks: models/callbacks + errors: models/errors + operations: models/operations + shared: models/shared + webhooks: models/webhooks + inputModelSuffix: input + installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=previous-versions/assess maxMethodParams: 0 + outputModelSuffix: output packageName: codat-assess + published: true + repoSubDirectory: previous-versions/assess diff --git a/previous-versions/assess/pylintrc b/previous-versions/assess/pylintrc old mode 100755 new mode 100644 diff --git a/previous-versions/assess/setup.py b/previous-versions/assess/setup.py old mode 100755 new mode 100644 index cc488af5c..bf09bdc5e --- a/previous-versions/assess/setup.py +++ b/previous-versions/assess/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="codat-assess", - version="0.32.0", + version="0.33.0", author="Codat", description="Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features.", long_description=long_description, @@ -30,7 +30,7 @@ "six>=1.16.0", "typing-inspect>=0.9.0", "typing_extensions>=4.7.1", - "urllib3>=2.0.4", + "urllib3>=1.26.18", ], extras_require={ "dev":["pylint==2.16.2"] diff --git a/previous-versions/assess/src/codatassess/__init__.py b/previous-versions/assess/src/codatassess/__init__.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/data_integrity.py b/previous-versions/assess/src/codatassess/data_integrity.py old mode 100755 new mode 100644 index 0b0017f14..c6794a93a --- a/previous-versions/assess/src/codatassess/data_integrity.py +++ b/previous-versions/assess/src/codatassess/data_integrity.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + 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. @@ -25,7 +26,10 @@ def details(self, request: operations.ListDataTypeDataIntegrityDetailsRequest, r headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -44,7 +48,7 @@ def do_request(): '5XX' ])) 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) if http_res.status_code == 200: @@ -53,16 +57,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -74,7 +82,10 @@ def status(self, request: operations.GetDataIntegrityStatusRequest, retries: Opt headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -93,7 +104,7 @@ def do_request(): '5XX' ])) 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) if http_res.status_code == 200: @@ -102,16 +113,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -124,7 +139,10 @@ def summary(self, request: operations.GetDataIntegritySummariesRequest, retries: headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -143,7 +161,7 @@ def do_request(): '5XX' ])) 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) if http_res.status_code == 200: @@ -152,12 +170,15 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', 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 old mode 100755 new mode 100644 index a706d8a87..9a2d5cc04 --- a/previous-versions/assess/src/codatassess/excel_reports.py +++ b/previous-versions/assess/src/codatassess/excel_reports.py @@ -18,6 +18,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def generate_excel_report(self, request: operations.GenerateExcelReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateExcelReportResponse: r"""Generate Excel report Generate an Excel report which can subsequently be downloaded. @@ -30,7 +31,10 @@ def generate_excel_report(self, request: operations.GenerateExcelReportRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -49,7 +53,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GenerateExcelReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -58,16 +62,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -82,7 +90,10 @@ def get_accounting_marketing_metrics(self, request: operations.GetAccountingMark headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -101,7 +112,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountingMarketingMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -110,16 +121,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -135,7 +150,10 @@ def get_excel_report(self, request: operations.GetExcelReportRequest, retries: O headers['Accept'] = 'application/json;q=1, application/octet-stream;q=0' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -154,7 +172,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetExcelReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -162,16 +180,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_excel_report_generation_status(self, request: operations.GetExcelReportGenerationStatusRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetExcelReportGenerationStatusResponse: r"""Get Excel report status Returns the status of the latest report requested. @@ -184,7 +206,10 @@ def get_excel_report_generation_status(self, request: operations.GetExcelReportG headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -203,7 +228,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetExcelReportGenerationStatusResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -212,12 +237,15 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res diff --git a/previous-versions/assess/src/codatassess/models/__init__.py b/previous-versions/assess/src/codatassess/models/__init__.py old mode 100755 new mode 100644 index 36628d6cc..722bb9982 --- a/previous-versions/assess/src/codatassess/models/__init__.py +++ b/previous-versions/assess/src/codatassess/models/__init__.py @@ -1,3 +1,4 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -# __init__.py + +# package diff --git a/previous-versions/assess/src/codatassess/models/errors/__init__.py b/previous-versions/assess/src/codatassess/models/errors/__init__.py old mode 100755 new mode 100644 index cfd848441..bf15fd116 --- a/previous-versions/assess/src/codatassess/models/errors/__init__.py +++ b/previous-versions/assess/src/codatassess/models/errors/__init__.py @@ -1,4 +1,6 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -from .sdkerror import SDKError -__all__ = ["SDKError"] +from .errormessage import * +from .sdkerror import * + +__all__ = ["ErrorMessage","SDKError"] diff --git a/previous-versions/assess/src/codatassess/models/shared/errormessage.py b/previous-versions/assess/src/codatassess/models/errors/errormessage.py old mode 100755 new mode 100644 similarity index 91% rename from previous-versions/assess/src/codatassess/models/shared/errormessage.py rename to previous-versions/assess/src/codatassess/models/errors/errormessage.py index d663da52e..e94df8a29 --- a/previous-versions/assess/src/codatassess/models/shared/errormessage.py +++ b/previous-versions/assess/src/codatassess/models/errors/errormessage.py @@ -8,8 +8,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) + @dataclasses.dataclass -class ErrorMessage: +class ErrorMessage(Exception): + r"""Your `query` parameter was not correctly formed""" 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 }}) r"""`True` if the error occurred transiently and can be retried.""" correlation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('correlationId'), 'exclude': lambda f: f is None }}) @@ -24,3 +26,5 @@ class ErrorMessage: r"""The HTTP status code returned by the error.""" + def __str__(self) -> str: + return utils.marshal_json(self, type(self)) diff --git a/previous-versions/assess/src/codatassess/models/errors/sdkerror.py b/previous-versions/assess/src/codatassess/models/errors/sdkerror.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/operations/__init__.py b/previous-versions/assess/src/codatassess/models/operations/__init__.py old mode 100755 new mode 100644 index ca396782a..277c8f8a9 --- a/previous-versions/assess/src/codatassess/models/operations/__init__.py +++ b/previous-versions/assess/src/codatassess/models/operations/__init__.py @@ -23,4 +23,4 @@ from .list_loan_transactions import * from .request_recurring_revenue_metrics import * -__all__ = ["GenerateExcelReportRequest","GenerateExcelReportResponse","GenerateLoanSummaryRequest","GenerateLoanSummaryResponse","GenerateLoanSummarySourceType","GenerateLoanTransactionsRequest","GenerateLoanTransactionsResponse","GenerateLoanTransactionsSourceType","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","GetLoanSummarySourceType","GetRecurringRevenueMetricsRequest","GetRecurringRevenueMetricsResponse","ListDataTypeDataIntegrityDetailsRequest","ListDataTypeDataIntegrityDetailsResponse","ListLoanTransactionsRequest","ListLoanTransactionsResponse","ListLoanTransactionsSourceType","RequestRecurringRevenueMetricsRequest","RequestRecurringRevenueMetricsResponse"] +__all__ = ["GenerateExcelReportRequest","GenerateExcelReportResponse","GenerateLoanSummaryRequest","GenerateLoanSummaryResponse","GenerateLoanTransactionsRequest","GenerateLoanTransactionsResponse","GetAccountingMarketingMetricsRequest","GetAccountingMarketingMetricsResponse","GetAccountsForEnhancedBalanceSheetRequest","GetAccountsForEnhancedBalanceSheetResponse","GetAccountsForEnhancedProfitAndLossRequest","GetAccountsForEnhancedProfitAndLossResponse","GetCommerceCustomerRetentionMetricsRequest","GetCommerceCustomerRetentionMetricsResponse","GetCommerceLifetimeValueMetricsRequest","GetCommerceLifetimeValueMetricsResponse","GetCommerceOrdersMetricsRequest","GetCommerceOrdersMetricsResponse","GetCommerceRefundsMetricsRequest","GetCommerceRefundsMetricsResponse","GetCommerceRevenueMetricsRequest","GetCommerceRevenueMetricsResponse","GetDataIntegrityStatusRequest","GetDataIntegrityStatusResponse","GetDataIntegritySummariesRequest","GetDataIntegritySummariesResponse","GetEnhancedCashFlowTransactionsRequest","GetEnhancedCashFlowTransactionsResponse","GetEnhancedInvoicesReportRequest","GetEnhancedInvoicesReportResponse","GetExcelReportGenerationStatusRequest","GetExcelReportGenerationStatusResponse","GetExcelReportRequest","GetExcelReportResponse","GetExcelReportResponseBody","GetLoanSummaryQueryParamSourceType","GetLoanSummaryRequest","GetLoanSummaryResponse","GetRecurringRevenueMetricsRequest","GetRecurringRevenueMetricsResponse","ListDataTypeDataIntegrityDetailsRequest","ListDataTypeDataIntegrityDetailsResponse","ListLoanTransactionsQueryParamSourceType","ListLoanTransactionsRequest","ListLoanTransactionsResponse","QueryParamSourceType","RequestRecurringRevenueMetricsRequest","RequestRecurringRevenueMetricsResponse","SourceType"] 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 old mode 100755 new mode 100644 index 6186410fc..9aca5d4eb --- 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,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 excelstatus as shared_excelstatus +from ...models.shared import excelreporttype as shared_excelreporttype +from ...models.shared import excelstatus as shared_excelstatus from typing import Optional @@ -23,13 +22,11 @@ class GenerateExcelReportRequest: class GenerateExcelReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/assess/src/codatassess/models/operations/generate_loan_summary.py b/previous-versions/assess/src/codatassess/models/operations/generate_loan_summary.py old mode 100755 new mode 100644 index a8372fcd6..016b45b51 --- a/previous-versions/assess/src/codatassess/models/operations/generate_loan_summary.py +++ b/previous-versions/assess/src/codatassess/models/operations/generate_loan_summary.py @@ -3,11 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from enum import Enum -from typing import Optional -class GenerateLoanSummarySourceType(str, Enum): +class SourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -18,7 +16,7 @@ class GenerateLoanSummarySourceType(str, Enum): class GenerateLoanSummaryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a company.""" - source_type: GenerateLoanSummarySourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + source_type: SourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -28,11 +26,9 @@ class GenerateLoanSummaryRequest: class GenerateLoanSummaryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/assess/src/codatassess/models/operations/generate_loan_transactions.py b/previous-versions/assess/src/codatassess/models/operations/generate_loan_transactions.py old mode 100755 new mode 100644 index f722f4d2a..134985849 --- a/previous-versions/assess/src/codatassess/models/operations/generate_loan_transactions.py +++ b/previous-versions/assess/src/codatassess/models/operations/generate_loan_transactions.py @@ -3,11 +3,9 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import errormessage as shared_errormessage from enum import Enum -from typing import Optional -class GenerateLoanTransactionsSourceType(str, Enum): +class QueryParamSourceType(str, Enum): r"""Data source type""" BANKING = 'banking' COMMERCE = 'commerce' @@ -18,7 +16,7 @@ class GenerateLoanTransactionsSourceType(str, Enum): class GenerateLoanTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a company.""" - source_type: GenerateLoanTransactionsSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + source_type: QueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type""" @@ -28,11 +26,9 @@ class GenerateLoanTransactionsRequest: class GenerateLoanTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index ad09f7da4..8f4c57117 --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -35,12 +34,10 @@ class GetAccountingMarketingMetricsRequest: class GetAccountingMarketingMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index dc7329c24..86173c53e --- 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 @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedreport as shared_enhancedreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedreport as shared_enhancedreport from typing import Optional @@ -24,13 +23,11 @@ class GetAccountsForEnhancedBalanceSheetRequest: class GetAccountsForEnhancedBalanceSheetResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" enhanced_report: Optional[shared_enhancedreport.EnhancedReport] = dataclasses.field(default=None) r"""OK""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index fc415e0a7..a98e9096d --- 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 @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedreport as shared_enhancedreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedreport as shared_enhancedreport from typing import Optional @@ -24,13 +23,11 @@ class GetAccountsForEnhancedProfitAndLossRequest: class GetAccountsForEnhancedProfitAndLossResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" enhanced_report: Optional[shared_enhancedreport.EnhancedReport] = dataclasses.field(default=None) r"""OK""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 84c9c0631..962dfd18e --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -33,12 +32,10 @@ class GetCommerceCustomerRetentionMetricsRequest: class GetCommerceCustomerRetentionMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index a1914aaf0..c3d5af4c4 --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -33,12 +32,10 @@ class GetCommerceLifetimeValueMetricsRequest: class GetCommerceLifetimeValueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index 65346a060..707864384 --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -33,12 +32,10 @@ class GetCommerceOrdersMetricsRequest: class GetCommerceOrdersMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index 0d1f91706..91eb048c9 --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -33,12 +32,10 @@ class GetCommerceRefundsMetricsRequest: class GetCommerceRefundsMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index e383ed5cc..67bbc6793 --- 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,8 @@ 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 ...models.shared import periodunit as shared_periodunit +from ...models.shared import report as shared_report from typing import Optional @@ -33,12 +32,10 @@ class GetCommerceRevenueMetricsRequest: class GetCommerceRevenueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index 8669b37de..ee46313b6 --- 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 @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import errormessage as shared_errormessage -from ..shared import status as shared_status +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import status as shared_status from typing import Optional @@ -23,12 +22,10 @@ class GetDataIntegrityStatusRequest: class GetDataIntegrityStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index e3ac80889..fed1c5a6d --- 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 @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import errormessage as shared_errormessage -from ..shared import summaries as shared_summaries +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import summaries as shared_summaries from typing import Optional @@ -25,12 +24,10 @@ class GetDataIntegritySummariesRequest: class GetDataIntegritySummariesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" summaries: Optional[shared_summaries.Summaries] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index 1e317fa4e..dbea8f278 --- 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 @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedcashflowtransactions as shared_enhancedcashflowtransactions -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedcashflowtransactions as shared_enhancedcashflowtransactions from typing import Optional @@ -26,13 +25,11 @@ class GetEnhancedCashFlowTransactionsRequest: class GetEnhancedCashFlowTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" enhanced_cash_flow_transactions: Optional[shared_enhancedcashflowtransactions.EnhancedCashFlowTransactions] = dataclasses.field(default=None) r"""OK""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 90340b8c3..adc62d148 --- 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 @@ -3,8 +3,7 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import enhancedinvoicesreport as shared_enhancedinvoicesreport -from ..shared import errormessage as shared_errormessage +from ...models.shared import enhancedinvoicesreport as shared_enhancedinvoicesreport from typing import Optional @@ -26,13 +25,11 @@ class GetEnhancedInvoicesReportRequest: class GetEnhancedInvoicesReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" enhanced_invoices_report: Optional[shared_enhancedinvoicesreport.EnhancedInvoicesReport] = dataclasses.field(default=None) r"""OK""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index c3ff90c6b..958c7ce64 --- 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,7 @@ 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 ...models.shared import excelreporttype as shared_excelreporttype from typing import Optional @@ -19,7 +18,7 @@ class GetExcelReportRequest: @dataclasses.dataclass -class GetExcelReport200ApplicationOctetStream: +class GetExcelReportResponseBody: r"""OK""" @@ -29,12 +28,10 @@ class GetExcelReport200ApplicationOctetStream: class GetExcelReportResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" body: Optional[bytes] = 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 19b354ccb..d4bf20785 --- 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,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 excelstatus as shared_excelstatus +from ...models.shared import excelreporttype as shared_excelreporttype +from ...models.shared import excelstatus as shared_excelstatus from typing import Optional @@ -23,13 +22,11 @@ class GetExcelReportGenerationStatusRequest: class GetExcelReportGenerationStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index abb8b1962..153f5499a --- 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,12 +3,11 @@ 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 ...models.shared import loansummary as shared_loansummary from enum import Enum from typing import Optional -class GetLoanSummarySourceType(str, Enum): +class GetLoanSummaryQueryParamSourceType(str, Enum): r"""Data source type.""" BANKING = 'banking' COMMERCE = 'commerce' @@ -19,7 +18,7 @@ class GetLoanSummarySourceType(str, Enum): class GetLoanSummaryRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a company.""" - source_type: GetLoanSummarySourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + source_type: GetLoanSummaryQueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type.""" @@ -29,13 +28,11 @@ class GetLoanSummaryRequest: class GetLoanSummaryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 871b4f5d6..d733f55d0 --- 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,7 @@ 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 ...models.shared import report as shared_report from typing import Optional @@ -22,12 +21,10 @@ class GetRecurringRevenueMetricsRequest: class GetRecurringRevenueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" 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 old mode 100755 new mode 100644 index f30b9cc60..64de18755 --- 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 @@ -3,9 +3,8 @@ from __future__ import annotations import dataclasses import requests as requests_http -from ..shared import dataintegritydatatype as shared_dataintegritydatatype -from ..shared import details as shared_details -from ..shared import errormessage as shared_errormessage +from ...models.shared import dataintegritydatatype as shared_dataintegritydatatype +from ...models.shared import details as shared_details from typing import Optional @@ -31,13 +30,11 @@ class ListDataTypeDataIntegrityDetailsRequest: class ListDataTypeDataIntegrityDetailsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" details: Optional[shared_details.Details] = dataclasses.field(default=None) r"""OK""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 5fba39ba9..d31d27a1b --- 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,12 +3,11 @@ 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 ...models.shared import loantransactions as shared_loantransactions from enum import Enum from typing import Optional -class ListLoanTransactionsSourceType(str, Enum): +class ListLoanTransactionsQueryParamSourceType(str, Enum): r"""Data source type""" BANKING = 'banking' COMMERCE = 'commerce' @@ -19,7 +18,7 @@ class ListLoanTransactionsSourceType(str, Enum): class ListLoanTransactionsRequest: company_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'companyId', 'style': 'simple', 'explode': False }}) r"""Unique identifier for a company.""" - source_type: ListLoanTransactionsSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) + source_type: ListLoanTransactionsQueryParamSourceType = dataclasses.field(metadata={'query_param': { 'field_name': 'sourceType', 'style': 'form', 'explode': True }}) r"""Data source type""" @@ -29,13 +28,11 @@ class ListLoanTransactionsRequest: class ListLoanTransactionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" 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 old mode 100755 new mode 100644 index 0d7b2a0b9..11f32bfa0 --- 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,7 @@ 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 ...models.shared import report as shared_report from typing import Optional @@ -22,12 +21,10 @@ class RequestRecurringRevenueMetricsRequest: class RequestRecurringRevenueMetricsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - 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) - r"""Raw HTTP response; suitable for custom response parsing""" report: Optional[shared_report.Report] = dataclasses.field(default=None) r"""OK""" diff --git a/previous-versions/assess/src/codatassess/models/shared/__init__.py b/previous-versions/assess/src/codatassess/models/shared/__init__.py old mode 100755 new mode 100644 index ca84be55c..c157802d0 --- a/previous-versions/assess/src/codatassess/models/shared/__init__.py +++ b/previous-versions/assess/src/codatassess/models/shared/__init__.py @@ -31,7 +31,6 @@ from .enhancedreport import * from .enhancedreportaccountcategory import * from .enhancedreportinfo import * -from .errormessage import * from .excelreporttype import * from .excelreporttypes import * from .excelstatus import * @@ -62,4 +61,4 @@ from .summaries import * from .transactioncategory import * -__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"] +__all__ = ["AccountCategoriesUpdatedWebhook","AccountCategoriesUpdatedWebhookData","AccountCategoryLevel","AccountRef","Accounts","BankingTransactionRef","CommerceReportComponent","CommerceReportDimension","CommerceReportError","CommerceReportMeasure","DataIntegrityAmounts","DataIntegrityByAmount","DataIntegrityByCount","DataIntegrityConnectionID","DataIntegrityDataType","DataIntegrityDates","DataIntegrityDetails","DataIntegrityMatch","DataIntegrityStatus","DataIntegrityStatusInfo","DataIntegritySummary","DataSource","Details","EnhancedCashFlowItem","EnhancedCashFlowTransaction","EnhancedCashFlowTransactions","EnhancedInvoiceReportItem","EnhancedInvoicesReport","EnhancedReport","EnhancedReportAccountCategory","EnhancedReportInfo","ExcelReportType","ExcelReportTypes","ExcelStatus","HalRef","IntegrityStatus","InvoiceStatus","ItemRef","Items","LendingCustomerRef","Links","LoanRef","LoanSummary","LoanSummaryIntegrationType","LoanSummaryRecordRef","LoanSummaryRecordRefType","LoanSummaryReportInfo","LoanSummaryReportItem","LoanTransactionType","LoanTransactions","LoanTransactionsReportInfo","Payment","PeriodUnit","Report","ReportComponentMeasure","ReportInfo","ReportItem","ReportItems","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 old mode 100755 new mode 100644 index 8c85e5967..ac530204e --- a/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py +++ b/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhook.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountcategoriesupdatedwebhookdata as shared_accountcategoriesupdatedwebhookdata +from .accountcategoriesupdatedwebhookdata import AccountCategoriesUpdatedWebhookData from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -20,7 +20,7 @@ class AccountCategoriesUpdatedWebhook: 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 }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[shared_accountcategoriesupdatedwebhookdata.AccountCategoriesUpdatedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), '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 }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhookdata.py b/previous-versions/assess/src/codatassess/models/shared/accountcategoriesupdatedwebhookdata.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/accountcategorylevel.py b/previous-versions/assess/src/codatassess/models/shared/accountcategorylevel.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/accountref.py b/previous-versions/assess/src/codatassess/models/shared/accountref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/accounts.py b/previous-versions/assess/src/codatassess/models/shared/accounts.py old mode 100755 new mode 100644 index 1ef48567a..ba2da6c70 --- a/previous-versions/assess/src/codatassess/models/shared/accounts.py +++ b/previous-versions/assess/src/codatassess/models/shared/accounts.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import sourceref as shared_sourceref +from .sourceref import SourceRef from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -31,7 +31,7 @@ class Accounts: r"""The balance of the bank account.""" 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"""Name of the banking data source, e.g. \\"Plaid\\".""" - 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 }}) + source_ref: Optional[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\\".""" diff --git a/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py b/previous-versions/assess/src/codatassess/models/shared/bankingtransactionref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py b/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py old mode 100755 new mode 100644 index 105ca2fc5..e60a8f365 --- a/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereportcomponent.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import reportcomponentmeasure as shared_reportcomponentmeasure +from .reportcomponentmeasure import ReportComponentMeasure from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -20,6 +20,6 @@ class CommerceReportComponent: r"""The component's item number.""" item_display_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemDisplayName'), 'exclude': lambda f: f is None }}) r"""The component's item display name.""" - measures: Optional[List[shared_reportcomponentmeasure.ReportComponentMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) + measures: Optional[List[ReportComponentMeasure]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('measures'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py b/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py old mode 100755 new mode 100644 index 1795041bc..b720546d5 --- a/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py +++ b/previous-versions/assess/src/codatassess/models/shared/commercereportdimension.py @@ -9,7 +9,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class CommerceReportDimensionItems: +class Items: index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) r"""The dimension's items index.""" @@ -23,7 +23,7 @@ class CommerceReportDimension: r"""The dimension's display name.""" index: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('index'), 'exclude': lambda f: f is None }}) r"""The dimension's index.""" - items: Optional[List[CommerceReportDimensionItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('items'), 'exclude': lambda f: f is None }}) + items: Optional[List[Items]] = 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 }}) r"""The dimension's type.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/commercereporterror.py b/previous-versions/assess/src/codatassess/models/shared/commercereporterror.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/commercereportmeasure.py b/previous-versions/assess/src/codatassess/models/shared/commercereportmeasure.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py b/previous-versions/assess/src/codatassess/models/shared/dataintegrityamounts.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritybyamount.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritybycount.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritybycount.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegrityconnectionid.py b/previous-versions/assess/src/codatassess/models/shared/dataintegrityconnectionid.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritydatatype.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritydatatype.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritydates.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py old mode 100755 new mode 100644 index 5a0ad19eb..ff563cc7b --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritydetails.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritymatch as shared_dataintegritymatch +from .dataintegritymatch import DataIntegrityMatch from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -50,7 +50,7 @@ class DataIntegrityDetails: r"""The transaction description.""" 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 GUID of the transaction.""" - matches: Optional[List[shared_dataintegritymatch.DataIntegrityMatch]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matches'), 'exclude': lambda f: f is None }}) + matches: Optional[List[DataIntegrityMatch]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matches'), '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 data type of the record.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritymatch.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatus.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatus.py old mode 100755 new mode 100644 index 674c5b2fa..14b797fad --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatus.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatus.py @@ -2,10 +2,10 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegrityamounts as shared_dataintegrityamounts -from ..shared import dataintegrityconnectionid as shared_dataintegrityconnectionid -from ..shared import dataintegritydates as shared_dataintegritydates -from ..shared import dataintegritystatusinfo as shared_dataintegritystatusinfo +from .dataintegrityamounts import DataIntegrityAmounts +from .dataintegrityconnectionid import DataIntegrityConnectionID +from .dataintegritydates import DataIntegrityDates +from .dataintegritystatusinfo import DataIntegrityStatusInfo from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -14,12 +14,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataIntegrityStatus: - amounts: Optional[shared_dataintegrityamounts.DataIntegrityAmounts] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amounts'), 'exclude': lambda f: f is None }}) + amounts: Optional[DataIntegrityAmounts] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amounts'), 'exclude': lambda f: f is None }}) r"""Only returned for transactions. For accounts, there is nothing returned.""" - connection_ids: Optional[shared_dataintegrityconnectionid.DataIntegrityConnectionID] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionIds'), 'exclude': lambda f: f is None }}) - dates: Optional[shared_dataintegritydates.DataIntegrityDates] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dates'), 'exclude': lambda f: f is None }}) + connection_ids: Optional[DataIntegrityConnectionID] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionIds'), 'exclude': lambda f: f is None }}) + dates: Optional[DataIntegrityDates] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dates'), 'exclude': lambda f: f is None }}) r"""Only returned for transactions. For accounts, there is nothing returned.""" - status_info: Optional[shared_dataintegritystatusinfo.DataIntegrityStatusInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusInfo'), 'exclude': lambda f: f is None }}) + status_info: Optional[DataIntegrityStatusInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusInfo'), '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 data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py old mode 100755 new mode 100644 index 8ecf6d67e..46e0d6020 --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritystatusinfo.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import integritystatus as shared_integritystatus +from .integritystatus import IntegrityStatus from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataIntegrityStatusInfo: - current_status: Optional[shared_integritystatus.IntegrityStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus'), 'exclude': lambda f: f is None }}) + current_status: Optional[IntegrityStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('currentStatus'), 'exclude': lambda f: f is None }}) 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: diff --git a/previous-versions/assess/src/codatassess/models/shared/dataintegritysummary.py b/previous-versions/assess/src/codatassess/models/shared/dataintegritysummary.py old mode 100755 new mode 100644 index db4ff6642..c3266059f --- a/previous-versions/assess/src/codatassess/models/shared/dataintegritysummary.py +++ b/previous-versions/assess/src/codatassess/models/shared/dataintegritysummary.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritybyamount as shared_dataintegritybyamount -from ..shared import dataintegritybycount as shared_dataintegritybycount +from .dataintegritybyamount import DataIntegrityByAmount +from .dataintegritybycount import DataIntegrityByCount from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -12,8 +12,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataIntegritySummary: - by_amount: Optional[shared_dataintegritybyamount.DataIntegrityByAmount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byAmount'), 'exclude': lambda f: f is None }}) - by_count: Optional[shared_dataintegritybycount.DataIntegrityByCount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byCount'), 'exclude': lambda f: f is None }}) + by_amount: Optional[DataIntegrityByAmount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byAmount'), 'exclude': lambda f: f is None }}) + by_count: Optional[DataIntegrityByCount] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('byCount'), '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 data type which the data type in the URL has been matched against. For example, if you've matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/datasource.py b/previous-versions/assess/src/codatassess/models/shared/datasource.py old mode 100755 new mode 100644 index 63817e2eb..35fb7445a --- a/previous-versions/assess/src/codatassess/models/shared/datasource.py +++ b/previous-versions/assess/src/codatassess/models/shared/datasource.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accounts as shared_accounts +from .accounts import Accounts from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataSource: - accounts: Optional[List[shared_accounts.Accounts]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) + accounts: Optional[List[Accounts]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accounts'), 'exclude': lambda f: f is None }}) r"""An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/details.py b/previous-versions/assess/src/codatassess/models/shared/details.py old mode 100755 new mode 100644 index 5077d84a1..5ca09b0dd --- a/previous-versions/assess/src/codatassess/models/shared/details.py +++ b/previous-versions/assess/src/codatassess/models/shared/details.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritydetails as shared_dataintegritydetails -from ..shared import links as shared_links +from .dataintegritydetails import DataIntegrityDetails +from .links import Links from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,13 +12,13 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Details: - links: shared_links.Links = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('_links') }}) + 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') }}) r"""Current page number.""" page_size: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pageSize') }}) r"""Number of items to return in results array.""" total_results: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('totalResults') }}) r"""Total number of items.""" - results: Optional[List[shared_dataintegritydetails.DataIntegrityDetails]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) + results: Optional[List[DataIntegrityDetails]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('results'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowitem.py b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowitem.py old mode 100755 new mode 100644 index 3f0b8b7b2..90c1e9cd2 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowitem.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowitem.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedcashflowtransaction as shared_enhancedcashflowtransaction +from .enhancedcashflowtransaction import EnhancedCashFlowTransaction from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EnhancedCashFlowItem: - transactions: Optional[List[shared_enhancedcashflowtransaction.EnhancedCashFlowTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) + transactions: Optional[List[EnhancedCashFlowTransaction]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('transactions'), 'exclude': lambda f: f is None }}) r"""An array of transaction data.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py old mode 100755 new mode 100644 index 3fe1c4f02..91a3a4f8b --- a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransaction.py @@ -2,9 +2,9 @@ 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 .accountref import AccountRef +from .sourceref import SourceRef +from .transactioncategory import TransactionCategory from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @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 }}) + account_ref: Optional[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[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""The bank transaction amount.""" @@ -54,8 +54,8 @@ class EnhancedCashFlowTransaction: 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 }}) + source_ref: Optional[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 }}) + transaction_category: Optional[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 old mode 100755 new mode 100644 index 4e5b54979..8bc3f750b --- a/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedcashflowtransactions.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import datasource as shared_datasource -from ..shared import enhancedcashflowitem as shared_enhancedcashflowitem -from ..shared import reportinfo as shared_reportinfo +from .datasource import DataSource +from .enhancedcashflowitem import EnhancedCashFlowItem +from .reportinfo import ReportInfo from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -19,9 +19,9 @@ class EnhancedCashFlowTransactions: 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 }}) + data_sources: Optional[List[DataSource]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSources'), 'exclude': lambda f: f is None }}) + report_info: Optional[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 Lending API reports.""" - report_items: Optional[List[shared_enhancedcashflowitem.EnhancedCashFlowItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_items: Optional[List[EnhancedCashFlowItem]] = 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/enhancedinvoicereportitem.py b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py old mode 100755 new mode 100644 index 766bf6a44..39b63a546 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicereportitem.py @@ -2,9 +2,9 @@ from __future__ import annotations import dataclasses -from ..shared import invoicestatus as shared_invoicestatus -from ..shared import lendingcustomerref as shared_lendingcustomerref -from ..shared import payment as shared_payment +from .invoicestatus import InvoiceStatus +from .lendingcustomerref import LendingCustomerRef +from .payment import Payment from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -25,7 +25,7 @@ class EnhancedInvoiceReportItem: There are only a very small number of edge cases where this currency code is returned by the Codat system. """ - 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 }}) + customer_ref: Optional[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: @@ -94,9 +94,9 @@ class EnhancedInvoiceReportItem: > 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. """ - payments: Optional[List[shared_payment.Payment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) + payments: Optional[List[Payment]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('payments'), 'exclude': lambda f: f is None }}) 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 }}) + status: Optional[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. diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py old mode 100755 new mode 100644 index 6e68d83aa..7966b54a4 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedinvoicesreport.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedinvoicereportitem as shared_enhancedinvoicereportitem -from ..shared import reportinfo as shared_reportinfo +from .enhancedinvoicereportitem import EnhancedInvoiceReportItem +from .reportinfo import ReportInfo from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -13,8 +13,8 @@ @dataclasses.dataclass 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 }}) + report_info: Optional[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 Lending API reports.""" - 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 }}) + report_items: Optional[List[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 old mode 100755 new mode 100644 index e5dc8bacb..88fb8c8b3 --- a/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedreport.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import enhancedreportaccountcategory as shared_enhancedreportaccountcategory -from ..shared import enhancedreportinfo as shared_enhancedreportinfo +from .enhancedreportaccountcategory import EnhancedReportAccountCategory +from .enhancedreportinfo import EnhancedReportInfo from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -12,8 +12,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class EnhancedReportReportItem: - account_category: Optional[shared_enhancedreportaccountcategory.EnhancedReportAccountCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountCategory'), 'exclude': lambda f: f is None }}) +class ReportItem: + account_category: Optional[EnhancedReportAccountCategory] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountCategory'), 'exclude': lambda f: f is None }}) account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountId'), 'exclude': lambda f: f is None }}) r"""The unique account ID.""" account_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accountName'), 'exclude': lambda f: f is None }}) @@ -48,8 +48,8 @@ class EnhancedReportReportItem: @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EnhancedReport: - report_info: Optional[shared_enhancedreportinfo.EnhancedReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) - report_items: Optional[List[EnhancedReportReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_info: Optional[EnhancedReportInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportInfo'), 'exclude': lambda f: f is None }}) + report_items: Optional[List[ReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) r"""An array of report items.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedreportaccountcategory.py b/previous-versions/assess/src/codatassess/models/shared/enhancedreportaccountcategory.py old mode 100755 new mode 100644 index 42893b1a4..8de568f6b --- a/previous-versions/assess/src/codatassess/models/shared/enhancedreportaccountcategory.py +++ b/previous-versions/assess/src/codatassess/models/shared/enhancedreportaccountcategory.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import accountcategorylevel as shared_accountcategorylevel +from .accountcategorylevel import AccountCategoryLevel from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class EnhancedReportAccountCategory: - levels: Optional[List[shared_accountcategorylevel.AccountCategoryLevel]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) + levels: Optional[List[AccountCategoryLevel]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('levels'), 'exclude': lambda f: f is None }}) status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) r"""Returns a status of \\"Suggested\\" or \\"Confirmed\\". If an account has a confirmed category, it will replace any suggested category returned.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py b/previous-versions/assess/src/codatassess/models/shared/enhancedreportinfo.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/excelreporttype.py b/previous-versions/assess/src/codatassess/models/shared/excelreporttype.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py b/previous-versions/assess/src/codatassess/models/shared/excelreporttypes.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/excelstatus.py b/previous-versions/assess/src/codatassess/models/shared/excelstatus.py old mode 100755 new mode 100644 index 20ee2fcb9..f97044213 --- a/previous-versions/assess/src/codatassess/models/shared/excelstatus.py +++ b/previous-versions/assess/src/codatassess/models/shared/excelstatus.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import excelreporttypes as shared_excelreporttypes +from .excelreporttypes import ExcelReportTypes from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -42,7 +42,7 @@ class ExcelStatus: 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 }}) 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 }}) + report_type: Optional[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/halref.py b/previous-versions/assess/src/codatassess/models/shared/halref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/integritystatus.py b/previous-versions/assess/src/codatassess/models/shared/integritystatus.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py b/previous-versions/assess/src/codatassess/models/shared/invoicestatus.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/itemref.py b/previous-versions/assess/src/codatassess/models/shared/itemref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/lendingcustomerref.py b/previous-versions/assess/src/codatassess/models/shared/lendingcustomerref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/links.py b/previous-versions/assess/src/codatassess/models/shared/links.py old mode 100755 new mode 100644 index 633a7b39b..e0516dd17 --- a/previous-versions/assess/src/codatassess/models/shared/links.py +++ b/previous-versions/assess/src/codatassess/models/shared/links.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import halref as shared_halref +from .halref import HalRef from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -11,9 +11,9 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Links: - current: shared_halref.HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current') }}) - self_: shared_halref.HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('self') }}) - next: Optional[shared_halref.HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('next'), 'exclude': lambda f: f is None }}) - previous: Optional[shared_halref.HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('previous'), 'exclude': lambda f: f is None }}) + current: HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('current') }}) + self_: HalRef = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('self') }}) + next: Optional[HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('next'), 'exclude': lambda f: f is None }}) + previous: Optional[HalRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('previous'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/loanref.py b/previous-versions/assess/src/codatassess/models/shared/loanref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummary.py b/previous-versions/assess/src/codatassess/models/shared/loansummary.py old mode 100755 new mode 100644 index b25c6892a..e9397ce35 --- a/previous-versions/assess/src/codatassess/models/shared/loansummary.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummary.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryreportinfo as shared_loansummaryreportinfo -from ..shared import loansummaryreportitem as shared_loansummaryreportitem +from .loansummaryreportinfo import LoanSummaryReportInfo +from .loansummaryreportitem import LoanSummaryReportItem from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -12,8 +12,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class LoanSummary: - 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_loansummaryreportitem.LoanSummaryReportItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_info: Optional[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[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 old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py old mode 100755 new mode 100644 index c0b5e8e65..6ec2e0e13 --- a/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryrecordref.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryintegrationtype as shared_loansummaryintegrationtype -from ..shared import loansummaryrecordreftype as shared_loansummaryrecordreftype +from .loansummaryintegrationtype import LoanSummaryIntegrationType +from .loansummaryrecordreftype import LoanSummaryRecordRefType from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -16,9 +16,9 @@ class LoanSummaryRecordRef: 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[shared_loansummaryintegrationtype.LoanSummaryIntegrationType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('integrationType'), 'exclude': lambda f: f is None }}) + integration_type: Optional[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[shared_loansummaryrecordreftype.LoanSummaryRecordRefType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRefType'), 'exclude': lambda f: f is None }}) + record_ref_type: Optional[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 old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportinfo.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py old mode 100755 new mode 100644 index fdc4b2383..a6d055011 --- a/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py +++ b/previous-versions/assess/src/codatassess/models/shared/loansummaryreportitem.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import loansummaryrecordref as shared_loansummaryrecordref +from .loansummaryrecordref import LoanSummaryRecordRef from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -18,7 +18,7 @@ class LoanSummaryReportItem: r"""The description of the object being referred to. E.g. the account.""" lender_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lenderName'), 'exclude': lambda f: f is None }}) r"""The name of lender providing the loan.""" - 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 }}) + record_ref: Optional[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: diff --git a/previous-versions/assess/src/codatassess/models/shared/loantransactions.py b/previous-versions/assess/src/codatassess/models/shared/loantransactions.py old mode 100755 new mode 100644 index 1510505db..15dfe9c86 --- a/previous-versions/assess/src/codatassess/models/shared/loantransactions.py +++ b/previous-versions/assess/src/codatassess/models/shared/loantransactions.py @@ -2,8 +2,8 @@ from __future__ import annotations import dataclasses -from ..shared import loantransactionsreportinfo as shared_loantransactionsreportinfo -from ..shared import reportitems as shared_reportitems +from .loantransactionsreportinfo import LoanTransactionsReportInfo +from .reportitems import ReportItems from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Any, List, Optional @@ -14,8 +14,8 @@ 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_reportitems.ReportItems]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reportItems'), 'exclude': lambda f: f is None }}) + report_info: Optional[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[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 old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/payment.py b/previous-versions/assess/src/codatassess/models/shared/payment.py old mode 100755 new mode 100644 index c12278b87..a18c0ba83 --- a/previous-versions/assess/src/codatassess/models/shared/payment.py +++ b/previous-versions/assess/src/codatassess/models/shared/payment.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import bankingtransactionref as shared_bankingtransactionref +from .bankingtransactionref import BankingTransactionRef from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal @@ -14,7 +14,7 @@ class Payment: amount: Optional[Decimal] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('amount'), 'encoder': utils.decimalencoder(True, False), 'decoder': utils.decimaldecoder, 'exclude': lambda f: f is None }}) r"""Payment amount.""" - 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 }}) + banking_transaction_refs: Optional[List[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_. @@ -50,6 +50,13 @@ class Payment: | **GBP** | £20 | 1.277 | $25.54 | | **EUR** | €20 | 1.134 | $22.68 | | **RUB** | ₽20 | 0.015 | $0.30 | + + + ### Integration-specific details + + | Integration | Scenario | System behavior | + |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. | """ 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: diff --git a/previous-versions/assess/src/codatassess/models/shared/periodunit.py b/previous-versions/assess/src/codatassess/models/shared/periodunit.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/report.py b/previous-versions/assess/src/codatassess/models/shared/report.py old mode 100755 new mode 100644 index 33bfd233c..2562f072f --- 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 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 .commercereportcomponent import CommerceReportComponent +from .commercereportdimension import CommerceReportDimension +from .commercereporterror import CommerceReportError +from .commercereportmeasure import CommerceReportMeasure from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import Dict, List, Optional @@ -56,10 +56,10 @@ class Report: ## Dimensions """ - 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 }}) + dimensions: Optional[List[CommerceReportDimension]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dimensions'), 'exclude': lambda f: f is None }}) + errors: Optional[List[CommerceReportError]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is None }}) + measures: Optional[List[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[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/reportcomponentmeasure.py b/previous-versions/assess/src/codatassess/models/shared/reportcomponentmeasure.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/reportinfo.py b/previous-versions/assess/src/codatassess/models/shared/reportinfo.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/reportitems.py b/previous-versions/assess/src/codatassess/models/shared/reportitems.py old mode 100755 new mode 100644 index cc1ef6c85..9374c265e --- a/previous-versions/assess/src/codatassess/models/shared/reportitems.py +++ b/previous-versions/assess/src/codatassess/models/shared/reportitems.py @@ -2,15 +2,15 @@ from __future__ import annotations import dataclasses -from ..shared import itemref as shared_itemref -from ..shared import loanref as shared_loanref +from .itemref import ItemRef +from .loanref import LoanRef from codatassess import utils from dataclasses_json import Undefined, dataclass_json from decimal import Decimal from enum import Enum from typing import Optional -class ReportItemsLoanTransactionType(str, Enum): +class LoanTransactionType(str, Enum): r"""The type of loan transaction.""" INVESTMENT = 'Investment' REPAYMENT = 'Repayment' @@ -44,11 +44,11 @@ class ReportItems: > 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 }}) + item_ref: Optional[ItemRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemRef'), 'exclude': lambda f: f is None }}) lender_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lenderName'), 'exclude': lambda f: f is None }}) r"""The name of lender providing the loan.""" - 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 }}) + loan_ref: Optional[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[LoanTransactionType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loanTransactionType'), 'exclude': lambda f: f is None }}) r"""The type of loan transaction.""" diff --git a/previous-versions/assess/src/codatassess/models/shared/security.py b/previous-versions/assess/src/codatassess/models/shared/security.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/sourceref.py b/previous-versions/assess/src/codatassess/models/shared/sourceref.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/shared/status.py b/previous-versions/assess/src/codatassess/models/shared/status.py old mode 100755 new mode 100644 index 6b978e5b3..5b5296644 --- a/previous-versions/assess/src/codatassess/models/shared/status.py +++ b/previous-versions/assess/src/codatassess/models/shared/status.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritystatus as shared_dataintegritystatus +from .dataintegritystatus import DataIntegrityStatus from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,6 +11,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Status: - metadata: Optional[List[shared_dataintegritystatus.DataIntegrityStatus]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) + metadata: Optional[List[DataIntegrityStatus]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/summaries.py b/previous-versions/assess/src/codatassess/models/shared/summaries.py old mode 100755 new mode 100644 index 908f7af95..d3c8d0c90 --- a/previous-versions/assess/src/codatassess/models/shared/summaries.py +++ b/previous-versions/assess/src/codatassess/models/shared/summaries.py @@ -2,7 +2,7 @@ from __future__ import annotations import dataclasses -from ..shared import dataintegritysummary as shared_dataintegritysummary +from .dataintegritysummary import DataIntegritySummary from codatassess import utils from dataclasses_json import Undefined, dataclass_json from typing import List, Optional @@ -11,6 +11,6 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Summaries: - summaries: Optional[List[shared_dataintegritysummary.DataIntegritySummary]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summaries'), 'exclude': lambda f: f is None }}) + summaries: Optional[List[DataIntegritySummary]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('summaries'), 'exclude': lambda f: f is None }}) diff --git a/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py b/previous-versions/assess/src/codatassess/models/shared/transactioncategory.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/webhooks/__init__.py b/previous-versions/assess/src/codatassess/models/webhooks/__init__.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/models/webhooks/account_categories_updated.py b/previous-versions/assess/src/codatassess/models/webhooks/account_categories_updated.py old mode 100755 new mode 100644 index 0e103b30c..3a7846f65 --- a/previous-versions/assess/src/codatassess/models/webhooks/account_categories_updated.py +++ b/previous-versions/assess/src/codatassess/models/webhooks/account_categories_updated.py @@ -3,16 +3,15 @@ from __future__ import annotations import dataclasses import requests as requests_http -from typing import Optional @dataclasses.dataclass class AccountCategoriesUpdatedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/previous-versions/assess/src/codatassess/reports.py b/previous-versions/assess/src/codatassess/reports.py old mode 100755 new mode 100644 index 69e95a8f3..fe475e6a3 --- a/previous-versions/assess/src/codatassess/reports.py +++ b/previous-versions/assess/src/codatassess/reports.py @@ -13,6 +13,7 @@ def __init__(self, sdk_config: SDKConfiguration) -> None: self.sdk_configuration = sdk_config + def generate_loan_summary(self, request: operations.GenerateLoanSummaryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateLoanSummaryResponse: r"""Generate loan summaries report The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. @@ -29,7 +30,10 @@ def generate_loan_summary(self, request: operations.GenerateLoanSummaryRequest, headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -48,21 +52,25 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GenerateLoanSummaryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 202: pass - elif http_res.status_code in [401, 404]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def generate_loan_transactions(self, request: operations.GenerateLoanTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GenerateLoanTransactionsResponse: r"""Generate loan transactions report The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. @@ -79,7 +87,10 @@ def generate_loan_transactions(self, request: operations.GenerateLoanTransaction headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -98,21 +109,25 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GenerateLoanTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 202: pass - elif http_res.status_code in [401, 404]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -127,7 +142,10 @@ def get_accounts_for_enhanced_balance_sheet(self, request: operations.GetAccount headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -146,7 +164,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountsForEnhancedBalanceSheetResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -155,16 +173,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + 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. @@ -179,7 +201,10 @@ def get_accounts_for_enhanced_profit_and_loss(self, request: operations.GetAccou headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -198,7 +223,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetAccountsForEnhancedProfitAndLossResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -207,16 +232,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_customer_retention_metrics(self, request: operations.GetCommerceCustomerRetentionMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceCustomerRetentionMetricsResponse: r"""Get customer retention metrics Gets the customer retention metrics for a specific company connection, over one or more periods of time. @@ -229,7 +258,10 @@ def get_commerce_customer_retention_metrics(self, request: operations.GetCommerc headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -248,7 +280,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceCustomerRetentionMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -257,16 +289,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_lifetime_value_metrics(self, request: operations.GetCommerceLifetimeValueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceLifetimeValueMetricsResponse: r"""Get lifetime value metric Gets the lifetime value metric for a specific company connection, over one or more periods of time. @@ -279,7 +315,10 @@ def get_commerce_lifetime_value_metrics(self, request: operations.GetCommerceLif headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -298,7 +337,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceLifetimeValueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -307,16 +346,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_orders_metrics(self, request: operations.GetCommerceOrdersMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceOrdersMetricsResponse: r"""Get orders report Gets the order information for a specific company connection, over one or more periods of time. @@ -329,7 +372,10 @@ def get_commerce_orders_metrics(self, request: operations.GetCommerceOrdersMetri headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -348,7 +394,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceOrdersMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -357,16 +403,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_refunds_metrics(self, request: operations.GetCommerceRefundsMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceRefundsMetricsResponse: r"""Get refunds report Gets the refunds information for a specific company connection, over one or more periods of time. @@ -379,7 +429,10 @@ def get_commerce_refunds_metrics(self, request: operations.GetCommerceRefundsMet headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -398,7 +451,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceRefundsMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -407,16 +460,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_commerce_revenue_metrics(self, request: operations.GetCommerceRevenueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetCommerceRevenueMetricsResponse: r"""Get commerce revenue metrics Get the revenue and revenue growth for a specific company connection, over one or more periods of time. @@ -429,7 +486,10 @@ def get_commerce_revenue_metrics(self, request: operations.GetCommerceRevenueMet headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -448,7 +508,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetCommerceRevenueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -457,16 +517,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_enhanced_cash_flow_transactions(self, request: operations.GetEnhancedCashFlowTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetEnhancedCashFlowTransactionsResponse: r"""Get enhanced cash flow report > **Categorization engine** @@ -483,7 +547,10 @@ def get_enhanced_cash_flow_transactions(self, request: operations.GetEnhancedCas headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -502,7 +569,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetEnhancedCashFlowTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -511,16 +578,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_enhanced_invoices_report(self, request: operations.GetEnhancedInvoicesReportRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetEnhancedInvoicesReportResponse: r"""Get enhanced invoices report Gets a list of invoices linked to the corresponding banking transaction @@ -533,7 +604,10 @@ def get_enhanced_invoices_report(self, request: operations.GetEnhancedInvoicesRe headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -552,7 +626,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetEnhancedInvoicesReportResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -561,16 +635,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetLoanSummaryResponse: r"""Get loan summaries The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. @@ -587,7 +665,10 @@ def get_loan_summary(self, request: operations.GetLoanSummaryRequest, retries: O headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -606,7 +687,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetLoanSummaryResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -615,16 +696,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def get_recurring_revenue_metrics(self, request: operations.GetRecurringRevenueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.GetRecurringRevenueMetricsResponse: r"""Get key subscription revenue metrics Gets key metrics for subscription revenue. @@ -636,7 +721,10 @@ def get_recurring_revenue_metrics(self, request: operations.GetRecurringRevenueM headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -655,7 +743,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.GetRecurringRevenueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -664,16 +752,20 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.ListLoanTransactionsResponse: r"""List loan transactions The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/codat-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. @@ -690,7 +782,10 @@ def list_loan_transactions(self, request: operations.ListLoanTransactionsRequest headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -709,7 +804,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.ListLoanTransactionsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -718,16 +813,20 @@ def do_request(): 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]: + elif http_res.status_code in [400, 401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', http_res.status_code, http_res.text, http_res) return res + def request_recurring_revenue_metrics(self, request: operations.RequestRecurringRevenueMetricsRequest, retries: Optional[utils.RetryConfig] = None) -> operations.RequestRecurringRevenueMetricsResponse: r"""Generate key subscription revenue metrics Requests production of key subscription revenue metrics. @@ -739,7 +838,10 @@ def request_recurring_revenue_metrics(self, request: operations.RequestRecurring headers['Accept'] = 'application/json' headers['user-agent'] = self.sdk_configuration.user_agent - client = self.sdk_configuration.security_client + if callable(self.sdk_configuration.security): + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security()) + else: + client = utils.configure_security_client(self.sdk_configuration.client, self.sdk_configuration.security) global_retry_config = self.sdk_configuration.retry_config retry_config = retries @@ -758,7 +860,7 @@ def do_request(): '5XX' ])) content_type = http_res.headers.get('Content-Type') - + res = operations.RequestRecurringRevenueMetricsResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: @@ -767,12 +869,15 @@ def do_request(): 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]: + elif http_res.status_code in [401, 402, 403, 404, 429, 500, 503]: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[shared.ErrorMessage]) - res.error_message = out + out = utils.unmarshal_json(http_res.text, errors.ErrorMessage) + out.raw_response = http_res + raise 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 >= 400 and http_res.status_code < 500 or http_res.status_code >= 500 and http_res.status_code < 600: + raise errors.SDKError('API error occurred', 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 old mode 100755 new mode 100644 index 529e47483..611ea7b8d --- a/previous-versions/assess/src/codatassess/sdk.py +++ b/previous-versions/assess/src/codatassess/sdk.py @@ -17,17 +17,17 @@ class CodatAssess: [See our OpenAPI spec](https://github.com/codatio/oas) """ + reports: Reports + r"""Enriched reports and analyses of financial data""" data_integrity: DataIntegrity r"""Match mutable accounting data with immutable banking data to increase confidence in financial data""" excel_reports: ExcelReports r"""Downloadable reports""" - reports: Reports - r"""Enriched reports and analyses of financial data""" sdk_configuration: SDKConfiguration def __init__(self, - auth_header: str, + auth_header: str , server_idx: int = None, server_url: str = None, url_params: Dict[str, str] = None, @@ -37,7 +37,7 @@ def __init__(self, """Instantiates the SDK configuring it with the provided parameters. :param auth_header: The auth_header required for authentication - :type auth_header: str + :type auth_header: Union[str,Callable[[], str]] :param server_idx: The index of the server to use for all operations :type server_idx: int :param server_url: The server URL to use for all operations @@ -52,20 +52,18 @@ def __init__(self, if client is None: client = requests_http.Session() - - security_client = utils.configure_security_client(client, shared.Security(auth_header = auth_header)) - + security = shared.Security(auth_header = auth_header) if server_url is not None: if url_params is not None: server_url = utils.template_url(server_url, url_params) - self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx, retry_config=retry_config) + self.sdk_configuration = SDKConfiguration(client, security, server_url, server_idx, retry_config=retry_config) self._init_sdks() def _init_sdks(self): + self.reports = Reports(self.sdk_configuration) self.data_integrity = DataIntegrity(self.sdk_configuration) self.excel_reports = ExcelReports(self.sdk_configuration) - self.reports = Reports(self.sdk_configuration) \ No newline at end of file diff --git a/previous-versions/assess/src/codatassess/sdkconfiguration.py b/previous-versions/assess/src/codatassess/sdkconfiguration.py old mode 100755 new mode 100644 index c539ad5dc..f27722ba8 --- a/previous-versions/assess/src/codatassess/sdkconfiguration.py +++ b/previous-versions/assess/src/codatassess/sdkconfiguration.py @@ -2,9 +2,10 @@ import requests from dataclasses import dataclass -from typing import Dict, Tuple +from typing import Dict, Tuple, Callable, Union from .utils.retries import RetryConfig from .utils import utils +from codatassess.models import shared SERVERS = [ @@ -16,14 +17,14 @@ @dataclass class SDKConfiguration: client: requests.Session - security_client: requests.Session + security: Union[shared.Security,Callable[[], shared.Security]] = None server_url: str = '' server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0' - sdk_version: str = '0.32.0' - gen_version: str = '2.159.2' - user_agent: str = 'speakeasy-sdk/python 0.32.0 2.159.2 1.0 codat-assess' + sdk_version: str = '0.33.0' + gen_version: str = '2.214.3' + user_agent: str = 'speakeasy-sdk/python 0.33.0 2.214.3 1.0 codat-assess' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: diff --git a/previous-versions/assess/src/codatassess/utils/__init__.py b/previous-versions/assess/src/codatassess/utils/__init__.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/utils/retries.py b/previous-versions/assess/src/codatassess/utils/retries.py old mode 100755 new mode 100644 diff --git a/previous-versions/assess/src/codatassess/utils/utils.py b/previous-versions/assess/src/codatassess/utils/utils.py old mode 100755 new mode 100644 index ccfad9f7a..1a60d4064 --- a/previous-versions/assess/src/codatassess/utils/utils.py +++ b/previous-versions/assess/src/codatassess/utils/utils.py @@ -12,7 +12,7 @@ from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, get_args, get_origin) from xmlrpc.client import boolean - +from typing_inspect import is_optional_type import dateutil.parser import requests from dataclasses_json import DataClassJsonMixin @@ -169,7 +169,7 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass serialization = param_metadata.get('serialization', '') if serialization != '': serialized_params = _get_serialized_params( - param_metadata, f_name, param) + param_metadata, field.type, f_name, param) for key, value in serialized_params.items(): path = path.replace( '{' + key + '}', value, 1) @@ -261,7 +261,7 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[ f_name = metadata.get("field_name") serialization = metadata.get('serialization', '') if serialization != '': - serialized_parms = _get_serialized_params(metadata, f_name, value) + serialized_parms = _get_serialized_params(metadata, field.type, f_name, value) for key, value in serialized_parms.items(): if key in params: params[key].extend(value) @@ -304,12 +304,12 @@ def get_headers(headers_params: dataclass) -> Dict[str, str]: return headers -def _get_serialized_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, str]: +def _get_serialized_params(metadata: Dict, field_type: type, field_name: str, obj: any) -> Dict[str, str]: params: Dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': - params[metadata.get("field_name", field_name)] = marshal_json(obj) + params[metadata.get("field_name", field_name)] = marshal_json(obj, field_type) return params @@ -394,14 +394,14 @@ def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delim } -def serialize_request_body(request: dataclass, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ +def serialize_request_body(request: dataclass, request_type: type, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ str, any, any]: if request is None: if not nullable and optional: return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): - return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], + return serialize_content_type(request_field_name, request_type, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request, encoder) request_val = getattr(request, request_field_name) @@ -421,13 +421,13 @@ def serialize_request_body(request: dataclass, request_field_name: str, nullable if request_metadata is None: raise Exception('invalid request type') - return serialize_content_type(request_field_name, request_metadata.get('media_type', 'application/octet-stream'), + return serialize_content_type(request_field_name, request_type, request_metadata.get('media_type', 'application/octet-stream'), request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: +def serialize_content_type(field_name: str, request_type: any, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request, encoder), None + return media_type, marshal_json(request, request_type, encoder), None if re.match(r'multipart\/.*', media_type) is not None: return serialize_multipart_form(media_type, request) if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: @@ -478,7 +478,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, form.append([field_name, [file_name, content]]) elif field_metadata.get("json") is True: to_append = [field_metadata.get("field_name", field.name), [ - None, marshal_json(val), "application/json"]] + None, marshal_json(val, field.type), "application/json"]] form.append(to_append) else: field_name = field_metadata.get( @@ -531,7 +531,7 @@ def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: field_name = metadata.get('field_name', field.name) if metadata.get('json'): - form[field_name] = [marshal_json(val)] + form[field_name] = [marshal_json(val, field.type)] else: if metadata.get('style', 'form') == 'form': form = {**form, **_populate_form( @@ -697,15 +697,17 @@ def unmarshal_json(data, typ, decoder=None): return out.res if decoder is None else decoder(out.res) -def marshal_json(val, encoder=None): - marshal = make_dataclass('Marshal', [('res', type(val))], +def marshal_json(val, typ, encoder=None): + if not is_optional_type(typ) and val is None: + raise ValueError(f"Could not marshal None into non-optional type: {typ}") + + marshal = make_dataclass('Marshal', [('res', typ)], bases=(DataClassJsonMixin,)) marshaller = marshal(res=val) json_dict = marshaller.to_dict() - val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) - return json.dumps(val) + return json.dumps(val, separators=(',', ':'), sort_keys=True) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -759,6 +761,8 @@ def bigintencode(val: int): def bigintdecoder(val): + if isinstance(val, float): + raise ValueError(f"{val} is a float") return int(val) @@ -828,6 +832,24 @@ def list_decode(val: List): return list_decode +def union_encoder(all_encoders: Dict[str, Callable]): + def selective_encoder(val: any): + if type(val) in all_encoders: + return all_encoders[type(val)](val) + return val + return selective_encoder + +def union_decoder(all_decoders: List[Callable]): + def selective_decoder(val: any): + decoded = val + for decoder in all_decoders: + try: + decoded = decoder(val) + break + except (TypeError, ValueError): + continue + return decoded + return selective_decoder def get_field_name(name): def override(_, _field_name=name): diff --git a/previous-versions/assess/tests/helpers.py b/previous-versions/assess/tests/helpers.py new file mode 100644 index 000000000..b3d095040 --- /dev/null +++ b/previous-versions/assess/tests/helpers.py @@ -0,0 +1,61 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import re + + +def sort_query_parameters(url): + parts = url.split("?") + + if len(parts) == 1: + return url + + query = parts[1] + params = query.split("&") + + params.sort(key=lambda x: x.split('=')[0]) + + return parts[0] + "?" + "&".join(params) + + +def sort_serialized_maps(inp: any, regex: str, delim: str): + + def sort_map(m): + entire_match = m.group(0) + + groups = m.groups() + + for group in groups: + pairs = [] + if '=' in group: + pairs = group.split(delim) + + pairs.sort(key=lambda x: x.split('=')[0]) + else: + values = group.split(delim) + + if len(values) == 1: + pairs = values + else: + pairs = [''] * int(len(values)/2) + # loop though every 2nd item + for i in range(0, len(values), 2): + pairs[int(i/2)] = values[i] + delim + values[i+1] + + pairs.sort(key=lambda x: x.split(delim)[0]) + + entire_match = entire_match.replace(group, delim.join(pairs)) + + return entire_match + + if isinstance(inp, str): + return re.sub(regex, sort_map, inp) + elif isinstance(inp, list): + for i, v in enumerate(inp): + inp[i] = sort_serialized_maps(v, regex, delim) + return inp + elif isinstance(inp, dict): + for k, v in inp.items(): + inp[k] = sort_serialized_maps(v, regex, delim) + return inp + else: + raise Exception("Unsupported type")