Skip to content

Commit 8cd59f9

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0 ., Speakeasy CLI 1.332.1
1 parent 12d83ed commit 8cd59f9

File tree

16 files changed

+6967
-998
lines changed

16 files changed

+6967
-998
lines changed

‎.speakeasy/gen.lock

+12-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: 89968bf0-a755-4d50-9acb-d47410010f05
33
management:
4-
docChecksum: f5cf06d8d5f2ec68226ab161d7a73cba
4+
docChecksum: 638dbecd668cc1d7818c3b5aefd2d3e1
55
docVersion: 0.4.0 .
6-
speakeasyVersion: 1.331.0
7-
generationVersion: 2.365.0
8-
releaseVersion: 3.3.12
9-
configChecksum: 199b7630db1994159978669e4420220e
6+
speakeasyVersion: 1.332.1
7+
generationVersion: 2.366.1
8+
releaseVersion: 3.3.13
9+
configChecksum: 16cc8531611b24455d1fef7f42778c46
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-typescript
@@ -34,6 +34,7 @@ generatedFiles:
3434
- src/sdk/github.ts
3535
- src/sdk/organizations.ts
3636
- src/sdk/reports.ts
37+
- src/sdk/shorturls.ts
3738
- src/sdk/suggest.ts
3839
- src/sdk/embeds.ts
3940
- src/sdk/events.ts
@@ -112,6 +113,7 @@ generatedFiles:
112113
- src/sdk/models/operations/getchangesreportsignedurl.ts
113114
- src/sdk/models/operations/getlintingreportsignedurl.ts
114115
- src/sdk/models/operations/uploadreport.ts
116+
- src/sdk/models/operations/create.ts
115117
- src/sdk/models/operations/applyoperationids.ts
116118
- src/sdk/models/operations/suggestoperationids.ts
117119
- src/sdk/models/operations/suggestoperationidsregistry.ts
@@ -171,6 +173,7 @@ generatedFiles:
171173
- src/sdk/models/shared/organizationusage.ts
172174
- src/sdk/models/shared/organization.ts
173175
- src/sdk/models/shared/report.ts
176+
- src/sdk/models/shared/shorturl.ts
174177
- src/sdk/models/shared/suggestedoperationids.ts
175178
- src/sdk/models/shared/suggestoperationidsopts.ts
176179
- src/sdk/models/shared/embedaccesstokenresponse.ts
@@ -288,6 +291,8 @@ generatedFiles:
288291
- docs/sdk/models/operations/uploadreportrequestbody.md
289292
- docs/sdk/models/operations/uploadreportuploadedreport.md
290293
- docs/sdk/models/operations/uploadreportresponse.md
294+
- docs/sdk/models/operations/createrequestbody.md
295+
- docs/sdk/models/operations/createresponse.md
291296
- docs/sdk/models/operations/applyoperationidsrequestbody.md
292297
- docs/sdk/models/operations/applyoperationidsrequest.md
293298
- docs/sdk/models/operations/applyoperationidsresponse.md
@@ -370,6 +375,7 @@ generatedFiles:
370375
- docs/sdk/models/shared/organization.md
371376
- docs/sdk/models/shared/typet.md
372377
- docs/sdk/models/shared/report.md
378+
- docs/sdk/models/shared/shorturl.md
373379
- docs/sdk/models/shared/suggestedoperationids.md
374380
- docs/sdk/models/shared/depthstyle.md
375381
- docs/sdk/models/shared/style.md
@@ -394,6 +400,7 @@ generatedFiles:
394400
- docs/sdks/github/README.md
395401
- docs/sdks/organizations/README.md
396402
- docs/sdks/reports/README.md
403+
- docs/sdks/shorturls/README.md
397404
- docs/sdks/suggest/README.md
398405
- docs/sdks/embeds/README.md
399406
- docs/sdks/events/README.md

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ run();
138138
* [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
139139
* [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
140140

141+
### [shortURLs](docs/sdks/shorturls/README.md)
142+
143+
* [create](docs/sdks/shorturls/README.md#create) - Shorten a URL.
144+
141145
### [suggest](docs/sdks/suggest/README.md)
142146

143147
* [applyOperationIDs](docs/sdks/suggest/README.md#applyoperationids) - Apply operation ID suggestions and download result.

‎RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1586,4 +1586,14 @@ Based on:
15861586
### Generated
15871587
- [typescript v3.3.12] .
15881588
### Releases
1589-
- [NPM v3.3.12] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.12 - .
1589+
- [NPM v3.3.12] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.12 - .
1590+
1591+
## 2024-07-12 00:12:40
1592+
### Changes
1593+
Based on:
1594+
- OpenAPI Doc 0.4.0 . https://docs.speakeasyapi.dev/openapi.yaml
1595+
- Speakeasy CLI 1.332.1 (2.366.1) https://github.com/speakeasy-api/speakeasy
1596+
### Generated
1597+
- [typescript v3.3.13] .
1598+
### Releases
1599+
- [NPM v3.3.13] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.3.13 - .

‎docs/sdk/models/operations/createrequestbody.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreateRequestBody
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `url` | *string* | :heavy_check_mark: | URL to shorten |

‎docs/sdk/models/operations/createresponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CreateResponse
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
8+
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `shortURL` | [shared.ShortURL](../../../sdk/models/shared/shorturl.md) | :heavy_minus_sign: | OK |
10+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
11+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/sdk/models/shared/shorturl.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ShortURL
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------ | ------------------ | ------------------ | ------------------ |
8+
| `fullUrl` | *string* | :heavy_check_mark: | N/A |
9+
| `shortUrl` | *string* | :heavy_check_mark: | N/A |

‎docs/sdks/shorturls/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# ShortURLs
2+
(*shortURLs*)
3+
4+
## Overview
5+
6+
REST APIs for managing short URLs
7+
8+
### Available Operations
9+
10+
* [create](#create) - Shorten a URL.
11+
12+
## create
13+
14+
Shorten a URL.
15+
16+
### Example Usage
17+
18+
```typescript
19+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
20+
21+
async function run() {
22+
const sdk = new Speakeasy({
23+
security: {
24+
apiKey: "<YOUR_API_KEY_HERE>",
25+
},
26+
});
27+
28+
const res = await sdk.shortURLs.create({
29+
url: "http://limp-pastry.org",
30+
});
31+
32+
if (res.statusCode == 200) {
33+
// handle response
34+
}
35+
}
36+
37+
run();
38+
```
39+
40+
### Parameters
41+
42+
| Parameter | Type | Required | Description |
43+
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
44+
| `request` | [operations.CreateRequestBody](../../sdk/models/operations/createrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
45+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
46+
47+
48+
### Response
49+
50+
**Promise<[operations.CreateResponse](../../sdk/models/operations/createresponse.md)>**
51+
### Errors
52+
53+
| Error Object | Status Code | Content Type |
54+
| --------------- | --------------- | --------------- |
55+
| errors.SDKError | 4xx-5xx | */* |

‎gen.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ generation:
1010
auth:
1111
oAuth2ClientCredentialsEnabled: false
1212
typescript:
13-
version: 3.3.12
13+
version: 3.3.13
1414
author: Speakeasy
1515
clientServerStatusCodesAsErrors: false
1616
flattenGlobalSecurity: false

0 commit comments

Comments
 (0)