Skip to content

Commit d175a12

Browse files
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.4.2
1 parent 661d46b commit d175a12

File tree

7 files changed

+76
-45
lines changed

7 files changed

+76
-45
lines changed

README.md

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
# speakeasy-client-sdk-typescript
2-
3-
This is the Speakeasy API Client SDK for Typescript. It is generated from our OpenAPI spec found at https://docs.speakeasyapi.dev/openapi.yaml and used for interacting with the [Speakeasy API](https://docs.speakeasyapi.dev/docs/speakeasy-api/speakeasy-api).
4-
5-
This SDK was generated using Speakeasy's SDK Generator. For more information on how to use the generator to generate your own SDKs, please see the [Speakeasy Client SDK Generator Docs](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks).
1+
# @speakeasy-api/speakeasy-client-sdk-typescript
62

73
<!-- Start SDK Installation -->
84
## SDK Installation
@@ -20,39 +16,51 @@ yarn add @speakeasy-api/speakeasy-client-sdk-typescript
2016
```
2117
<!-- End SDK Installation -->
2218

23-
## Example usage
24-
19+
## SDK Example Usage
20+
<!-- Start SDK Example Usage -->
2521
```typescript
26-
// Replace relative paths below with npm module once it's published
27-
import {
28-
SDK,
29-
WithSecurity,
30-
} from "speakeasy-client-sdk-typescript";
31-
import {
32-
Security,
33-
SchemeApiKey,
34-
} from "speakeasy-client-sdk-typescript/src/sdk/models/shared";
35-
import {
36-
GetApisResponse,
37-
GetApisRequest,
38-
GetApisQueryParams,
39-
GetApisOp,
40-
} from "speakeasy-client-sdk-typescript/src/sdk/models/operations";
22+
import { SDK, withSecurity} from "@speakeasy-api/speakeasy-client-sdk-typescript";
23+
import { GetApisRequest, GetApisResponse } from "@speakeasy-api/speakeasy-client-sdk-typescript/src/sdk/models/operations";
4124
import { AxiosError } from "axios";
4225

43-
const security: Security = new Security(new SchemeApiKey("YOUR_API_KEY")); // Replace with your API key from your Speakeasy Workspace
44-
const sdk: SDK = new SDK(WithSecurity(security));
45-
46-
const metadata: Map<string, string[]> = new Map([["label", ["1"]]]);
47-
const op: GetApisOp = new GetApisOp(true);
48-
49-
const request: GetApisRequest = new GetApisRequest(
50-
new GetApisQueryParams(metadata, op)
51-
);
52-
sdk.Apis.getApis(request).then((res: GetApisResponse | AxiosError) => {
53-
console.log(res);
26+
const sdk = new SDK(withSecurity(
27+
security: {
28+
apiKey: {
29+
apiKey: "YOUR_API_KEY_HERE",
30+
},
31+
}
32+
));
33+
34+
const req: GetApisRequest = {
35+
queryParams: {
36+
metadata: {
37+
"deserunt": [
38+
"nulla",
39+
"id",
40+
"vero",
41+
],
42+
"perspiciatis": [
43+
"nihil",
44+
"fuga",
45+
"facilis",
46+
"eum",
47+
],
48+
"iusto": [
49+
"saepe",
50+
"inventore",
51+
],
52+
},
53+
op: {
54+
and: false,
55+
},
56+
},
57+
};
58+
59+
sdk.apis.getApis(req).then((res: GetApisResponse | AxiosError) => {
60+
// handle response
5461
});
5562
```
63+
<!-- End SDK Example Usage -->
5664

5765
<!-- Start SDK Available Operations -->
5866
## SDK Available Operations

RELEASES.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,12 @@ Based on:
4646
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
4747
- Speakeasy CLI 1.3.3 https://github.com/speakeasy-api/speakeasy
4848
### Releases
49-
- [NPM v1.3.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.3.2 - .
49+
- [NPM v1.3.2] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.3.2 - .
50+
51+
## Version 1.4.0
52+
### Changes
53+
Based on:
54+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
55+
- Speakeasy CLI 1.4.2 https://github.com/speakeasy-api/speakeasy
56+
### Releases
57+
- [NPM v1.4.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.4.0 - .

files.gen

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ src/sdk/schemas.ts
88
src/sdk/sdk.ts
99
package-lock.json
1010
package.json
11+
src/index.ts
12+
src/internal/utils/contenttype.ts
13+
src/internal/utils/headers.ts
14+
src/internal/utils/index.ts
15+
src/internal/utils/pathparams.ts
16+
src/internal/utils/queryparams.ts
17+
src/internal/utils/requestbody.ts
18+
src/internal/utils/retries.ts
19+
src/internal/utils/security.ts
20+
src/internal/utils/utils.ts
21+
src/sdk/index.ts
22+
tsconfig.json
1123
src/sdk/models/operations/deleteapiendpoint.ts
1224
src/sdk/models/operations/findapiendpoint.ts
1325
src/sdk/models/operations/generateopenapispecforapiendpoint.ts

gen.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
configVersion: 1.0.0
12
management:
2-
openapi-checksum: 2bba3b8f9d211b02569b3f9aff0d34b4
3-
openapi-version: 0.3.0
4-
speakeasy-version: 1.3.3
3+
docChecksum: 2bba3b8f9d211b02569b3f9aff0d34b4
4+
docVersion: 0.3.0
5+
speakeasyVersion: 1.4.2
6+
generation:
7+
telemetryEnabled: true
8+
sdkClassName: SDK
59
typescript:
6-
version: 1.3.2
7-
packagename: '@speakeasy-api/speakeasy-client-sdk-typescript'
10+
version: 1.4.0
811
author: Speakeasy
9-
telemetryenabled: true
12+
packageName: '@speakeasy-api/speakeasy-client-sdk-typescript'

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@speakeasy-api/speakeasy-client-sdk-typescript",
3-
"version": "1.3.2",
3+
"version": "1.4.0",
44
"author": "Speakeasy",
55
"scripts": {
66
"prepare": "tsc --build"

src/sdk/sdk.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ export class SDK {
4040
public _securityClient: AxiosInstance;
4141
public _serverURL: string;
4242
private _language = "typescript";
43-
private _sdkVersion = "1.3.2";
44-
private _genVersion = "1.3.3";
43+
private _sdkVersion = "1.4.0";
44+
private _genVersion = "1.4.2";
4545

4646
constructor(props: SDKProps) {
4747
this._serverURL = props.serverUrl ?? ServerList[ServerProd];

0 commit comments

Comments
 (0)