Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.448.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@speakeasybot
speakeasybot committed Nov 27, 2024
1 parent e75f00c commit c62c0a9
Show file tree
Hide file tree
Showing 89 changed files with 1,874 additions and 1,942 deletions.
18 changes: 9 additions & 9 deletions .speakeasy/gen.lock
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
lockVersion: 2.0.0
id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8
management:
docChecksum: 71c79847d66ec9266de8dac133004f2c
docChecksum: 013cd33b5b1382cd5f4a528664c3b567
docVersion: v1
speakeasyVersion: 1.438.0
generationVersion: 2.457.1
releaseVersion: 1.3.1
configChecksum: 658cd1dccb21eefe19cc7bd36410f63b
speakeasyVersion: 1.448.0
generationVersion: 2.466.0
releaseVersion: 1.4.0
configChecksum: d230d40f9aa069e972589344260c6aa8
repoURL: https://github.com/clerk/clerk-sdk-python.git
installationURL: https://github.com/clerk/clerk-sdk-python.git
published: true
features:
python:
additionalDependencies: 1.0.0
additionalProperties: 1.0.1
constsAndDefaults: 1.0.4
core: 5.6.4
constsAndDefaults: 1.0.5
core: 5.6.8
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
enumUnions: 0.1.0
Expand All @@ -36,8 +36,7 @@ features:
responseFormat: 1.0.1
retries: 3.0.2
sdkHooks: 1.0.0
tests: 1.6.0
unions: 3.0.3
unions: 3.0.4
uploadStreams: 1.0.0
generatedFiles:
- .gitattributes
Expand Down Expand Up @@ -1934,3 +1933,4 @@ examples:
application/json: {"id": "<id>", "object": "organization_domain", "organization_id": "<id>", "name": "<value>", "enrollment_mode": "automatic_invitation", "affiliation_email_address": "<value>", "verification": {"status": "unverified", "strategy": "<value>", "attempts": 991464, "expire_at": 627690}, "total_pending_invitations": 488852, "total_pending_suggestions": 984008, "created_at": 54062, "updated_at": 896501}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
generatedTests: {}
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 1.3.1
version: 1.4.0
additionalDependencies:
dev:
pytest: ^8.3.3
Expand Down
19 changes: 10 additions & 9 deletions .speakeasy/workflow.lock
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
speakeasyVersion: 1.438.0
speakeasyVersion: 1.448.0
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:e89d3d42646d1804adab2c71e3590848a232acd0a6e18e1bddbdacbbebd22c57
sourceBlobDigest: sha256:44d33d8984dd639bbff908aee705242bc26fc9fcd380c4b3f355f419767172b2
sourceRevisionDigest: sha256:0731ab86f11d2f2fa0a65e095379e5d957bbc2a4426cfbf5803df96d7716b04c
sourceBlobDigest: sha256:76d36ff5a4a0ebd8d1e7624cceda16a56bd360229fd03b7c65d865cfdc2dfe6b
tags:
- latest
- main
- speakeasy-sdk-regen-1732580417
- v1
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:e89d3d42646d1804adab2c71e3590848a232acd0a6e18e1bddbdacbbebd22c57
sourceBlobDigest: sha256:44d33d8984dd639bbff908aee705242bc26fc9fcd380c4b3f355f419767172b2
codeSamplesNamespace: clerk-openapi-code-samples
codeSamplesRevisionDigest: sha256:451997437b6cb4252f6235d61551d71e090c734b87e291437dcb200d975e8b2d
sourceRevisionDigest: sha256:0731ab86f11d2f2fa0a65e095379e5d957bbc2a4426cfbf5803df96d7716b04c
sourceBlobDigest: sha256:76d36ff5a4a0ebd8d1e7624cceda16a56bd360229fd03b7c65d865cfdc2dfe6b
codeSamplesNamespace: clerk-openapi-python-code-samples
codeSamplesRevisionDigest: sha256:c6596ea40504a6a9730089d0444da049581837f020cd7cb6a3f02cb31fd1b24c
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand All @@ -38,5 +39,5 @@ workflow:
token: $pypi_token
codeSamples:
registry:
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi-code-samples
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi-python-code-samples
blocking: false
2 changes: 1 addition & 1 deletion .speakeasy/workflow.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ targets:
token: $pypi_token
codeSamples:
registry:
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi-code-samples
location: registry.speakeasyapi.dev/clerk/clerk/clerk-openapi-python-code-samples
blocking: false
120 changes: 57 additions & 63 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,14 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
# Synchronous Example
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
) as s:
res = s.email_addresses.get(email_address_id="email_address_id_example")

res = s.email_addresses.get(email_address_id="email_address_id_example")

if res is not None:
# handle response
pass
if res is not None:
# handle response
pass
```

</br>
Expand All @@ -108,13 +107,14 @@ import asyncio
from clerk_backend_api import Clerk

async def main():
s = Clerk(
async with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
if res is not None:
# handle response
pass
) as s:
res = await s.email_addresses.get_async(email_address_id="email_address_id_example")

if res is not None:
# handle response
pass

asyncio.run(main())
```
Expand Down Expand Up @@ -365,19 +365,18 @@ Certain SDK methods accept file objects as part of a request body or multi-part
```python
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.users.set_profile_image(user_id="usr_test123", file={
"file_name": "example.file",
"content": open("example.file", "rb"),
"content_type": "<value>",
})
) as s:
res = s.users.set_profile_image(user_id="usr_test123", file={
"file_name": "example.file",
"content": open("example.file", "rb"),
"content_type": "<value>",
})

if res is not None:
# handle response
pass
if res is not None:
# handle response
pass

```
<!-- End File uploads [file-upload] -->
Expand All @@ -392,12 +391,11 @@ To change the default retry strategy for a single API call, simply provide a `Re
from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

s = Clerk()

s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
with Clerk() as s:
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d",
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

# Use the SDK ...
# Use the SDK ...

```

Expand All @@ -406,13 +404,12 @@ If you'd like to override the default retry strategy for all operations that sup
from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
)

s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
) as s:
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

# Use the SDK ...
# Use the SDK ...

```
<!-- End Retries [retries] -->
Expand Down Expand Up @@ -443,26 +440,25 @@ When custom error responses are specified for an operation, the SDK may also rai
```python
from clerk_backend_api import Clerk, models

s = Clerk(
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = None
try:
res = s.clients.verify(request={
"token": "jwt_token_example",
})

if res is not None:
# handle response
pass

except models.ClerkErrors as e:
# handle e.data: models.ClerkErrorsData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
) as s:
res = None
try:
res = s.clients.verify(request={
"token": "jwt_token_example",
})

if res is not None:
# handle response
pass

except models.ClerkErrors as e:
# handle e.data: models.ClerkErrorsData
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
```
<!-- End Error Handling [errors] -->

Expand All @@ -475,13 +471,12 @@ The default server can also be overridden globally by passing a URL to the `serv
```python
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
server_url="https://api.clerk.com/v1",
)

s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
) as s:
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

# Use the SDK ...
# Use the SDK ...

```
<!-- End Server Selection [server] -->
Expand Down Expand Up @@ -582,13 +577,12 @@ To authenticate with the API the `bearer_auth` parameter must be set when initia
```python
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
) as s:
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

# Use the SDK ...
# Use the SDK ...

```
<!-- End Authentication [security] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,4 +188,14 @@ Based on:
### Generated
- [python v1.3.1] .
### Releases
- [PyPI v1.3.1] https://pypi.org/project/clerk-backend-api/1.3.1 - .
- [PyPI v1.3.1] https://pypi.org/project/clerk-backend-api/1.3.1 - .

## 2024-11-27 00:20:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.448.0 (2.466.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v1.4.0] .
### Releases
- [PyPI v1.4.0] https://pypi.org/project/clerk-backend-api/1.4.0 - .
26 changes: 13 additions & 13 deletions USAGE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
# Synchronous Example
from clerk_backend_api import Clerk

s = Clerk(
with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
) as s:
res = s.email_addresses.get(email_address_id="email_address_id_example")

res = s.email_addresses.get(email_address_id="email_address_id_example")

if res is not None:
# handle response
pass
if res is not None:
# handle response
pass
```

</br>
Expand All @@ -23,13 +22,14 @@ import asyncio
from clerk_backend_api import Clerk

async def main():
s = Clerk(
async with Clerk(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = await s.email_addresses.get_async(email_address_id="email_address_id_example")
if res is not None:
# handle response
pass
) as s:
res = await s.email_addresses.get_async(email_address_id="email_address_id_example")

if res is not None:
# handle response
pass

asyncio.run(main())
```
Expand Down
8 changes: 4 additions & 4 deletions docs/models/updateemailaddressrequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Fields

| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `email_address_id` | *str* | :heavy_check_mark: | The ID of the email address to update | email_address_id_example |
| `request_body` | [Optional[models.UpdateEmailAddressRequestBody]](../models/updateemailaddressrequestbody.md) | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `email_address_id` | *str* | :heavy_check_mark: | The ID of the email address to update | email_address_id_example |
| `request_body` | [models.UpdateEmailAddressRequestBody](../models/updateemailaddressrequestbody.md) | :heavy_check_mark: | N/A | |
8 changes: 4 additions & 4 deletions docs/models/updatejwttemplaterequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `template_id` | *str* | :heavy_check_mark: | The ID of the JWT template to update |
| `request_body` | [Optional[models.UpdateJWTTemplateRequestBody]](../models/updatejwttemplaterequestbody.md) | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `template_id` | *str* | :heavy_check_mark: | The ID of the JWT template to update |
| `request_body` | [models.UpdateJWTTemplateRequestBody](../models/updatejwttemplaterequestbody.md) | :heavy_check_mark: | N/A |
Loading

0 comments on commit c62c0a9

Please sign in to comment.