Skip to content

Commit 4a1f6e4

Browse files
TristanSpeakEasyTristanSpeakEasy
authored
Merge pull request #2 from speakeasy-api/speakeasy-sdk-regen-1722903800
2 parents 75fc0aa + b10ca65 commit 4a1f6e4

Some content is hidden

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

64 files changed

+403
-298
lines changed

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
.venv/
2+
README-PYPI.md
13
pyrightconfig.json
24
.python-version
35
.DS_Store
46
venv/
57
src/*.egg-info/
68
__pycache__/
79
.pytest_cache/
8-
.idea
10+
.idea

‎.speakeasy/gen.lock

+14-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: b0b519b1-d1d3-43b2-82dd-b4292eadd4b0
33
management:
4-
docChecksum: 312822a7ccdbf7c77dbbfeef49fb2053
4+
docChecksum: 7e5374ccd8317cf07089c151d486221b
55
docVersion: 0.4.0 .
6-
speakeasyVersion: 1.351.1
7-
generationVersion: 2.384.3
8-
releaseVersion: 7.0.0-rc.0
9-
configChecksum: 1d686a63e7865a7b7cb6ff50fbdaeda1
6+
speakeasyVersion: 1.361.1
7+
generationVersion: 2.393.4
8+
releaseVersion: 7.0.0-rc.1
9+
configChecksum: 352cb880812185e4b20ae9e7ae20962a
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
@@ -15,19 +15,20 @@ features:
1515
python:
1616
acceptHeaders: 3.0.0
1717
additionalDependencies: 1.0.0
18-
core: 5.3.1
18+
core: 5.3.7
1919
defaultEnabledRetries: 0.2.0
2020
deprecations: 3.0.0
2121
downloadStreams: 1.0.1
22-
envVarSecurityUsage: 0.2.1
22+
envVarSecurityUsage: 0.3.1
2323
examples: 3.0.0
24-
globalSecurity: 3.0.0
24+
globalSecurity: 3.0.2
2525
globalSecurityCallbacks: 1.0.0
2626
globalServerURLs: 3.0.0
2727
globals: 3.0.0
2828
inputOutputModels: 3.0.0
2929
multipartFileContentType: 1.0.0
3030
nullables: 1.0.0
31+
openEnums: 1.0.0
3132
responseFormat: 1.0.0
3233
retries: 3.0.0
3334
sdkHooks: 1.0.0
@@ -53,9 +54,12 @@ generatedFiles:
5354
- src/speakeasy_client_sdk_python/events.py
5455
- src/speakeasy_client_sdk_python/sdk.py
5556
- .vscode/settings.json
57+
- poetry.toml
5658
- py.typed
5759
- pylintrc
5860
- pyproject.toml
61+
- scripts/compile.sh
62+
- scripts/prepare-readme.py
5963
- scripts/publish.sh
6064
- src/speakeasy_client_sdk_python/__init__.py
6165
- src/speakeasy_client_sdk_python/basesdk.py
@@ -175,6 +179,7 @@ generatedFiles:
175179
- src/speakeasy_client_sdk_python/models/shared/preflighttoken.py
176180
- src/speakeasy_client_sdk_python/models/shared/preflightrequest.py
177181
- src/speakeasy_client_sdk_python/models/shared/accesstoken.py
182+
- src/speakeasy_client_sdk_python/models/shared/accounttype.py
178183
- src/speakeasy_client_sdk_python/models/shared/featureflag.py
179184
- src/speakeasy_client_sdk_python/models/shared/user.py
180185
- src/speakeasy_client_sdk_python/models/shared/accessdetails.py
@@ -379,14 +384,13 @@ generatedFiles:
379384
- docs/models/shared/preflightrequest.md
380385
- docs/models/shared/claims.md
381386
- docs/models/shared/accesstokenuser.md
382-
- docs/models/shared/accesstokenaccounttype.md
383387
- docs/models/shared/workspaces.md
384388
- docs/models/shared/accesstoken.md
389+
- docs/models/shared/accounttype.md
385390
- docs/models/shared/featureflag.md
386391
- docs/models/shared/user.md
387392
- docs/models/shared/level.md
388393
- docs/models/shared/accessdetails.md
389-
- docs/models/shared/accounttype.md
390394
- docs/models/shared/apikeydetails.md
391395
- docs/models/shared/unboundedrequest.md
392396
- docs/models/shared/boundedrequest.md
@@ -404,7 +408,6 @@ generatedFiles:
404408
- docs/models/shared/githubmissingpublishingsecretsresponse.md
405409
- docs/models/shared/githubstorepublishingsecretsrequest.md
406410
- docs/models/shared/githubtriggeractionrequest.md
407-
- docs/models/shared/organizationaccounttype.md
408411
- docs/models/shared/organization.md
409412
- docs/models/shared/organizationusageresponse.md
410413
- docs/models/shared/organizationusage.md

‎.speakeasy/gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ generation:
1010
auth:
1111
oAuth2ClientCredentialsEnabled: false
1212
python:
13-
version: 7.0.0-rc.0
13+
version: 7.0.0-rc.1
1414
additionalDependencies:
1515
dev: {}
1616
main: {}

‎.speakeasy/workflow.lock

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
speakeasyVersion: 1.351.1
1+
speakeasyVersion: 1.361.1
22
sources:
33
speakeasy-openapi:
44
sourceNamespace: speakeasy-openapi
5-
sourceRevisionDigest: sha256:02836429166e1c637402f0f067f36aed1706d9ee7693eee13cd84382cdcc8df4
6-
sourceBlobDigest: sha256:e3e8d5f794c2d732b4bee571c092e80d1aaf1a5e3e998300b313ee4b8f9fc012
5+
sourceRevisionDigest: sha256:f9c9ffd7c550f43e427c2bfe5fdbbe55f91d3dae20a90063d7e430762d9152c5
6+
sourceBlobDigest: sha256:be0a96c80997c1222c549aeb6f7f2b1a96a494e56f8df0c2dddad9a95a43b631
77
tags:
88
- latest
99
- main
1010
targets:
1111
speakeasy-client-sdk-python:
1212
source: speakeasy-openapi
1313
sourceNamespace: speakeasy-openapi
14-
sourceRevisionDigest: sha256:02836429166e1c637402f0f067f36aed1706d9ee7693eee13cd84382cdcc8df4
15-
sourceBlobDigest: sha256:e3e8d5f794c2d732b4bee571c092e80d1aaf1a5e3e998300b313ee4b8f9fc012
14+
sourceRevisionDigest: sha256:f9c9ffd7c550f43e427c2bfe5fdbbe55f91d3dae20a90063d7e430762d9152c5
15+
sourceBlobDigest: sha256:be0a96c80997c1222c549aeb6f7f2b1a96a494e56f8df0c2dddad9a95a43b631
1616
outLocation: /github/workspace/repo
1717
workflow:
1818
workflowVersion: 1.0.0

‎.vscode/settings.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"python.testing.pytestArgs": ["tests", "-vv"],
33
"python.testing.unittestEnabled": false,
4-
"python.testing.pytestEnabled": true
4+
"python.testing.pytestEnabled": true,
5+
"pylint.args": ["--rcfile=pylintrc"]
56
}

‎README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,12 @@ poetry add speakeasy-client-sdk-python
2121

2222
```python
2323
# Synchronous Example
24-
import os
2524
from speakeasy_client_sdk_python import Speakeasy
2625
from speakeasy_client_sdk_python.models import shared
2726

2827
s = Speakeasy(
2928
security=shared.Security(
30-
api_key=os.getenv("API_KEY", ""),
29+
api_key="<YOUR_API_KEY_HERE>",
3130
),
3231
)
3332

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

5250
async def main():
5351
s = Speakeasy(
5452
security=shared.Security(
55-
api_key=os.getenv("API_KEY", ""),
53+
api_key="<YOUR_API_KEY_HERE>",
5654
),
5755
)
5856
res = await s.apis.get_apis_async()
@@ -200,13 +198,12 @@ Handling errors in this SDK should largely match your expectations. All operati
200198
### Example
201199

202200
```python
203-
import os
204201
from speakeasy_client_sdk_python import Speakeasy
205202
from speakeasy_client_sdk_python.models import errors, shared
206203

207204
s = Speakeasy(
208205
security=shared.Security(
209-
api_key=os.getenv("API_KEY", ""),
206+
api_key="<YOUR_API_KEY_HERE>",
210207
),
211208
)
212209

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

248245
```python
249-
import os
250246
from speakeasy_client_sdk_python import Speakeasy
251247
from speakeasy_client_sdk_python.models import shared
252248

253249
s = Speakeasy(
254250
server="prod",
255251
security=shared.Security(
256-
api_key=os.getenv("API_KEY", ""),
252+
api_key="<YOUR_API_KEY_HERE>",
257253
),
258254
)
259255

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

275271
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:
276272
```python
277-
import os
278273
from speakeasy_client_sdk_python import Speakeasy
279274
from speakeasy_client_sdk_python.models import shared
280275

281276
s = Speakeasy(
282277
server_url="https://api.prod.speakeasyapi.dev",
283278
security=shared.Security(
284-
api_key=os.getenv("API_KEY", ""),
279+
api_key="<YOUR_API_KEY_HERE>",
285280
),
286281
)
287282

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

398393
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:
399394
```python
400-
import os
401395
from speakeasy_client_sdk_python import Speakeasy
402396
from speakeasy_client_sdk_python.models import shared
403397

404398
s = Speakeasy(
405399
security=shared.Security(
406-
api_key=os.getenv("API_KEY", ""),
400+
api_key="<YOUR_API_KEY_HERE>",
407401
),
408402
)
409403

@@ -440,13 +434,12 @@ The following global parameter is available.
440434
### Example
441435

442436
```python
443-
import os
444437
from speakeasy_client_sdk_python import Speakeasy
445438
from speakeasy_client_sdk_python.models import shared
446439

447440
s = Speakeasy(
448441
security=shared.Security(
449-
api_key=os.getenv("API_KEY", ""),
442+
api_key="<YOUR_API_KEY_HERE>",
450443
),
451444
)
452445

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

468461
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
469462
```python
470-
import os
471463
from speakeasy.utils import BackoffStrategy, RetryConfig
472464
from speakeasy_client_sdk_python import Speakeasy
473465
from speakeasy_client_sdk_python.models import shared
474466

475467
s = Speakeasy(
476468
security=shared.Security(
477-
api_key=os.getenv("API_KEY", ""),
469+
api_key="<YOUR_API_KEY_HERE>",
478470
),
479471
)
480472

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

494486
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:
495487
```python
496-
import os
497488
from speakeasy.utils import BackoffStrategy, RetryConfig
498489
from speakeasy_client_sdk_python import Speakeasy
499490
from speakeasy_client_sdk_python.models import shared
500491

501492
s = Speakeasy(
502493
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
503494
security=shared.Security(
504-
api_key=os.getenv("API_KEY", ""),
495+
api_key="<YOUR_API_KEY_HERE>",
505496
),
506497
)
507498

@@ -529,13 +520,12 @@ Certain SDK methods accept file objects as part of a request body or multi-part
529520
>
530521
531522
```python
532-
import os
533523
from speakeasy_client_sdk_python import Speakeasy
534524
from speakeasy_client_sdk_python.models import shared
535525

536526
s = Speakeasy(
537527
security=shared.Security(
538-
api_key=os.getenv("API_KEY", ""),
528+
api_key="<YOUR_API_KEY_HERE>",
539529
),
540530
)
541531

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

565+
<!-- Start IDE Support [idesupport] -->
566+
## IDE Support
567+
568+
### PyCharm
569+
570+
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.
571+
572+
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
573+
<!-- End IDE Support [idesupport] -->
574+
575575
<!-- Placeholder for Future Speakeasy SDK Sections -->
576576

577577

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1776,4 +1776,14 @@ Based on:
17761776
### Generated
17771777
- [python v7.0.0-rc.0] .
17781778
### Releases
1779-
- [PyPI v7.0.0-rc.0] https://pypi.org/project/speakeasy-client-sdk-python/7.0.0-rc.0 - .
1779+
- [PyPI v7.0.0-rc.0] https://pypi.org/project/speakeasy-client-sdk-python/7.0.0-rc.0 - .
1780+
1781+
## 2024-08-10 08:51:50
1782+
### Changes
1783+
Based on:
1784+
- OpenAPI Doc
1785+
- Speakeasy CLI 1.361.1 (2.393.4) https://github.com/speakeasy-api/speakeasy
1786+
### Generated
1787+
- [python v7.0.0-rc.1] .
1788+
### Releases
1789+
- [PyPI v7.0.0-rc.1] https://pypi.org/project/speakeasy-client-sdk-python/7.0.0-rc.1 - .

‎USAGE.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
<!-- Start SDK Example Usage [usage] -->
22
```python
33
# Synchronous Example
4-
import os
54
from speakeasy_client_sdk_python import Speakeasy
65
from speakeasy_client_sdk_python.models import shared
76

87
s = Speakeasy(
98
security=shared.Security(
10-
api_key=os.getenv("API_KEY", ""),
9+
api_key="<YOUR_API_KEY_HERE>",
1110
),
1211
)
1312

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

3230
async def main():
3331
s = Speakeasy(
3432
security=shared.Security(
35-
api_key=os.getenv("API_KEY", ""),
33+
api_key="<YOUR_API_KEY_HERE>",
3634
),
3735
)
3836
res = await s.apis.get_apis_async()

‎docs/models/shared/accesstokenaccounttype.md

-10
This file was deleted.

‎docs/models/shared/accounttype.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
| ------------ | ------------ |
88
| `FREE` | free |
99
| `SCALE_UP` | scale-up |
10+
| `BUSINESS` | business |
1011
| `ENTERPRISE` | enterprise |

‎docs/models/shared/apikeydetails.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
| Field | Type | Required | Description |
77
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
8-
| `account_type` | [shared.AccountType](../../models/shared/accounttype.md) | :heavy_check_mark: | N/A |
8+
| `account_type_v2` | [shared.AccountType](../../models/shared/accounttype.md) | :heavy_check_mark: | N/A |
99
| `enabled_features` | List[*str*] | :heavy_check_mark: | N/A |
1010
| `org_slug` | *str* | :heavy_check_mark: | N/A |
1111
| `telemetry_disabled` | *bool* | :heavy_check_mark: | N/A |

0 commit comments

Comments
 (0)