Skip to content

platform: release v5.0.2 (in-house codegen) #661

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 v5.0.2 (in-house codegen) #661

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
  •  
  •  
  •  
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 @@ -158,4 +158,14 @@ Based on:
### Generated
- [python v5.0.1] platform
### Releases
- [PyPI v5.0.1] https://pypi.org/project/codat-platform/5.0.1 - platform
- [PyPI v5.0.1] https://pypi.org/project/codat-platform/5.0.1 - platform

## 2026-08-07 11:55:25
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
- codat sdk-codegen b5f25135143b1ccfb99c941df11a7a1596dbe31e https://github.com/codat-spikes/sdk-codegen
### Generated
- [python v5.0.2] platform
### Releases
- [PyPI v5.0.2] https://pypi.org/project/codat-platform/5.0.2 - platform
98 changes: 50 additions & 48 deletions platform/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,51 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from codat_platform import CodatPlatform
from codat_platform.models import shared


with CodatPlatform(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as cp_client:

res = cp_client.settings.create_api_key(request={
"name": "azure-invoice-finance-processor",
})

# Handle response
print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from codat_platform import CodatPlatform
from codat_platform.models import shared

async def main():

async with CodatPlatform(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as cp_client:

res = await cp_client.settings.create_api_key_async(request={
"name": "azure-invoice-finance-processor",
})

# Handle response
print(res)

asyncio.run(main())
```
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from codat_platform import CodatPlatform
from codat_platform.models import shared


with CodatPlatform(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as cp_client:

res = cp_client.companies.add_product(request={
"company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
"product_identifier": "bank-feeds",
})

# Handle response
print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from codat_platform import CodatPlatform
from codat_platform.models import shared

async def main():

async with CodatPlatform(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
) as cp_client:

res = await cp_client.companies.add_product_async(request={
"company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
"product_identifier": "bank-feeds",
})

# Handle response
print(res)

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->
28 changes: 13 additions & 15 deletions platform/docs/models/errors/errormessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# ErrorMessage

Your API request was not properly authorized.


## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
# ErrorMessage


## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
| `validation` | [OptionalNullable[shared.ErrorValidation]](../../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. |
16 changes: 8 additions & 8 deletions platform/docs/models/operations/addproductrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AddProductRequest


## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
# AddProductRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `product_identifier` | *str* | :heavy_check_mark: | Human-readable product identifier for a product. | **Example 1:** bank-feeds<br/>**Example 2:** lending<br/>**Example 3:** payables<br/>**Example 4:** expenses |
Loading