Skip to content

Commit 98b0f7e

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.114.1
1 parent 8a2286d commit 98b0f7e

File tree

86 files changed

+1003
-1008
lines changed

Some content is hidden

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

86 files changed

+1003
-1008
lines changed

‎README.md

Lines changed: 69 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +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-
### [apiEndpoints](docs/sdks/apiendpoints/README.md)
56-
57-
* [deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
58-
* [findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
59-
* [generateOpenApiSpecForApiEndpoint](docs/sdks/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
60-
* [generatePostmanCollectionForApiEndpoint](docs/sdks/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint.
61-
* [getAllApiEndpoints](docs/sdks/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID.
62-
* [getAllForVersionApiEndpoints](docs/sdks/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID.
63-
* [getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
64-
* [upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
65-
66-
### [apis](docs/sdks/apis/README.md)
55+
### [.apis](docs/sdks/apis/README.md)
6756

6857
* [deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
6958
* [generateOpenApiSpec](docs/sdks/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api.
@@ -72,31 +61,24 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7261
* [getApis](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace
7362
* [upsertApi](docs/sdks/apis/README.md#upsertapi) - Upsert an Api
7463

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

77-
* [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
78-
* [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
79-
* [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
66+
* [deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
67+
* [findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
68+
* [generateOpenApiSpecForApiEndpoint](docs/sdks/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
69+
* [generatePostmanCollectionForApiEndpoint](docs/sdks/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint.
70+
* [getAllApiEndpoints](docs/sdks/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID.
71+
* [getAllForVersionApiEndpoints](docs/sdks/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID.
72+
* [getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
73+
* [upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
8074

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

8377
* [deleteVersionMetadata](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
8478
* [getVersionMetadata](docs/sdks/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID.
8579
* [insertVersionMetadata](docs/sdks/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID.
8680

87-
### [plugins](docs/sdks/plugins/README.md)
88-
89-
* [getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
90-
* [runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
91-
* [upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
92-
93-
### [requests](docs/sdks/requests/README.md)
94-
95-
* [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
96-
* [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
97-
* [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
98-
99-
### [schemas](docs/sdks/schemas/README.md)
81+
### [.schemas](docs/sdks/schemas/README.md)
10082

10183
* [deleteSchema](docs/sdks/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api.
10284
* [downloadSchema](docs/sdks/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID.
@@ -106,6 +88,24 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
10688
* [getSchemaRevision](docs/sdks/schemas/README.md#getschemarevision) - Get information about a particular schema revision for an Api.
10789
* [getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
10890
* [registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
91+
92+
### [.requests](docs/sdks/requests/README.md)
93+
94+
* [generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
95+
* [getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
96+
* [queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
97+
98+
### [.plugins](docs/sdks/plugins/README.md)
99+
100+
* [getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
101+
* [runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
102+
* [upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
103+
104+
### [.embeds](docs/sdks/embeds/README.md)
105+
106+
* [getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
107+
* [getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
108+
* [revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
109109
<!-- End SDK Available Operations -->
110110

111111

@@ -132,8 +132,6 @@ Here's an example of one such pagination call:
132132
# Error Handling
133133

134134
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.
135-
136-
137135
<!-- End Error Handling -->
138136

139137

@@ -151,19 +149,18 @@ You can override the default server globally by passing a server name to the `se
151149

152150
For example:
153151

154-
155152
```typescript
156153
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
157154

158155
(async () => {
159156
const sdk = new Speakeasy({
157+
server: "prod",
160158
security: {
161159
apiKey: "",
162160
},
163-
server: "prod",
164161
});
165162

166-
const res = await sdk.speakeasy.validateApiKey();
163+
const res = await sdk.validateApiKey();
167164

168165
if (res.statusCode == 200) {
169166
// handle response
@@ -177,19 +174,18 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
177174

178175
The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
179176

180-
181177
```typescript
182178
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
183179

184180
(async () => {
185181
const sdk = new Speakeasy({
182+
serverURL: "https://api.prod.speakeasyapi.dev",
186183
security: {
187184
apiKey: "",
188185
},
189-
serverURL: "https://api.prod.speakeasyapi.dev",
190186
});
191187

192-
const res = await sdk.speakeasy.validateApiKey();
188+
const res = await sdk.validateApiKey();
193189

194190
if (res.statusCode == 200) {
195191
// handle response
@@ -220,9 +216,43 @@ const httpClient = axios.create({
220216

221217
const sdk = new Speakeasy({defaultClient: httpClient});
222218
```
219+
<!-- End Custom HTTP Client -->
223220
224221
225-
<!-- End Custom HTTP Client -->
222+
223+
<!-- Start Authentication -->
224+
225+
# Authentication
226+
227+
## Per-Client Security Schemes
228+
229+
Your SDK supports the following security scheme globally:
230+
231+
| Name | Type | Scheme |
232+
| -------- | -------- | -------- |
233+
| `apiKey` | apiKey | API key |
234+
235+
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
236+
237+
```typescript
238+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
239+
240+
(async () => {
241+
const sdk = new Speakeasy({
242+
security: {
243+
apiKey: "",
244+
},
245+
});
246+
247+
const res = await sdk.validateApiKey();
248+
249+
if (res.statusCode == 200) {
250+
// handle response
251+
}
252+
})();
253+
254+
```
255+
<!-- End Authentication -->
226256

227257
<!-- Placeholder for Future Speakeasy SDK Sections -->
228258

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1016,4 +1016,14 @@ Based on:
10161016
### Generated
10171017
- [typescript v1.62.1] .
10181018
### Releases
1019-
- [NPM v1.62.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.1 - .
1019+
- [NPM v1.62.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.1 - .
1020+
1021+
## 2023-11-07 00:10:52
1022+
### Changes
1023+
Based on:
1024+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1025+
- Speakeasy CLI 1.114.1 (2.181.1) https://github.com/speakeasy-api/speakeasy
1026+
### Generated
1027+
- [typescript v2.0.0] .
1028+
### Releases
1029+
- [NPM v2.0.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/2.0.0 - .

‎docs/models/operations/downloadschemaresponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8+
| `twoHundredApplicationJsonSchema` | *Uint8Array* | :heavy_minus_sign: | OK |
9+
| `twoHundredApplicationXYamlSchema` | *Uint8Array* | :heavy_minus_sign: | OK |
810
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
911
| `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response |
10-
| `schema` | *Uint8Array* | :heavy_minus_sign: | OK |
1112
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
1213
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/downloadschemarevisionresponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
| Field | Type | Required | Description |
77
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
8+
| `twoHundredApplicationJsonSchema` | *Uint8Array* | :heavy_minus_sign: | OK |
9+
| `twoHundredApplicationXYamlSchema` | *Uint8Array* | :heavy_minus_sign: | OK |
810
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
911
| `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response |
10-
| `schema` | *Uint8Array* | :heavy_minus_sign: | OK |
1112
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
1213
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/registerschemarequestbodyfile.md renamed to ‎docs/models/operations/file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# RegisterSchemaRequestBodyFile
1+
# File
22

33

44
## Fields
55

66
| Field | Type | Required | Description |
77
| ------------------ | ------------------ | ------------------ | ------------------ |
88
| `content` | *Uint8Array* | :heavy_check_mark: | N/A |
9-
| `file` | *string* | :heavy_check_mark: | N/A |
9+
| `fileName` | *string* | :heavy_check_mark: | N/A |

‎docs/models/operations/getallapiendpointsresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
| Field | Type | Required | Description |
77
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
8-
| `apiEndpoints` | [shared.ApiEndpoint](../../models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |
98
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
109
| `error` | [shared.ErrorT](../../models/shared/errort.md) | :heavy_minus_sign: | Default error response |
1110
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
12-
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
12+
| `classes` | [shared.ApiEndpoint](../../models/shared/apiendpoint.md)[] | :heavy_minus_sign: | OK |

‎docs/models/operations/getallapiversionsrequest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
8-
| `apiID` | *string* | :heavy_check_mark: | The ID of the Api to retrieve. |
9-
| `metadata` | Record<string, *string*[]> | :heavy_minus_sign: | Metadata to filter Apis on |
10-
| `op` | [GetAllApiVersionsOp](../../models/operations/getallapiversionsop.md) | :heavy_minus_sign: | Configuration for filter operations |
6+
| Field | Type | Required | Description |
7+
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
8+
| `apiID` | *string* | :heavy_check_mark: | The ID of the Api to retrieve. |
9+
| `metadata` | Record<string, *string*[]> | :heavy_minus_sign: | Metadata to filter Apis on |
10+
| `op` | [operations.Op](../../models/operations/op.md) | :heavy_minus_sign: | Configuration for filter operations |

0 commit comments

Comments
 (0)