Skip to content

Commit 20c6d4b

Browse files
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.173.0
1 parent c04c937 commit 20c6d4b

Some content is hidden

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

61 files changed

+724
-626
lines changed

.speakeasy/gen.lock

Lines changed: 21 additions & 18 deletions
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: ba638b2ad28966c596e28321a2003686
5-
docVersion: 0.3.0
4+
docChecksum: dff663dce4f21ddf3fc2332b7d7be92b
5+
docVersion: 0.4.0
66
speakeasyVersion: internal
7-
generationVersion: 2.250.12
8-
releaseVersion: 5.0.0
9-
configChecksum: cd8bb4065d3f66420412fdee00510406
7+
generationVersion: 2.250.16
8+
releaseVersion: 5.1.0
9+
configChecksum: e8aa5833a2494c942488ff20935dee69
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
@@ -18,6 +18,7 @@ features:
1818
examples: 2.81.3
1919
globalSecurity: 2.83.2
2020
globalServerURLs: 2.82.1
21+
globals: 2.81.1
2122
inputOutputModels: 2.83.0
2223
serverIDs: 2.81.1
2324
generatedFiles:
@@ -26,9 +27,10 @@ generatedFiles:
2627
- src/speakeasy/apiendpoints.py
2728
- src/speakeasy/metadata.py
2829
- src/speakeasy/schemas.py
30+
- src/speakeasy/auth.py
2931
- src/speakeasy/requests.py
30-
- src/speakeasy/plugins.py
3132
- src/speakeasy/embeds.py
33+
- src/speakeasy/events.py
3234
- src/speakeasy/sdk.py
3335
- pylintrc
3436
- setup.py
@@ -38,7 +40,6 @@ generatedFiles:
3840
- src/speakeasy/utils/utils.py
3941
- src/speakeasy/models/errors/sdkerror.py
4042
- tests/helpers.py
41-
- src/speakeasy/models/operations/validateapikey.py
4243
- src/speakeasy/models/operations/deleteapi.py
4344
- src/speakeasy/models/operations/generateopenapispec.py
4445
- src/speakeasy/models/operations/generatepostmancollection.py
@@ -64,15 +65,14 @@ generatedFiles:
6465
- src/speakeasy/models/operations/getschemarevision.py
6566
- src/speakeasy/models/operations/getschemas.py
6667
- src/speakeasy/models/operations/registerschema.py
68+
- src/speakeasy/models/operations/validateapikey.py
6769
- src/speakeasy/models/operations/generaterequestpostmancollection.py
6870
- src/speakeasy/models/operations/getrequestfromeventlog.py
6971
- src/speakeasy/models/operations/queryeventlog.py
70-
- src/speakeasy/models/operations/getplugins.py
71-
- src/speakeasy/models/operations/runplugin.py
72-
- src/speakeasy/models/operations/upsertplugin.py
7372
- src/speakeasy/models/operations/getembedaccesstoken.py
7473
- src/speakeasy/models/operations/getvalidembedaccesstokens.py
7574
- src/speakeasy/models/operations/revokeembedaccesstoken.py
75+
- src/speakeasy/models/operations/postworkspaceevents.py
7676
- src/speakeasy/models/shared/error.py
7777
- src/speakeasy/models/shared/generateopenapispecdiff.py
7878
- src/speakeasy/models/shared/api.py
@@ -83,20 +83,20 @@ generatedFiles:
8383
- src/speakeasy/models/shared/versionmetadata_input.py
8484
- src/speakeasy/models/shared/schema.py
8585
- src/speakeasy/models/shared/schemadiff.py
86+
- src/speakeasy/models/shared/apikeydetails.py
8687
- src/speakeasy/models/shared/unboundedrequest.py
8788
- src/speakeasy/models/shared/boundedrequest.py
8889
- src/speakeasy/models/shared/requestmetadata.py
8990
- src/speakeasy/models/shared/filters.py
9091
- src/speakeasy/models/shared/filter_.py
91-
- src/speakeasy/models/shared/plugin.py
9292
- src/speakeasy/models/shared/embedaccesstokenresponse.py
9393
- src/speakeasy/models/shared/embedtoken.py
94+
- src/speakeasy/models/shared/clievent.py
9495
- src/speakeasy/models/shared/security.py
9596
- src/speakeasy/models/__init__.py
9697
- src/speakeasy/models/errors/__init__.py
9798
- src/speakeasy/models/operations/__init__.py
9899
- src/speakeasy/models/shared/__init__.py
99-
- docs/models/operations/validateapikeyresponse.md
100100
- docs/models/operations/deleteapirequest.md
101101
- docs/models/operations/deleteapiresponse.md
102102
- docs/models/operations/generateopenapispecrequest.md
@@ -151,21 +151,20 @@ generatedFiles:
151151
- docs/models/operations/registerschemarequestbody.md
152152
- docs/models/operations/registerschemarequest.md
153153
- docs/models/operations/registerschemaresponse.md
154+
- docs/models/operations/validateapikeyresponse.md
154155
- docs/models/operations/generaterequestpostmancollectionrequest.md
155156
- docs/models/operations/generaterequestpostmancollectionresponse.md
156157
- docs/models/operations/getrequestfromeventlogrequest.md
157158
- docs/models/operations/getrequestfromeventlogresponse.md
158159
- docs/models/operations/queryeventlogrequest.md
159160
- docs/models/operations/queryeventlogresponse.md
160-
- docs/models/operations/getpluginsresponse.md
161-
- docs/models/operations/runpluginrequest.md
162-
- docs/models/operations/runpluginresponse.md
163-
- docs/models/operations/upsertpluginresponse.md
164161
- docs/models/operations/getembedaccesstokenrequest.md
165162
- docs/models/operations/getembedaccesstokenresponse.md
166163
- docs/models/operations/getvalidembedaccesstokensresponse.md
167164
- docs/models/operations/revokeembedaccesstokenrequest.md
168165
- docs/models/operations/revokeembedaccesstokenresponse.md
166+
- docs/models/operations/postworkspaceeventsrequest.md
167+
- docs/models/operations/postworkspaceeventsresponse.md
169168
- docs/models/shared/error.md
170169
- docs/models/shared/generateopenapispecdiff.md
171170
- docs/models/shared/api.md
@@ -177,22 +176,26 @@ generatedFiles:
177176
- docs/models/shared/schema.md
178177
- docs/models/shared/valuechange.md
179178
- docs/models/shared/schemadiff.md
179+
- docs/models/shared/apikeydetails.md
180180
- docs/models/shared/unboundedrequest.md
181181
- docs/models/shared/boundedrequest.md
182182
- docs/models/shared/requestmetadata.md
183183
- docs/models/shared/filters.md
184184
- docs/models/shared/filter_.md
185-
- docs/models/shared/plugin.md
186185
- docs/models/shared/embedaccesstokenresponse.md
187186
- docs/models/shared/embedtoken.md
187+
- docs/models/shared/generatebumptype.md
188+
- docs/models/shared/interactiontype.md
189+
- docs/models/shared/clievent.md
188190
- docs/models/shared/security.md
189191
- docs/sdks/speakeasy/README.md
190192
- docs/sdks/apis/README.md
191193
- docs/sdks/apiendpoints/README.md
192194
- docs/sdks/metadata/README.md
193195
- docs/sdks/schemas/README.md
196+
- docs/sdks/auth/README.md
194197
- docs/sdks/requests/README.md
195-
- docs/sdks/plugins/README.md
196198
- docs/sdks/embeds/README.md
199+
- docs/sdks/events/README.md
197200
- USAGE.md
198201
- .gitattributes

README.md

Lines changed: 93 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ s = speakeasy.Speakeasy(
2121
security=shared.Security(
2222
api_key="<YOUR_API_KEY_HERE>",
2323
),
24+
workspace_id='string',
2425
)
2526

2627
req = operations.GetApisRequest(
@@ -36,7 +37,7 @@ req = operations.GetApisRequest(
3637

3738
res = s.apis.get_apis(req)
3839

39-
if res.classes is not None:
40+
if res.apis is not None:
4041
# handle response
4142
pass
4243
```
@@ -45,10 +46,6 @@ if res.classes is not None:
4546
<!-- Start Available Resources and Operations [operations] -->
4647
## Available Resources and Operations
4748

48-
### [Speakeasy SDK](docs/sdks/speakeasy/README.md)
49-
50-
* [validate_api_key](docs/sdks/speakeasy/README.md#validate_api_key) - Validate the current api key.
51-
5249
### [apis](docs/sdks/apis/README.md)
5350

5451
* [delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
@@ -86,23 +83,25 @@ if res.classes is not None:
8683
* [get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
8784
* [register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
8885

86+
### [auth](docs/sdks/auth/README.md)
87+
88+
* [validate_api_key](docs/sdks/auth/README.md#validate_api_key) - Validate the current api key.
89+
8990
### [requests](docs/sdks/requests/README.md)
9091

9192
* [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
9293
* [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
9394
* [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
9495

95-
### [plugins](docs/sdks/plugins/README.md)
96-
97-
* [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
98-
* [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
99-
* [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
100-
10196
### [embeds](docs/sdks/embeds/README.md)
10297

10398
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
10499
* [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.
105100
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
101+
102+
### [events](docs/sdks/events/README.md)
103+
104+
* [post_workspace_events](docs/sdks/events/README.md#post_workspace_events) - Post events for a specific workspace
106105
<!-- End Available Resources and Operations [operations] -->
107106

108107

@@ -124,18 +123,23 @@ Handling errors in this SDK should largely match your expectations. All operati
124123

125124
```python
126125
import speakeasy
127-
from speakeasy.models import shared
126+
from speakeasy.models import operations, shared
128127

129128
s = speakeasy.Speakeasy(
130129
security=shared.Security(
131130
api_key="<YOUR_API_KEY_HERE>",
132131
),
132+
workspace_id='string',
133133
)
134134

135+
req = operations.DeleteAPIRequest(
136+
api_id='string',
137+
version_id='string',
138+
)
135139

136140
res = None
137141
try:
138-
res = s.validate_api_key()
142+
res = s.apis.delete_api(req)
139143
except errors.SDKError as e:
140144
print(e) # handle exception
141145
raise(e)
@@ -163,17 +167,22 @@ You can override the default server globally by passing a server name to the `se
163167

164168
```python
165169
import speakeasy
166-
from speakeasy.models import shared
170+
from speakeasy.models import operations, shared
167171

168172
s = speakeasy.Speakeasy(
169173
server="prod",
170174
security=shared.Security(
171175
api_key="<YOUR_API_KEY_HERE>",
172176
),
177+
workspace_id='string',
173178
)
174179

180+
req = operations.DeleteAPIRequest(
181+
api_id='string',
182+
version_id='string',
183+
)
175184

176-
res = s.validate_api_key()
185+
res = s.apis.delete_api(req)
177186

178187
if res.status_code == 200:
179188
# handle response
@@ -186,17 +195,22 @@ if res.status_code == 200:
186195
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:
187196
```python
188197
import speakeasy
189-
from speakeasy.models import shared
198+
from speakeasy.models import operations, shared
190199

191200
s = speakeasy.Speakeasy(
192201
server_url="https://api.prod.speakeasyapi.dev",
193202
security=shared.Security(
194203
api_key="<YOUR_API_KEY_HERE>",
195204
),
205+
workspace_id='string',
196206
)
197207

208+
req = operations.DeleteAPIRequest(
209+
api_id='string',
210+
version_id='string',
211+
)
198212

199-
res = s.validate_api_key()
213+
res = s.apis.delete_api(req)
200214

201215
if res.status_code == 200:
202216
# handle response
@@ -238,23 +252,83 @@ This SDK supports the following security scheme globally:
238252
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
239253
```python
240254
import speakeasy
241-
from speakeasy.models import shared
255+
from speakeasy.models import operations, shared
242256

243257
s = speakeasy.Speakeasy(
244258
security=shared.Security(
245259
api_key="<YOUR_API_KEY_HERE>",
246260
),
261+
workspace_id='string',
247262
)
248263

264+
req = operations.DeleteAPIRequest(
265+
api_id='string',
266+
version_id='string',
267+
)
249268

250-
res = s.validate_api_key()
269+
res = s.apis.delete_api(req)
251270

252271
if res.status_code == 200:
253272
# handle response
254273
pass
255274
```
256275
<!-- End Authentication [security] -->
257276

277+
<!-- Start Global Parameters [global-parameters] -->
278+
## Global Parameters
279+
280+
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.
281+
282+
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.
283+
284+
285+
### Available Globals
286+
287+
The following global parameter is available.
288+
289+
| Name | Type | Required | Description |
290+
| ---- | ---- |:--------:| ----------- |
291+
| workspace_id | str | | The workspace_id parameter. |
292+
293+
294+
### Example
295+
296+
```python
297+
import dateutil.parser
298+
import speakeasy
299+
from speakeasy.models import operations, shared
300+
301+
s = speakeasy.Speakeasy(
302+
security=shared.Security(
303+
api_key="<YOUR_API_KEY_HERE>",
304+
),
305+
workspace_id='string',
306+
)
307+
308+
req = operations.PostWorkspaceEventsRequest(
309+
request_body=[
310+
shared.CliEvent(
311+
created_at=dateutil.parser.isoparse('2024-11-21T06:58:42.120Z'),
312+
execution_id='string',
313+
id='<ID>',
314+
interaction_type=shared.InteractionType.CLI_EXEC,
315+
local_started_at=dateutil.parser.isoparse('2024-05-07T12:35:47.182Z'),
316+
speakeasy_api_key_name='string',
317+
speakeasy_version='string',
318+
success=False,
319+
workspace_id='string',
320+
),
321+
],
322+
)
323+
324+
res = s.events.post_workspace_events(req)
325+
326+
if res.status_code == 200:
327+
# handle response
328+
pass
329+
```
330+
<!-- End Global Parameters [global-parameters] -->
331+
258332
<!-- Placeholder for Future Speakeasy SDK Sections -->
259333

260334

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1186,4 +1186,14 @@ Based on:
11861186
### Generated
11871187
- [python v5.0.0] .
11881188
### Releases
1189-
- [PyPI v5.0.0] https://pypi.org/project/speakeasy-client-sdk-python/5.0.0 - .
1189+
- [PyPI v5.0.0] https://pypi.org/project/speakeasy-client-sdk-python/5.0.0 - .
1190+
1191+
## 2024-02-08 00:10:03
1192+
### Changes
1193+
Based on:
1194+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1195+
- Speakeasy CLI 1.173.0 (2.250.16) https://github.com/speakeasy-api/speakeasy
1196+
### Generated
1197+
- [python v5.1.0] .
1198+
### Releases
1199+
- [PyPI v5.1.0] https://pypi.org/project/speakeasy-client-sdk-python/5.1.0 - .

USAGE.md

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

1213
req = operations.GetApisRequest(
@@ -22,7 +23,7 @@ req = operations.GetApisRequest(
2223

2324
res = s.apis.get_apis(req)
2425

25-
if res.classes is not None:
26+
if res.apis is not None:
2627
# handle response
2728
pass
2829
```

0 commit comments

Comments
 (0)