Skip to content

Commit 95a9d7e

Browse files
speakeasybotfrankie567
authored andcommitted
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6
1 parent 0f6b45d commit 95a9d7e

File tree

32 files changed

+221
-255
lines changed

32 files changed

+221
-255
lines changed

.speakeasy/gen.lock

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
lockVersion: 2.0.0
22
id: e7042734-e669-4c36-85da-bbb4a7500ac8
33
management:
4-
docChecksum: 2d641484229a829e6171b797314760ce
4+
docChecksum: 731f3794df11184c4a3ac24b324ecdf6
55
docVersion: 0.1.0
6-
speakeasyVersion: 1.404.5
7-
generationVersion: 2.426.2
8-
releaseVersion: 0.4.1
9-
configChecksum: 6aea9f6f581f9755af0c0fbc99cdfcfc
6+
speakeasyVersion: 1.405.6
7+
generationVersion: 2.428.1
8+
releaseVersion: 0.4.2
9+
configChecksum: f27ad139c4fe9ee20fa554911db773e3
1010
repoURL: https://github.com/polarsource/polar-python.git
1111
installationURL: https://github.com/polarsource/polar-python.git
1212
published: true
1313
features:
1414
python:
1515
additionalDependencies: 1.0.0
1616
constsAndDefaults: 1.0.3
17-
core: 5.5.6
17+
core: 5.5.7
1818
defaultEnabledRetries: 0.2.0
1919
devContainers: 3.0.0
2020
enumUnions: 0.1.0

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ generation:
1515
auth:
1616
oAuth2ClientCredentialsEnabled: true
1717
python:
18-
version: 0.4.1
18+
version: 0.4.2
1919
additionalDependencies:
2020
dev: {}
2121
main: {}

.speakeasy/workflow.lock

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
speakeasyVersion: 1.404.5
1+
speakeasyVersion: 1.405.6
22
sources:
33
Polar-OAS:
44
sourceNamespace: polar-oas
5-
sourceRevisionDigest: sha256:815ab6de4e6c5b2b5a88dfd060ecb4141f0f19b4d34f0c1d650f03409118c1f2
6-
sourceBlobDigest: sha256:5eb0bac1eec44a3257c05fa5dad4dd44e9c066c1bf593658718856fca6070228
5+
sourceRevisionDigest: sha256:15f41a063c8850c3d4bbe8b1208336e04d00a09c1e78bdbcd41ab43c0b31f11e
6+
sourceBlobDigest: sha256:8f7ec4a81270266c320453ee9e2ac7e2f8a0c71d2ee84c72f4fbda5b9ac1fc4d
77
tags:
88
- latest
99
- main
1010
targets:
1111
polar:
1212
source: Polar-OAS
1313
sourceNamespace: polar-oas
14-
sourceRevisionDigest: sha256:815ab6de4e6c5b2b5a88dfd060ecb4141f0f19b4d34f0c1d650f03409118c1f2
15-
sourceBlobDigest: sha256:5eb0bac1eec44a3257c05fa5dad4dd44e9c066c1bf593658718856fca6070228
14+
sourceRevisionDigest: sha256:15f41a063c8850c3d4bbe8b1208336e04d00a09c1e78bdbcd41ab43c0b31f11e
15+
sourceBlobDigest: sha256:8f7ec4a81270266c320453ee9e2ac7e2f8a0c71d2ee84c72f4fbda5b9ac1fc4d
1616
workflow:
1717
workflowVersion: 1.0.0
1818
speakeasyVersion: latest

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -295,12 +295,23 @@ if res is not None:
295295
<!-- Start Error Handling [errors] -->
296296
## Error Handling
297297

298-
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
298+
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
299299

300-
| Error Object | Status Code | Content Type |
300+
By default, an API error will raise a models.SDKError exception, which has the following properties:
301+
302+
| Property | Type | Description |
303+
|-----------------|------------------|-----------------------|
304+
| `.status_code` | *int* | The HTTP status code |
305+
| `.message` | *str* | The error message |
306+
| `.raw_response` | *httpx.Response* | The raw HTTP response |
307+
| `.body` | *str* | The response content |
308+
309+
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `list_async` method may raise the following exceptions:
310+
311+
| Error Type | Status Code | Content Type |
301312
| -------------------------- | -------------------------- | -------------------------- |
302313
| models.HTTPValidationError | 422 | application/json |
303-
| models.SDKError | 4xx-5xx | */* |
314+
| models.SDKError | 4XX, 5XX | \*/\* |
304315

305316
### Example
306317

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,4 +183,14 @@ Based on:
183183
### Generated
184184
- [python v0.4.1] .
185185
### Releases
186-
- [PyPI v0.4.1] https://pypi.org/project/polar-sdk/0.4.1 - .
186+
- [PyPI v0.4.1] https://pypi.org/project/polar-sdk/0.4.1 - .
187+
188+
## 2024-10-02 00:11:55
189+
### Changes
190+
Based on:
191+
- OpenAPI Doc
192+
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
193+
### Generated
194+
- [python v0.4.2] .
195+
### Releases
196+
- [PyPI v0.4.2] https://pypi.org/project/polar-sdk/0.4.2 - .

docs/models/userinfoorganization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `sub` | *str* | :heavy_check_mark: | N/A |
9-
| `name` | *Nullable[str]* | :heavy_check_mark: | N/A |
6+
| Field | Type | Required | Description |
7+
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
8+
| `sub` | *str* | :heavy_check_mark: | N/A |
9+
| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |

docs/models/userinfouser.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
## Fields
55

6-
| Field | Type | Required | Description |
7-
| ------------------ | ------------------ | ------------------ | ------------------ |
8-
| `sub` | *str* | :heavy_check_mark: | N/A |
9-
| `name` | *Nullable[str]* | :heavy_check_mark: | N/A |
10-
| `email` | *Nullable[str]* | :heavy_check_mark: | N/A |
11-
| `email_verified` | *Nullable[bool]* | :heavy_check_mark: | N/A |
6+
| Field | Type | Required | Description |
7+
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
8+
| `sub` | *str* | :heavy_check_mark: | N/A |
9+
| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
10+
| `email` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
11+
| `email_verified` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |

docs/sdks/advertisements/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,10 @@ if res is not None:
4949

5050
### Errors
5151

52-
| Error Object | Status Code | Content Type |
52+
| Error Type | Status Code | Content Type |
5353
| -------------------------- | -------------------------- | -------------------------- |
5454
| models.HTTPValidationError | 422 | application/json |
55-
| models.SDKError | 4xx-5xx | */* |
56-
55+
| models.SDKError | 4XX, 5XX | \*/\* |
5756

5857
## get
5958

@@ -89,8 +88,8 @@ if res is not None:
8988

9089
### Errors
9190

92-
| Error Object | Status Code | Content Type |
91+
| Error Type | Status Code | Content Type |
9392
| -------------------------- | -------------------------- | -------------------------- |
9493
| models.ResourceNotFound | 404 | application/json |
9594
| models.HTTPValidationError | 422 | application/json |
96-
| models.SDKError | 4xx-5xx | */* |
95+
| models.SDKError | 4XX, 5XX | \*/\* |

docs/sdks/articles/README.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,10 @@ if res is not None:
5959

6060
### Errors
6161

62-
| Error Object | Status Code | Content Type |
62+
| Error Type | Status Code | Content Type |
6363
| -------------------------- | -------------------------- | -------------------------- |
6464
| models.HTTPValidationError | 422 | application/json |
65-
| models.SDKError | 4xx-5xx | */* |
66-
65+
| models.SDKError | 4XX, 5XX | \*/\* |
6766

6867
## create
6968

@@ -101,11 +100,10 @@ if res is not None:
101100

102101
### Errors
103102

104-
| Error Object | Status Code | Content Type |
103+
| Error Type | Status Code | Content Type |
105104
| -------------------------- | -------------------------- | -------------------------- |
106105
| models.HTTPValidationError | 422 | application/json |
107-
| models.SDKError | 4xx-5xx | */* |
108-
106+
| models.SDKError | 4XX, 5XX | \*/\* |
109107

110108
## get
111109

@@ -141,12 +139,11 @@ if res is not None:
141139

142140
### Errors
143141

144-
| Error Object | Status Code | Content Type |
142+
| Error Type | Status Code | Content Type |
145143
| -------------------------- | -------------------------- | -------------------------- |
146144
| models.ResourceNotFound | 404 | application/json |
147145
| models.HTTPValidationError | 422 | application/json |
148-
| models.SDKError | 4xx-5xx | */* |
149-
146+
| models.SDKError | 4XX, 5XX | \*/\* |
150147

151148
## update
152149

@@ -183,13 +180,12 @@ if res is not None:
183180

184181
### Errors
185182

186-
| Error Object | Status Code | Content Type |
183+
| Error Type | Status Code | Content Type |
187184
| -------------------------- | -------------------------- | -------------------------- |
188185
| models.NotPermitted | 403 | application/json |
189186
| models.ResourceNotFound | 404 | application/json |
190187
| models.HTTPValidationError | 422 | application/json |
191-
| models.SDKError | 4xx-5xx | */* |
192-
188+
| models.SDKError | 4XX, 5XX | \*/\* |
193189

194190
## delete
195191

@@ -219,13 +215,12 @@ s.articles.delete(id="<value>")
219215

220216
### Errors
221217

222-
| Error Object | Status Code | Content Type |
218+
| Error Type | Status Code | Content Type |
223219
| -------------------------- | -------------------------- | -------------------------- |
224220
| models.NotPermitted | 403 | application/json |
225221
| models.ResourceNotFound | 404 | application/json |
226222
| models.HTTPValidationError | 422 | application/json |
227-
| models.SDKError | 4xx-5xx | */* |
228-
223+
| models.SDKError | 4XX, 5XX | \*/\* |
229224

230225
## receivers
231226

@@ -261,11 +256,10 @@ if res is not None:
261256

262257
### Errors
263258

264-
| Error Object | Status Code | Content Type |
259+
| Error Type | Status Code | Content Type |
265260
| -------------------------- | -------------------------- | -------------------------- |
266261
| models.HTTPValidationError | 422 | application/json |
267-
| models.SDKError | 4xx-5xx | */* |
268-
262+
| models.SDKError | 4XX, 5XX | \*/\* |
269263

270264
## preview
271265

@@ -304,13 +298,12 @@ if res is not None:
304298

305299
### Errors
306300

307-
| Error Object | Status Code | Content Type |
301+
| Error Type | Status Code | Content Type |
308302
| -------------------------- | -------------------------- | -------------------------- |
309303
| models.NotPermitted | 403 | application/json |
310304
| models.ResourceNotFound | 404 | application/json |
311305
| models.HTTPValidationError | 422 | application/json |
312-
| models.SDKError | 4xx-5xx | */* |
313-
306+
| models.SDKError | 4XX, 5XX | \*/\* |
314307

315308
## send
316309

@@ -346,9 +339,9 @@ if res is not None:
346339

347340
### Errors
348341

349-
| Error Object | Status Code | Content Type |
342+
| Error Type | Status Code | Content Type |
350343
| -------------------------- | -------------------------- | -------------------------- |
351344
| models.NotPermitted | 403 | application/json |
352345
| models.ResourceNotFound | 404 | application/json |
353346
| models.HTTPValidationError | 422 | application/json |
354-
| models.SDKError | 4xx-5xx | */* |
347+
| models.SDKError | 4XX, 5XX | \*/\* |

docs/sdks/benefits/README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,10 @@ if res is not None:
5353

5454
### Errors
5555

56-
| Error Object | Status Code | Content Type |
56+
| Error Type | Status Code | Content Type |
5757
| -------------------------- | -------------------------- | -------------------------- |
5858
| models.HTTPValidationError | 422 | application/json |
59-
| models.SDKError | 4xx-5xx | */* |
60-
59+
| models.SDKError | 4XX, 5XX | \*/\* |
6160

6261
## create
6362

@@ -101,11 +100,10 @@ if res is not None:
101100

102101
### Errors
103102

104-
| Error Object | Status Code | Content Type |
103+
| Error Type | Status Code | Content Type |
105104
| -------------------------- | -------------------------- | -------------------------- |
106105
| models.HTTPValidationError | 422 | application/json |
107-
| models.SDKError | 4xx-5xx | */* |
108-
106+
| models.SDKError | 4XX, 5XX | \*/\* |
109107

110108
## get
111109

@@ -141,12 +139,11 @@ if res is not None:
141139

142140
### Errors
143141

144-
| Error Object | Status Code | Content Type |
142+
| Error Type | Status Code | Content Type |
145143
| -------------------------- | -------------------------- | -------------------------- |
146144
| models.ResourceNotFound | 404 | application/json |
147145
| models.HTTPValidationError | 422 | application/json |
148-
| models.SDKError | 4xx-5xx | */* |
149-
146+
| models.SDKError | 4XX, 5XX | \*/\* |
150147

151148
## update
152149

@@ -186,13 +183,12 @@ if res is not None:
186183

187184
### Errors
188185

189-
| Error Object | Status Code | Content Type |
186+
| Error Type | Status Code | Content Type |
190187
| -------------------------- | -------------------------- | -------------------------- |
191188
| models.NotPermitted | 403 | application/json |
192189
| models.ResourceNotFound | 404 | application/json |
193190
| models.HTTPValidationError | 422 | application/json |
194-
| models.SDKError | 4xx-5xx | */* |
195-
191+
| models.SDKError | 4XX, 5XX | \*/\* |
196192

197193
## delete
198194

@@ -226,13 +222,12 @@ s.benefits.delete(id="<value>")
226222

227223
### Errors
228224

229-
| Error Object | Status Code | Content Type |
225+
| Error Type | Status Code | Content Type |
230226
| -------------------------- | -------------------------- | -------------------------- |
231227
| models.NotPermitted | 403 | application/json |
232228
| models.ResourceNotFound | 404 | application/json |
233229
| models.HTTPValidationError | 422 | application/json |
234-
| models.SDKError | 4xx-5xx | */* |
235-
230+
| models.SDKError | 4XX, 5XX | \*/\* |
236231

237232
## grants
238233

@@ -279,8 +274,8 @@ if res is not None:
279274

280275
### Errors
281276

282-
| Error Object | Status Code | Content Type |
277+
| Error Type | Status Code | Content Type |
283278
| -------------------------- | -------------------------- | -------------------------- |
284279
| models.ResourceNotFound | 404 | application/json |
285280
| models.HTTPValidationError | 422 | application/json |
286-
| models.SDKError | 4xx-5xx | */* |
281+
| models.SDKError | 4XX, 5XX | \*/\* |

0 commit comments

Comments
 (0)