Skip to content

chore: 🐝 Update SDK - Generate Platform library #584

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
Apr 26, 2024
Merged

chore: 🐝 Update SDK - Generate Platform library #584

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
46 changes: 34 additions & 12 deletions platform/.speakeasy/gen.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
lockVersion: 2.0.0
id: ede4f28e-23c0-442d-89ba-baa76ae2da6e
management:
docChecksum: 6b9afa35a1ca4d8a1834643e80dd9a19
docChecksum: 91b86a7707fc536ccbdc7b7345d775a0
docVersion: 3.0.0
speakeasyVersion: internal
generationVersion: 2.277.0
releaseVersion: 3.4.0
configChecksum: 29197c333cff36b846fe087471e16d21
speakeasyVersion: 1.274.1
generationVersion: 2.314.0
releaseVersion: 3.5.0
configChecksum: 80bf5d1b7da8b1a6ec5440792d84c83d
repoURL: https://github.com/codatio/client-sdk-python.git
repoSubDirectory: platform
installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=platform
published: true
features:
python:
constsAndDefaults: 0.1.3
core: 4.5.0
core: 4.6.5
deprecations: 2.81.1
examples: 2.81.3
globalSecurity: 2.83.4
globalServerURLs: 2.82.1
globalSecurity: 2.83.5
globalServerURLs: 2.82.2
groups: 2.81.2
ignores: 2.81.1
inputOutputModels: 2.83.1
nameOverrides: 2.81.1
retries: 2.82.1
nameOverrides: 2.81.2
responseFormat: 0.1.0
retries: 2.82.2
webhooks: 1.0.0
generatedFiles:
- src/codatplatform/sdkconfiguration.py
- src/codatplatform/settings.py
- src/codatplatform/companies.py
- src/codatplatform/cors_settings.py
- src/codatplatform/connection_management.py
- src/codatplatform/connections.py
- src/codatplatform/custom_data_type.py
- src/codatplatform/push_data.py
Expand All @@ -36,6 +41,7 @@ generatedFiles:
- src/codatplatform/supplemental_data.py
- src/codatplatform/webhooks.py
- src/codatplatform/sdk.py
- py.typed
- pylintrc
- setup.py
- src/codatplatform/__init__.py
Expand All @@ -56,6 +62,9 @@ generatedFiles:
- src/codatplatform/models/operations/get_company.py
- src/codatplatform/models/operations/list_companies.py
- src/codatplatform/models/operations/update_company.py
- src/codatplatform/models/operations/get_connection_management_access_token.py
- src/codatplatform/models/operations/get_connection_management_cors_settings.py
- src/codatplatform/models/operations/set_connection_management_cors_settings.py
- src/codatplatform/models/operations/create_connection.py
- src/codatplatform/models/operations/delete_connection.py
- src/codatplatform/models/operations/get_connection.py
Expand Down Expand Up @@ -108,6 +117,8 @@ generatedFiles:
- src/codatplatform/models/shared/companies.py
- src/codatplatform/models/shared/links.py
- src/codatplatform/models/shared/halref.py
- src/codatplatform/models/shared/connectionmanagementaccesstoken.py
- src/codatplatform/models/shared/connectionmanagementallowedorigins.py
- src/codatplatform/models/shared/connections.py
- src/codatplatform/models/shared/updateconnectionstatus.py
- src/codatplatform/models/shared/customdatatypeconfiguration.py
Expand All @@ -129,7 +140,9 @@ generatedFiles:
- src/codatplatform/models/shared/pushchangetype.py
- src/codatplatform/models/shared/pushoperationref.py
- src/codatplatform/models/shared/pushoperations.py
- src/codatplatform/models/shared/datastatuses.py
- src/codatplatform/models/shared/datastatus.py
- src/codatplatform/models/shared/status.py
- src/codatplatform/models/shared/pulloperations.py
- src/codatplatform/models/shared/companygroupassignment.py
- src/codatplatform/models/shared/group.py
Expand Down Expand Up @@ -205,6 +218,10 @@ generatedFiles:
- docs/models/operations/listcompaniesresponse.md
- docs/models/operations/updatecompanyrequest.md
- docs/models/operations/updatecompanyresponse.md
- docs/models/operations/getconnectionmanagementaccesstokenrequest.md
- docs/models/operations/getconnectionmanagementaccesstokenresponse.md
- docs/models/operations/getconnectionmanagementcorssettingsresponse.md
- docs/models/operations/setconnectionmanagementcorssettingsresponse.md
- docs/models/operations/createconnectionrequestbody.md
- docs/models/operations/createconnectionrequest.md
- docs/models/operations/createconnectionresponse.md
Expand Down Expand Up @@ -288,14 +305,16 @@ generatedFiles:
- docs/models/shared/companies.md
- docs/models/shared/links.md
- docs/models/shared/halref.md
- docs/models/shared/connectionmanagementaccesstoken.md
- docs/models/shared/connectionmanagementallowedorigins.md
- docs/models/shared/connections.md
- docs/models/shared/updateconnectionstatus.md
- docs/models/shared/customdatatypeconfiguration.md
- docs/models/shared/customdatatyperecords.md
- docs/models/shared/content.md
- docs/models/shared/modifieddate.md
- docs/models/shared/customdatatyperecord.md
- docs/models/shared/status.md
- docs/models/shared/datasetstatus.md
- docs/models/shared/pulloperation.md
- docs/models/shared/pushoption.md
- docs/models/shared/pushvalidationinfo.md
Expand All @@ -312,8 +331,10 @@ generatedFiles:
- docs/models/shared/pushchangetype.md
- docs/models/shared/pushoperationref.md
- docs/models/shared/pushoperations.md
- docs/models/shared/datastatuses.md
- docs/models/shared/datatypes.md
- docs/models/shared/datastatus.md
- docs/models/shared/status.md
- docs/models/shared/pulloperations.md
- docs/models/shared/companygroupassignment.md
- docs/models/shared/group.md
Expand Down Expand Up @@ -372,6 +393,8 @@ generatedFiles:
- docs/models/utils/retryconfig.md
- docs/sdks/settings/README.md
- docs/sdks/companies/README.md
- docs/sdks/connectionmanagement/README.md
- docs/sdks/corssettings/README.md
- docs/sdks/connections/README.md
- docs/sdks/customdatatype/README.md
- docs/sdks/pushdata/README.md
Expand All @@ -382,7 +405,6 @@ generatedFiles:
- docs/sdks/webhooks/README.md
- USAGE.md
- .gitattributes
- src/codatplatform/_hooks/registration.py
- src/codatplatform/_hooks/sdkhooks.py
- src/codatplatform/_hooks/types.py
- src/codatplatform/_hooks/__init__.py
22 changes: 19 additions & 3 deletions platform/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```
<!-- End SDK Example Usage [usage] -->

Expand All @@ -61,6 +62,15 @@ if res.api_key_details is not None:
* [list](docs/sdks/companies/README.md#list) - List companies
* [update](docs/sdks/companies/README.md#update) - Update company

### [connection_management](docs/sdks/connectionmanagement/README.md)

* [get_access_token](docs/sdks/connectionmanagement/README.md#get_access_token) - Get access token

### [connection_management.cors_settings](docs/sdks/corssettings/README.md)

* [get](docs/sdks/corssettings/README.md#get) - Get CORS settings
* [set](docs/sdks/corssettings/README.md#set) - Set CORS settings

### [connections](docs/sdks/connections/README.md)

* [create](docs/sdks/connections/README.md#create) - Create connection
Expand Down Expand Up @@ -148,6 +158,7 @@ res = s.settings.create_api_key(req,
if res.api_key_details is not None:
# handle response
pass

```

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:
Expand All @@ -157,7 +168,7 @@ from codatplatform.models import shared
from codatplatform.utils import BackoffStrategy, RetryConfig

s = codatplatform.CodatPlatform(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False),
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
Expand All @@ -172,6 +183,7 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```
<!-- End Retries [retries] -->

Expand All @@ -183,7 +195,7 @@ Handling errors in this SDK should largely match your expectations. All operati
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.ErrorMessage | 400,401,402,403,409,429,500,503 | application/json |
| errors.SDKError | 4x-5xx | */* |
| errors.SDKError | 4xx-5xx | */* |

### Example

Expand Down Expand Up @@ -214,6 +226,7 @@ except errors.SDKError as e:
if res.api_key_details is not None:
# handle response
pass

```
<!-- End Error Handling [errors] -->

Expand Down Expand Up @@ -250,6 +263,7 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```


Expand All @@ -276,6 +290,7 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```
<!-- End Server Selection [server] -->

Expand All @@ -291,7 +306,7 @@ import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatplatform.CodatPlatform(client: http_client)
s = codatplatform.CodatPlatform(client=http_client)
```
<!-- End Custom HTTP Client [http-client] -->

Expand Down Expand Up @@ -326,6 +341,7 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```
<!-- End Authentication [security] -->

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 @@ -88,4 +88,14 @@ Based on:
### Generated
- [python v3.4.0] platform
### Releases
- [PyPI v3.4.0] https://pypi.org/project/codat-platform/3.4.0 - platform
- [PyPI v3.4.0] https://pypi.org/project/codat-platform/3.4.0 - platform

## 2024-04-26 13:53:28
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v3.5.0] platform
### Releases
- [PyPI v3.5.0] https://pypi.org/project/codat-platform/3.5.0 - platform
1 change: 1 addition & 0 deletions platform/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ res = s.settings.create_api_key(req)
if res.api_key_details is not None:
# handle response
pass

```
<!-- End SDK Example Usage [usage] -->
2 changes: 1 addition & 1 deletion platform/docs/models/operations/getcompanydatastatusresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `data_statuses` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK |
| `data_statuses` | [Optional[shared.DataStatuses]](../../models/shared/datastatuses.md) | :heavy_minus_sign: | OK |
8 changes: 8 additions & 0 deletions platform/docs/models/operations/getconnectionmanagementaccesstokenrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# GetConnectionManagementAccessTokenRequest


## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
11 changes: 11 additions & 0 deletions platform/docs/models/operations/getconnectionmanagementaccesstokenresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetConnectionManagementAccessTokenResponse


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `connection_management_access_token` | [Optional[shared.ConnectionManagementAccessToken]](../../models/shared/connectionmanagementaccesstoken.md) | :heavy_minus_sign: | Success |
11 changes: 11 additions & 0 deletions platform/docs/models/operations/getconnectionmanagementcorssettingsresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# GetConnectionManagementCorsSettingsResponse


## Fields

| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | |
| `connection_management_allowed_origins` | [Optional[shared.ConnectionManagementAllowedOrigins]](../../models/shared/connectionmanagementallowedorigins.md) | :heavy_minus_sign: | Success | {<br/>"allowedOrigins": [<br/>"https://www.bank-of-dave.com"<br/>]<br/>} |
Loading