Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: 🐝 Update SDK - Generate 1.4.0 #61

Merged
merged 1 commit into from
Nov 27, 2024
Merged

chore: 🐝 Update SDK - Generate 1.4.0 #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions .speakeasy/gen.lock
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
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
Open in desktop
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:c28f47287a7b4933285aff49a199931d37e8e7e8ce75e88468140f95f284e331
sourceBlobDigest: sha256:d20d10387a61e374eef4ee2b380b1e3798c4d43a1fa1d085fe3782672234d708
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:c28f47287a7b4933285aff49a199931d37e8e7e8ce75e88468140f95f284e331
sourceBlobDigest: sha256:d20d10387a61e374eef4ee2b380b1e3798c4d43a1fa1d085fe3782672234d708
codeSamplesNamespace: clerk-openapi-python-code-samples
codeSamplesRevisionDigest: sha256:dbd857b062cde8a584b23d94a7d5f2187513871d02a8e8b16c0d114dcfab9c61
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
Open in desktop
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
Open in desktop
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
Open in desktop
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 14:15:09
### 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
Open in desktop
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
3 changes: 2 additions & 1 deletion docs/models/ticketverificationstrategy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@

| Name | Value |
| -------- | -------- |
| `TICKET` | ticket |
| `TICKET` | ticket |
| `SAML` | saml |
8 changes: 4 additions & 4 deletions docs/models/updateemailaddressrequest.md
View file
Open in desktop
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
Open in desktop
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 |
8 changes: 4 additions & 4 deletions docs/models/updatephonenumberrequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `phone_number_id` | *str* | :heavy_check_mark: | The ID of the phone number to update | phone_12345 |
| `request_body` | [Optional[models.UpdatePhoneNumberRequestBody]](../models/updatephonenumberrequestbody.md) | :heavy_minus_sign: | N/A | |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `phone_number_id` | *str* | :heavy_check_mark: | The ID of the phone number to update | phone_12345 |
| `request_body` | [models.UpdatePhoneNumberRequestBody](../models/updatephonenumberrequestbody.md) | :heavy_check_mark: | N/A | |
Loading