Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
400 changes: 200 additions & 200 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
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.6
version: 0.5.0-alpha.7
additionalDependencies:
dev: {}
main: {}
Expand Down
8 changes: 4 additions & 4 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@ speakeasyVersion: 1.331.2
sources:
clerk-openapi:
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:4ce22a0cdb7433f376f0842a2dda1143fc61c2da241b5903d6239a44fc978fec
sourceBlobDigest: sha256:c715e59591e54f9e2beca3ed567d1a12edc3f20580cac065511ce19c4423e3aa
sourceRevisionDigest: sha256:83887503bf502c2b1e816b079beba5218998adb827d73f2ac6de809e14f4389b
sourceBlobDigest: sha256:0181726a4ca9a31eae12e6bdd2d42c0aeca0e25a76d8e9c82b57a829b69dff68
tags:
- latest
- main
targets:
clerk-sdk-python:
source: clerk-openapi
sourceNamespace: clerk-openapi
sourceRevisionDigest: sha256:4ce22a0cdb7433f376f0842a2dda1143fc61c2da241b5903d6239a44fc978fec
sourceBlobDigest: sha256:c715e59591e54f9e2beca3ed567d1a12edc3f20580cac065511ce19c4423e3aa
sourceRevisionDigest: sha256:83887503bf502c2b1e816b079beba5218998adb827d73f2ac6de809e14f4389b
sourceBlobDigest: sha256:0181726a4ca9a31eae12e6bdd2d42c0aeca0e25a76d8e9c82b57a829b69dff68
outLocation: .
workflow:
workflowVersion: 1.0.0
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ The Clerk Python library provides convenient access to the Clerk REST API from a

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

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

Expand All @@ -29,7 +29,7 @@ poetry add clerk

```python
# Synchronous Example
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand All @@ -50,7 +50,7 @@ The same SDK client can also be used to make asychronous requests by importing a
```python
# Asynchronous Example
import asyncio
from clerk import Clerk
from clerk_backend_api import Clerk
import os

async def main():
Expand Down Expand Up @@ -270,7 +270,7 @@ return value of `Next` is `None`, then there are no more pages to be fetched.

Here's an example of one such pagination call:
```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -303,7 +303,7 @@ Certain SDK methods accept file objects as part of a request body or multi-part
>

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -331,8 +331,8 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from clerk import Clerk
from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

s = Clerk()

Expand All @@ -346,8 +346,8 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from clerk import Clerk
from clerk.utils import BackoffStrategy, RetryConfig
from clerk_backend_api import Clerk

s = Clerk(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
Expand All @@ -374,7 +374,7 @@ Handling errors in this SDK should largely match your expectations. All operati
### Example

```python
from clerk import Clerk, models
from clerk_backend_api import Clerk, models
import os

s = Clerk(
Expand Down Expand Up @@ -418,7 +418,7 @@ You can override the default server globally by passing a server index to the `s
#### Example

```python
from clerk import Clerk
from clerk_backend_api import Clerk

s = Clerk(
server_idx=0,
Expand All @@ -436,7 +436,7 @@ s.misc.get_public_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable

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:
```python
from clerk import Clerk
from clerk_backend_api import Clerk

s = Clerk(
server_url="https://api.clerk.com/v1",
Expand All @@ -459,7 +459,7 @@ This allows you to wrap the client with your own custom logic, such as adding cu

For example, you could specify a header for every request that this sdk makes as follows:
```python
from clerk import Clerk
from clerk_backend_api import Clerk
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
Expand All @@ -468,8 +468,8 @@ s = Clerk(client=http_client)

or you could wrap the client with your own custom logic:
```python
from clerk import Clerk
from clerk.httpclient import AsyncHttpClient
from clerk_backend_api import Clerk
from clerk_backend_api.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
Expand Down Expand Up @@ -544,7 +544,7 @@ This SDK supports the following security scheme globally:

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

s = Clerk(
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,14 @@ Based on:
### Generated
- [python v0.5.0-alpha.6] .
### Releases
- [PyPI v0.5.0-alpha.6] https://pypi.org/project/clerk/0.5.0-alpha.6 - .
- [PyPI v0.5.0-alpha.6] https://pypi.org/project/clerk/0.5.0-alpha.6 - .

## 2024-07-11 21:13:04
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.331.2 (2.366.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.5.0-alpha.7] .
### Releases
- [PyPI v0.5.0-alpha.7] https://pypi.org/project/clerk-backend-api/0.5.0-alpha.7 - .
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand All @@ -22,7 +22,7 @@ The same SDK client can also be used to make asychronous requests by importing a
```python
# Asynchronous Example
import asyncio
from clerk import Clerk
from clerk_backend_api import Clerk
import os

async def main():
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/actortokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `actor` parameter needs to include at least a "sub" key whose value is the I
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -60,7 +60,7 @@ Revokes a pending actor token.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/allowlistidentifiers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Get a list of all identifiers allowed to sign up to an instance
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -54,7 +54,7 @@ Create an identifier allowed to sign up to an instance
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -96,7 +96,7 @@ Delete an identifier from the instance allow-list
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/betafeatures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Updates the settings of an instance
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -66,7 +66,7 @@ WARNING: Changing your domain will invalidate all current user sessions (i.e. us
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -105,7 +105,7 @@ WARNING: Changing your domain will invalidate all current user sessions (i.e. us
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/blocklistidentifierssdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Get a list of all identifiers which are not allowed to access an instance
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -54,7 +54,7 @@ Create an identifier that is blocked from accessing an instance
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -95,7 +95,7 @@ Delete an identifier from the instance block-list
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/clients/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Warning: the endpoint is being deprecated and will be removed in future versions
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -65,7 +65,7 @@ Verifies the client in the provided token
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -106,7 +106,7 @@ Returns the details of a client.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
8 changes: 4 additions & 4 deletions docs/sdks/domainssdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The response will contain the primary domain for the instance and any satellite
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -59,7 +59,7 @@ If you're planning to configure the new satellite domain to run behind a proxy,
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -103,7 +103,7 @@ It is currently not possible to delete the instance's primary domain.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -151,7 +151,7 @@ update the instance's home origin, affecting the default application paths.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
8 changes: 4 additions & 4 deletions docs/sdks/emailaddresses/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Create a new email address
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -59,7 +59,7 @@ Returns the details of an email address.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -100,7 +100,7 @@ Delete the email address with the given ID
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down Expand Up @@ -141,7 +141,7 @@ Updates an email address.
### Example Usage

```python
from clerk import Clerk
from clerk_backend_api import Clerk
import os

s = Clerk(
Expand Down
Loading