dominic-clerk-test-sdk 0.0.10
Python Client SDK Generated by Speakeasy.
License: Apache-2.0
Requires Python: >=3.9.2

# dominic-clerk-test-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage *dominic-clerk-test-sdk* API.

[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=dominic-clerk-test-sdk&utm_campaign=python)
[![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)


<br /><br />
> [!IMPORTANT]
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/dominictest/test). Delete this section before > publishing to a package manager.

<!-- 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. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).

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
<!-- $toc-max-depth=2 -->
* [dominic-clerk-test-sdk](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#dominic-clerk-test-sdk)
  * [SDK Installation](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#sdk-installation)
  * [IDE Support](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#ide-support)
  * [SDK Example Usage](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#sdk-example-usage)
  * [Authentication](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#authentication)
  * [Available Resources and Operations](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#available-resources-and-operations)
  * [File uploads](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#file-uploads)
  * [Retries](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#retries)
  * [Error Handling](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#error-handling)
  * [Server Selection](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#server-selection)
  * [Custom HTTP Client](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#custom-http-client)
  * [Resource Management](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#resource-management)
  * [Debugging](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#debugging)
* [Development](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#development)
  * [Maturity](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#maturity)
  * [Contributions](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/#contributions)

<!-- End Table of Contents [toc] -->

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

> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with *uv*, *pip*, or *poetry* package managers.

### uv

*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

```bash
uv add dominic-clerk-test-sdk
```

### 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 dominic-clerk-test-sdk
```

### 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 dominic-clerk-test-sdk
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from dominic-clerk-test-sdk python
```

It's also possible to write a standalone Python script without needing to set up a whole project like so:

```python
#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "dominic-clerk-test-sdk",
# ]
# ///

from dominic_clerk_test_sdk import DominicClerkTestSDK

sdk = DominicClerkTestSDK(
  # SDK arguments
)

# Rest of script here...
```

Once that is saved to a file, you can run it with `uv run script.py` where
`script.py` can be replaced with the actual file name.
<!-- 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

### Example

```python
# Synchronous Example
from dominic_clerk_test_sdk import DominicClerkTestSDK
import os


with DominicClerkTestSDK(
    bearer_auth=os.getenv("DOMINICCLERKTESTSDK_BEARER_AUTH", ""),
) as dcts_client:

    res = dcts_client.email_addresses.get(email_address_id="<id>")

    # Handle response
    print(res)
```

</br>

The same SDK client can also be used to make asynchronous requests by importing asyncio.

```python
# Asynchronous Example
import asyncio
from dominic_clerk_test_sdk import DominicClerkTestSDK
import os

async def main():

    async with DominicClerkTestSDK(
        bearer_auth=os.getenv("DOMINICCLERKTESTSDK_BEARER_AUTH", ""),
    ) as dcts_client:

        res = await dcts_client.email_addresses.get_async(email_address_id="<id>")

        # Handle response
        print(res)

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name          | Type | Scheme      | Environment Variable              |
| ------------- | ---- | ----------- | --------------------------------- |
| `bearer_auth` | http | HTTP Bearer | `DOMINICCLERKTESTSDK_BEARER_AUTH` |

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


with DominicClerkTestSDK(
    bearer_auth=os.getenv("DOMINICCLERKTESTSDK_BEARER_AUTH", ""),
) as dcts_client:

    dcts_client.miscellaneous.get_public_interstitial()

    # Use the SDK ...

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [actor_tokens](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/actortokens/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/actortokens/README.md#create) - Create actor token
* [revoke](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/actortokens/README.md#revoke) - Revoke actor token

### [allowlist_identifiers](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/allowlistidentifiers/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/allowlistidentifiers/README.md#list) - List all identifiers on the allow-list
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/allowlistidentifiers/README.md#create) - Add identifier to the allow-list
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/allowlistidentifiers/README.md#delete) - Delete identifier from allow-list

### [beta_features](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/betafeatures/README.md)

* [update_instance_settings](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/betafeatures/README.md#update_instance_settings) - Update instance settings
* [~~update_production_instance_domain~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/betafeatures/README.md#update_production_instance_domain) - Update production instance domain :warning: **Deprecated**

### [billing](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md)

* [list_plans](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#list_plans) - List all billing plans
* [list_subscription_items](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#list_subscription_items) - List all subscription items
* [cancel_subscription_item](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#cancel_subscription_item) - Cancel a subscription item
* [extend_subscription_item_free_trial](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#extend_subscription_item_free_trial) - Extend free trial for a subscription item
* [list_statements](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#list_statements) - List all billing statements
* [get_statement](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#get_statement) - Retrieve a billing statement
* [get_statement_payment_attempts](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/billing/README.md#get_statement_payment_attempts) - List payment attempts for a billing statement

### [blocklist_identifiers](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/blocklistidentifierssdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/blocklistidentifierssdk/README.md#list) - List all identifiers on the block-list
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/blocklistidentifierssdk/README.md#create) - Add identifier to the block-list
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/blocklistidentifierssdk/README.md#delete) - Delete identifier from block-list

### [clients](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/clients/README.md)

* [~~list~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/clients/README.md#list) - List all clients :warning: **Deprecated**
* [verify](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/clients/README.md#verify) - Verify a client
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/clients/README.md#get) - Get a client

### [domains](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/domainssdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/domainssdk/README.md#list) - List all instance domains
* [add](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/domainssdk/README.md#add) - Add a domain
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/domainssdk/README.md#delete) - Delete a satellite domain
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/domainssdk/README.md#update) - Update a domain

### [email_addresses](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailaddresses/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailaddresses/README.md#create) - Create an email address
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailaddresses/README.md#get) - Retrieve an email address
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailaddresses/README.md#delete) - Delete an email address
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailaddresses/README.md#update) - Update an email address

### [~~email_and_sms_templates~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailandsmstemplates/README.md)

* [~~upsert~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailandsmstemplates/README.md#upsert) - Update a template for a given type and slug :warning: **Deprecated**

### [~~email_sms_templates~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailsmstemplates/README.md)

* [~~list~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailsmstemplates/README.md#list) - List all templates :warning: **Deprecated**
* [~~get~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailsmstemplates/README.md#get) - Retrieve a template :warning: **Deprecated**
* [~~revert~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailsmstemplates/README.md#revert) - Revert a template :warning: **Deprecated**
* [~~toggle_template_delivery~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/emailsmstemplates/README.md#toggle_template_delivery) - Toggle the delivery by Clerk for a template of a given type and slug :warning: **Deprecated**

### [instance_settings](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md)

* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md#get) - Fetch the current instance
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md#update) - Update instance settings
* [update_restrictions](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md#update_restrictions) - Update instance restrictions
* [change_domain](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md#change_domain) - Update production instance domain
* [update_organization_settings](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/instancesettingssdk/README.md#update_organization_settings) - Update instance organization settings

### [invitations](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/invitations/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/invitations/README.md#create) - Create an invitation
* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/invitations/README.md#list) - List all invitations
* [bulk_create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/invitations/README.md#bulk_create) - Create multiple invitations
* [revoke](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/invitations/README.md#revoke) - Revokes an invitation

### [jwks](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwkssdk/README.md)

* [get_jwks](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwkssdk/README.md#get_jwks) - Retrieve the JSON Web Key Set of the instance

### [jwt_templates](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md#list) - List all templates
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md#create) - Create a JWT template
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md#get) - Retrieve a template
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md#update) - Update a JWT template
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/jwttemplates/README.md#delete) - Delete a Template

### [m2m](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/m2m/README.md)

* [create_token](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/m2m/README.md#create_token) - Create a M2M Token
* [list_tokens](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/m2m/README.md#list_tokens) - Get M2M Tokens
* [revoke_token](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/m2m/README.md#revoke_token) - Revoke a M2M Token
* [verify_token](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/m2m/README.md#verify_token) - Verify a M2M Token

### [machines](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#list) - Get a list of machines for an instance
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#create) - Create a machine
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#get) - Retrieve a machine
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#update) - Update a machine
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#delete) - Delete a machine
* [get_secret_key](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#get_secret_key) - Retrieve a machine secret key
* [rotate_secret_key](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#rotate_secret_key) - Rotate a machine's secret key
* [create_scope](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#create_scope) - Create a machine scope
* [delete_scope](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/machines/README.md#delete_scope) - Delete a machine scope

### [miscellaneous](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/miscellaneous/README.md)

* [get_public_interstitial](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/miscellaneous/README.md#get_public_interstitial) - Returns the markup for the interstitial page

### [oauth_access_tokens](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthaccesstokens/README.md)

* [verify](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthaccesstokens/README.md#verify) - Verify an OAuth Access Token

### [oauth_applications](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#list) - Get a list of OAuth applications for an instance
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#create) - Create an OAuth application
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#get) - Retrieve an OAuth application by ID
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#update) - Update an OAuth application
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#delete) - Delete an OAuth application
* [rotate_secret](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/oauthapplicationssdk/README.md#rotate_secret) - Rotate the client secret of the given OAuth application

### [organization_domains](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md#create) - Create a new organization domain.
* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md#list) - Get a list of all domains of an organization.
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md#update) - Update an organization domain.
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md#delete) - Remove a domain from an organization.
* [list_all](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationdomainssdk/README.md#list_all) - List all organization domains

### [organization_invitations](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md)

* [get_all](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#get_all) - Get a list of organization invitations for the current instance
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#create) - Create and send an organization invitation
* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#list) - Get a list of organization invitations
* [bulk_create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#bulk_create) - Bulk create and send organization invitations
* [~~list_pending~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#list_pending) - Get a list of pending organization invitations :warning: **Deprecated**
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#get) - Retrieve an organization invitation by ID
* [revoke](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationinvitationssdk/README.md#revoke) - Revoke a pending organization invitation

### [organization_memberships](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md#create) - Create a new organization membership
* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md#list) - Get a list of all members of an organization
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md#update) - Update an organization membership
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md#delete) - Remove a member from an organization
* [update_metadata](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationmembershipssdk/README.md#update_metadata) - Merge and update organization membership metadata

### [organization_permissions](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md#list) - Get a list of all organization permissions
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md#create) - Create a new organization permission
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md#get) - Get an organization permission
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md#update) - Update an organization permission
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationpermissions/README.md#delete) - Delete an organization permission

### [organization_roles](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#list) - Get a list of organization roles
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#create) - Create an organization role
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#get) - Retrieve an organization role
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#update) - Update an organization role
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#delete) - Delete an organization role
* [assign_permission](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#assign_permission) - Assign a permission to an organization role
* [remove_permission](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationroles/README.md#remove_permission) - Remove a permission from an organization role

### [organizations](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#list) - Get a list of organizations for an instance
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#create) - Create an organization
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#get) - Retrieve an organization by ID or slug
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#update) - Update an organization
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#delete) - Delete an organization
* [merge_metadata](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#merge_metadata) - Merge and update metadata for an organization
* [upload_logo](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#upload_logo) - Upload a logo for the organization
* [delete_logo](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#delete_logo) - Delete the organization's logo.
* [get_billing_subscription](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/organizationssdk/README.md#get_billing_subscription) - Retrieve an organization's billing subscription

### [phone_numbers](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/phonenumbers/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/phonenumbers/README.md#create) - Create a phone number
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/phonenumbers/README.md#get) - Retrieve a phone number
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/phonenumbers/README.md#delete) - Delete a phone number
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/phonenumbers/README.md#update) - Update a phone number

### [proxy_checks](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/proxychecks/README.md)

* [verify](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/proxychecks/README.md#verify) - Verify the proxy configuration for your domain

### [redirect_urls](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/redirecturls/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/redirecturls/README.md#list) - List all redirect URLs
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/redirecturls/README.md#create) - Create a redirect URL
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/redirecturls/README.md#get) - Retrieve a redirect URL
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/redirecturls/README.md#delete) - Delete a redirect URL

### [saml_connections](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md#list) - Get a list of SAML Connections for an instance
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md#create) - Create a SAML Connection
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md#get) - Retrieve a SAML Connection by ID
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md#update) - Update a SAML Connection
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/samlconnectionssdk/README.md#delete) - Delete a SAML Connection

### [sessions](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#list) - List all sessions
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#create) - Create a new active session
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#get) - Retrieve a session
* [refresh](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#refresh) - Refresh a session
* [revoke](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#revoke) - Revoke a session
* [create_token](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#create_token) - Create a session token
* [create_token_from_template](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/sessions/README.md#create_token_from_template) - Create a session token from a JWT template

### [sign_in_tokens](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signintokens/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signintokens/README.md#create) - Create sign-in token
* [revoke](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signintokens/README.md#revoke) - Revoke the given sign-in token

### [sign_ups](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signups/README.md)

* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signups/README.md#get) - Retrieve a sign-up by ID
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/signups/README.md#update) - Update a sign-up

### [~~templates~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/templates/README.md)

* [~~preview~~](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/templates/README.md#preview) - Preview changes to a template :warning: **Deprecated**

### [testing_tokens](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/testingtokens/README.md)

* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/testingtokens/README.md#create) - Retrieve a new testing token

### [users](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#list) - List all users
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#create) - Create a new user
* [count](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#count) - Count users
* [get](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get) - Retrieve a user
* [update](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#update) - Update a user
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete) - Delete a user
* [ban](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#ban) - Ban a user
* [unban](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#unban) - Unban a user
* [bulk_ban](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#bulk_ban) - Ban multiple users
* [bulk_unban](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#bulk_unban) - Unban multiple users
* [lock](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#lock) - Lock a user
* [unlock](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#unlock) - Unlock a user
* [set_profile_image](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#set_profile_image) - Set user profile image
* [delete_profile_image](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_profile_image) - Delete user profile image
* [update_metadata](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#update_metadata) - Merge and update a user's metadata
* [get_billing_subscription](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get_billing_subscription) - Retrieve a user's billing subscription
* [get_o_auth_access_token](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get_o_auth_access_token) - Retrieve the OAuth access token of a user
* [get_organization_memberships](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get_organization_memberships) - Retrieve all memberships for a user
* [get_organization_invitations](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get_organization_invitations) - Retrieve all invitations for a user
* [verify_password](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#verify_password) - Verify the password of a user
* [verify_totp](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#verify_totp) - Verify a TOTP or backup code for a user
* [disable_mfa](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#disable_mfa) - Disable a user's MFA methods
* [delete_backup_codes](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_backup_codes) - Disable all user's Backup codes
* [delete_passkey](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_passkey) - Delete a user passkey
* [delete_web3_wallet](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_web3_wallet) - Delete a user web3 wallet
* [delete_totp](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_totp) - Delete all the user's TOTPs
* [delete_external_account](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#delete_external_account) - Delete External Account
* [get_instance_organization_memberships](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/users/README.md#get_instance_organization_memberships) - Get a list of all organization memberships within an instance.

### [waitlist_entries](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md)

* [list](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md#list) - List all waitlist entries
* [create](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md#create) - Create a waitlist entry
* [delete](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md#delete) - Delete a pending waitlist entry
* [invite](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md#invite) - Invite a waitlist entry
* [reject](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/waitlistentriessdk/README.md#reject) - Reject a waitlist entry

### [webhooks](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/webhooks/README.md)

* [create_svix_app](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/webhooks/README.md#create_svix_app) - Create a Svix app
* [delete_svix_app](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/webhooks/README.md#delete_svix_app) - Delete a Svix app
* [generate_svix_auth_url](https://github.com/dominic-clerk/speakeasy-python-test/blob/master/docs/sdks/webhooks/README.md#generate_svix_auth_url) - Create a Svix Dashboard URL

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>

```python
from dominic_clerk_test_sdk import DominicClerkTestSDK
import os


with DominicClerkTestSDK(
    bearer_auth=os.getenv("DOMINICCLERKTESTSDK_BEARER_AUTH", ""),
) as dcts_client:

    res = dcts_cli