Skip to content

platform: release v6.2.2 (in-house codegen) #677

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

Open
codat-sdk-generator wants to merge 1 commit into
base: experimental/in-house-codegen
Choose a base branch
from
Open

platform: release v6.2.2 (in-house codegen) #677

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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3,605 changes: 0 additions & 3,605 deletions platform/.speakeasy/gen.lock
View file
Open in desktop

This file was deleted.

90 changes: 0 additions & 90 deletions platform/.speakeasy/gen.yaml
View file
Open in desktop

This file was deleted.

12 changes: 11 additions & 1 deletion platform/RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,4 +234,14 @@ 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-05 19:30:19
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
- codat sdk-codegen 1b5626f25df09d713121c5e8a048d9b44b3b7178 https://github.com/codat-spikes/sdk-codegen
### Generated
- [typescript v6.2.2] platform
### Releases
- [NPM v6.2.2] https://www.npmjs.com/package/@codat/platform/v/6.2.2 - platform
41 changes: 20 additions & 21 deletions platform/USAGE.md
View file
Open in desktop
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
View file
Open in desktop
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 platform/docs/sdk/models/errors/errormessage.md
View file
Open in desktop
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/platform/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/platform/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