Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
18,190 changes: 0 additions & 18,190 deletions lending/.speakeasy/gen.lock

This file was deleted.

91 changes: 0 additions & 91 deletions lending/.speakeasy/gen.yaml

This file was deleted.

12 changes: 11 additions & 1 deletion lending/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,14 @@ Based on:
### Generated
- [typescript v7.6.0] lending
### Releases
- [NPM v7.6.0] https://www.npmjs.com/package/@codat/lending/v/7.6.0 - lending
- [NPM v7.6.0] https://www.npmjs.com/package/@codat/lending/v/7.6.0 - lending

## 2026-08-05 19:30:17
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Lending.yaml
- codat sdk-codegen 1b5626f25df09d713121c5e8a048d9b44b3b7178 https://github.com/codat-spikes/sdk-codegen
### Generated
- [typescript v7.6.1] lending
### Releases
- [NPM v7.6.1] https://www.npmjs.com/package/@codat/lending/v/7.6.1 - lending
43 changes: 22 additions & 21 deletions lending/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
const result = await codatLending.companies.list({
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
tags: "region=uk && team=invoice-finance",
});

console.log(result);
}

run();

```
<!-- Start SDK Example Usage [usage] -->
```typescript
import { CodatLending } from "@codat/lending";

const codatLending = new CodatLending({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
const result = await codatLending.accountingBankData.listTransactions({
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
accountId: "13d946f0-c5d5-42bc-b092-97ece17923ab",
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});

console.log(result);
}

run();
```
<!-- End SDK Example Usage [usage] -->
46 changes: 23 additions & 23 deletions lending/docs/lib/utils/retryconfig.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# RetryConfig

Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.

## Fields

| Name | Type | Description | Example |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |

## BackoffStrategy

The backoff strategy allows retrying a request with an exponential backoff between each retry.

### Fields

| Name | Type | Description | Example |
| ------------------ | ------------ | ----------------------------------------- | -------- |
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
# RetryConfig
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
## Fields
| Name | Type | Description | Example |
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
## BackoffStrategy
The backoff strategy allows retrying a request with an exponential backoff between each retry.
### Fields
| Name | Type | Description | Example |
| ------------------ | ------------ | ----------------------------------------- | -------- |
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
42 changes: 20 additions & 22 deletions lending/docs/sdk/models/errors/errormessage.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
# ErrorMessage

Your `query` parameter was not correctly formed

## Example Usage

```typescript
import { ErrorMessage } from "@codat/lending/sdk/models/errors";

// No examples available for this model
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
# ErrorMessage

## Example Usage

```typescript
import { ErrorMessage } from "@codat/lending/sdk/models/errors";

// No examples available for this model
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `detailedErrorCode` | *number* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
Loading