Skip to content

Commit cd967dc

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.4.0, Speakeasy CLI 1.257.1
1 parent 0be1867 commit cd967dc

File tree

13 files changed

+196
-12
lines changed

13 files changed

+196
-12
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: b0b519b1-d1d3-43b2-82dd-b4292eadd4b0
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: 5.6.7
9-
configChecksum: 07c1104d9a89045f0101cd18069bf3ab
6+
speakeasyVersion: 1.257.1
7+
generationVersion: 2.308.2
8+
releaseVersion: 5.6.8
9+
configChecksum: 1e037a4dc92ae586cfd752020044ad26
1010
repoURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
1111
repoSubDirectory: .
1212
installationURL: https://github.com/speakeasy-api/speakeasy-client-sdk-python.git
@@ -85,6 +85,7 @@ generatedFiles:
8585
- src/speakeasy/models/operations/getrequestfromeventlog.py
8686
- src/speakeasy/models/operations/queryeventlog.py
8787
- src/speakeasy/models/operations/getorganizations.py
88+
- src/speakeasy/models/operations/getchangesreportsignedurl.py
8889
- src/speakeasy/models/operations/getlintingreportsignedurl.py
8990
- src/speakeasy/models/operations/uploadreport.py
9091
- src/speakeasy/models/operations/getembedaccesstoken.py
@@ -214,6 +215,9 @@ generatedFiles:
214215
- docs/models/operations/queryeventlogrequest.md
215216
- docs/models/operations/queryeventlogresponse.md
216217
- docs/models/operations/getorganizationsresponse.md
218+
- docs/models/operations/getchangesreportsignedurlrequest.md
219+
- docs/models/operations/getchangesreportsignedurlsignedaccess.md
220+
- docs/models/operations/getchangesreportsignedurlresponse.md
217221
- docs/models/operations/getlintingreportsignedurlrequest.md
218222
- docs/models/operations/getlintingreportsignedurlsignedaccess.md
219223
- docs/models/operations/getlintingreportsignedurlresponse.md

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ if res.apis is not None:
103103

104104
### [reports](docs/sdks/reports/README.md)
105105

106+
* [get_changes_report_signed_url](docs/sdks/reports/README.md#get_changes_report_signed_url) - Get the signed access url for the change reports for a particular document.
106107
* [get_linting_report_signed_url](docs/sdks/reports/README.md#get_linting_report_signed_url) - Get the signed access url for the linting reports for a particular document.
107108
* [upload_report](docs/sdks/reports/README.md#upload_report) - Upload a report.
108109

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1456,4 +1456,14 @@ Based on:
14561456
### Generated
14571457
- [python v5.6.7] .
14581458
### Releases
1459-
- [PyPI v5.6.7] https://pypi.org/project/speakeasy-client-sdk-python/5.6.7 - .
1459+
- [PyPI v5.6.7] https://pypi.org/project/speakeasy-client-sdk-python/5.6.7 - .
1460+
1461+
## 2024-04-18 00:10:43
1462+
### Changes
1463+
Based on:
1464+
- OpenAPI Doc 0.4.0 https://docs.speakeasyapi.dev/openapi.yaml
1465+
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
1466+
### Generated
1467+
- [python v5.6.8] .
1468+
### Releases
1469+
- [PyPI v5.6.8] https://pypi.org/project/speakeasy-client-sdk-python/5.6.8 - .

‎docs/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+
| `document_checksum` | *str* | :heavy_check_mark: | The checksum of the document to retrieve the signed access url for. |

‎docs/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+
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
9+
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
10+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
11+
| `signed_access` | [Optional[operations.GetChangesReportSignedURLSignedAccess]](../../models/operations/getchangesreportsignedurlsignedaccess.md) | :heavy_minus_sign: | OK |

‎docs/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` | *str* | :heavy_check_mark: | N/A |

‎docs/sdks/reports/README.md

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

88
### Available Operations
99

10+
* [get_changes_report_signed_url](#get_changes_report_signed_url) - Get the signed access url for the change reports for a particular document.
1011
* [get_linting_report_signed_url](#get_linting_report_signed_url) - Get the signed access url for the linting reports for a particular document.
1112
* [upload_report](#upload_report) - Upload a report.
1213

14+
## get_changes_report_signed_url
15+
16+
Get the signed access url for the change reports for a particular document.
17+
18+
### Example Usage
19+
20+
```python
21+
import speakeasy
22+
from speakeasy.models import operations, shared
23+
24+
s = speakeasy.Speakeasy(
25+
security=shared.Security(
26+
api_key="<YOUR_API_KEY_HERE>",
27+
),
28+
workspace_id='<value>',
29+
)
30+
31+
req = operations.GetChangesReportSignedURLRequest(
32+
document_checksum='<value>',
33+
)
34+
35+
res = s.reports.get_changes_report_signed_url(req)
36+
37+
if res.signed_access is not None:
38+
# handle response
39+
pass
40+
41+
```
42+
43+
### Parameters
44+
45+
| Parameter | Type | Required | Description |
46+
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
47+
| `request` | [operations.GetChangesReportSignedURLRequest](../../models/operations/getchangesreportsignedurlrequest.md) | :heavy_check_mark: | The request object to use for the request. |
48+
49+
50+
### Response
51+
52+
**[operations.GetChangesReportSignedURLResponse](../../models/operations/getchangesreportsignedurlresponse.md)**
53+
### Errors
54+
55+
| Error Object | Status Code | Content Type |
56+
| --------------- | --------------- | --------------- |
57+
| errors.SDKError | 4xx-5xx | */* |
58+
1359
## get_linting_report_signed_url
1460

1561
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
python:
13-
version: 5.6.7
13+
version: 5.6.8
1414
additionalDependencies:
1515
dependencies: {}
1616
extraDependencies:

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
setuptools.setup(
2121
name='speakeasy-client-sdk-python',
22-
version='5.6.7',
22+
version='5.6.8',
2323
author='Speakeasy',
2424
description='Speakeasy API Client SDK for Python',
2525
url='https://github.com/speakeasy-api/speakeasy-client-sdk-python.git',

‎src/speakeasy/models/operations/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
from .getapiendpoint import *
2020
from .getapis import *
2121
from .getblob import *
22+
from .getchangesreportsignedurl import *
2223
from .getembedaccesstoken import *
2324
from .getlintingreportsignedurl import *
2425
from .getmanifest import *
@@ -48,4 +49,4 @@
4849
from .upsertapiendpoint import *
4950
from .validateapikey import *
5051

51-
__all__ = ["DeleteAPIEndpointRequest","DeleteAPIEndpointResponse","DeleteAPIRequest","DeleteAPIResponse","DeleteSchemaRequest","DeleteSchemaResponse","DeleteVersionMetadataRequest","DeleteVersionMetadataResponse","DownloadSchemaRequest","DownloadSchemaResponse","DownloadSchemaRevisionRequest","DownloadSchemaRevisionResponse","File","FindAPIEndpointRequest","FindAPIEndpointResponse","GenerateOpenAPISpecForAPIEndpointRequest","GenerateOpenAPISpecForAPIEndpointResponse","GenerateOpenAPISpecRequest","GenerateOpenAPISpecResponse","GeneratePostmanCollectionForAPIEndpointRequest","GeneratePostmanCollectionForAPIEndpointResponse","GeneratePostmanCollectionRequest","GeneratePostmanCollectionResponse","GenerateRequestPostmanCollectionRequest","GenerateRequestPostmanCollectionResponse","GetAPIEndpointRequest","GetAPIEndpointResponse","GetAccessTokenRequest","GetAccessTokenResponse","GetAllAPIEndpointsRequest","GetAllAPIEndpointsResponse","GetAllAPIVersionsRequest","GetAllAPIVersionsResponse","GetAllForVersionAPIEndpointsRequest","GetAllForVersionAPIEndpointsResponse","GetApisRequest","GetApisResponse","GetBlobRequest","GetBlobResponse","GetEmbedAccessTokenRequest","GetEmbedAccessTokenResponse","GetLintingReportSignedURLRequest","GetLintingReportSignedURLResponse","GetLintingReportSignedURLSignedAccess","GetManifestRequest","GetManifestResponse","GetNamespacesResponse","GetOrganizationsResponse","GetRequestFromEventLogRequest","GetRequestFromEventLogResponse","GetRevisionsRequest","GetRevisionsResponse","GetSchemaDiffRequest","GetSchemaDiffResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaRevisionRequest","GetSchemaRevisionResponse","GetSchemasRequest","GetSchemasResponse","GetTagsRequest","GetTagsResponse","GetUserResponse","GetValidEmbedAccessTokensResponse","GetVersionMetadataRequest","GetVersionMetadataResponse","GetWorkspaceAccessRequest","GetWorkspaceAccessResponse","GetWorkspaceEventsGlobals","GetWorkspaceEventsRequest","GetWorkspaceEventsResponse","GetWorkspaceTargetsGlobals","GetWorkspaceTargetsRequest","GetWorkspaceTargetsResponse","InsertVersionMetadataRequest","InsertVersionMetadataResponse","Op","PostWorkspaceEventsGlobals","PostWorkspaceEventsRequest","PostWorkspaceEventsResponse","PreflightResponse","QueryEventLogRequest","QueryEventLogResponse","QueryParamOp","RegisterSchemaFile","RegisterSchemaRequest","RegisterSchemaRequestBody","RegisterSchemaResponse","RevokeEmbedAccessTokenRequest","RevokeEmbedAccessTokenResponse","UploadReportRequestBody","UploadReportResponse","UploadReportUploadedReport","UpsertAPIEndpointRequest","UpsertAPIEndpointResponse","UpsertAPIRequest","UpsertAPIResponse","ValidateAPIKeyResponse"]
52+
__all__ = ["DeleteAPIEndpointRequest","DeleteAPIEndpointResponse","DeleteAPIRequest","DeleteAPIResponse","DeleteSchemaRequest","DeleteSchemaResponse","DeleteVersionMetadataRequest","DeleteVersionMetadataResponse","DownloadSchemaRequest","DownloadSchemaResponse","DownloadSchemaRevisionRequest","DownloadSchemaRevisionResponse","File","FindAPIEndpointRequest","FindAPIEndpointResponse","GenerateOpenAPISpecForAPIEndpointRequest","GenerateOpenAPISpecForAPIEndpointResponse","GenerateOpenAPISpecRequest","GenerateOpenAPISpecResponse","GeneratePostmanCollectionForAPIEndpointRequest","GeneratePostmanCollectionForAPIEndpointResponse","GeneratePostmanCollectionRequest","GeneratePostmanCollectionResponse","GenerateRequestPostmanCollectionRequest","GenerateRequestPostmanCollectionResponse","GetAPIEndpointRequest","GetAPIEndpointResponse","GetAccessTokenRequest","GetAccessTokenResponse","GetAllAPIEndpointsRequest","GetAllAPIEndpointsResponse","GetAllAPIVersionsRequest","GetAllAPIVersionsResponse","GetAllForVersionAPIEndpointsRequest","GetAllForVersionAPIEndpointsResponse","GetApisRequest","GetApisResponse","GetBlobRequest","GetBlobResponse","GetChangesReportSignedURLRequest","GetChangesReportSignedURLResponse","GetChangesReportSignedURLSignedAccess","GetEmbedAccessTokenRequest","GetEmbedAccessTokenResponse","GetLintingReportSignedURLRequest","GetLintingReportSignedURLResponse","GetLintingReportSignedURLSignedAccess","GetManifestRequest","GetManifestResponse","GetNamespacesResponse","GetOrganizationsResponse","GetRequestFromEventLogRequest","GetRequestFromEventLogResponse","GetRevisionsRequest","GetRevisionsResponse","GetSchemaDiffRequest","GetSchemaDiffResponse","GetSchemaRequest","GetSchemaResponse","GetSchemaRevisionRequest","GetSchemaRevisionResponse","GetSchemasRequest","GetSchemasResponse","GetTagsRequest","GetTagsResponse","GetUserResponse","GetValidEmbedAccessTokensResponse","GetVersionMetadataRequest","GetVersionMetadataResponse","GetWorkspaceAccessRequest","GetWorkspaceAccessResponse","GetWorkspaceEventsGlobals","GetWorkspaceEventsRequest","GetWorkspaceEventsResponse","GetWorkspaceTargetsGlobals","GetWorkspaceTargetsRequest","GetWorkspaceTargetsResponse","InsertVersionMetadataRequest","InsertVersionMetadataResponse","Op","PostWorkspaceEventsGlobals","PostWorkspaceEventsRequest","PostWorkspaceEventsResponse","PreflightResponse","QueryEventLogRequest","QueryEventLogResponse","QueryParamOp","RegisterSchemaFile","RegisterSchemaRequest","RegisterSchemaRequestBody","RegisterSchemaResponse","RevokeEmbedAccessTokenRequest","RevokeEmbedAccessTokenResponse","UploadReportRequestBody","UploadReportResponse","UploadReportUploadedReport","UpsertAPIEndpointRequest","UpsertAPIEndpointResponse","UpsertAPIRequest","UpsertAPIResponse","ValidateAPIKeyResponse"]

‎src/speakeasy/models/operations/getchangesreportsignedurl.py

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
2+
3+
from __future__ import annotations
4+
import dataclasses
5+
import requests as requests_http
6+
from dataclasses_json import Undefined, dataclass_json
7+
from speakeasy import utils
8+
from typing import Optional
9+
10+
11+
@dataclasses.dataclass
12+
class GetChangesReportSignedURLRequest:
13+
document_checksum: str = dataclasses.field(metadata={'path_param': { 'field_name': 'documentChecksum', 'style': 'simple', 'explode': False }})
14+
r"""The checksum of the document to retrieve the signed access url for."""
15+
16+
17+
18+
19+
@dataclass_json(undefined=Undefined.EXCLUDE)
20+
@dataclasses.dataclass
21+
class GetChangesReportSignedURLSignedAccess:
22+
r"""OK"""
23+
url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('url') }})
24+
25+
26+
27+
28+
@dataclasses.dataclass
29+
class GetChangesReportSignedURLResponse:
30+
content_type: str = dataclasses.field()
31+
r"""HTTP response content type for this operation"""
32+
status_code: int = dataclasses.field()
33+
r"""HTTP response status code for this operation"""
34+
raw_response: requests_http.Response = dataclasses.field()
35+
r"""Raw HTTP response; suitable for custom response parsing"""
36+
signed_access: Optional[GetChangesReportSignedURLSignedAccess] = dataclasses.field(default=None)
37+
r"""OK"""
38+
39+

0 commit comments

Comments
 (0)