Skip to content

Commit

Permalink
Merge pull request #2 from speakeasy-api/speakeasy-sdk-regen-1722903800
Browse files Browse the repository at this point in the history
  • Loading branch information
TristanSpeakEasy authored Aug 10, 2024
2 parents 75fc0aa + b10ca65 commit 4a1f6e4
Show file tree
Hide file tree
Showing 64 changed files with 403 additions and 298 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
.venv/
README-PYPI.md
pyrightconfig.json
.python-version
.DS_Store
venv/
src/*.egg-info/
__pycache__/
.pytest_cache/
.idea
.idea
25 changes: 14 additions & 11 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: 312822a7ccdbf7c77dbbfeef49fb2053
docChecksum: 7e5374ccd8317cf07089c151d486221b
docVersion: 0.4.0 .
speakeasyVersion: 1.351.1
generationVersion: 2.384.3
releaseVersion: 7.0.0-rc.0
configChecksum: 1d686a63e7865a7b7cb6ff50fbdaeda1
speakeasyVersion: 1.361.1
generationVersion: 2.393.4
releaseVersion: 7.0.0-rc.1
configChecksum: 352cb880812185e4b20ae9e7ae20962a
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,19 +15,20 @@ features:
python:
acceptHeaders: 3.0.0
additionalDependencies: 1.0.0
core: 5.3.1
core: 5.3.7
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
downloadStreams: 1.0.1
envVarSecurityUsage: 0.2.1
envVarSecurityUsage: 0.3.1
examples: 3.0.0
globalSecurity: 3.0.0
globalSecurity: 3.0.2
globalSecurityCallbacks: 1.0.0
globalServerURLs: 3.0.0
globals: 3.0.0
inputOutputModels: 3.0.0
multipartFileContentType: 1.0.0
nullables: 1.0.0
openEnums: 1.0.0
responseFormat: 1.0.0
retries: 3.0.0
sdkHooks: 1.0.0
Expand All @@ -53,9 +54,12 @@ generatedFiles:
- src/speakeasy_client_sdk_python/events.py
- src/speakeasy_client_sdk_python/sdk.py
- .vscode/settings.json
- poetry.toml
- py.typed
- pylintrc
- pyproject.toml
- scripts/compile.sh
- scripts/prepare-readme.py
- scripts/publish.sh
- src/speakeasy_client_sdk_python/__init__.py
- src/speakeasy_client_sdk_python/basesdk.py
Expand Down Expand Up @@ -175,6 +179,7 @@ generatedFiles:
- src/speakeasy_client_sdk_python/models/shared/preflighttoken.py
- src/speakeasy_client_sdk_python/models/shared/preflightrequest.py
- src/speakeasy_client_sdk_python/models/shared/accesstoken.py
- src/speakeasy_client_sdk_python/models/shared/accounttype.py
- src/speakeasy_client_sdk_python/models/shared/featureflag.py
- src/speakeasy_client_sdk_python/models/shared/user.py
- src/speakeasy_client_sdk_python/models/shared/accessdetails.py
Expand Down Expand Up @@ -379,14 +384,13 @@ generatedFiles:
- docs/models/shared/preflightrequest.md
- docs/models/shared/claims.md
- docs/models/shared/accesstokenuser.md
- docs/models/shared/accesstokenaccounttype.md
- docs/models/shared/workspaces.md
- docs/models/shared/accesstoken.md
- docs/models/shared/accounttype.md
- docs/models/shared/featureflag.md
- docs/models/shared/user.md
- docs/models/shared/level.md
- docs/models/shared/accessdetails.md
- docs/models/shared/accounttype.md
- docs/models/shared/apikeydetails.md
- docs/models/shared/unboundedrequest.md
- docs/models/shared/boundedrequest.md
Expand All @@ -404,7 +408,6 @@ generatedFiles:
- docs/models/shared/githubmissingpublishingsecretsresponse.md
- docs/models/shared/githubstorepublishingsecretsrequest.md
- docs/models/shared/githubtriggeractionrequest.md
- docs/models/shared/organizationaccounttype.md
- docs/models/shared/organization.md
- docs/models/shared/organizationusageresponse.md
- docs/models/shared/organizationusage.md
Expand Down
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: 7.0.0-rc.0
version: 7.0.0-rc.1
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.351.1
speakeasyVersion: 1.361.1
sources:
speakeasy-openapi:
sourceNamespace: speakeasy-openapi
sourceRevisionDigest: sha256:02836429166e1c637402f0f067f36aed1706d9ee7693eee13cd84382cdcc8df4
sourceBlobDigest: sha256:e3e8d5f794c2d732b4bee571c092e80d1aaf1a5e3e998300b313ee4b8f9fc012
sourceRevisionDigest: sha256:f9c9ffd7c550f43e427c2bfe5fdbbe55f91d3dae20a90063d7e430762d9152c5
sourceBlobDigest: sha256:be0a96c80997c1222c549aeb6f7f2b1a96a494e56f8df0c2dddad9a95a43b631
tags:
- latest
- main
targets:
speakeasy-client-sdk-python:
source: speakeasy-openapi
sourceNamespace: speakeasy-openapi
sourceRevisionDigest: sha256:02836429166e1c637402f0f067f36aed1706d9ee7693eee13cd84382cdcc8df4
sourceBlobDigest: sha256:e3e8d5f794c2d732b4bee571c092e80d1aaf1a5e3e998300b313ee4b8f9fc012
sourceRevisionDigest: sha256:f9c9ffd7c550f43e427c2bfe5fdbbe55f91d3dae20a90063d7e430762d9152c5
sourceBlobDigest: sha256:be0a96c80997c1222c549aeb6f7f2b1a96a494e56f8df0c2dddad9a95a43b631
outLocation: /github/workspace/repo
workflow:
workflowVersion: 1.0.0
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"python.testing.pytestArgs": ["tests", "-vv"],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true
"python.testing.pytestEnabled": true,
"pylint.args": ["--rcfile=pylintrc"]
}
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ poetry add speakeasy-client-sdk-python

```python
# Synchronous Example
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand All @@ -45,14 +44,13 @@ The same SDK client can also be used to make asychronous requests by importing a
```python
# Asynchronous Example
import asyncio
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

async def main():
s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)
res = await s.apis.get_apis_async()
Expand Down Expand Up @@ -200,13 +198,12 @@ Handling errors in this SDK should largely match your expectations. All operati
### Example

```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import errors, shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand Down Expand Up @@ -246,14 +243,13 @@ You can override the default server globally by passing a server name to the `se
#### Example

```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
server="prod",
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand All @@ -274,14 +270,13 @@ if res is not None:

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
server_url="https://api.prod.speakeasyapi.dev",
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand Down Expand Up @@ -397,13 +392,12 @@ This SDK supports the following security schemes globally:

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand Down Expand Up @@ -440,13 +434,12 @@ The following global parameter is available.
### Example

```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand All @@ -467,14 +460,13 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
import os
from speakeasy.utils import BackoffStrategy, RetryConfig
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand All @@ -493,15 +485,14 @@ if res is not None:

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 os
from speakeasy.utils import BackoffStrategy, RetryConfig
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand Down Expand Up @@ -529,13 +520,12 @@ Certain SDK methods accept file objects as part of a request body or multi-part
>
```python
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand Down Expand Up @@ -572,6 +562,16 @@ s = Speakeasy(debug_logger=logging.getLogger("speakeasy_client_sdk_python"))
```
<!-- End Debugging [debug] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->


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

## 2024-08-10 08:51:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.361.1 (2.393.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v7.0.0-rc.1] .
### Releases
- [PyPI v7.0.0-rc.1] https://pypi.org/project/speakeasy-client-sdk-python/7.0.0-rc.1 - .
6 changes: 2 additions & 4 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)

Expand All @@ -25,14 +24,13 @@ The same SDK client can also be used to make asychronous requests by importing a
```python
# Asynchronous Example
import asyncio
import os
from speakeasy_client_sdk_python import Speakeasy
from speakeasy_client_sdk_python.models import shared

async def main():
s = Speakeasy(
security=shared.Security(
api_key=os.getenv("API_KEY", ""),
api_key="<YOUR_API_KEY_HERE>",
),
)
res = await s.apis.get_apis_async()
Expand Down
10 changes: 0 additions & 10 deletions docs/models/shared/accesstokenaccounttype.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/models/shared/accounttype.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@
| ------------ | ------------ |
| `FREE` | free |
| `SCALE_UP` | scale-up |
| `BUSINESS` | business |
| `ENTERPRISE` | enterprise |
2 changes: 1 addition & 1 deletion docs/models/shared/apikeydetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `account_type` | [shared.AccountType](../../models/shared/accounttype.md) | :heavy_check_mark: | N/A |
| `account_type_v2` | [shared.AccountType](../../models/shared/accounttype.md) | :heavy_check_mark: | N/A |
| `enabled_features` | List[*str*] | :heavy_check_mark: | N/A |
| `org_slug` | *str* | :heavy_check_mark: | N/A |
| `telemetry_disabled` | *bool* | :heavy_check_mark: | N/A |
Expand Down
Loading

0 comments on commit 4a1f6e4

Please sign in to comment.