Skip to content

Commit 8a2286d

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.108.1
1 parent 32ac197 commit 8a2286d

File tree

14 files changed

+156
-13
lines changed

14 files changed

+156
-13
lines changed

‎README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,104 @@ return value of `next` is `null`, then there are no more pages to be fetched.
126126
Here's an example of one such pagination call:
127127
<!-- End Pagination -->
128128

129+
130+
131+
<!-- Start Error Handling -->
132+
# Error Handling
133+
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.
135+
136+
137+
<!-- End Error Handling -->
138+
139+
140+
141+
<!-- Start Server Selection -->
142+
# Server Selection
143+
144+
## Select Server by Name
145+
146+
You can override the default server globally by passing a server name to the `server: string` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
147+
148+
| Name | Server | Variables |
149+
| ----- | ------ | --------- |
150+
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
151+
152+
For example:
153+
154+
155+
```typescript
156+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
157+
158+
(async () => {
159+
const sdk = new Speakeasy({
160+
security: {
161+
apiKey: "",
162+
},
163+
server: "prod",
164+
});
165+
166+
const res = await sdk.speakeasy.validateApiKey();
167+
168+
if (res.statusCode == 200) {
169+
// handle response
170+
}
171+
})();
172+
173+
```
174+
175+
176+
## Override Server URL Per-Client
177+
178+
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:
179+
180+
181+
```typescript
182+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
183+
184+
(async () => {
185+
const sdk = new Speakeasy({
186+
security: {
187+
apiKey: "",
188+
},
189+
serverURL: "https://api.prod.speakeasyapi.dev",
190+
});
191+
192+
const res = await sdk.speakeasy.validateApiKey();
193+
194+
if (res.statusCode == 200) {
195+
// handle response
196+
}
197+
})();
198+
199+
```
200+
<!-- End Server Selection -->
201+
202+
203+
204+
<!-- Start Custom HTTP Client -->
205+
# Custom HTTP Client
206+
207+
The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
208+
209+
210+
For example, you could specify a header for every request that your sdk makes as follows:
211+
212+
```typescript
213+
from @speakeasy-api/speakeasy-client-sdk-typescript import Speakeasy;
214+
import axios;
215+
216+
const httpClient = axios.create({
217+
headers: {'x-custom-header': 'someValue'}
218+
})
219+
220+
221+
const sdk = new Speakeasy({defaultClient: httpClient});
222+
```
223+
224+
225+
<!-- End Custom HTTP Client -->
226+
129227
<!-- Placeholder for Future Speakeasy SDK Sections -->
130228
131229

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1006,4 +1006,14 @@ Based on:
10061006
### Generated
10071007
- [typescript v1.62.0] .
10081008
### Releases
1009-
- [NPM v1.62.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.0 - .
1009+
- [NPM v1.62.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.0 - .
1010+
1011+
## 2023-10-27 00:10:48
1012+
### Changes
1013+
Based on:
1014+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1015+
- Speakeasy CLI 1.108.1 (2.172.4) https://github.com/speakeasy-api/speakeasy
1016+
### Generated
1017+
- [typescript v1.62.1] .
1018+
### Releases
1019+
- [NPM v1.62.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.1 - .

‎docs/sdks/apiendpoints/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
3838
versionID: "string",
3939
});
4040

41+
4142
if (res.statusCode == 200) {
4243
// handle response
4344
}
@@ -80,6 +81,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
8081
versionID: "string",
8182
});
8283

84+
8385
if (res.statusCode == 200) {
8486
// handle response
8587
}
@@ -122,6 +124,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
122124
versionID: "string",
123125
});
124126

127+
125128
if (res.statusCode == 200) {
126129
// handle response
127130
}
@@ -163,6 +166,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
163166
versionID: "string",
164167
});
165168

169+
166170
if (res.statusCode == 200) {
167171
// handle response
168172
}
@@ -202,6 +206,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
202206
apiID: "string",
203207
});
204208

209+
205210
if (res.statusCode == 200) {
206211
// handle response
207212
}
@@ -242,6 +247,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
242247
versionID: "string",
243248
});
244249

250+
245251
if (res.statusCode == 200) {
246252
// handle response
247253
}
@@ -283,6 +289,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
283289
versionID: "string",
284290
});
285291

292+
286293
if (res.statusCode == 200) {
287294
// handle response
288295
}
@@ -332,6 +339,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
332339
versionID: "string",
333340
});
334341

342+
335343
if (res.statusCode == 200) {
336344
// handle response
337345
}

‎docs/sdks/apis/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
3535
versionID: "string",
3636
});
3737

38+
3839
if (res.statusCode == 200) {
3940
// handle response
4041
}
@@ -76,6 +77,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7677
versionID: "string",
7778
});
7879

80+
7981
if (res.statusCode == 200) {
8082
// handle response
8183
}
@@ -116,6 +118,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
116118
versionID: "string",
117119
});
118120

121+
119122
if (res.statusCode == 200) {
120123
// handle response
121124
}
@@ -164,6 +167,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
164167
},
165168
});
166169

170+
167171
if (res.statusCode == 200) {
168172
// handle response
169173
}
@@ -211,6 +215,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
211215
},
212216
});
213217

218+
214219
if (res.statusCode == 200) {
215220
// handle response
216221
}
@@ -261,6 +266,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
261266
apiID: "string",
262267
});
263268

269+
264270
if (res.statusCode == 200) {
265271
// handle response
266272
}

‎docs/sdks/embeds/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
4343
},
4444
});
4545

46+
4647
if (res.statusCode == 200) {
4748
// handle response
4849
}
@@ -80,6 +81,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
8081

8182
const res = await sdk.embeds.getValidEmbedAccessTokens();
8283

84+
8385
if (res.statusCode == 200) {
8486
// handle response
8587
}
@@ -118,6 +120,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
118120
tokenID: "string",
119121
});
120122

123+
121124
if (res.statusCode == 200) {
122125
// handle response
123126
}

‎docs/sdks/metadata/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
3434
versionID: "string",
3535
});
3636

37+
3738
if (res.statusCode == 200) {
3839
// handle response
3940
}
@@ -74,6 +75,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7475
versionID: "string",
7576
});
7677

78+
7779
if (res.statusCode == 200) {
7880
// handle response
7981
}
@@ -118,6 +120,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
118120
versionID: "string",
119121
});
120122

123+
121124
if (res.statusCode == 200) {
122125
// handle response
123126
}

‎docs/sdks/plugins/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
2929

3030
const res = await sdk.plugins.getPlugins();
3131

32+
3233
if (res.statusCode == 200) {
3334
// handle response
3435
}
@@ -79,6 +80,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7980
pluginID: "string",
8081
});
8182

83+
8284
if (res.statusCode == 200) {
8385
// handle response
8486
}
@@ -121,6 +123,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
121123
workspaceId: "string",
122124
});
123125

126+
124127
if (res.statusCode == 200) {
125128
// handle response
126129
}

‎docs/sdks/requests/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
3232
requestID: "string",
3333
});
3434

35+
3536
if (res.statusCode == 200) {
3637
// handle response
3738
}
@@ -71,6 +72,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7172
requestID: "string",
7273
});
7374

75+
7476
if (res.statusCode == 200) {
7577
// handle response
7678
}
@@ -122,6 +124,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
122124
},
123125
});
124126

127+
125128
if (res.statusCode == 200) {
126129
// handle response
127130
}

‎docs/sdks/schemas/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
3838
versionID: "string",
3939
});
4040

41+
4142
if (res.statusCode == 200) {
4243
// handle response
4344
}
@@ -78,6 +79,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
7879
versionID: "string",
7980
});
8081

82+
8183
if (res.statusCode == 200) {
8284
// handle response
8385
}
@@ -119,6 +121,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
119121
versionID: "string",
120122
});
121123

124+
122125
if (res.statusCode == 200) {
123126
// handle response
124127
}
@@ -160,6 +163,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
160163
versionID: "string",
161164
});
162165

166+
163167
if (res.statusCode == 200) {
164168
// handle response
165169
}
@@ -202,6 +206,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
202206
versionID: "string",
203207
});
204208

209+
205210
if (res.statusCode == 200) {
206211
// handle response
207212
}
@@ -244,6 +249,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
244249
versionID: "string",
245250
});
246251

252+
247253
if (res.statusCode == 200) {
248254
// handle response
249255
}
@@ -285,6 +291,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
285291
versionID: "string",
286292
});
287293

294+
288295
if (res.statusCode == 200) {
289296
// handle response
290297
}
@@ -332,6 +339,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
332339
versionID: "string",
333340
});
334341

342+
335343
if (res.statusCode == 200) {
336344
// handle response
337345
}

0 commit comments

Comments
 (0)