Skip to content

Commit 486e407

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.23.0
1 parent a1b90b6 commit 486e407

Some content is hidden

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

51 files changed

+1305
-66
lines changed

‎README.md

+49-50
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,10 @@ yarn add @speakeasy-api/speakeasy-client-sdk-typescript
1919
## SDK Example Usage
2020
<!-- Start SDK Example Usage -->
2121
```typescript
22-
import {
23-
GetApisRequest,
24-
GetApisResponse
25-
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
26-
27-
import { AxiosError } from "axios";
2822
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
23+
import { GetApisRequest, GetApisResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
24+
import { AxiosError } from "axios";
25+
2926
const sdk = new Speakeasy({
3027
security: {
3128
apiKey: "YOUR_API_KEY_HERE",
@@ -56,72 +53,74 @@ const req: GetApisRequest = {
5653
};
5754

5855
sdk.apis.getApis(req).then((res: GetApisResponse | AxiosError) => {
59-
// handle response
56+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
57+
// handle response
58+
}
6059
});
6160
```
6261
<!-- End SDK Example Usage -->
6362

6463
<!-- Start SDK Available Operations -->
6564
## Available Resources and Operations
6665

67-
### Speakeasy SDK
66+
### [Speakeasy SDK](docs/speakeasy/README.md)
6867

69-
* `validateApiKey` - Validate the current api key.
68+
* [validateApiKey](docs/speakeasy/validateapikey.md) - Validate the current api key.
7069

71-
### apiEndpoints
70+
### [apiEndpoints](docs/apiendpoints/README.md)
7271

73-
* `deleteApiEndpoint` - Delete an ApiEndpoint.
74-
* `findApiEndpoint` - Find an ApiEndpoint via its displayName.
75-
* `generateOpenApiSpecForApiEndpoint` - Generate an OpenAPI specification for a particular ApiEndpoint.
76-
* `generatePostmanCollectionForApiEndpoint` - Generate a Postman collection for a particular ApiEndpoint.
77-
* `getAllApiEndpoints` - Get all Api endpoints for a particular apiID.
78-
* `getAllForVersionApiEndpoints` - Get all ApiEndpoints for a particular apiID and versionID.
79-
* `getApiEndpoint` - Get an ApiEndpoint.
80-
* `upsertApiEndpoint` - Upsert an ApiEndpoint.
72+
* [deleteApiEndpoint](docs/apiendpoints/deleteapiendpoint.md) - Delete an ApiEndpoint.
73+
* [findApiEndpoint](docs/apiendpoints/findapiendpoint.md) - Find an ApiEndpoint via its displayName.
74+
* [generateOpenApiSpecForApiEndpoint](docs/apiendpoints/generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint.
75+
* [generatePostmanCollectionForApiEndpoint](docs/apiendpoints/generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint.
76+
* [getAllApiEndpoints](docs/apiendpoints/getallapiendpoints.md) - Get all Api endpoints for a particular apiID.
77+
* [getAllForVersionApiEndpoints](docs/apiendpoints/getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID.
78+
* [getApiEndpoint](docs/apiendpoints/getapiendpoint.md) - Get an ApiEndpoint.
79+
* [upsertApiEndpoint](docs/apiendpoints/upsertapiendpoint.md) - Upsert an ApiEndpoint.
8180

82-
### apis
81+
### [apis](docs/apis/README.md)
8382

84-
* `deleteApi` - Delete an Api.
85-
* `generateOpenApiSpec` - Generate an OpenAPI specification for a particular Api.
86-
* `generatePostmanCollection` - Generate a Postman collection for a particular Api.
87-
* `getAllApiVersions` - Get all Api versions for a particular ApiEndpoint.
88-
* `getApis` - Get a list of Apis for a given workspace
89-
* `upsertApi` - Upsert an Api
83+
* [deleteApi](docs/apis/deleteapi.md) - Delete an Api.
84+
* [generateOpenApiSpec](docs/apis/generateopenapispec.md) - Generate an OpenAPI specification for a particular Api.
85+
* [generatePostmanCollection](docs/apis/generatepostmancollection.md) - Generate a Postman collection for a particular Api.
86+
* [getAllApiVersions](docs/apis/getallapiversions.md) - Get all Api versions for a particular ApiEndpoint.
87+
* [getApis](docs/apis/getapis.md) - Get a list of Apis for a given workspace
88+
* [upsertApi](docs/apis/upsertapi.md) - Upsert an Api
9089

91-
### embeds
90+
### [embeds](docs/embeds/README.md)
9291

93-
* `getEmbedAccessToken` - Get an embed access token for the current workspace.
94-
* `getValidEmbedAccessTokens` - Get all valid embed access tokens for the current workspace.
95-
* `revokeEmbedAccessToken` - Revoke an embed access EmbedToken.
92+
* [getEmbedAccessToken](docs/embeds/getembedaccesstoken.md) - Get an embed access token for the current workspace.
93+
* [getValidEmbedAccessTokens](docs/embeds/getvalidembedaccesstokens.md) - Get all valid embed access tokens for the current workspace.
94+
* [revokeEmbedAccessToken](docs/embeds/revokeembedaccesstoken.md) - Revoke an embed access EmbedToken.
9695

97-
### metadata
96+
### [metadata](docs/metadata/README.md)
9897

99-
* `deleteVersionMetadata` - Delete metadata for a particular apiID and versionID.
100-
* `getVersionMetadata` - Get all metadata for a particular apiID and versionID.
101-
* `insertVersionMetadata` - Insert metadata for a particular apiID and versionID.
98+
* [deleteVersionMetadata](docs/metadata/deleteversionmetadata.md) - Delete metadata for a particular apiID and versionID.
99+
* [getVersionMetadata](docs/metadata/getversionmetadata.md) - Get all metadata for a particular apiID and versionID.
100+
* [insertVersionMetadata](docs/metadata/insertversionmetadata.md) - Insert metadata for a particular apiID and versionID.
102101

103-
### plugins
102+
### [plugins](docs/plugins/README.md)
104103

105-
* `getPlugins` - Get all plugins for the current workspace.
106-
* `runPlugin` - Run a plugin
107-
* `upsertPlugin` - Upsert a plugin
104+
* [getPlugins](docs/plugins/getplugins.md) - Get all plugins for the current workspace.
105+
* [runPlugin](docs/plugins/runplugin.md) - Run a plugin
106+
* [upsertPlugin](docs/plugins/upsertplugin.md) - Upsert a plugin
108107

109-
### requests
108+
### [requests](docs/requests/README.md)
110109

111-
* `generateRequestPostmanCollection` - Generate a Postman collection for a particular request.
112-
* `getRequestFromEventLog` - Get information about a particular request.
113-
* `queryEventLog` - Query the event log to retrieve a list of requests.
110+
* [generateRequestPostmanCollection](docs/requests/generaterequestpostmancollection.md) - Generate a Postman collection for a particular request.
111+
* [getRequestFromEventLog](docs/requests/getrequestfromeventlog.md) - Get information about a particular request.
112+
* [queryEventLog](docs/requests/queryeventlog.md) - Query the event log to retrieve a list of requests.
114113

115-
### schemas
114+
### [schemas](docs/schemas/README.md)
116115

117-
* `deleteSchema` - Delete a particular schema revision for an Api.
118-
* `downloadSchema` - Download the latest schema for a particular apiID.
119-
* `downloadSchemaRevision` - Download a particular schema revision for an Api.
120-
* `getSchema` - Get information about the latest schema.
121-
* `getSchemaDiff` - Get a diff of two schema revisions for an Api.
122-
* `getSchemaRevision` - Get information about a particular schema revision for an Api.
123-
* `getSchemas` - Get information about all schemas associated with a particular apiID.
124-
* `registerSchema` - Register a schema.
116+
* [deleteSchema](docs/schemas/deleteschema.md) - Delete a particular schema revision for an Api.
117+
* [downloadSchema](docs/schemas/downloadschema.md) - Download the latest schema for a particular apiID.
118+
* [downloadSchemaRevision](docs/schemas/downloadschemarevision.md) - Download a particular schema revision for an Api.
119+
* [getSchema](docs/schemas/getschema.md) - Get information about the latest schema.
120+
* [getSchemaDiff](docs/schemas/getschemadiff.md) - Get a diff of two schema revisions for an Api.
121+
* [getSchemaRevision](docs/schemas/getschemarevision.md) - Get information about a particular schema revision for an Api.
122+
* [getSchemas](docs/schemas/getschemas.md) - Get information about all schemas associated with a particular apiID.
123+
* [registerSchema](docs/schemas/registerschema.md) - Register a schema.
125124
<!-- End SDK Available Operations -->
126125

127126
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)

‎RELEASES.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -334,4 +334,12 @@ Based on:
334334
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
335335
- Speakeasy CLI 1.22.1 (2.20.1) https://github.com/speakeasy-api/speakeasy
336336
### Releases
337-
- [NPM v1.18.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.18.0 - .
337+
- [NPM v1.18.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.18.0 - .
338+
339+
## 2023-04-25 09:13:06
340+
### Changes
341+
Based on:
342+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
343+
- Speakeasy CLI 1.23.0 (2.21.0) https://github.com/speakeasy-api/speakeasy
344+
### Releases
345+
- [NPM v1.19.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.19.0 - .

‎USAGE.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
<!-- Start SDK Example Usage -->
22
```typescript
3-
import {
4-
GetApisRequest,
5-
GetApisResponse
6-
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
7-
8-
import { AxiosError } from "axios";
93
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
4+
import { GetApisRequest, GetApisResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
5+
import { AxiosError } from "axios";
6+
107
const sdk = new Speakeasy({
118
security: {
129
apiKey: "YOUR_API_KEY_HERE",
@@ -37,7 +34,9 @@ const req: GetApisRequest = {
3734
};
3835

3936
sdk.apis.getApis(req).then((res: GetApisResponse | AxiosError) => {
40-
// handle response
37+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
38+
// handle response
39+
}
4140
});
4241
```
4342
<!-- End SDK Example Usage -->

‎docs/apiendpoints/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# apiEndpoints
2+
3+
REST APIs for managing ApiEndpoint entities
4+
5+
6+
* [deleteApiEndpoint](deleteapiendpoint.md) - Delete an ApiEndpoint.
7+
* [findApiEndpoint](findapiendpoint.md) - Find an ApiEndpoint via its displayName.
8+
* [generateOpenApiSpecForApiEndpoint](generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint.
9+
* [generatePostmanCollectionForApiEndpoint](generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint.
10+
* [getAllApiEndpoints](getallapiendpoints.md) - Get all Api endpoints for a particular apiID.
11+
* [getAllForVersionApiEndpoints](getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID.
12+
* [getApiEndpoint](getapiendpoint.md) - Get an ApiEndpoint.
13+
* [upsertApiEndpoint](upsertapiendpoint.md) - Upsert an ApiEndpoint.

‎docs/apiendpoints/deleteapiendpoint.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# deleteApiEndpoint
2+
Available in: `apiEndpoints`
3+
4+
Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
5+
6+
## Example Usage
7+
```typescript
8+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
9+
import { DeleteApiEndpointRequest, DeleteApiEndpointResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
10+
import { AxiosError } from "axios";
11+
12+
const sdk = new Speakeasy({
13+
security: {
14+
apiKey: "YOUR_API_KEY_HERE",
15+
},
16+
});
17+
18+
const req: DeleteApiEndpointRequest = {
19+
apiEndpointID: "delectus",
20+
apiID: "tempora",
21+
versionID: "suscipit",
22+
};
23+
24+
sdk.apiEndpoints.deleteApiEndpoint(req).then((res: DeleteApiEndpointResponse | AxiosError) => {
25+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
26+
// handle response
27+
}
28+
});
29+
```

‎docs/apiendpoints/findapiendpoint.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# findApiEndpoint
2+
Available in: `apiEndpoints`
3+
4+
Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
5+
This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.
6+
7+
## Example Usage
8+
```typescript
9+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
10+
import { FindApiEndpointRequest, FindApiEndpointResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
11+
import { AxiosError } from "axios";
12+
13+
const sdk = new Speakeasy({
14+
security: {
15+
apiKey: "YOUR_API_KEY_HERE",
16+
},
17+
});
18+
19+
const req: FindApiEndpointRequest = {
20+
apiID: "molestiae",
21+
displayName: "minus",
22+
versionID: "placeat",
23+
};
24+
25+
sdk.apiEndpoints.findApiEndpoint(req).then((res: FindApiEndpointResponse | AxiosError) => {
26+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
27+
// handle response
28+
}
29+
});
30+
```

‎docs/apiendpoints/generateopenapispecforapiendpoint.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# generateOpenApiSpecForApiEndpoint
2+
Available in: `apiEndpoints`
3+
4+
This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
5+
Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
6+
7+
## Example Usage
8+
```typescript
9+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
10+
import {
11+
GenerateOpenApiSpecForApiEndpointRequest,
12+
GenerateOpenApiSpecForApiEndpointResponse,
13+
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
14+
import { AxiosError } from "axios";
15+
16+
const sdk = new Speakeasy({
17+
security: {
18+
apiKey: "YOUR_API_KEY_HERE",
19+
},
20+
});
21+
22+
const req: GenerateOpenApiSpecForApiEndpointRequest = {
23+
apiEndpointID: "voluptatum",
24+
apiID: "iusto",
25+
versionID: "excepturi",
26+
};
27+
28+
sdk.apiEndpoints.generateOpenApiSpecForApiEndpoint(req).then((res: GenerateOpenApiSpecForApiEndpointResponse | AxiosError) => {
29+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
30+
// handle response
31+
}
32+
});
33+
```

‎docs/apiendpoints/generatepostmancollectionforapiendpoint.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# generatePostmanCollectionForApiEndpoint
2+
Available in: `apiEndpoints`
3+
4+
Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
5+
6+
## Example Usage
7+
```typescript
8+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
9+
import {
10+
GeneratePostmanCollectionForApiEndpointRequest,
11+
GeneratePostmanCollectionForApiEndpointResponse,
12+
} from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
13+
import { AxiosError } from "axios";
14+
15+
const sdk = new Speakeasy({
16+
security: {
17+
apiKey: "YOUR_API_KEY_HERE",
18+
},
19+
});
20+
21+
const req: GeneratePostmanCollectionForApiEndpointRequest = {
22+
apiEndpointID: "nisi",
23+
apiID: "recusandae",
24+
versionID: "temporibus",
25+
};
26+
27+
sdk.apiEndpoints.generatePostmanCollectionForApiEndpoint(req).then((res: GeneratePostmanCollectionForApiEndpointResponse | AxiosError) => {
28+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
29+
// handle response
30+
}
31+
});
32+
```

‎docs/apiendpoints/getallapiendpoints.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# getAllApiEndpoints
2+
Available in: `apiEndpoints`
3+
4+
Get all Api endpoints for a particular apiID.
5+
6+
## Example Usage
7+
```typescript
8+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
9+
import { GetAllApiEndpointsRequest, GetAllApiEndpointsResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
10+
import { AxiosError } from "axios";
11+
12+
const sdk = new Speakeasy({
13+
security: {
14+
apiKey: "YOUR_API_KEY_HERE",
15+
},
16+
});
17+
18+
const req: GetAllApiEndpointsRequest = {
19+
apiID: "ab",
20+
};
21+
22+
sdk.apiEndpoints.getAllApiEndpoints(req).then((res: GetAllApiEndpointsResponse | AxiosError) => {
23+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
24+
// handle response
25+
}
26+
});
27+
```

‎docs/apiendpoints/getallforversionapiendpoints.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# getAllForVersionApiEndpoints
2+
Available in: `apiEndpoints`
3+
4+
Get all ApiEndpoints for a particular apiID and versionID.
5+
6+
## Example Usage
7+
```typescript
8+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
9+
import { GetAllForVersionApiEndpointsRequest, GetAllForVersionApiEndpointsResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/dist/sdk/models/operations";
10+
import { AxiosError } from "axios";
11+
12+
const sdk = new Speakeasy({
13+
security: {
14+
apiKey: "YOUR_API_KEY_HERE",
15+
},
16+
});
17+
18+
const req: GetAllForVersionApiEndpointsRequest = {
19+
apiID: "quis",
20+
versionID: "veritatis",
21+
};
22+
23+
sdk.apiEndpoints.getAllForVersionApiEndpoints(req).then((res: GetAllForVersionApiEndpointsResponse | AxiosError) => {
24+
if (res instanceof UsageExamplePostResponse && res.statusCode == 200) {
25+
// handle response
26+
}
27+
});
28+
```

0 commit comments

Comments
 (0)