Skip to content

Commit 4c86b36

Browse files
authored
Merge pull request #452 from codatio/speakeasy-sdk-regen-1697551895
chore: speakeasy sdk regeneration - Generate Assess library
2 parents f383b9b + 950db49 commit 4c86b36

File tree

132 files changed

+1632
-649
lines changed

Some content is hidden

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

132 files changed

+1632
-649
lines changed

previous-versions/assess/README.md

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,30 @@ yarn add @codat/assess
2323

2424
## Example Usage
2525
<!-- Start SDK Example Usage -->
26-
27-
2826
```typescript
2927
import { CodatAssess } from "@codat/assess";
30-
import { ListDataTypeDataIntegrityDetailsResponse } from "@codat/assess/dist/sdk/models/operations";
3128
import { DataIntegrityDataType } from "@codat/assess/dist/sdk/models/shared";
3229

33-
const sdk = new CodatAssess({
34-
security: {
35-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
36-
},
37-
});
38-
39-
sdk.dataIntegrity.details({
40-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
41-
dataType: DataIntegrityDataType.BankingAccounts,
42-
orderBy: "-modifiedDate",
43-
page: 1,
44-
pageSize: 100,
45-
query: "corrupti",
46-
}).then((res: ListDataTypeDataIntegrityDetailsResponse) => {
47-
if (res.statusCode == 200) {
48-
// handle response
49-
}
50-
});
30+
(async () => {
31+
const sdk = new CodatAssess({
32+
security: {
33+
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
34+
},
35+
});
36+
37+
const res = await sdk.dataIntegrity.details({
38+
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
39+
dataType: DataIntegrityDataType.BankingAccounts,
40+
orderBy: "-modifiedDate",
41+
page: 1,
42+
pageSize: 100,
43+
});
44+
45+
if (res.statusCode == 200) {
46+
// handle response
47+
}
48+
})();
49+
5150
```
5251
<!-- End SDK Example Usage -->
5352

@@ -70,6 +69,8 @@ sdk.dataIntegrity.details({
7069

7170
### [reports](docs/sdks/reports/README.md)
7271

72+
* [generateLoanSummary](docs/sdks/reports/README.md#generateloansummary) - Generate loan summaries report
73+
* [generateLoanTransactions](docs/sdks/reports/README.md#generateloantransactions) - Generate loan transactions report
7374
* [getAccountsForEnhancedBalanceSheet](docs/sdks/reports/README.md#getaccountsforenhancedbalancesheet) - Get enhanced balance sheet accounts
7475
* [getAccountsForEnhancedProfitAndLoss](docs/sdks/reports/README.md#getaccountsforenhancedprofitandloss) - Get enhanced profit and loss accounts
7576
* [getCommerceCustomerRetentionMetrics](docs/sdks/reports/README.md#getcommercecustomerretentionmetrics) - Get customer retention metrics
@@ -79,9 +80,21 @@ sdk.dataIntegrity.details({
7980
* [getCommerceRevenueMetrics](docs/sdks/reports/README.md#getcommercerevenuemetrics) - Get commerce revenue metrics
8081
* [getEnhancedCashFlowTransactions](docs/sdks/reports/README.md#getenhancedcashflowtransactions) - Get enhanced cash flow report
8182
* [getEnhancedInvoicesReport](docs/sdks/reports/README.md#getenhancedinvoicesreport) - Get enhanced invoices report
82-
* [getLoanSummary](docs/sdks/reports/README.md#getloansummary) - Get enhanced loan summaries
83+
* [getLoanSummary](docs/sdks/reports/README.md#getloansummary) - Get loan summaries
8384
* [getRecurringRevenueMetrics](docs/sdks/reports/README.md#getrecurringrevenuemetrics) - Get key subscription revenue metrics
84-
* [listLoanTransactions](docs/sdks/reports/README.md#listloantransactions) - List enhanced loan transactions
85+
* [listLoanTransactions](docs/sdks/reports/README.md#listloantransactions) - List loan transactions
8586
* [requestRecurringRevenueMetrics](docs/sdks/reports/README.md#requestrecurringrevenuemetrics) - Generate key subscription revenue metrics
8687
<!-- End SDK Available Operations -->
88+
89+
90+
91+
<!-- Start Dev Containers -->
92+
93+
94+
95+
<!-- End Dev Containers -->
96+
97+
<!-- Placeholder for Future Speakeasy SDK Sections -->
98+
99+
87100
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

previous-versions/assess/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,4 +606,14 @@ Based on:
606606
### Generated
607607
- [typescript v0.34.0] previous-versions/assess
608608
### Releases
609-
- [NPM v0.34.0] https://www.npmjs.com/package/@codat/assess/v/0.34.0 - previous-versions/assess
609+
- [NPM v0.34.0] https://www.npmjs.com/package/@codat/assess/v/0.34.0 - previous-versions/assess
610+
611+
## 2023-10-17 14:11:31
612+
### Changes
613+
Based on:
614+
- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
615+
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
616+
### Generated
617+
- [typescript v0.35.0] previous-versions/assess
618+
### Releases
619+
- [NPM v0.35.0] https://www.npmjs.com/package/@codat/assess/v/0.35.0 - previous-versions/assess

previous-versions/assess/USAGE.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,27 @@
33

44
```typescript
55
import { CodatAssess } from "@codat/assess";
6-
import { ListDataTypeDataIntegrityDetailsResponse } from "@codat/assess/dist/sdk/models/operations";
76
import { DataIntegrityDataType } from "@codat/assess/dist/sdk/models/shared";
87

9-
const sdk = new CodatAssess({
10-
security: {
11-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
12-
},
13-
});
8+
(async () => {
9+
const sdk = new CodatAssess({
10+
security: {
11+
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
12+
},
13+
});
14+
15+
const res = await sdk.dataIntegrity.details({
16+
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
17+
dataType: DataIntegrityDataType.BankingAccounts,
18+
orderBy: "-modifiedDate",
19+
page: 1,
20+
pageSize: 100,
21+
});
22+
23+
if (res.statusCode == 200) {
24+
// handle response
25+
}
26+
})();
1427

15-
sdk.dataIntegrity.details({
16-
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
17-
dataType: DataIntegrityDataType.BankingAccounts,
18-
orderBy: "-modifiedDate",
19-
page: 1,
20-
pageSize: 100,
21-
query: "corrupti",
22-
}).then((res: ListDataTypeDataIntegrityDetailsResponse) => {
23-
if (res.statusCode == 200) {
24-
// handle response
25-
}
26-
});
2728
```
2829
<!-- 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-
| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
8+
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
99
| `reportType` | [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-
| `contentType` | *string* | :heavy_check_mark: | N/A |
8+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
1010
| `excelStatus` | [shared.ExcelStatus](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK |
11-
| `statusCode` | *number* | :heavy_check_mark: | N/A |
12-
| `rawResponse` | [AxiosResponse>](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
11+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
12+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
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+
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9+
| `sourceType` | [GenerateLoanSummarySourceType](../../models/operations/generateloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | |
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+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
10+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
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 |
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+
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9+
| `sourceType` | [GenerateLoanTransactionsSourceType](../../models/operations/generateloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | |
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+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
10+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)