Skip to content

Commit f392535

Browse files
github-actions[bot]speakeasybot
github-actions[bot]
and
speakeasybot
authored
ci: regenerated with OpenAPI Doc 3.0.0, Speakeasy CLI 1.179.0 (#568)
Co-authored-by: speakeasybot <[email protected]>
1 parent c371e79 commit f392535

File tree

154 files changed

+944
-508
lines changed

Some content is hidden

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

154 files changed

+944
-508
lines changed

‎platform/.speakeasy/gen.lock‎

Lines changed: 370 additions & 0 deletions
Large diffs are not rendered by default.

‎platform/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ if res.api_key_details is not None:
121121
<!-- Start Retries [retries] -->
122122
## Retries
123123

124-
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
124+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
125125

126-
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
126+
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
127127
```python
128128
import codatplatform
129129
from codatplatform.models import shared
@@ -147,7 +147,7 @@ if res.api_key_details is not None:
147147
pass
148148
```
149149

150-
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
150+
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
151151
```python
152152
import codatplatform
153153
from codatplatform.models import shared
@@ -186,7 +186,7 @@ Handling errors in this SDK should largely match your expectations. All operati
186186

187187
```python
188188
import codatplatform
189-
from codatplatform.models import shared
189+
from codatplatform.models import errors, shared
190190

191191
s = codatplatform.CodatPlatform(
192192
security=shared.Security(
@@ -202,10 +202,10 @@ res = None
202202
try:
203203
res = s.settings.create_api_key(req)
204204
except errors.ErrorMessage as e:
205-
print(e) # handle exception
205+
# handle exception
206206
raise(e)
207207
except errors.SDKError as e:
208-
print(e) # handle exception
208+
# handle exception
209209
raise(e)
210210

211211
if res.api_key_details is not None:
@@ -279,7 +279,7 @@ if res.api_key_details is not None:
279279
<!-- Start Custom HTTP Client [http-client] -->
280280
## Custom HTTP Client
281281

282-
The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
282+
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
283283

284284
For example, you could specify a header for every request that this sdk makes as follows:
285285
```python

‎platform/RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,14 @@ Based on:
6868
### Generated
6969
- [python v3.2.0] platform
7070
### Releases
71-
- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform
71+
- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform
72+
73+
## 2024-02-14 10:44:02
74+
### Changes
75+
Based on:
76+
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
77+
- Speakeasy CLI 1.179.0 (2.257.2) https://github.com/speakeasy-api/speakeasy
78+
### Generated
79+
- [python v3.3.0] platform
80+
### Releases
81+
- [PyPI v3.3.0] https://pypi.org/project/codat-platform/3.3.0 - platform

‎platform/docs/models/errors/errormessage.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ Bad Request
55

66
## Fields
77

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. |
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. |
16+
| `validation` | [Optional[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. |

‎platform/docs/models/operations/addcompanytogrouprequest.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
| Field | Type | Required | Description | Example |
77
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
8-
| `company_group_assignment` | [Optional[shared.CompanyGroupAssignment]](../../models/shared/companygroupassignment.md) | :heavy_minus_sign: | N/A | |
9-
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
8+
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9+
| `company_group_assignment` | [Optional[shared.CompanyGroupAssignment]](../../models/shared/companygroupassignment.md) | :heavy_minus_sign: | N/A | |

0 commit comments

Comments
 (0)