Metadata-Version: 2.4
Name: bluejay-sdk
Version: 0.3.1
Summary: Python Client SDK Generated by Speakeasy.
Author: Speakeasy
License: Apache-2.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: httpcore>=1.0.9
Requires-Dist: httpx>=0.28.1
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.0
Requires-Dist: opentelemetry-sdk>=1.0
Requires-Dist: pydantic>=2.11.2
Provides-Extra: livekit
Requires-Dist: livekit-agents>=1.0; extra == "livekit"

# bluejay-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage *bluejay-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=bluejay-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/bluejay/bluejay). Delete this section before > publishing to a package manager.

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

Bluejay API: Bluejay API
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [bluejay-sdk](#bluejay-sdk)
  * [SDK Installation](#sdk-installation)
  * [IDE Support](#ide-support)
  * [SDK Example Usage](#sdk-example-usage)
  * [Authentication](#authentication)
  * [Available Resources and Operations](#available-resources-and-operations)
  * [Retries](#retries)
  * [Error Handling](#error-handling)
  * [Server Selection](#server-selection)
  * [Custom HTTP Client](#custom-http-client)
  * [Resource Management](#resource-management)
  * [Debugging](#debugging)
* [Development](#development)
  * [Maturity](#maturity)
  * [Contributions](#contributions)

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

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

> [!TIP]
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).


> [!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 git+<UNSET>.git
```

### 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 git+<UNSET>.git
```

### 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 git+<UNSET>.git
```

### 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 bluejay-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.10"
# dependencies = [
#     "bluejay-sdk",
# ]
# ///

from bluejay import Bluejay

sdk = Bluejay(
  # 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 bluejay import Bluejay
import os


with Bluejay(
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:

    res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
        "frequency": "cron",
        "expression": "<value>",
    })

    # 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 bluejay import Bluejay
import os

async def main():

    async with Bluejay(
        api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
    ) as b_client:

        res = await b_client.schedules.create_schedule_async(simulation_id="<id>", schedule={
            "frequency": "cron",
            "expression": "<value>",
        })

        # 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   |
| -------------- | ------ | ------- | ---------------------- |
| `api_key_auth` | apiKey | API key | `BLUEJAY_API_KEY_AUTH` |

To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
```python
from bluejay import Bluejay
import os


with Bluejay(
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:

    res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
        "frequency": "cron",
        "expression": "<value>",
    })

    # Handle response
    print(res)

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

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

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

### [AgentWorkflow](docs/sdks/agentworkflow/README.md)

* [get_workflow_summary](docs/sdks/agentworkflow/README.md#get_workflow_summary) - Get Workflow Summary
* [patch_workflow_node](docs/sdks/agentworkflow/README.md#patch_workflow_node) - Patch Workflow Node
* [delete_workflow_node](docs/sdks/agentworkflow/README.md#delete_workflow_node) - Delete Workflow Node
* [add_workflow_node](docs/sdks/agentworkflow/README.md#add_workflow_node) - Add Workflow Node
* [add_workflow_edge](docs/sdks/agentworkflow/README.md#add_workflow_edge) - Add Workflow Edge
* [delete_workflow_edge](docs/sdks/agentworkflow/README.md#delete_workflow_edge) - Delete Workflow Edge

### [Agents](docs/sdks/agents/README.md)

* [add_agent](docs/sdks/agents/README.md#add_agent) - Add Agent
* [update_agent](docs/sdks/agents/README.md#update_agent) - Update Agent
* [update_agent_by_external_id](docs/sdks/agents/README.md#update_agent_by_external_id) - Update Agent By External Id
* [get_agent](docs/sdks/agents/README.md#get_agent) - Get Agent
* [get_agent_by_external_id](docs/sdks/agents/README.md#get_agent_by_external_id) - Get Agent By External Id
* [get_all_agents](docs/sdks/agents/README.md#get_all_agents) - Get All Agents
* [delete_agent](docs/sdks/agents/README.md#delete_agent) - Delete Agent

### [CallLogs](docs/sdks/calllogs/README.md)

* [retrieve_call_logs](docs/sdks/calllogs/README.md#retrieve_call_logs) - Retrieve Call Logs
* [retrieve_call_log](docs/sdks/calllogs/README.md#retrieve_call_log) - Retrieve Call Log
* [delete_call_log](docs/sdks/calllogs/README.md#delete_call_log) - Delete Call Log
* [update_log](docs/sdks/calllogs/README.md#update_log) - Update Log

### [Communities](docs/sdks/communities/README.md)

* [create_community](docs/sdks/communities/README.md#create_community) - Create Community
* [get_community](docs/sdks/communities/README.md#get_community) - Get Community
* [delete_community](docs/sdks/communities/README.md#delete_community) - Delete Community
* [get_communities](docs/sdks/communities/README.md#get_communities) - Get Communities
* [update_community](docs/sdks/communities/README.md#update_community) - Update Community
* [add_digital_humans_to_community](docs/sdks/communities/README.md#add_digital_humans_to_community) - Add Digital Humans To Community
* [remove_digital_humans_from_community](docs/sdks/communities/README.md#remove_digital_humans_from_community) - Remove Digital Humans From Community

### [Conversations](docs/sdks/conversations/README.md)

* [end_conversations](docs/sdks/conversations/README.md#end_conversations) - End Conversations

### [CustomMetrics](docs/sdks/custommetrics/README.md)

* [create_custom_metric](docs/sdks/custommetrics/README.md#create_custom_metric) - Create Custom Metric
* [create_custom_metrics](docs/sdks/custommetrics/README.md#create_custom_metrics) - Create Custom Metrics
* [get_custom_metric](docs/sdks/custommetrics/README.md#get_custom_metric) - Get Custom Metric
* [delete_custom_metric](docs/sdks/custommetrics/README.md#delete_custom_metric) - Delete Custom Metric
* [get_custom_metrics](docs/sdks/custommetrics/README.md#get_custom_metrics) - Get Custom Metrics
* [~~get_custom_metrics_by_agent~~](docs/sdks/custommetrics/README.md#get_custom_metrics_by_agent) - Get Custom Metrics By Agent :warning: **Deprecated**
* [update_custom_metric](docs/sdks/custommetrics/README.md#update_custom_metric) - Update Custom Metric
* [bulk_update_custom_metrics](docs/sdks/custommetrics/README.md#bulk_update_custom_metrics) - Bulk Update Custom Metrics
* [bulk_delete_custom_metrics](docs/sdks/custommetrics/README.md#bulk_delete_custom_metrics) - Bulk Delete Custom Metrics
* [generate_custom_metrics](docs/sdks/custommetrics/README.md#generate_custom_metrics) - Generate Custom Metrics

### [DigitalHumans](docs/sdks/digitalhumans/README.md)

* [create_digital_human](docs/sdks/digitalhumans/README.md#create_digital_human) - Create Digital Human
* [bulk_create_digital_humans](docs/sdks/digitalhumans/README.md#bulk_create_digital_humans) - Bulk Create Digital Humans
* [get_digital_human](docs/sdks/digitalhumans/README.md#get_digital_human) - Get Digital Human
* [delete_digital_human](docs/sdks/digitalhumans/README.md#delete_digital_human) - Delete Digital Human
* [get_digital_human_by_test_name](docs/sdks/digitalhumans/README.md#get_digital_human_by_test_name) - Get Digital Human By Test Name
* [get_digital_humans_by_simulation](docs/sdks/digitalhumans/README.md#get_digital_humans_by_simulation) - Get Digital Humans By Simulation
* [get_all_digital_humans](docs/sdks/digitalhumans/README.md#get_all_digital_humans) - Get All Digital Humans
* [update_digital_human](docs/sdks/digitalhumans/README.md#update_digital_human) - Update Digital Human
* [bulk_delete_digital_humans](docs/sdks/digitalhumans/README.md#bulk_delete_digital_humans) - Bulk Delete Digital Humans
* [list_custom_background_noises](docs/sdks/digitalhumans/README.md#list_custom_background_noises) - List Custom Background Noises
* [create_custom_background_noise](docs/sdks/digitalhumans/README.md#create_custom_background_noise) - Create Custom Background Noise
* [update_custom_background_noise](docs/sdks/digitalhumans/README.md#update_custom_background_noise) - Update Custom Background Noise
* [delete_custom_background_noise](docs/sdks/digitalhumans/README.md#delete_custom_background_noise) - Delete Custom Background Noise
* [generate_objectives_endpoint](docs/sdks/digitalhumans/README.md#generate_objectives_endpoint) - Generate Objectives Endpoint
* [generate_intent_summary_endpoint](docs/sdks/digitalhumans/README.md#generate_intent_summary_endpoint) - Generate Intent Summary Endpoint
* [generate_prompt_summary_endpoint](docs/sdks/digitalhumans/README.md#generate_prompt_summary_endpoint) - Generate Prompt Summary Endpoint
* [generate_formatted_transcript_endpoint](docs/sdks/digitalhumans/README.md#generate_formatted_transcript_endpoint) - Generate Formatted Transcript Endpoint
* [generate_digital_humans](docs/sdks/digitalhumans/README.md#generate_digital_humans) - Generate Digital Humans

### [ElevenLabs](docs/sdks/elevenlabs/README.md)

* [list_elevenlabs_agents](docs/sdks/elevenlabs/README.md#list_elevenlabs_agents) - List Elevenlabs Agents
* [list_elevenlabs_branches](docs/sdks/elevenlabs/README.md#list_elevenlabs_branches) - List Elevenlabs Branches

### [Evaluate](docs/sdks/evaluate/README.md)

* [evaluate](docs/sdks/evaluate/README.md#evaluate) - Evaluate

### [Folders](docs/sdks/folders/README.md)

* [create_folder](docs/sdks/folders/README.md#create_folder) - Create Folder
* [get_all_folders](docs/sdks/folders/README.md#get_all_folders) - Get All Folders
* [get_folder](docs/sdks/folders/README.md#get_folder) - Get Folder
* [delete_folder](docs/sdks/folders/README.md#delete_folder) - Delete Folder
* [move_agent_to_folder](docs/sdks/folders/README.md#move_agent_to_folder) - Move Agent To Folder
* [update_folder](docs/sdks/folders/README.md#update_folder) - Update Folder
* [get_agents_by_folder](docs/sdks/folders/README.md#get_agents_by_folder) - Get Agents By Folder

### [HTTPTextAgent](docs/sdks/httptextagent/README.md)

* [queue_http_simulation_run](docs/sdks/httptextagent/README.md#queue_http_simulation_run) - Queue Http Simulation Run
* [send_http_text_message](docs/sdks/httptextagent/README.md#send_http_text_message) - Send Http Text Message

### [PhoneNumbers](docs/sdks/phonenumbers/README.md)

* [get_phone_numbers](docs/sdks/phonenumbers/README.md#get_phone_numbers) - Get Phone Numbers
* [add_phone_number](docs/sdks/phonenumbers/README.md#add_phone_number) - Add Phone Number
* [release_phone_number](docs/sdks/phonenumbers/README.md#release_phone_number) - Release Phone Number

### [RetrieveSimulationResults](docs/sdks/retrievesimulationresults/README.md)

* [retrieve_simulation_results](docs/sdks/retrievesimulationresults/README.md#retrieve_simulation_results) - Retrieve Simulation Results
* [retrieve_simulation_result](docs/sdks/retrievesimulationresults/README.md#retrieve_simulation_result) - Retrieve Simulation Result

### [ScenarioBuilder](docs/sdks/scenariobuilder/README.md)

* [create_workflow_v2](docs/sdks/scenariobuilder/README.md#create_workflow_v2) - Create Workflow V2
* [list_workflows_v2](docs/sdks/scenariobuilder/README.md#list_workflows_v2) - List Workflows V2
* [validate_workflow_definition](docs/sdks/scenariobuilder/README.md#validate_workflow_definition) - Validate Workflow Definition
* [duplicate_workflow_v2](docs/sdks/scenariobuilder/README.md#duplicate_workflow_v2) - Duplicate Workflow V2
* [get_workflow_v2](docs/sdks/scenariobuilder/README.md#get_workflow_v2) - Get Workflow V2
* [update_workflow_v2](docs/sdks/scenariobuilder/README.md#update_workflow_v2) - Update Workflow V2
* [delete_workflow_v2](docs/sdks/scenariobuilder/README.md#delete_workflow_v2) - Delete Workflow V2

### [Schedules](docs/sdks/schedules/README.md)

* [create_schedule](docs/sdks/schedules/README.md#create_schedule) - Create Schedule
* [update_schedule](docs/sdks/schedules/README.md#update_schedule) - Update Schedule
* [delete_schedule](docs/sdks/schedules/README.md#delete_schedule) - Delete Schedule
* [get_schedule](docs/sdks/schedules/README.md#get_schedule) - Get Schedule
* [list_schedules](docs/sdks/schedules/README.md#list_schedules) - List Schedules

### [Simulations](docs/sdks/simulations/README.md)

* [delete_simulation](docs/sdks/simulations/README.md#delete_simulation) - Delete Simulation
* [update_simulation](docs/sdks/simulations/README.md#update_simulation) - Update Simulation
* [get_simulation](docs/sdks/simulations/README.md#get_simulation) - Get Simulation
* [create_simulation](docs/sdks/simulations/README.md#create_simulation) - Create Simulation
* [get_all_simulations](docs/sdks/simulations/README.md#get_all_simulations) - Get All Simulations
* [get_simulations_by_agent](docs/sdks/simulations/README.md#get_simulations_by_agent) - Get Simulations By Agent
* [get_simulation_runs](docs/sdks/simulations/README.md#get_simulation_runs) - Get Simulation Runs
* [queue_simulation_run](docs/sdks/simulations/README.md#queue_simulation_run) - Queue Simulation Run Endpoint

### [TextSimulations](docs/sdks/textsimulations/README.md)

* [queue_sms_simulation_run](docs/sdks/textsimulations/README.md#queue_sms_simulation_run) - Queue Sms Simulation Run

### [Traces](docs/sdks/traces/README.md)

* [get_trace](docs/sdks/traces/README.md#get_trace) - Get Trace
* [get_span](docs/sdks/traces/README.md#get_span) - Get Span
* [get_all_traces](docs/sdks/traces/README.md#get_all_traces) - Get All Traces

### [Translation](docs/sdks/translation/README.md)

* [translate_transcript](docs/sdks/translation/README.md#translate_transcript) - Translate a call transcript

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

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

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


with Bluejay(
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:

    res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
        "frequency": "cron",
        "expression": "<value>",
    },
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

```

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 bluejay import Bluejay
from bluejay.utils import BackoffStrategy, RetryConfig
import os


with Bluejay(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:

    res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
        "frequency": "cron",
        "expression": "<value>",
    })

    # Handle response
    print(res)

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

[`BluejayError`](./src/bluejay/errors/bluejayerror.py) is the base class for all HTTP error responses. It has the following properties:

| Property           | Type             | Description                                                                             |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------- |
| `err.message`      | `str`            | Error message                                                                           |
| `err.status_code`  | `int`            | HTTP response status code eg `404`                                                      |
| `err.headers`      | `httpx.Headers`  | HTTP response headers                                                                   |
| `err.body`         | `str`            | HTTP body. Can be empty string if no body is returned.                                  |
| `err.raw_response` | `httpx.Response` | Raw HTTP response                                                                       |
| `err.data`         |                  | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |

### Example
```python
from bluejay import Bluejay, errors
import os


with Bluejay(
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:
    res = None
    try:

        res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
            "frequency": "cron",
            "expression": "<value>",
        })

        # Handle response
        print(res)


    except errors.BluejayError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.HTTPValidationError):
            print(e.data.detail)  # Optional[List[models.ValidationError]]
```

### Error Classes
**Primary errors:**
* [`BluejayError`](./src/bluejay/errors/bluejayerror.py): The base class for HTTP error responses.
  * [`HTTPValidationError`](./src/bluejay/errors/httpvalidationerror.py): Validation Error. Status code `422`.

<details><summary>Less common errors (5)</summary>

<br />

**Network errors:**
* [`httpx.RequestError`](https://www.python-httpx.org/exceptions/#httpx.RequestError): Base class for request errors.
    * [`httpx.ConnectError`](https://www.python-httpx.org/exceptions/#httpx.ConnectError): HTTP client was unable to make a request to a server.
    * [`httpx.TimeoutException`](https://www.python-httpx.org/exceptions/#httpx.TimeoutException): HTTP request timed out.


**Inherit from [`BluejayError`](./src/bluejay/errors/bluejayerror.py)**:
* [`ResponseValidationError`](./src/bluejay/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.

</details>
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from bluejay import Bluejay
import os


with Bluejay(
    server_url="https://api.getbluejay.ai",
    api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
) as b_client:

    res = b_client.schedules.create_schedule(simulation_id="<id>", schedule={
        "frequency": "cron",
        "expression": "<value>",
    })

    # Handle response
    print(res)

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

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

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Bluejay(client=http_client)
```

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

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Bluejay(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Resource Management [resource-management] -->
## Resource Management

The `Bluejay` class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a [context manager][context-manager] and reuse it across the application.

[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers

```python
from bluejay import Bluejay
import os
def main():

    with Bluejay(
        api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
    ) as b_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Bluejay(
        api_key_auth=os.getenv("BLUEJAY_API_KEY_AUTH", ""),
    ) as b_client:
        # Rest of application here...
```
<!-- End Resource Management [resource-management] -->

<!-- Start Debugging [debug] -->
## Debugging

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 bluejay import Bluejay
import logging

logging.basicConfig(level=logging.DEBUG)
s = Bluejay(debug_logger=logging.getLogger("bluejay"))
```

You can also enable a default debug logger by setting an environment variable `BLUEJAY_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# Development

## Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 

### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=bluejay-sdk&utm_campaign=python)
