Skip to content

Commit 32a9989

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.180.0
1 parent a673a53 commit 32a9989

File tree

25 files changed

+349
-200
lines changed

25 files changed

+349
-200
lines changed

‎.speakeasy/gen.lock

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
lockVersion: 2.0.0
22
id: b0b519b1-d1d3-43b2-82dd-b4292eadd4b0
33
management:
4-
docChecksum: 557634d4bb5964b949ae70f79f40d856
4+
docChecksum: c81aa4e807522359d28c09ee16d252ba
55
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.253.0
8-
releaseVersion: 5.2.1
9-
configChecksum: c7cf88f22624c91877992d2516e05c24
7+
generationVersion: 2.258.0
8+
releaseVersion: 5.2.2
9+
configChecksum: 45a62d301fb93165c7d0110e1b0f78fa
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
1313
published: true
1414
features:
1515
python:
16-
core: 4.4.5
16+
core: 4.4.6
1717
downloadStreams: 0.0.2
1818
examples: 2.81.3
1919
globalSecurity: 2.83.2
@@ -66,6 +66,7 @@ generatedFiles:
6666
- src/speakeasy/models/operations/getschemarevision.py
6767
- src/speakeasy/models/operations/getschemas.py
6868
- src/speakeasy/models/operations/registerschema.py
69+
- src/speakeasy/models/operations/getworkspaceaccess.py
6970
- src/speakeasy/models/operations/validateapikey.py
7071
- src/speakeasy/models/operations/generaterequestpostmancollection.py
7172
- src/speakeasy/models/operations/getrequestfromeventlog.py
@@ -84,6 +85,7 @@ generatedFiles:
8485
- src/speakeasy/models/shared/versionmetadata_input.py
8586
- src/speakeasy/models/shared/schema.py
8687
- src/speakeasy/models/shared/schemadiff.py
88+
- src/speakeasy/models/shared/accessdetails.py
8789
- src/speakeasy/models/shared/apikeydetails.py
8890
- src/speakeasy/models/shared/unboundedrequest.py
8991
- src/speakeasy/models/shared/boundedrequest.py
@@ -152,6 +154,8 @@ generatedFiles:
152154
- docs/models/operations/registerschemarequestbody.md
153155
- docs/models/operations/registerschemarequest.md
154156
- docs/models/operations/registerschemaresponse.md
157+
- docs/models/operations/getworkspaceaccessrequest.md
158+
- docs/models/operations/getworkspaceaccessresponse.md
155159
- docs/models/operations/validateapikeyresponse.md
156160
- docs/models/operations/generaterequestpostmancollectionrequest.md
157161
- docs/models/operations/generaterequestpostmancollectionresponse.md
@@ -177,6 +181,7 @@ generatedFiles:
177181
- docs/models/shared/schema.md
178182
- docs/models/shared/valuechange.md
179183
- docs/models/shared/schemadiff.md
184+
- docs/models/shared/accessdetails.md
180185
- docs/models/shared/apikeydetails.md
181186
- docs/models/shared/unboundedrequest.md
182187
- docs/models/shared/boundedrequest.md
@@ -194,10 +199,10 @@ generatedFiles:
194199
- docs/sdks/apiendpoints/README.md
195200
- docs/sdks/metadata/README.md
196201
- docs/sdks/schemas/README.md
202+
- docs/models/utils/retryconfig.md
197203
- docs/sdks/auth/README.md
198204
- docs/sdks/requests/README.md
199205
- docs/sdks/embeds/README.md
200-
- docs/models/utils/retryconfig.md
201206
- docs/sdks/events/README.md
202207
- USAGE.md
203208
- .gitattributes

‎README.md

Lines changed: 30 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ s = speakeasy.Speakeasy(
2121
security=shared.Security(
2222
api_key="<YOUR_API_KEY_HERE>",
2323
),
24-
workspace_id='string',
24+
workspace_id='<value>',
2525
)
2626

2727
req = operations.GetApisRequest()
@@ -76,6 +76,7 @@ if res.apis is not None:
7676

7777
### [auth](docs/sdks/auth/README.md)
7878

79+
* [get_workspace_access](docs/sdks/auth/README.md#get_workspace_access) - Get access allowances for a particular workspace
7980
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
8081

8182
### [requests](docs/sdks/requests/README.md)
@@ -114,44 +115,29 @@ Handling errors in this SDK should largely match your expectations. All operati
114115
### Example
115116

116117
```python
117-
import dateutil.parser
118118
import speakeasy
119119
from speakeasy.models import errors, operations, shared
120120

121121
s = speakeasy.Speakeasy(
122122
security=shared.Security(
123123
api_key="<YOUR_API_KEY_HERE>",
124124
),
125-
workspace_id='string',
125+
workspace_id='<value>',
126126
)
127127

128-
req = operations.PostWorkspaceEventsRequest(
129-
request_body=[
130-
shared.CliEvent(
131-
created_at=dateutil.parser.isoparse('2024-11-21T06:58:42.120Z'),
132-
execution_id='string',
133-
id='<ID>',
134-
interaction_type=shared.InteractionType.CLI_EXEC,
135-
local_started_at=dateutil.parser.isoparse('2024-05-07T12:35:47.182Z'),
136-
speakeasy_api_key_name='string',
137-
speakeasy_version='string',
138-
success=False,
139-
workspace_id='string',
140-
),
141-
],
142-
)
128+
req = operations.GetWorkspaceAccessRequest()
143129

144130
res = None
145131
try:
146-
res = s.events.post_workspace_events(req)
132+
res = s.auth.get_workspace_access(req)
147133
except errors.Error as e:
148134
# handle exception
149135
raise(e)
150136
except errors.SDKError as e:
151137
# handle exception
152138
raise(e)
153139

154-
if res.status_code == 200:
140+
if res.access_details is not None:
155141
# handle response
156142
pass
157143
```
@@ -181,12 +167,12 @@ s = speakeasy.Speakeasy(
181167
security=shared.Security(
182168
api_key="<YOUR_API_KEY_HERE>",
183169
),
184-
workspace_id='string',
170+
workspace_id='<value>',
185171
)
186172

187173
req = operations.DeleteAPIRequest(
188-
api_id='string',
189-
version_id='string',
174+
api_id='<value>',
175+
version_id='<value>',
190176
)
191177

192178
res = s.apis.delete_api(req)
@@ -209,12 +195,12 @@ s = speakeasy.Speakeasy(
209195
security=shared.Security(
210196
api_key="<YOUR_API_KEY_HERE>",
211197
),
212-
workspace_id='string',
198+
workspace_id='<value>',
213199
)
214200

215201
req = operations.DeleteAPIRequest(
216-
api_id='string',
217-
version_id='string',
202+
api_id='<value>',
203+
version_id='<value>',
218204
)
219205

220206
res = s.apis.delete_api(req)
@@ -265,12 +251,12 @@ s = speakeasy.Speakeasy(
265251
security=shared.Security(
266252
api_key="<YOUR_API_KEY_HERE>",
267253
),
268-
workspace_id='string',
254+
workspace_id='<value>',
269255
)
270256

271257
req = operations.DeleteAPIRequest(
272-
api_id='string',
273-
version_id='string',
258+
api_id='<value>',
259+
version_id='<value>',
274260
)
275261

276262
res = s.apis.delete_api(req)
@@ -286,7 +272,7 @@ if res.status_code == 200:
286272

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

289-
For example, you can set `workspaceID` to `'string'` at SDK initialization and then you do not have to pass the same value on calls to operations like `post_workspace_events`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
275+
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 `post_workspace_events`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
290276

291277

292278
### Available Globals
@@ -309,21 +295,21 @@ s = speakeasy.Speakeasy(
309295
security=shared.Security(
310296
api_key="<YOUR_API_KEY_HERE>",
311297
),
312-
workspace_id='string',
298+
workspace_id='<value>',
313299
)
314300

315301
req = operations.PostWorkspaceEventsRequest(
316302
request_body=[
317303
shared.CliEvent(
318304
created_at=dateutil.parser.isoparse('2024-11-21T06:58:42.120Z'),
319-
execution_id='string',
320-
id='<ID>',
305+
execution_id='<value>',
306+
id='<id>',
321307
interaction_type=shared.InteractionType.CLI_EXEC,
322308
local_started_at=dateutil.parser.isoparse('2024-05-07T12:35:47.182Z'),
323-
speakeasy_api_key_name='string',
324-
speakeasy_version='string',
309+
speakeasy_api_key_name='<value>',
310+
speakeasy_version='<value>',
325311
success=False,
326-
workspace_id='string',
312+
workspace_id='<value>',
327313
),
328314
],
329315
)
@@ -343,7 +329,6 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
343329

344330
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
345331
```python
346-
import dateutil.parser
347332
import speakeasy
348333
from speakeasy.models import operations, shared
349334
from speakeasy.utils import BackoffStrategy, RetryConfig
@@ -352,36 +337,21 @@ s = speakeasy.Speakeasy(
352337
security=shared.Security(
353338
api_key="<YOUR_API_KEY_HERE>",
354339
),
355-
workspace_id='string',
340+
workspace_id='<value>',
356341
)
357342

358-
req = operations.PostWorkspaceEventsRequest(
359-
request_body=[
360-
shared.CliEvent(
361-
created_at=dateutil.parser.isoparse('2024-11-21T06:58:42.120Z'),
362-
execution_id='string',
363-
id='<ID>',
364-
interaction_type=shared.InteractionType.CLI_EXEC,
365-
local_started_at=dateutil.parser.isoparse('2024-05-07T12:35:47.182Z'),
366-
speakeasy_api_key_name='string',
367-
speakeasy_version='string',
368-
success=False,
369-
workspace_id='string',
370-
),
371-
],
372-
)
343+
req = operations.GetWorkspaceAccessRequest()
373344

374-
res = s.events.post_workspace_events(req,
345+
res = s.auth.get_workspace_access(req,
375346
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))
376347

377-
if res.status_code == 200:
348+
if res.access_details is not None:
378349
# handle response
379350
pass
380351
```
381352

382353
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:
383354
```python
384-
import dateutil.parser
385355
import speakeasy
386356
from speakeasy.models import operations, shared
387357
from speakeasy.utils import BackoffStrategy, RetryConfig
@@ -391,28 +361,14 @@ s = speakeasy.Speakeasy(
391361
security=shared.Security(
392362
api_key="<YOUR_API_KEY_HERE>",
393363
),
394-
workspace_id='string',
364+
workspace_id='<value>',
395365
)
396366

397-
req = operations.PostWorkspaceEventsRequest(
398-
request_body=[
399-
shared.CliEvent(
400-
created_at=dateutil.parser.isoparse('2024-11-21T06:58:42.120Z'),
401-
execution_id='string',
402-
id='<ID>',
403-
interaction_type=shared.InteractionType.CLI_EXEC,
404-
local_started_at=dateutil.parser.isoparse('2024-05-07T12:35:47.182Z'),
405-
speakeasy_api_key_name='string',
406-
speakeasy_version='string',
407-
success=False,
408-
workspace_id='string',
409-
),
410-
],
411-
)
367+
req = operations.GetWorkspaceAccessRequest()
412368

413-
res = s.events.post_workspace_events(req)
369+
res = s.auth.get_workspace_access(req)
414370

415-
if res.status_code == 200:
371+
if res.access_details is not None:
416372
# handle response
417373
pass
418374
```

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1216,4 +1216,14 @@ Based on:
12161216
### Generated
12171217
- [python v5.2.1] .
12181218
### Releases
1219-
- [PyPI v5.2.1] https://pypi.org/project/speakeasy-client-sdk-python/5.2.1 - .
1219+
- [PyPI v5.2.1] https://pypi.org/project/speakeasy-client-sdk-python/5.2.1 - .
1220+
1221+
## 2024-02-15 00:10:11
1222+
### Changes
1223+
Based on:
1224+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1225+
- Speakeasy CLI 1.180.0 (2.258.0) https://github.com/speakeasy-api/speakeasy
1226+
### Generated
1227+
- [python v5.2.2] .
1228+
### Releases
1229+
- [PyPI v5.2.2] https://pypi.org/project/speakeasy-client-sdk-python/5.2.2 - .

‎USAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ s = speakeasy.Speakeasy(
77
security=shared.Security(
88
api_key="<YOUR_API_KEY_HERE>",
99
),
10-
workspace_id='string',
10+
workspace_id='<value>',
1111
)
1212

1313
req = operations.GetApisRequest()

‎docs/models/operations/getworkspaceaccessrequest.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GetWorkspaceAccessRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
8+
| `gen_lock_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the generation target. |

‎docs/models/operations/getworkspaceaccessresponse.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetWorkspaceAccessResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
8+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
10+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11+
| `access_details` | [Optional[shared.AccessDetails]](../../models/shared/accessdetails.md) | :heavy_minus_sign: | OK |

‎docs/models/shared/accessdetails.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AccessDetails
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| -------------------- | -------------------- | -------------------- | -------------------- |
8+
| `generation_allowed` | *bool* | :heavy_check_mark: | N/A |

‎docs/models/shared/apikeydetails.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `workspace_id` | *str* | :heavy_check_mark: | N/A |
6+
| Field | Type | Required | Description |
7+
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
8+
| `workspace_id` | *str* | :heavy_check_mark: | N/A |
9+
| `generation_access_unlimited` | *Optional[bool]* | :heavy_minus_sign: | N/A |

0 commit comments

Comments
 (0)