Skip to content

Commit 9861c1b

Browse files
dcoplowedcoplowe
authored
Merge pull request #463 from codatio/speakeasy-sdk-regen-1697552163
chore: speakeasy sdk regeneration - Generate Assess library
2 parents 33835d5 + a35b11e commit 9861c1b

File tree

191 files changed

+1405
-719
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

191 files changed

+1405
-719
lines changed

‎previous-versions/assess/README.md‎

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,84 @@ Assess helps you make smarter credit decisions on small businesses by enabling y
88
You can use that data for automating decisioning and surfacing new insights on the customer, all via one API.
99

1010
<!-- Start SDK Installation -->
11-
replace me
11+
## SDK Installation
12+
13+
```bash
14+
pip install codat-assess
15+
```
1216
<!-- End SDK Installation -->
1317

1418
## Example Usage
1519
<!-- Start SDK Example Usage -->
16-
replace me
20+
```python
21+
import codatassess
22+
from codatassess.models import operations, shared
23+
24+
s = codatassess.CodatAssess(
25+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
26+
)
27+
28+
req = operations.ListDataTypeDataIntegrityDetailsRequest(
29+
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
30+
data_type=shared.DataIntegrityDataType.BANKING_ACCOUNTS,
31+
order_by='-modifiedDate',
32+
page=1,
33+
page_size=100,
34+
)
35+
36+
res = s.data_integrity.details(req)
37+
38+
if res.details is not None:
39+
# handle response
40+
pass
41+
```
1742
<!-- End SDK Example Usage -->
1843

1944
<!-- Start SDK Available Operations -->
20-
replace me
45+
## Available Resources and Operations
46+
47+
48+
### [data_integrity](docs/sdks/dataintegrity/README.md)
49+
50+
* [details](docs/sdks/dataintegrity/README.md#details) - List data type data integrity
51+
* [status](docs/sdks/dataintegrity/README.md#status) - Get data integrity status
52+
* [summary](docs/sdks/dataintegrity/README.md#summary) - Get data integrity summary
53+
54+
### [excel_reports](docs/sdks/excelreports/README.md)
55+
56+
* [generate_excel_report](docs/sdks/excelreports/README.md#generate_excel_report) - Generate Excel report
57+
* [get_accounting_marketing_metrics](docs/sdks/excelreports/README.md#get_accounting_marketing_metrics) - Get marketing metrics report
58+
* [get_excel_report](docs/sdks/excelreports/README.md#get_excel_report) - Download Excel report
59+
* [get_excel_report_generation_status](docs/sdks/excelreports/README.md#get_excel_report_generation_status) - Get Excel report status
60+
61+
### [reports](docs/sdks/reports/README.md)
62+
63+
* [generate_loan_summary](docs/sdks/reports/README.md#generate_loan_summary) - Generate loan summaries report
64+
* [generate_loan_transactions](docs/sdks/reports/README.md#generate_loan_transactions) - Generate loan transactions report
65+
* [get_accounts_for_enhanced_balance_sheet](docs/sdks/reports/README.md#get_accounts_for_enhanced_balance_sheet) - Get enhanced balance sheet accounts
66+
* [get_accounts_for_enhanced_profit_and_loss](docs/sdks/reports/README.md#get_accounts_for_enhanced_profit_and_loss) - Get enhanced profit and loss accounts
67+
* [get_commerce_customer_retention_metrics](docs/sdks/reports/README.md#get_commerce_customer_retention_metrics) - Get customer retention metrics
68+
* [get_commerce_lifetime_value_metrics](docs/sdks/reports/README.md#get_commerce_lifetime_value_metrics) - Get lifetime value metric
69+
* [get_commerce_orders_metrics](docs/sdks/reports/README.md#get_commerce_orders_metrics) - Get orders report
70+
* [get_commerce_refunds_metrics](docs/sdks/reports/README.md#get_commerce_refunds_metrics) - Get refunds report
71+
* [get_commerce_revenue_metrics](docs/sdks/reports/README.md#get_commerce_revenue_metrics) - Get commerce revenue metrics
72+
* [get_enhanced_cash_flow_transactions](docs/sdks/reports/README.md#get_enhanced_cash_flow_transactions) - Get enhanced cash flow report
73+
* [get_enhanced_invoices_report](docs/sdks/reports/README.md#get_enhanced_invoices_report) - Get enhanced invoices report
74+
* [get_loan_summary](docs/sdks/reports/README.md#get_loan_summary) - Get loan summaries
75+
* [get_recurring_revenue_metrics](docs/sdks/reports/README.md#get_recurring_revenue_metrics) - Get key subscription revenue metrics
76+
* [list_loan_transactions](docs/sdks/reports/README.md#list_loan_transactions) - List loan transactions
77+
* [request_recurring_revenue_metrics](docs/sdks/reports/README.md#request_recurring_revenue_metrics) - Generate key subscription revenue metrics
2178
<!-- End SDK Available Operations -->
79+
80+
81+
82+
<!-- Start Dev Containers -->
83+
84+
85+
86+
<!-- End Dev Containers -->
87+
88+
<!-- Placeholder for Future Speakeasy SDK Sections -->
89+
90+
2291
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎previous-versions/assess/RELEASES.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
3+
## 2023-10-17 14:15:57
4+
### Changes
5+
Based on:
6+
- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
7+
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
8+
### Generated
9+
- [python v0.32.0] previous-versions/assess
10+
### Releases
11+
- [PyPI v0.32.0] https://pypi.org/project/codat-assess/0.32.0 - previous-versions/assess

‎previous-versions/assess/USAGE.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ import codatassess
66
from codatassess.models import operations, shared
77

88
s = codatassess.CodatAssess(
9-
security=shared.Security(
10-
auth_header="Basic BASE_64_ENCODED(API_KEY)",
11-
),
9+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
1210
)
1311

1412
req = operations.ListDataTypeDataIntegrityDetailsRequest(
@@ -17,12 +15,12 @@ req = operations.ListDataTypeDataIntegrityDetailsRequest(
1715
order_by='-modifiedDate',
1816
page=1,
1917
page_size=100,
20-
query='corrupti',
2118
)
2219

2320
res = s.data_integrity.details(req)
2421

2522
if res.details is not None:
2623
# handle response
24+
pass
2725
```
2826
<!-- End SDK Example Usage -->

‎previous-versions/assess/docs/models/operations/generateexcelreportrequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
| Field | Type | Required | Description | Example |
77
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
8-
| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
99
| `report_type` | [shared.ExcelReportType](../../models/shared/excelreporttype.md) | :heavy_check_mark: | The type of report you want to generate and download. | |

‎previous-versions/assess/docs/models/operations/generateexcelreportresponse.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8-
| `content_type` | *str* | :heavy_check_mark: | N/A |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
1010
| `excel_status` | [Optional[shared.ExcelStatus]](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK |
11-
| `status_code` | *int* | :heavy_check_mark: | N/A |
12-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A |
11+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
12+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎previous-versions/assess/docs/models/operations/generateloansummaryrequest.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# GenerateLoanSummaryRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9+
| `source_type` | [GenerateLoanSummarySourceType](../../models/operations/generateloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | |

‎previous-versions/assess/docs/models/operations/generateloansummaryresponse.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GenerateLoanSummaryResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
10+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎previous-versions/assess/docs/models/operations/generateloansummarysourcetype.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# GenerateLoanSummarySourceType
2+
3+
Data source type.
4+
5+
6+
## Values
7+
8+
| Name | Value |
9+
| ------------ | ------------ |
10+
| `BANKING` | banking |
11+
| `COMMERCE` | commerce |
12+
| `ACCOUNTING` | accounting |

‎previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# GenerateLoanTransactionsRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9+
| `source_type` | [GenerateLoanTransactionsSourceType](../../models/operations/generateloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | |

‎previous-versions/assess/docs/models/operations/generateloantransactionsresponse.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GenerateLoanTransactionsResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
10+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)