Skip to content

chore: 🐝 Update SDK - Generate Platform library #568

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

Merged
merged 1 commit into from
Feb 14, 2024
Merged

chore: 🐝 Update SDK - Generate Platform library #568

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
370 changes: 370 additions & 0 deletions platform/.speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions platform/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,9 @@ if res.api_key_details is not None:
<!-- Start Retries [retries] -->
## Retries

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.
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.

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

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
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:
```python
import codatplatform
from codatplatform.models import shared
Expand Down Expand Up @@ -186,7 +186,7 @@ Handling errors in this SDK should largely match your expectations. All operati

```python
import codatplatform
from codatplatform.models import shared
from codatplatform.models import errors, shared

s = codatplatform.CodatPlatform(
security=shared.Security(
Expand All @@ -202,10 +202,10 @@ res = None
try:
res = s.settings.create_api_key(req)
except errors.ErrorMessage as e:
print(e) # handle exception
# handle exception
raise(e)
except errors.SDKError as e:
print(e) # handle exception
# handle exception
raise(e)

if res.api_key_details is not None:
Expand Down Expand Up @@ -279,7 +279,7 @@ if res.api_key_details is not None:
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

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.
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.

For example, you could specify a header for every request that this sdk makes as follows:
```python
Expand Down
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 @@ -68,4 +68,14 @@ Based on:
### Generated
- [python v3.2.0] platform
### Releases
- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform
- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform

## 2024-02-14 10:44:02
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
- Speakeasy CLI 1.179.0 (2.257.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v3.3.0] platform
### Releases
- [PyPI v3.3.0] https://pypi.org/project/codat-platform/3.3.0 - platform
17 changes: 9 additions & 8 deletions platform/docs/models/errors/errormessage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ Bad Request

## 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. |
| 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` | [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. |
4 changes: 2 additions & 2 deletions platform/docs/models/operations/addcompanytogrouprequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

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