You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[validate_api_key](docs/sdks/speakeasy/README.md#validate_api_key) - Validate the current api key.
51
-
52
49
### [apis](docs/sdks/apis/README.md)
53
50
54
51
*[delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
@@ -86,23 +83,25 @@ if res.classes is not None:
86
83
*[get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
87
84
*[register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
88
85
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
+
89
90
### [requests](docs/sdks/requests/README.md)
90
91
91
92
*[generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
92
93
*[get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
93
94
*[query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
94
95
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
-
101
96
### [embeds](docs/sdks/embeds/README.md)
102
97
103
98
*[get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
104
99
*[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.
105
100
*[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
106
105
<!-- End Available Resources and Operations [operations] -->
107
106
108
107
@@ -124,18 +123,23 @@ Handling errors in this SDK should largely match your expectations. All operati
124
123
125
124
```python
126
125
import speakeasy
127
-
from speakeasy.models import shared
126
+
from speakeasy.models importoperations, shared
128
127
129
128
s = speakeasy.Speakeasy(
130
129
security=shared.Security(
131
130
api_key="<YOUR_API_KEY_HERE>",
132
131
),
132
+
workspace_id='string',
133
133
)
134
134
135
+
req = operations.DeleteAPIRequest(
136
+
api_id='string',
137
+
version_id='string',
138
+
)
135
139
136
140
res =None
137
141
try:
138
-
res = s.validate_api_key()
142
+
res = s.apis.delete_api(req)
139
143
except errors.SDKError as e:
140
144
print(e) # handle exception
141
145
raise(e)
@@ -163,17 +167,22 @@ You can override the default server globally by passing a server name to the `se
163
167
164
168
```python
165
169
import speakeasy
166
-
from speakeasy.models import shared
170
+
from speakeasy.models importoperations, shared
167
171
168
172
s = speakeasy.Speakeasy(
169
173
server="prod",
170
174
security=shared.Security(
171
175
api_key="<YOUR_API_KEY_HERE>",
172
176
),
177
+
workspace_id='string',
173
178
)
174
179
180
+
req = operations.DeleteAPIRequest(
181
+
api_id='string',
182
+
version_id='string',
183
+
)
175
184
176
-
res = s.validate_api_key()
185
+
res = s.apis.delete_api(req)
177
186
178
187
if res.status_code ==200:
179
188
# handle response
@@ -186,17 +195,22 @@ if res.status_code == 200:
186
195
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:
187
196
```python
188
197
import speakeasy
189
-
from speakeasy.models import shared
198
+
from speakeasy.models importoperations, shared
190
199
191
200
s = speakeasy.Speakeasy(
192
201
server_url="https://api.prod.speakeasyapi.dev",
193
202
security=shared.Security(
194
203
api_key="<YOUR_API_KEY_HERE>",
195
204
),
205
+
workspace_id='string',
196
206
)
197
207
208
+
req = operations.DeleteAPIRequest(
209
+
api_id='string',
210
+
version_id='string',
211
+
)
198
212
199
-
res = s.validate_api_key()
213
+
res = s.apis.delete_api(req)
200
214
201
215
if res.status_code ==200:
202
216
# handle response
@@ -238,23 +252,83 @@ This SDK supports the following security scheme globally:
238
252
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
239
253
```python
240
254
import speakeasy
241
-
from speakeasy.models import shared
255
+
from speakeasy.models importoperations, shared
242
256
243
257
s = speakeasy.Speakeasy(
244
258
security=shared.Security(
245
259
api_key="<YOUR_API_KEY_HERE>",
246
260
),
261
+
workspace_id='string',
247
262
)
248
263
264
+
req = operations.DeleteAPIRequest(
265
+
api_id='string',
266
+
version_id='string',
267
+
)
249
268
250
-
res = s.validate_api_key()
269
+
res = s.apis.delete_api(req)
251
270
252
271
if res.status_code ==200:
253
272
# handle response
254
273
pass
255
274
```
256
275
<!-- End Authentication [security] -->
257
276
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. |
0 commit comments