Skip to content

Commit 2514074

Browse files
author
codat-sdk-codegen
committed
platform: regenerate with the in-house pipeline @ b5f2513, version 5.0.1 -> 5.0.2
1 parent 2348452 commit 2514074

383 files changed

Lines changed: 30555 additions & 26944 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

platform/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,14 @@ Based on:
158158
### Generated
159159
- [python v5.0.1] platform
160160
### Releases
161-
- [PyPI v5.0.1] https://pypi.org/project/codat-platform/5.0.1 - platform
161+
- [PyPI v5.0.1] https://pypi.org/project/codat-platform/5.0.1 - platform
162+
163+
## 2026-08-07 11:55:25
164+
### Changes
165+
Based on:
166+
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
167+
- codat sdk-codegen b5f25135143b1ccfb99c941df11a7a1596dbe31e https://github.com/codat-spikes/sdk-codegen
168+
### Generated
169+
- [python v5.0.2] platform
170+
### Releases
171+
- [PyPI v5.0.2] https://pypi.org/project/codat-platform/5.0.2 - platform

platform/USAGE.md

Lines changed: 50 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,51 @@
1-
<!-- Start SDK Example Usage [usage] -->
2-
```python
3-
# Synchronous Example
4-
from codat_platform import CodatPlatform
5-
from codat_platform.models import shared
6-
7-
8-
with CodatPlatform(
9-
security=shared.Security(
10-
auth_header="Basic BASE_64_ENCODED(API_KEY)",
11-
),
12-
) as cp_client:
13-
14-
res = cp_client.settings.create_api_key(request={
15-
"name": "azure-invoice-finance-processor",
16-
})
17-
18-
# Handle response
19-
print(res)
20-
```
21-
22-
</br>
23-
24-
The same SDK client can also be used to make asynchronous requests by importing asyncio.
25-
26-
```python
27-
# Asynchronous Example
28-
import asyncio
29-
from codat_platform import CodatPlatform
30-
from codat_platform.models import shared
31-
32-
async def main():
33-
34-
async with CodatPlatform(
35-
security=shared.Security(
36-
auth_header="Basic BASE_64_ENCODED(API_KEY)",
37-
),
38-
) as cp_client:
39-
40-
res = await cp_client.settings.create_api_key_async(request={
41-
"name": "azure-invoice-finance-processor",
42-
})
43-
44-
# Handle response
45-
print(res)
46-
47-
asyncio.run(main())
48-
```
1+
<!-- Start SDK Example Usage [usage] -->
2+
```python
3+
# Synchronous Example
4+
from codat_platform import CodatPlatform
5+
from codat_platform.models import shared
6+
7+
8+
with CodatPlatform(
9+
security=shared.Security(
10+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
11+
),
12+
) as cp_client:
13+
14+
res = cp_client.companies.add_product(request={
15+
"company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
16+
"product_identifier": "bank-feeds",
17+
})
18+
19+
# Handle response
20+
print(res)
21+
```
22+
23+
</br>
24+
25+
The same SDK client can also be used to make asynchronous requests by importing asyncio.
26+
27+
```python
28+
# Asynchronous Example
29+
import asyncio
30+
from codat_platform import CodatPlatform
31+
from codat_platform.models import shared
32+
33+
async def main():
34+
35+
async with CodatPlatform(
36+
security=shared.Security(
37+
auth_header="Basic BASE_64_ENCODED(API_KEY)",
38+
),
39+
) as cp_client:
40+
41+
res = await cp_client.companies.add_product_async(request={
42+
"company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
43+
"product_identifier": "bank-feeds",
44+
})
45+
46+
# Handle response
47+
print(res)
48+
49+
asyncio.run(main())
50+
```
4951
<!-- End SDK Example Usage [usage] -->
Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
# ErrorMessage
2-
3-
Your API request was not properly authorized.
4-
5-
6-
## Fields
7-
8-
| Field | Type | Required | Description |
9-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
10-
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
11-
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
12-
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
13-
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
14-
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
15-
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
1+
# ErrorMessage
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
8+
| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
9+
| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
10+
| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
11+
| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. |
12+
| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. |
13+
| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. |
1614
| `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. |
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# AddProductRequest
2-
3-
4-
## Fields
5-
6-
| Field | Type | Required | Description | Example |
7-
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
8-
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
1+
# AddProductRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description | Example |
7+
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
99
| `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 |

0 commit comments

Comments
 (0)