Skip to content
Merged
  •  
  •  
  •  
3,605 changes: 0 additions & 3,605 deletions platform/.speakeasy/gen.lock

This file was deleted.

90 changes: 0 additions & 90 deletions platform/.speakeasy/gen.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,16 +570,10 @@ const sdk = new CodatPlatform({ debugLogger: console });
```
<!-- End Debugging [debug] -->

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

<!-- Start Codat Support Notes -->
## Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance.
You can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](mailto:[email protected]).
We're here to help ensure a smooth experience for you.
<!-- End Codat Support Notes -->

<!-- Start Codat Generated By -->
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
<!-- End Codat Generated By -->
19 changes: 18 additions & 1 deletion platform/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,4 +234,21 @@ Based on:
### Generated
- [typescript v6.2.1] platform
### Releases
- [NPM v6.2.1] https://www.npmjs.com/package/@codat/platform/v/6.2.1 - platform
- [NPM v6.2.1] https://www.npmjs.com/package/@codat/platform/v/6.2.1 - platform

## 2026-08-25
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
- Codat SDK Codegen
### Generated
- [typescript v7.0.0] platform
### Releases
- [NPM v7.0.0] https://www.npmjs.com/package/@codat/platform/v/7.0.0 - platform

### Notes
**Breaking:** only the paths listed in `exports` in `package.json` resolve now. Importing a file by its path inside the package, for example `@codat/platform/sdk/models/shared/apikeydetails.js`, no longer works - import from `@codat/platform/sdk/models/shared` or the package root instead.

The zod validation schemas (`*$inboundSchema` / `*$outboundSchema`) are gone and zod is no longer a dependency. Each model now exports `ApiKeyDetailsFromJSON`, `ApiKeyDetailsToJSON` and `instanceOfApiKeyDetails`.

`SDKError.message` now holds the message on its own. The status code, the content type and the response body are still on the error, as `statusCode`, `contentType` and `body`.
41 changes: 20 additions & 21 deletions platform/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
const result = await codatPlatform.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 { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

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

console.log(result);
}

run();
```
<!-- End SDK Example Usage [usage] -->
46 changes: 23 additions & 23 deletions platform/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` |
Loading