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
*[validateApiKey](docs/sdks/speakeasy/README.md#validateapikey) - Validate the current api key.
59
-
60
57
### [apis](docs/sdks/apis/README.md)
61
58
62
59
*[deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
@@ -94,23 +91,25 @@ run();
94
91
*[getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
95
92
*[registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
96
93
94
+
### [auth](docs/sdks/auth/README.md)
95
+
96
+
*[validateApiKey](docs/sdks/auth/README.md#validateapikey) - Validate the current api key.
97
+
97
98
### [requests](docs/sdks/requests/README.md)
98
99
99
100
*[generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
100
101
*[getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
101
102
*[queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
102
103
103
-
### [plugins](docs/sdks/plugins/README.md)
104
-
105
-
*[getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
106
-
*[runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
107
-
*[upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
108
-
109
104
### [embeds](docs/sdks/embeds/README.md)
110
105
111
106
*[getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
112
107
*[getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
113
108
*[revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
109
+
110
+
### [events](docs/sdks/events/README.md)
111
+
112
+
*[postWorkspaceEvents](docs/sdks/events/README.md#postworkspaceevents) - Post events for a specific workspace
114
113
<!-- End Available Resources and Operations [operations] -->
115
114
116
115
@@ -138,11 +137,15 @@ async function run() {
138
137
security: {
139
138
apiKey: "<YOUR_API_KEY_HERE>",
140
139
},
140
+
workspaceID: "string",
141
141
});
142
142
143
143
let res;
144
144
try {
145
-
res=awaitsdk.validateApiKey();
145
+
res=awaitsdk.apis.deleteApi({
146
+
apiID: "string",
147
+
versionID: "string",
148
+
});
146
149
} catch (err) {
147
150
if (errinstanceoferrors.SDKError) {
148
151
console.error(err); // handle exception
@@ -184,9 +187,13 @@ async function run() {
184
187
security: {
185
188
apiKey: "<YOUR_API_KEY_HERE>",
186
189
},
190
+
workspaceID: "string",
187
191
});
188
192
189
-
const res =awaitsdk.validateApiKey();
193
+
const res =awaitsdk.apis.deleteApi({
194
+
apiID: "string",
195
+
versionID: "string",
196
+
});
190
197
191
198
if (res.statusCode==200) {
192
199
// handle response
@@ -210,9 +217,13 @@ async function run() {
210
217
security: {
211
218
apiKey: "<YOUR_API_KEY_HERE>",
212
219
},
220
+
workspaceID: "string",
213
221
});
214
222
215
-
const res =awaitsdk.validateApiKey();
223
+
const res =awaitsdk.apis.deleteApi({
224
+
apiID: "string",
225
+
versionID: "string",
226
+
});
216
227
217
228
if (res.statusCode==200) {
218
229
// handle response
@@ -267,9 +278,13 @@ async function run() {
267
278
security: {
268
279
apiKey: "<YOUR_API_KEY_HERE>",
269
280
},
281
+
workspaceID: "string",
270
282
});
271
283
272
-
const res =awaitsdk.validateApiKey();
284
+
const res =awaitsdk.apis.deleteApi({
285
+
apiID: "string",
286
+
versionID: "string",
287
+
});
273
288
274
289
if (res.statusCode==200) {
275
290
// handle response
@@ -281,6 +296,66 @@ run();
281
296
```
282
297
<!-- End Authentication [security] -->
283
298
299
+
<!-- Start Global Parameters [global-parameters] -->
300
+
## Global Parameters
301
+
302
+
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.
303
+
304
+
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 `postWorkspaceEvents`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
305
+
306
+
307
+
### Available Globals
308
+
309
+
The following global parameter is available.
310
+
311
+
| Name | Type | Required | Description |
312
+
| ---- | ---- |:--------:| ----------- |
313
+
| workspaceID | string || The workspaceID parameter. |
0 commit comments