Skip to content

Commit aecbad5

Browse files
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.116.0
1 parent 98b0f7e commit aecbad5

File tree

155 files changed

+1096
-901
lines changed

Some content is hidden

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

155 files changed

+1096
-901
lines changed

README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
5252

5353
* [validateApiKey](docs/sdks/speakeasy/README.md#validateapikey) - Validate the current api key.
5454

55-
### [.apis](docs/sdks/apis/README.md)
55+
### [apis](docs/sdks/apis/README.md)
5656

5757
* [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
5858
* [generateOpenApiSpec](docs/sdks/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api.
@@ -61,7 +61,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
6161
* [getApis](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace
6262
* [upsertApi](docs/sdks/apis/README.md#upsertapi) - Upsert an Api
6363

64-
### [.apiEndpoints](docs/sdks/apiendpoints/README.md)
64+
### [apiEndpoints](docs/sdks/apiendpoints/README.md)
6565

6666
* [deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
6767
* [findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
@@ -72,13 +72,13 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7272
* [getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
7373
* [upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
7474

75-
### [.metadata](docs/sdks/metadata/README.md)
75+
### [metadata](docs/sdks/metadata/README.md)
7676

7777
* [deleteVersionMetadata](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
7878
* [getVersionMetadata](docs/sdks/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID.
7979
* [insertVersionMetadata](docs/sdks/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID.
8080

81-
### [.schemas](docs/sdks/schemas/README.md)
81+
### [schemas](docs/sdks/schemas/README.md)
8282

8383
* [deleteSchema](docs/sdks/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api.
8484
* [downloadSchema](docs/sdks/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID.
@@ -89,19 +89,19 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
8989
* [getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
9090
* [registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
9191

92-
### [.requests](docs/sdks/requests/README.md)
92+
### [requests](docs/sdks/requests/README.md)
9393

9494
* [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
9595
* [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
9696
* [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
9797

98-
### [.plugins](docs/sdks/plugins/README.md)
98+
### [plugins](docs/sdks/plugins/README.md)
9999

100100
* [getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
101101
* [runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
102102
* [upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
103103

104-
### [.embeds](docs/sdks/embeds/README.md)
104+
### [embeds](docs/sdks/embeds/README.md)
105105

106106
* [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
107107
* [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
@@ -131,7 +131,36 @@ Here's an example of one such pagination call:
131131
<!-- Start Error Handling -->
132132
# Error Handling
133133

134-
Handling errors in your SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
134+
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
135+
136+
| Error Object | Status Code | Content Type |
137+
| --------------- | --------------- | --------------- |
138+
| errors.SDKError | 400-600 | */* |
139+
140+
141+
## Example
142+
143+
```typescript
144+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
145+
146+
(async () => {
147+
const sdk = new Speakeasy({
148+
security: {
149+
apiKey: "",
150+
},
151+
});
152+
153+
let res;
154+
try {
155+
res = await sdk.validateApiKey();
156+
} catch (e) {}
157+
158+
if (res.statusCode == 200) {
159+
// handle response
160+
}
161+
})();
162+
163+
```
135164
<!-- End Error Handling -->
136165

137166

@@ -221,12 +250,11 @@ const sdk = new Speakeasy({defaultClient: httpClient});
221250
222251
223252
<!-- Start Authentication -->
224-
225253
# Authentication
226254
227255
## Per-Client Security Schemes
228256
229-
Your SDK supports the following security scheme globally:
257+
This SDK supports the following security scheme globally:
230258
231259
| Name | Type | Scheme |
232260
| -------- | -------- | -------- |

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1026,4 +1026,14 @@ Based on:
10261026
### Generated
10271027
- [typescript v2.0.0] .
10281028
### Releases
1029-
- [NPM v2.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.0.0 - .
1029+
- [NPM v2.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.0.0 - .
1030+
1031+
## 2023-11-09 00:10:51
1032+
### Changes
1033+
Based on:
1034+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1035+
- Speakeasy CLI 1.116.0 (2.185.0) https://github.com/speakeasy-api/speakeasy
1036+
### Generated
1037+
- [typescript v2.1.0] .
1038+
### Releases
1039+
- [NPM v2.1.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.1.0 - .

docs/models/operations/findapiendpointresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/generateopenapispecforapiendpointresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/generateopenapispecresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/getallapiendpointsresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/getallapiversionsrequest.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/models/operations/getallforversionapiendpointsresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/getapiendpointresponse.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/models/operations/getapisrequest.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)