Skip to content

chore: speakeasy sdk regeneration - Generate Assess library #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2023
Merged

chore: speakeasy sdk regeneration - Generate Assess library #452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 36 additions & 23 deletions previous-versions/assess/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,30 @@ yarn add @codat/assess

## Example Usage
<!-- Start SDK Example Usage -->


```typescript
import { CodatAssess } from "@codat/assess";
import { ListDataTypeDataIntegrityDetailsResponse } from "@codat/assess/dist/sdk/models/operations";
import { DataIntegrityDataType } from "@codat/assess/dist/sdk/models/shared";

const sdk = new CodatAssess({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});

sdk.dataIntegrity.details({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
dataType: DataIntegrityDataType.BankingAccounts,
orderBy: "-modifiedDate",
page: 1,
pageSize: 100,
query: "corrupti",
}).then((res: ListDataTypeDataIntegrityDetailsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
(async () => {
const sdk = new CodatAssess({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});

const res = await sdk.dataIntegrity.details({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
dataType: DataIntegrityDataType.BankingAccounts,
orderBy: "-modifiedDate",
page: 1,
pageSize: 100,
});

if (res.statusCode == 200) {
// handle response
}
})();

```
<!-- End SDK Example Usage -->

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

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

* [generateLoanSummary](docs/sdks/reports/README.md#generateloansummary) - Generate loan summaries report
* [generateLoanTransactions](docs/sdks/reports/README.md#generateloantransactions) - Generate loan transactions report
* [getAccountsForEnhancedBalanceSheet](docs/sdks/reports/README.md#getaccountsforenhancedbalancesheet) - Get enhanced balance sheet accounts
* [getAccountsForEnhancedProfitAndLoss](docs/sdks/reports/README.md#getaccountsforenhancedprofitandloss) - Get enhanced profit and loss accounts
* [getCommerceCustomerRetentionMetrics](docs/sdks/reports/README.md#getcommercecustomerretentionmetrics) - Get customer retention metrics
Expand All @@ -79,9 +80,21 @@ sdk.dataIntegrity.details({
* [getCommerceRevenueMetrics](docs/sdks/reports/README.md#getcommercerevenuemetrics) - Get commerce revenue metrics
* [getEnhancedCashFlowTransactions](docs/sdks/reports/README.md#getenhancedcashflowtransactions) - Get enhanced cash flow report
* [getEnhancedInvoicesReport](docs/sdks/reports/README.md#getenhancedinvoicesreport) - Get enhanced invoices report
* [getLoanSummary](docs/sdks/reports/README.md#getloansummary) - Get enhanced loan summaries
* [getLoanSummary](docs/sdks/reports/README.md#getloansummary) - Get loan summaries
* [getRecurringRevenueMetrics](docs/sdks/reports/README.md#getrecurringrevenuemetrics) - Get key subscription revenue metrics
* [listLoanTransactions](docs/sdks/reports/README.md#listloantransactions) - List enhanced loan transactions
* [listLoanTransactions](docs/sdks/reports/README.md#listloantransactions) - List loan transactions
* [requestRecurringRevenueMetrics](docs/sdks/reports/README.md#requestrecurringrevenuemetrics) - Generate key subscription revenue metrics
<!-- End SDK Available Operations -->



<!-- Start Dev Containers -->



<!-- End Dev Containers -->

<!-- Placeholder for Future Speakeasy SDK Sections -->


### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
12 changes: 11 additions & 1 deletion previous-versions/assess/RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,4 +606,14 @@ Based on:
### Generated
- [typescript v0.34.0] previous-versions/assess
### Releases
- [NPM v0.34.0] https://www.npmjs.com/package/@codat/assess/v/0.34.0 - previous-versions/assess
- [NPM v0.34.0] https://www.npmjs.com/package/@codat/assess/v/0.34.0 - previous-versions/assess

## 2023-10-17 14:11:31
### Changes
Based on:
- OpenAPI Doc 1.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Assess.yaml
- Speakeasy CLI 1.100.2 (2.159.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.0] previous-versions/assess
### Releases
- [NPM v0.35.0] https://www.npmjs.com/package/@codat/assess/v/0.35.0 - previous-versions/assess
37 changes: 19 additions & 18 deletions previous-versions/assess/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,27 @@

```typescript
import { CodatAssess } from "@codat/assess";
import { ListDataTypeDataIntegrityDetailsResponse } from "@codat/assess/dist/sdk/models/operations";
import { DataIntegrityDataType } from "@codat/assess/dist/sdk/models/shared";

const sdk = new CodatAssess({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
(async () => {
const sdk = new CodatAssess({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});

const res = await sdk.dataIntegrity.details({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
dataType: DataIntegrityDataType.BankingAccounts,
orderBy: "-modifiedDate",
page: 1,
pageSize: 100,
});

if (res.statusCode == 200) {
// handle response
}
})();

sdk.dataIntegrity.details({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
dataType: DataIntegrityDataType.BankingAccounts,
orderBy: "-modifiedDate",
page: 1,
pageSize: 100,
query: "corrupti",
}).then((res: ListDataTypeDataIntegrityDetailsResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```
<!-- End SDK Example Usage -->
2 changes: 1 addition & 1 deletion previous-versions/assess/docs/models/operations/generateexcelreportrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `reportType` | [shared.ExcelReportType](../../models/shared/excelreporttype.md) | :heavy_check_mark: | The type of report you want to generate and download. | |
6 changes: 3 additions & 3 deletions previous-versions/assess/docs/models/operations/generateexcelreportresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | N/A |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
| `excelStatus` | [shared.ExcelStatus](../../models/shared/excelstatus.md) | :heavy_minus_sign: | OK |
| `statusCode` | *number* | :heavy_check_mark: | N/A |
| `rawResponse` | [AxiosResponse>](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
9 changes: 9 additions & 0 deletions previous-versions/assess/docs/models/operations/generateloansummaryrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GenerateLoanSummaryRequest


## Fields

| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `sourceType` | [GenerateLoanSummarySourceType](../../models/operations/generateloansummarysourcetype.md) | :heavy_check_mark: | Data source type. | |
11 changes: 11 additions & 0 deletions previous-versions/assess/docs/models/operations/generateloansummaryresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GenerateLoanSummaryResponse


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
12 changes: 12 additions & 0 deletions previous-versions/assess/docs/models/operations/generateloansummarysourcetype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GenerateLoanSummarySourceType

Data source type.


## Values

| Name | Value |
| ------------ | ------------ |
| `Banking` | banking |
| `Commerce` | commerce |
| `Accounting` | accounting |
9 changes: 9 additions & 0 deletions previous-versions/assess/docs/models/operations/generateloantransactionsrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GenerateLoanTransactionsRequest


## Fields

| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `sourceType` | [GenerateLoanTransactionsSourceType](../../models/operations/generateloantransactionssourcetype.md) | :heavy_check_mark: | Data source type | |
11 changes: 11 additions & 0 deletions ...ious-versions/assess/docs/models/operations/generateloantransactionsresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GenerateLoanTransactionsResponse


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `errorMessage` | [shared.ErrorMessage](../../models/shared/errormessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
12 changes: 12 additions & 0 deletions ...us-versions/assess/docs/models/operations/generateloantransactionssourcetype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GenerateLoanTransactionsSourceType

Data source type


## Values

| Name | Value |
| ------------ | ------------ |
| `Banking` | banking |
| `Commerce` | commerce |
| `Accounting` | accounting |
Loading