Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.346.3
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Jul 27, 2024
1 parent 3749650 commit 5f3b0cf
Show file tree
Hide file tree
Showing 204 changed files with 3,189 additions and 2,586 deletions.
42 changes: 29 additions & 13 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: b0b519b1-d1d3-43b2-82dd-b4292eadd4b0
management:
docChecksum: 5b362866a3e7a85c830c6cb1f1cf4896
docChecksum: 312822a7ccdbf7c77dbbfeef49fb2053
docVersion: 0.4.0 .
speakeasyVersion: 1.332.1
generationVersion: 2.366.1
releaseVersion: 6.2.0
configChecksum: 48969b4d7724988d84c0cce48b9a8753
speakeasyVersion: 1.346.3
generationVersion: 2.379.6
releaseVersion: 6.3.0
configChecksum: 511764c1ed21807dbbda4fcd048339ff
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
repoSubDirectory: .
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
Expand All @@ -15,10 +15,11 @@ features:
python:
acceptHeaders: 3.0.0
additionalDependencies: 1.0.0
core: 5.0.0
core: 5.2.4
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
downloadStreams: 1.0.0
envVarSecurityUsage: 0.2.0
examples: 3.0.0
globalSecurity: 3.0.0
globalSecurityCallbacks: 1.0.0
Expand All @@ -30,6 +31,7 @@ features:
responseFormat: 1.0.0
retries: 3.0.0
sdkHooks: 1.0.0
serverEventsSentinels: 0.1.0
serverIDs: 3.0.0
uploadStreams: 1.0.0
generatedFiles:
Expand All @@ -47,18 +49,22 @@ generatedFiles:
- src/speakeasy_client_sdk_python/shorturls.py
- src/speakeasy_client_sdk_python/suggest.py
- src/speakeasy_client_sdk_python/embeds.py
- src/speakeasy_client_sdk_python/workspaces.py
- src/speakeasy_client_sdk_python/events.py
- src/speakeasy_client_sdk_python/sdk.py
- .vscode/settings.json
- py.typed
- pylintrc
- pyproject.toml
- scripts/publish.sh
- src/speakeasy_client_sdk_python/__init__.py
- src/speakeasy_client_sdk_python/basesdk.py
- src/speakeasy_client_sdk_python/httpclient.py
- src/speakeasy_client_sdk_python/py.typed
- src/speakeasy_client_sdk_python/types/__init__.py
- src/speakeasy_client_sdk_python/types/basemodel.py
- src/speakeasy_client_sdk_python/utils/__init__.py
- src/speakeasy_client_sdk_python/utils/annotations.py
- src/speakeasy_client_sdk_python/utils/enums.py
- src/speakeasy_client_sdk_python/utils/eventstreaming.py
- src/speakeasy_client_sdk_python/utils/forms.py
Expand Down Expand Up @@ -122,6 +128,7 @@ generatedFiles:
- src/speakeasy_client_sdk_python/models/operations/githubstorepublishingsecrets.py
- src/speakeasy_client_sdk_python/models/operations/triggeraction.py
- src/speakeasy_client_sdk_python/models/operations/createfreetrial.py
- src/speakeasy_client_sdk_python/models/operations/getorganization.py
- src/speakeasy_client_sdk_python/models/operations/getorganizationusage.py
- src/speakeasy_client_sdk_python/models/operations/getorganizations.py
- src/speakeasy_client_sdk_python/models/operations/getchangesreportsignedurl.py
Expand All @@ -134,11 +141,14 @@ generatedFiles:
- src/speakeasy_client_sdk_python/models/operations/getembedaccesstoken.py
- src/speakeasy_client_sdk_python/models/operations/getvalidembedaccesstokens.py
- src/speakeasy_client_sdk_python/models/operations/revokeembedaccesstoken.py
- src/speakeasy_client_sdk_python/models/operations/getworkspace.py
- src/speakeasy_client_sdk_python/models/operations/getworkspaceeventsbytarget.py
- src/speakeasy_client_sdk_python/models/operations/getworkspacetargets.py
- src/speakeasy_client_sdk_python/models/operations/postworkspaceevents.py
- src/speakeasy_client_sdk_python/models/operations/searchworkspaceevents.py
- src/speakeasy_client_sdk_python/models/operations/__init__.py
- src/speakeasy_client_sdk_python/models/errors/error.py
- src/speakeasy_client_sdk_python/models/errors/__init__.py
- src/speakeasy_client_sdk_python/models/shared/generateopenapispecdiff.py
- src/speakeasy_client_sdk_python/models/shared/api.py
- src/speakeasy_client_sdk_python/models/shared/api_input.py
Expand Down Expand Up @@ -183,24 +193,22 @@ generatedFiles:
- src/speakeasy_client_sdk_python/models/shared/githubmissingpublishingsecretsresponse.py
- src/speakeasy_client_sdk_python/models/shared/githubstorepublishingsecretsrequest.py
- src/speakeasy_client_sdk_python/models/shared/githubtriggeractionrequest.py
- src/speakeasy_client_sdk_python/models/shared/organization.py
- src/speakeasy_client_sdk_python/models/shared/organizationusageresponse.py
- src/speakeasy_client_sdk_python/models/shared/organizationusage.py
- src/speakeasy_client_sdk_python/models/shared/organization.py
- src/speakeasy_client_sdk_python/models/shared/report.py
- src/speakeasy_client_sdk_python/models/shared/shorturl.py
- src/speakeasy_client_sdk_python/models/shared/suggestedoperationids.py
- src/speakeasy_client_sdk_python/models/shared/suggestoperationidsopts.py
- src/speakeasy_client_sdk_python/models/shared/embedaccesstokenresponse.py
- src/speakeasy_client_sdk_python/models/shared/embedtoken.py
- src/speakeasy_client_sdk_python/models/shared/workspace.py
- src/speakeasy_client_sdk_python/models/shared/clievent.py
- src/speakeasy_client_sdk_python/models/shared/interactiontype.py
- src/speakeasy_client_sdk_python/models/shared/targetsdk.py
- src/speakeasy_client_sdk_python/models/shared/security.py
- src/speakeasy_client_sdk_python/models/internal/globals.py
- src/speakeasy_client_sdk_python/models/__init__.py
- src/speakeasy_client_sdk_python/models/errors/__init__.py
- src/speakeasy_client_sdk_python/models/operations/__init__.py
- src/speakeasy_client_sdk_python/models/shared/__init__.py
- src/speakeasy_client_sdk_python/models/internal/globals.py
- src/speakeasy_client_sdk_python/models/internal/__init__.py
- docs/models/operations/deleteapirequest.md
- docs/models/operations/deleteapiresponse.md
Expand Down Expand Up @@ -296,6 +304,8 @@ generatedFiles:
- docs/models/operations/githubstorepublishingsecretsresponse.md
- docs/models/operations/triggeractionresponse.md
- docs/models/operations/createfreetrialresponse.md
- docs/models/operations/getorganizationrequest.md
- docs/models/operations/getorganizationresponse.md
- docs/models/operations/getorganizationusageresponse.md
- docs/models/operations/getorganizationsresponse.md
- docs/models/operations/getchangesreportsignedurlrequest.md
Expand Down Expand Up @@ -324,6 +334,9 @@ generatedFiles:
- docs/models/operations/getvalidembedaccesstokensresponse.md
- docs/models/operations/revokeembedaccesstokenrequest.md
- docs/models/operations/revokeembedaccesstokenresponse.md
- docs/models/operations/getworkspaceglobals.md
- docs/models/operations/getworkspacerequest.md
- docs/models/operations/getworkspaceresponse.md
- docs/models/operations/getworkspaceeventsbytargetglobals.md
- docs/models/operations/getworkspaceeventsbytargetrequest.md
- docs/models/operations/getworkspaceeventsbytargetresponse.md
Expand Down Expand Up @@ -390,10 +403,10 @@ generatedFiles:
- docs/models/shared/githubmissingpublishingsecretsresponse.md
- docs/models/shared/githubstorepublishingsecretsrequest.md
- docs/models/shared/githubtriggeractionrequest.md
- docs/models/shared/organizationusageresponse.md
- docs/models/shared/organizationusage.md
- docs/models/shared/organizationaccounttype.md
- docs/models/shared/organization.md
- docs/models/shared/organizationusageresponse.md
- docs/models/shared/organizationusage.md
- docs/models/shared/type.md
- docs/models/shared/report.md
- docs/models/shared/shorturl.md
Expand All @@ -403,6 +416,7 @@ generatedFiles:
- docs/models/shared/suggestoperationidsopts.md
- docs/models/shared/embedaccesstokenresponse.md
- docs/models/shared/embedtoken.md
- docs/models/shared/workspace.md
- docs/models/shared/generatebumptype.md
- docs/models/shared/openapidiffbumptype.md
- docs/models/shared/clievent.md
Expand All @@ -425,9 +439,11 @@ generatedFiles:
- docs/sdks/shorturls/README.md
- docs/sdks/suggest/README.md
- docs/sdks/embeds/README.md
- docs/sdks/workspaces/README.md
- docs/sdks/events/README.md
- USAGE.md
- .gitattributes
- src/speakeasy_client_sdk_python/_hooks/sdkhooks.py
- src/speakeasy_client_sdk_python/_hooks/types.py
- src/speakeasy_client_sdk_python/_hooks/__init__.py
- CONTRIBUTING.md
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
python:
version: 6.2.0
version: 6.3.0
additionalDependencies:
dev: {}
main: {}
Expand Down
10 changes: 5 additions & 5 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
speakeasyVersion: 1.332.1
speakeasyVersion: 1.346.3
sources:
speakeasy-openapi:
sourceNamespace: speakeasy-openapi
sourceRevisionDigest: sha256:121b6a8fba2d6cc7179b89ab8591c1e2941f165008a40ce4f11129d7029625af
sourceBlobDigest: sha256:006c8b9bf2fa7c9da133155e3cba4d985edd45e5ebf8e41639a771c7a207fca5
sourceRevisionDigest: sha256:d406788bc634eed35f120d28218a266db43ece356bf8604e3d0e58c11186990e
sourceBlobDigest: sha256:469530993014d334b464cacfcc662663e2e72db61a1ad2838b91e4c8fab4f3f3
tags:
- latest
- main
targets:
speakeasy-client-sdk-python:
source: speakeasy-openapi
sourceNamespace: speakeasy-openapi
sourceRevisionDigest: sha256:121b6a8fba2d6cc7179b89ab8591c1e2941f165008a40ce4f11129d7029625af
sourceBlobDigest: sha256:006c8b9bf2fa7c9da133155e3cba4d985edd45e5ebf8e41639a771c7a207fca5
sourceRevisionDigest: sha256:d406788bc634eed35f120d28218a266db43ece356bf8604e3d0e58c11186990e
sourceBlobDigest: sha256:469530993014d334b464cacfcc662663e2e72db61a1ad2838b91e4c8fab4f3f3
outLocation: /github/workspace/repo
workflow:
workflowVersion: 1.0.0
Expand Down
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"python.testing.pytestArgs": ["tests", "-vv"],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
}
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to This Repository

Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.

## How to Report Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:

- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed

## Issue Triage and Upstream Fixes

We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.

## Contact

If you have any questions or need further assistance, please feel free to reach out by opening an issue.

Thank you for your understanding and cooperation!

The Maintainers
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ s = Speakeasy(
)


res = s.apis.get_apis(request={})
res = s.apis.get_apis()

if res.apis is not None:
# handle response
Expand All @@ -55,7 +55,7 @@ async def main():
api_key=os.getenv("API_KEY", ""),
),
)
res = await s.apis.get_apis_async(request={})
res = await s.apis.get_apis_async()
if res.apis is not None:
# handle response
pass
Expand Down Expand Up @@ -143,6 +143,7 @@ asyncio.run(main())
### [organizations](docs/sdks/organizations/README.md)

* [create_free_trial](docs/sdks/organizations/README.md#create_free_trial) - Create a free trial for an organization
* [get_organization](docs/sdks/organizations/README.md#get_organization) - Get organization
* [get_organization_usage](docs/sdks/organizations/README.md#get_organization_usage) - Get billing usage summary for a particular organization
* [get_organizations](docs/sdks/organizations/README.md#get_organizations) - Get organizations for a user

Expand All @@ -168,6 +169,10 @@ asyncio.run(main())
* [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.

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

* [get_workspace](docs/sdks/workspaces/README.md#get_workspace) - Get workspace

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

* [get_workspace_events_by_target](docs/sdks/events/README.md#get_workspace_events_by_target) - Load recent events for a particular workspace
Expand Down Expand Up @@ -420,7 +425,7 @@ if res is not None:

A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set `workspaceID` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_workspace_events_by_target`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
For example, you can set `workspaceID` to `"<value>"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_workspace`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.


### Available Globals
Expand All @@ -446,11 +451,9 @@ s = Speakeasy(
)


res = s.events.get_workspace_events_by_target(request={
"target_id": "<value>",
})
res = s.workspaces.get_workspace()

if res.cli_event_batch is not None:
if res.workspace is not None:
# handle response
pass

Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -1756,4 +1756,14 @@ Based on:
### Generated
- [python v6.2.0] .
### Releases
- [PyPI v6.2.0] https://pypi.org/project/speakeasy-client-sdk-python/6.2.0 - .
- [PyPI v6.2.0] https://pypi.org/project/speakeasy-client-sdk-python/6.2.0 - .

## 2024-07-27 00:11:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.346.3 (2.379.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v6.3.0] .
### Releases
- [PyPI v6.3.0] https://pypi.org/project/speakeasy-client-sdk-python/6.3.0 - .
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ s = Speakeasy(
)


res = s.apis.get_apis(request={})
res = s.apis.get_apis()

if res.apis is not None:
# handle response
Expand All @@ -35,7 +35,7 @@ async def main():
api_key=os.getenv("API_KEY", ""),
),
)
res = await s.apis.get_apis_async(request={})
res = await s.apis.get_apis_async()
if res.apis is not None:
# handle response
pass
Expand Down
8 changes: 8 additions & 0 deletions docs/models/operations/getorganizationrequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# GetOrganizationRequest


## Fields

| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `organization_id` | *str* | :heavy_check_mark: | Unique identifier of the organization. |
12 changes: 12 additions & 0 deletions docs/models/operations/getorganizationresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GetOrganizationResponse


## 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` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | *Optional[errors.Error]* | :heavy_minus_sign: | Default error response |
| `organization` | [Optional[shared.Organization]](../../models/shared/organization.md) | :heavy_minus_sign: | OK |
2 changes: 1 addition & 1 deletion docs/models/operations/getschemaresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | *Optional[errors.Error]* | :heavy_minus_sign: | Default error response |
| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | OK |
| `schema_` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | OK |
2 changes: 1 addition & 1 deletion docs/models/operations/getschemarevisionresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `error` | *Optional[errors.Error]* | :heavy_minus_sign: | Default error response |
| `schema` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | OK |
| `schema_` | [Optional[shared.Schema]](../../models/shared/schema.md) | :heavy_minus_sign: | OK |
Loading

0 comments on commit 5f3b0cf

Please sign in to comment.