Skip to content

Commit

Permalink
Merge pull request #56 from clerk/speakeasy-sdk-regen-1731339780
Browse files Browse the repository at this point in the history
chore: 🐝 Update SDK - Generate 1.3.0
  • Loading branch information
speakeasybot authored Nov 11, 2024
2 parents f25f667 + 6842ac6 commit 93df85a
Show file tree
Hide file tree
Showing 11 changed files with 48 additions and 57 deletions.
18 changes: 9 additions & 9 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
python:
version: 1.2.0
version: 1.3.0
additionalDependencies:
dev:
pytest: ^8.3.3
Expand All @@ -24,6 +24,7 @@ python:
authors:
- Clerk
clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError
description: Python Client SDK for clerk.dev
enumFormat: enum
fixFlags:
Expand Down
14 changes: 8 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
speakeasyVersion: 1.428.0
speakeasyVersion: 1.437.0
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:32d28c22120d0b90c85b6a67e85c77fd170f91a1c6a419c2f00c6fbb659dfaa4
sourceBlobDigest: sha256:ac4af071d2df658a8f43fb4ecf597f40d81750b13930645ae5523edbb46abab1
sourceRevisionDigest: sha256:b9003a9949cb3383f2cdaf2d335e2690613bf936b1807dabb3db73ea6de9681b
sourceBlobDigest: sha256:a6fe6b772943fa5f6ea18ff77bc4a90528bce97944df850b2b84c862466a0c29
tags:
- latest
- main
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:32d28c22120d0b90c85b6a67e85c77fd170f91a1c6a419c2f00c6fbb659dfaa4
sourceBlobDigest: sha256:ac4af071d2df658a8f43fb4ecf597f40d81750b13930645ae5523edbb46abab1
sourceRevisionDigest: sha256:b9003a9949cb3383f2cdaf2d335e2690613bf936b1807dabb3db73ea6de9681b
sourceBlobDigest: sha256:a6fe6b772943fa5f6ea18ff77bc4a90528bce97944df850b2b84c862466a0c29
codeSamplesNamespace: clerk-openapi-code-samples
codeSamplesRevisionDigest: sha256:51a35774b712e61587715c33e2ae31cc98c7e6a0f93b33065a483085c7197f95
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
clerk-openapi:
inputs:
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2021-02-05.yml
- location: https://raw.githubusercontent.com/clerk/openapi-specs/refs/heads/main/bapi/2024-10-01.yml
overlays:
- location: ./fixes.yaml
- location: ./examples.yaml
Expand Down
38 changes: 7 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,10 +433,10 @@ By default, an API error will raise a models.SDKError exception, which has the f

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 `verify_async` method may raise the following exceptions:

| Error Type | Status Code | Content Type |
| ------------------ | ------------------ | ------------------ |
| models.ClerkErrors | 400, 401, 404 | application/json |
| models.SDKError | 4XX, 5XX | \*/\* |
| Error Type | Status Code | Content Type |
| ------------------ | ------------- | ---------------- |
| models.ClerkErrors | 400, 401, 404 | application/json |
| models.SDKError | 4XX, 5XX | \*/\* |

### Example

Expand Down Expand Up @@ -469,30 +469,6 @@ except models.SDKError as e:
<!-- Start Server Selection [server] -->
## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.clerk.com/v1` | None |

#### Example

```python
from clerk_backend_api import Clerk

s = Clerk(
server_idx=0,
)

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

# Use the SDK ...

```


### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
Expand Down Expand Up @@ -598,9 +574,9 @@ s = Clerk(async_client=CustomClient(httpx.AsyncClient()))

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `bearer_auth` | http | HTTP Bearer |
| Name | Type | Scheme |
| ------------- | ---- | ----------- |
| `bearer_auth` | http | HTTP Bearer |

To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
```python
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,14 @@ Based on:
### Generated
- [python v1.2.0] .
### Releases
- [PyPI v1.2.0] https://pypi.org/project/clerk-backend-api/1.2.0 - .
- [PyPI v1.2.0] https://pypi.org/project/clerk-backend-api/1.2.0 - .

## 2024-11-11 15:42:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.437.0 (2.456.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v1.3.0] .
### Releases
- [PyPI v1.3.0] https://pypi.org/project/clerk-backend-api/1.3.0 - .
3 changes: 2 additions & 1 deletion docs/models/type.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
| `OAUTH_GOOGLE` | oauth_google |
| `OAUTH_MOCK` | oauth_mock |
| `SAML` | saml |
| `OAUTH_MICROSOFT` | oauth_microsoft |
| `EMAIL_LINK` | email_link |
| `OAUTH_APPLE` | oauth_apple |
| `OAUTH_DISCORD` | oauth_discord |
| `OAUTH_MICROSOFT` | oauth_microsoft |
| `OAUTH_GITHUB` | oauth_github |
4 changes: 2 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "clerk-backend-api"
version = "1.2.0"
version = "1.3.0"
description = "Python Client SDK for clerk.dev"
authors = ["Clerk",]
readme = "README-PYPI.md"
Expand Down
2 changes: 1 addition & 1 deletion src/clerk_backend_api/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import importlib.metadata

__title__: str = "clerk-backend-api"
__version__: str = "1.2.0"
__version__: str = "1.3.0"

try:
if __package__ is not None:
Expand Down
3 changes: 2 additions & 1 deletion src/clerk_backend_api/models/identificationlink.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ class Type(str, Enum):
OAUTH_GOOGLE = "oauth_google"
OAUTH_MOCK = "oauth_mock"
SAML = "saml"
OAUTH_MICROSOFT = "oauth_microsoft"
EMAIL_LINK = "email_link"
OAUTH_APPLE = "oauth_apple"
OAUTH_DISCORD = "oauth_discord"
OAUTH_MICROSOFT = "oauth_microsoft"
OAUTH_GITHUB = "oauth_github"


Expand Down
6 changes: 3 additions & 3 deletions src/clerk_backend_api/sdkconfiguration.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ class SDKConfiguration:
server_idx: Optional[int] = 0
language: str = "python"
openapi_doc_version: str = "v1"
sdk_version: str = "1.2.0"
gen_version: str = "2.447.4"
user_agent: str = "speakeasy-sdk/python 1.2.0 2.447.4 v1 clerk-backend-api"
sdk_version: str = "1.3.0"
gen_version: str = "2.456.0"
user_agent: str = "speakeasy-sdk/python 1.3.0 2.456.0 v1 clerk-backend-api"
retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET)
timeout_ms: Optional[int] = None

Expand Down

0 comments on commit 93df85a

Please sign in to comment.