Skip to content

Commit

Permalink
Merge pull request #10 from clerk/speakeasy-sdk-regen-1725271755
Browse files Browse the repository at this point in the history 
chore: 🐝 Update SDK - Generate 0.5.0-alpha.12
  • Loading branch information
@octoper
octoper authored Sep 2, 2024
2 parents d06fbf6 + 291fd96 commit 28eb032
Show file tree
Hide file tree
Showing 86 changed files with 650 additions and 399 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
README-PYPI.md
.venv/
venv/
src/*.egg-info/
Expand Down
17 changes: 9 additions & 8 deletions .speakeasy/gen.lock
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
lockVersion: 2.0.0
id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8
management:
docChecksum: c41c5490f198f58506f13380ae55aa59
docChecksum: fae7f7a09c243660c1f412f56e7e9e5a
docVersion: v1
speakeasyVersion: 1.355.0
generationVersion: 2.387.0
releaseVersion: 0.5.0-alpha.11
configChecksum: 1804e08e82b6b13125dccf9edf256490
speakeasyVersion: 1.385.0
generationVersion: 2.407.2
releaseVersion: 0.5.0-alpha.12
configChecksum: c58c5b116d09e439c6ce3b13dbe914da
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
constsAndDefaults: 1.0.2
core: 5.3.4
core: 5.4.2
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
envVarSecurityUsage: 0.3.1
examples: 3.0.0
flatRequests: 1.0.1
flattening: 3.0.0
globalSecurity: 3.0.1
globalSecurity: 3.0.2
globalSecurityCallbacks: 1.0.0
globalSecurityFlattening: 1.0.0
globalServerURLs: 3.0.0
Expand All @@ -33,7 +33,7 @@ features:
responseFormat: 1.0.0
retries: 3.0.0
sdkHooks: 1.0.0
unions: 3.0.1
unions: 3.0.2
uploadStreams: 1.0.0
generatedFiles:
- src/clerk_backend_api/sdkconfiguration.py
Expand Down Expand Up @@ -71,6 +71,7 @@ generatedFiles:
- pylintrc
- pyproject.toml
- scripts/compile.sh
- scripts/prepare-readme.py
- scripts/publish.sh
- src/clerk_backend_api/__init__.py
- src/clerk_backend_api/basesdk.py
Expand Down
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
python:
version: 0.5.0-alpha.11
version: 0.5.0-alpha.12
additionalDependencies:
dev: {}
main: {}
Expand Down
10 changes: 5 additions & 5 deletions .speakeasy/workflow.lock
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
speakeasyVersion: 1.355.0
speakeasyVersion: 1.385.0
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:cb8608ec7757028df6422016affe39a59400a122606fe3a64561019546196545
sourceBlobDigest: sha256:5491a54b7c32b3f8a39f3496ab1df0c4858e2ff6f0855d844d2d854bc887cec5
sourceRevisionDigest: sha256:1c42a5b721828dd03a1012e4c108fc1fca15a9ebbe318daf24dc61c0adab3111
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
tags:
- latest
- main
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:cb8608ec7757028df6422016affe39a59400a122606fe3a64561019546196545
sourceBlobDigest: sha256:5491a54b7c32b3f8a39f3496ab1df0c4858e2ff6f0855d844d2d854bc887cec5
sourceRevisionDigest: sha256:1c42a5b721828dd03a1012e4c108fc1fca15a9ebbe318daf24dc61c0adab3111
sourceBlobDigest: sha256:18aae668583e7fea915d4b01912c8f93532ed71703e5d485052a39dffc0e7e1c
outLocation: .
workflow:
workflowVersion: 1.0.0
Expand Down
63 changes: 58 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,72 @@

The Clerk Python library provides convenient access to the Clerk REST API from any Python application 3.0+. The library includes type definitions for all request params and response fields, and offers synchronous and asynchronous support powered by [httpx](https://www.python-httpx.org/)

<!-- Start Summary [summary] -->
## Summary

Clerk Backend API: The Clerk REST Backend API, meant to be accessed by backend
servers.

### Versions

When the API changes in a way that isn't compatible with older versions, a new version is released.
Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/backend-requests/versioning/overview).


Please see https://clerk.com/docs for more information.

More information about the API can be found at https://clerk.com/docs
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents

* [SDK Installation](#sdk-installation)
* [IDE Support](#ide-support)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Pagination](#pagination)
* [File uploads](#file-uploads)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [Debugging](#debugging)
<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

PIP
The SDK can be installed with either *pip* or *poetry* package managers.

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install clerk-backend-api
```

Poetry
### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add clerk-backend-api
```
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

Expand Down Expand Up @@ -381,7 +433,7 @@ try:
res = s.clients.list(limit=20, offset=10)

except models.ClerkErrors as e:
# handle exception
# handle e.data: models.ClerkErrorsData
raise(e)
except models.SDKError as e:
# handle exception
Expand Down Expand Up @@ -537,7 +589,7 @@ This SDK supports the following security scheme globally:
| ------------- | ------------- | ------------- |
| `bearer_auth` | http | HTTP Bearer |

To authenticate with the API the `null` parameter must be set when initializing the SDK client instance. For example:
To authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:
```python
from clerk_backend_api import Clerk

Expand All @@ -556,8 +608,9 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable
<!-- Start Debugging [debug] -->
## Debugging

To emit debug logs for SDK requests and responses you can pass a logger object directly into your SDK object.
You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from clerk_backend_api import Clerk
import logging
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,14 @@ Based on:
### Generated
- [python v0.5.0-alpha.11] .
### Releases
- [PyPI v0.5.0-alpha.11] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.11 - .
- [PyPI v0.5.0-alpha.11] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.11 - .

## 2024-09-02 10:09:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.385.0 (2.407.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.5.0-alpha.12] .
### Releases
- [PyPI v0.5.0-alpha.12] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.12 - .
4 changes: 2 additions & 2 deletions docs/models/getclientlistrequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | *Optional[float]* | :heavy_minus_sign: | Applies a limit to the number of results returned.<br/>Can be used for paginating the results together with `offset`. | 20 |
| `offset` | *Optional[float]* | :heavy_minus_sign: | Skip the first `offset` results when paginating.<br/>Needs to be an integer greater or equal to zero.<br/>To be used in conjunction with `limit`. | 10 |
| `limit` | *Optional[int]* | :heavy_minus_sign: | Applies a limit to the number of results returned.<br/>Can be used for paginating the results together with `offset`. | 20 |
| `offset` | *Optional[int]* | :heavy_minus_sign: | Skip the first `offset` results when paginating.<br/>Needs to be an integer greater or equal to zero.<br/>To be used in conjunction with `limit`. | 10 |
4 changes: 2 additions & 2 deletions docs/models/getsessionlistrequest.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
| `client_id` | *Optional[str]* | :heavy_minus_sign: | List sessions for the given client | client_123 |
| `user_id` | *Optional[str]* | :heavy_minus_sign: | List sessions for the given user | user_456 |
| `status` | [Optional[models.QueryParamStatus]](../models/queryparamstatus.md) | :heavy_minus_sign: | Filter sessions by the provided status | active |
| `limit` | *Optional[float]* | :heavy_minus_sign: | Applies a limit to the number of results returned.<br/>Can be used for paginating the results together with `offset`. | 20 |
| `offset` | *Optional[float]* | :heavy_minus_sign: | Skip the first `offset` results when paginating.<br/>Needs to be an integer greater or equal to zero.<br/>To be used in conjunction with `limit`. | 10 |
| `limit` | *Optional[int]* | :heavy_minus_sign: | Applies a limit to the number of results returned.<br/>Can be used for paginating the results together with `offset`. | 20 |
| `offset` | *Optional[int]* | :heavy_minus_sign: | Skip the first `offset` results when paginating.<br/>Needs to be an integer greater or equal to zero.<br/>To be used in conjunction with `limit`. | 10 |
Loading

0 comments on commit 28eb032

Please sign in to comment.