Skip to content

Commit 688061c

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.257.1
1 parent 9cc4123 commit 688061c

File tree

14 files changed

+6909
-998
lines changed

14 files changed

+6909
-998
lines changed

‎.speakeasy/gen.lock‎

Lines changed: 9 additions & 5 deletions
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: fb8d80dde775dc830ade2c3c3fe88d18
4+
docChecksum: 2b280a7f12ab57c144a654766cc34af2
55
docVersion: 0.4.0
6-
speakeasyVersion: 1.253.3
7-
generationVersion: 2.306.3
8-
releaseVersion: 3.2.4
9-
configChecksum: 83833ccb996f879f3990f0e1c6502f52
6+
speakeasyVersion: 1.257.1
7+
generationVersion: 2.308.2
8+
releaseVersion: 3.2.5
9+
configChecksum: 5f977ae0b9fbd2ccda7a4153b63b3788
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
@@ -93,6 +93,7 @@ generatedFiles:
9393
- src/sdk/models/operations/getrequestfromeventlog.ts
9494
- src/sdk/models/operations/queryeventlog.ts
9595
- src/sdk/models/operations/getorganizations.ts
96+
- src/sdk/models/operations/getchangesreportsignedurl.ts
9697
- src/sdk/models/operations/getlintingreportsignedurl.ts
9798
- src/sdk/models/operations/uploadreport.ts
9899
- src/sdk/models/operations/getembedaccesstoken.ts
@@ -219,6 +220,9 @@ generatedFiles:
219220
- docs/sdk/models/operations/queryeventlogrequest.md
220221
- docs/sdk/models/operations/queryeventlogresponse.md
221222
- docs/sdk/models/operations/getorganizationsresponse.md
223+
- docs/sdk/models/operations/getchangesreportsignedurlrequest.md
224+
- docs/sdk/models/operations/getchangesreportsignedurlsignedaccess.md
225+
- docs/sdk/models/operations/getchangesreportsignedurlresponse.md
222226
- docs/sdk/models/operations/getlintingreportsignedurlrequest.md
223227
- docs/sdk/models/operations/getlintingreportsignedurlsignedaccess.md
224228
- docs/sdk/models/operations/getlintingreportsignedurlresponse.md

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ run();
119119

120120
### [reports](docs/sdks/reports/README.md)
121121

122+
* [getChangesReportSignedUrl](docs/sdks/reports/README.md#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.
122123
* [getLintingReportSignedUrl](docs/sdks/reports/README.md#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
123124
* [uploadReport](docs/sdks/reports/README.md#uploadreport) - Upload a report.
124125

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1366,4 +1366,14 @@ Based on:
13661366
### Generated
13671367
- [typescript v3.2.4] .
13681368
### Releases
1369-
- [NPM v3.2.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.2.4 - .
1369+
- [NPM v3.2.4] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.2.4 - .
1370+
1371+
## 2024-04-18 00:11:33
1372+
### Changes
1373+
Based on:
1374+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1375+
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
1376+
### Generated
1377+
- [typescript v3.2.5] .
1378+
### Releases
1379+
- [NPM v3.2.5] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/3.2.5 - .

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GetChangesReportSignedUrlRequest
2+
3+
4+
## Fields
5+
6+
| Field | Type | Required | Description |
7+
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
8+
| `documentChecksum` | *string* | :heavy_check_mark: | The checksum of the document to retrieve the signed access url for. |

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GetChangesReportSignedUrlResponse
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+
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
10+
| `rawResponse` | [AxiosResponse](https://axios-http.com/docs/res_schema) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11+
| `signedAccess` | [operations.GetChangesReportSignedUrlSignedAccess](../../../sdk/models/operations/getchangesreportsignedurlsignedaccess.md) | :heavy_minus_sign: | OK |

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GetChangesReportSignedUrlSignedAccess
2+
3+
OK
4+
5+
6+
## Fields
7+
8+
| Field | Type | Required | Description |
9+
| ------------------ | ------------------ | ------------------ | ------------------ |
10+
| `url` | *string* | :heavy_check_mark: | N/A |

‎docs/sdks/reports/README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,56 @@ REST APIs for managing reports
77

88
### Available Operations
99

10+
* [getChangesReportSignedUrl](#getchangesreportsignedurl) - Get the signed access url for the change reports for a particular document.
1011
* [getLintingReportSignedUrl](#getlintingreportsignedurl) - Get the signed access url for the linting reports for a particular document.
1112
* [uploadReport](#uploadreport) - Upload a report.
1213

14+
## getChangesReportSignedUrl
15+
16+
Get the signed access url for the change reports for a particular document.
17+
18+
### Example Usage
19+
20+
```typescript
21+
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
22+
23+
async function run() {
24+
const sdk = new Speakeasy({
25+
security: {
26+
apiKey: "<YOUR_API_KEY_HERE>",
27+
},
28+
workspaceID: "<value>",
29+
});
30+
31+
const res = await sdk.reports.getChangesReportSignedUrl({
32+
documentChecksum: "<value>",
33+
});
34+
35+
if (res.statusCode == 200) {
36+
// handle response
37+
}
38+
}
39+
40+
run();
41+
```
42+
43+
### Parameters
44+
45+
| Parameter | Type | Required | Description |
46+
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
47+
| `request` | [operations.GetChangesReportSignedUrlRequest](../../sdk/models/operations/getchangesreportsignedurlrequest.md) | :heavy_check_mark: | The request object to use for the request. |
48+
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
49+
50+
51+
### Response
52+
53+
**Promise<[operations.GetChangesReportSignedUrlResponse](../../sdk/models/operations/getchangesreportsignedurlresponse.md)>**
54+
### Errors
55+
56+
| Error Object | Status Code | Content Type |
57+
| --------------- | --------------- | --------------- |
58+
| errors.SDKError | 4xx-5xx | */* |
59+
1360
## getLintingReportSignedUrl
1461

1562
Get the signed access url for the linting reports for a particular document.

‎gen.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ generation:
1010
auth:
1111
oAuth2ClientCredentialsEnabled: false
1212
typescript:
13-
version: 3.2.4
13+
version: 3.2.5
1414
author: Speakeasy
1515
clientServerStatusCodesAsErrors: false
1616
flattenGlobalSecurity: false

0 commit comments

Comments
 (0)