versions.yml

# yaml-language-server: $schema=../../../fern-versions-yml.schema.json
# For unreleased changes, use unreleased.yml
- version: 5.3.0
  changelogEntry:
    - summary: |
        Add aiohttp auto-detection for async clients. When the `httpx-aiohttp` package is installed,
        the async client automatically uses `HttpxAiohttpClient` instead of the default `httpx.AsyncClient`.
        Adds optional `aiohttp` and `httpx-aiohttp` dependencies exposed via a `[aiohttp]` pip extra,
        along with `DefaultAioHttpClient` and `DefaultAsyncHttpxClient` convenience classes in `_default_clients.py`.
      type: feat
  createdAt: "2026-04-02"
  irVersion: 65

- version: 5.2.1
  changelogEntry:
    - summary: |
        Fix an issue where a user-provided `httpx_client` was ignored when instantiating the OAuth token
        provider's internal HTTP client, causing custom transports, SSL certificates, and proxies to not
        apply to token-refresh requests.
      type: fix
  createdAt: "2026-03-31"
  irVersion: 65

- version: 5.2.0
  changelogEntry:
    - summary: |
        Add `maxRetries` custom config option. When set in `generators.yml`,
        the generated SDK uses the specified value as the default retry count instead of
        the hardcoded default of 2. Set to 0 to disable retries by default, which is
        useful for APIs with non-idempotent endpoints. SDK users can still override this
        per-request via `request_options`.
      type: feat
  createdAt: "2026-03-31"
  irVersion: 65

- version: 5.1.3
  changelogEntry:
    - summary: |
        Add transport-level connection error retries to the HTTP client. The retry logic now
        catches `httpx.ConnectError` and `httpx.RemoteProtocolError` (e.g., "Remote end closed
        connection without response") and retries with exponential backoff, matching the existing
        status-code-based retry behavior. Also fixes the existing status-code retry path to
        forward the `data` and `force_multipart` parameters on retry.
      type: fix
  createdAt: "2026-03-27"
  irVersion: 65

- version: 5.1.2
  changelogEntry:
    - summary: |
        Pretty-print generated wiremock-mappings.json with 2-space indentation
        to reduce diff sizes on subsequent SDK generations.
      type: chore
  createdAt: "2026-03-27"
  irVersion: 65

- version: 5.1.1
  changelogEntry:
    - summary: |
        Ensure `async_token` is accepted and forwarded in generated async client constructors
        for bearer token auth. Previously, `AsyncClientWrapper` supported `async_token` but
        the top-level async client only exposed it for OAuth client credentials flows, causing
        sync token callables to block the event loop in async contexts.
      type: fix
  createdAt: "2026-03-27"
  irVersion: 65

- version: 5.1.0
  changelogEntry:
    - summary: |
        Add Environments section to generated README showing how to select
        different environments (production/sandbox) when initializing the client.
      type: feat
  createdAt: "2026-03-27"
  irVersion: 65

- version: 5.0.8
  changelogEntry:
    - summary: |
        Eliminate Pydantic v2 deprecation warnings in `UniversalBaseModel`. Under Pydantic v2,
        the class-based `Config` pattern with `smart_union` and `allow_population_by_field_name`
        emits deprecation warnings. `UniversalBaseModel` now uses `model_config: ConfigDict` with
        `populate_by_name=True`, `validate_by_name=True`, and `validate_by_alias=True` (for v2.11+
        support) for v2, and a custom `@model_serializer` for datetime serialization instead of
        the deprecated `json_encoders`. Pydantic v1 continues to use the original class-based Config.
      type: fix
  createdAt: "2026-03-26"
  irVersion: 65

- version: 5.0.7
  changelogEntry:
    - summary: |
        Thread endpoint ID through dynamic snippet generator to differentiate
        generated snippets by endpoint.
      type: fix
  createdAt: "2026-03-25"
  irVersion: 65

- version: 5.0.6
  changelogEntry:
    - summary: |
        Fix `construct_type` to resolve `ForwardRef` annotations in nested model fields
        and use strict Literal discriminant matching for undiscriminated unions.

        Under Pydantic v2 with `from __future__ import annotations`, field annotations
        like `List["Block"]` remain as `list[ForwardRef('Block')]` even after
        `model_rebuild`. `construct_type` now resolves these ForwardRefs via the host
        model's module, ensuring nested data is recursively constructed into proper model
        instances instead of staying as raw dicts.

        Additionally, undiscriminated union resolution now requires Literal-typed
        discriminant fields to be present AND matching before accepting a candidate type.
        This prevents models with all-optional fields (e.g. `FigureDetails`) from greedily
        matching inputs that belong to a different variant or to a plain-dict fallback.
      type: fix
  createdAt: "2026-03-20"
  irVersion: 65

- version: 5.0.5
  changelogEntry:
    - summary: |
        Add enum handling to `construct_type()` to prevent Pydantic serialization warnings
        when enum values pass through untyped model construction paths.
      type: fix
  createdAt: "2026-03-20"
  irVersion: 65

- version: 5.0.4
  changelogEntry:
    - summary: |
        Fix optional complex-type parameters in multipart file upload requests being
        sent as `"null"` instead of being omitted. When an optional body property
        (e.g., `Optional[List[str]]`, `Optional[Any]`) defaults to `OMIT`,
        `json.dumps(jsonable_encoder(OMIT))` was evaluating to the string `"null"`,
        destroying the OMIT sentinel before `remove_omit_from_dict` could strip it.
        Optional non-primitive body properties now emit a ternary guard
        (`json.dumps(...) if prop is not OMIT else OMIT`) so that the OMIT sentinel
        is preserved and correctly removed from the request data.
      type: fix
  createdAt: "2026-03-18"
  irVersion: 65

- version: 5.0.3
  changelogEntry:
    - summary: |
        Skip Docker container management in generated `tests/conftest.py` when the
        `WIREMOCK_URL` environment variable is already set. This allows wire tests to
        run in CI/CD pipelines that provide an external WireMock sidecar container
        without requiring Docker-in-Docker support.
      type: fix
  createdAt: "2026-03-17"
  irVersion: 65

- version: 5.0.2
  changelogEntry:
    - summary: |
        Add docstring emission for unknown/any type alias definitions. When a type alias
        resolves to `typing.Any` and has a description in the API definition, the generated
        Python code now includes the docstring below the type alias declaration.
      type: fix
  createdAt: "2026-03-17"
  irVersion: 65

- version: 5.0.1
  changelogEntry:
    - summary: |
        Upgrade `pytest-asyncio` dev dependency from `^0.23.5` to `^1.0.0` in generated
        `pyproject.toml`. This eliminates deprecation warnings about `asyncio.iscoroutinefunction`,
        `asyncio.get_event_loop_policy`, and `asyncio.set_event_loop_policy` when running tests
        on Python 3.14+.
      type: chore
  createdAt: "2026-03-16"
  irVersion: 65

- version: 5.0.0
  changelogEntry:
    - summary: |
        Raise the default minimum Python version from `^3.8` to `^3.10` in generated
        `pyproject.toml`. This allows the dependency resolver to pick Pydantic 2.11+ and
        pydantic-core 2.33+, which ship pre-built wheels for Python 3.14, fixing
        installation failures on Python 3.14.
      type: feat
  createdAt: "2026-03-16"
  irVersion: 65

- version: 4.64.1
  changelogEntry:
    - summary: |
        Wrap `python-version` in quotes in generated GitHub CI workflow so versions like
        `^3.10` are not misinterpreted as `3.1` by the YAML parser.
      type: fix
  createdAt: "2026-03-16"
  irVersion: 65

- version: 4.64.0
  changelogEntry:
    - summary: |
        Add `omit_fern_headers` configuration option. When enabled, Fern platform headers
        (X-Fern-Language, X-Fern-SDK-Name, X-Fern-SDK-Version, X-Fern-Runtime,
        X-Fern-Platform, User-Agent) are omitted from generated SDK requests.
      type: feat
  createdAt: "2026-03-12"
  irVersion: 65

- version: 4.63.6
  changelogEntry:
    - summary: |
        Fix wire test generation for types with required fields missing from examples.
        When an OpenAPI example omits required fields on a nested object type, the generated
        test code now synthesizes reasonable default values (e.g., `""` for strings, `1` for
        integers, `[]` for lists) instead of emitting empty constructors like `ClassName()`
        that cause Pydantic `ValidationError` at runtime.
      type: fix
  createdAt: "2026-03-12"
  irVersion: 65

- version: 4.63.5
  changelogEntry:
    - summary: |
        Fix Python 3.14 compatibility by fully eliminating all `pydantic.v1` imports from the
        Pydantic V2 code path. The previous fix (4.55.4) replaced `pydantic.v1.datetime_parse`
        but left other `pydantic.v1` imports (typing utilities, json encoders, fields) that still
        trigger the "Core Pydantic V1 functionality isn't compatible with Python 3.14" warning.
        All `pydantic.v1` usages are now replaced with standard library equivalents
        (`typing.get_args`, `typing.get_origin`, `typing_extensions.Literal`), Pydantic V2 APIs
        (`pydantic.fields.FieldInfo`), and an inlined `encoders_by_type` dictionary.
      type: fix
  createdAt: "2026-03-11"
  irVersion: 65

- version: 4.63.4
  changelogEntry:
    - summary: |
        Add concurrency configuration to generated CI workflow with cancel-in-progress: false
        to prevent stacked runs from being cancelled when a newer run starts.
      type: chore
  createdAt: "2026-03-11"
  irVersion: 65

- version: 4.63.3
  changelogEntry:
    - summary: |
        Make wire test datetime normalization type-aware. String-typed query parameters
        that look like datetimes (e.g., `created_after: str`) are no longer incorrectly
        normalized with `.000` milliseconds. Only `DATE_TIME`-typed parameters are affected
        by the `datetime_milliseconds` config.
      type: fix
  createdAt: "2026-03-11"
  irVersion: 65

- version: 4.63.2
  changelogEntry:
    - summary: |
        Fix wire test datetime format mismatch. When `datetime_milliseconds` is false (default),
        WireMock stubs are now stripped of `.000` milliseconds to match the SDK's default
        `serialize_datetime` output. When true, test verification values include `.000` to match
        millisecond-precision output. Fixes wire test failures for APIs with datetime query parameters.
      type: fix
  createdAt: "2026-03-10"
  irVersion: 65

- version: 4.63.1
  changelogEntry:
    - summary: |
        Fix socket client generation to use keyword arguments when calling `construct_type`.
      type: fix
  createdAt: "2026-03-10"
  irVersion: 65

- version: 4.63.0
  changelogEntry:
    - summary: |
        Add `datetime_milliseconds` custom config option. When set to `true`,
        `serialize_datetime` always includes millisecond precision in ISO 8601 output
        (e.g., `2008-01-02T00:00:00.000Z` instead of `2008-01-02T00:00:00Z`).
        Useful for APIs that require a fixed-width datetime format with fractional seconds.
        Default behavior is unchanged.
      type: feat
  createdAt: "2026-03-10"
  irVersion: 65

- version: 4.62.4
  changelogEntry:
    - summary: |
        Re-throw errors after logging for README.md and reference.md generation failures.
        Documentation generation errors now break the generation flow so they are treated
        as important to fix.
      type: fix
  createdAt: "2026-03-10"
  irVersion: 65

- version: 4.62.3
  changelogEntry:
    - summary: |
        Fix dynamic snippets to include global headers in generated code examples.
        Previously, required global headers (e.g., `X-Organization-ID`) configured via
        `x-fern-global-headers` were missing from dynamic snippet output. Also fixes
        header value lookup to use wire values instead of a non-existent property.
      type: fix
  createdAt: "2026-03-10"
  irVersion: 65
- version: 4.62.2
  changelogEntry:
    - summary: |
        Improve error logging for reference.md generation failures. The generator
        now logs the actual error message and stack trace instead of a generic
        "this is OK" message, making it easier to diagnose generation issues.
      type: chore
  createdAt: "2026-03-09"
  irVersion: 65

- version: 4.62.1
  changelogEntry:
    - summary: |
        SDK clients now catch `pydantic.ValidationError` during response parsing and
        wrap it in `ParsingError` with the response body, headers, status code and cause. Previously,
        validation errors from `parse_obj_as` would bubble up raw, preventing users from
        inspecting the actual API response.
      type: fix
  createdAt: "2026-03-06"
  irVersion: 65

- version: 4.62.0
  changelogEntry:
    - summary: |
        Add `README.md` and `reference.md` generation to the python-v2 SDK generator.
        The v2 generator now produces README documentation with feature snippets
        (installation, usage, timeouts, custom client, exception handling, raw responses,
        websockets, custom sections) and endpoint reference documentation.
      type: feat
    - summary: |
        Format AST output with trailing commas in multiline function calls and
        inline list/dict formatting for improved code readability.
      type: chore
  createdAt: "2026-03-05"
  irVersion: 65

- version: 4.61.5
  changelogEntry:
    - summary: |
        Fix WebSocket client generation to respect `pydantic_config.skip_validation: true`.
        Previously, socket clients always used `parse_obj_as` (full Pydantic validation)
        regardless of the skip_validation flag. They now correctly use `construct_type`
        (no validation) when the flag is enabled, matching the behavior of HTTP clients.
      type: fix
  createdAt: "2026-03-05"
  irVersion: 65

- version: 4.61.4
  changelogEntry:
    - summary: |
        WebSocket clients now gracefully handle unknown message types instead of crashing.
        When the server sends a message type not yet in the SDK's union, the client logs a
        warning and skips the message rather than killing the connection with a validation error.
      type: fix
  createdAt: "2026-03-04"
  irVersion: 65

- version: 4.61.3
  changelogEntry:
    - summary: |
        Standardize WireMock configuration to use `WIREMOCK_URL` environment variable
        (e.g., `http://localhost:8080`) instead of `WIREMOCK_PORT`. The conftest plugin
        now sets `WIREMOCK_URL` after discovering the dynamically assigned port. Falls
        back to `http://localhost:8080` if the variable is not set.
      type: chore
  createdAt: "2026-03-02"
  irVersion: 65

- version: 4.61.2
  changelogEntry:
    - summary: |
        Re-add `@fern-api/generator-cli` to Python SDK Docker image. The CLI was inadvertently
        removed in 4.60.1 when JS-based generators migrated to using the generator-cli JS API
        directly. The Python generator still relies on the CLI binary via subprocess for
        README.md and reference.md generation.
      type: fix
  createdAt: "2026-02-27"
  irVersion: 65

- version: 4.61.1
  changelogEntry:
    - summary: |
        Fix `positional_single_property_constructors` breaking pydantic response deserialization.
        The custom `__init__` now uses `@typing.overload` with a permissive `*args, **kwargs` runtime
        signature, so pydantic can pass alias-keyed data freely during deserialization while still
        allowing positional construction like `Wrapper("value")`.
      type: fix
  createdAt: "2026-02-27"
  irVersion: 65

- version: 4.61.0
  changelogEntry:
    - summary: |
        Add support for `DATE_TIME_RFC_2822` primitive type. Fields with `format: date-time-rfc-2822`
        in OpenAPI specs now generate as `Rfc2822DateTime` (a `datetime.datetime` subclass) that
        parses RFC 2822 date strings (e.g., "Wed, 02 Oct 2002 13:00:00 GMT") using Python's
        `email.utils.parsedate_to_datetime`. Compatible with both Pydantic V1 (`__get_validators__`)
        and V2 (`__get_pydantic_core_schema__`), passing mypy strict type checking.
      type: feat
    - summary: |
        Fix code snippet generation for RFC 2822 datetime fields to use
        `email.utils.parsedate_to_datetime()` with RFC 2822 format strings instead of
        `datetime.fromisoformat()` with ISO 8601 format.
      type: fix
  createdAt: "2026-02-26"
  irVersion: 65

- version: 4.60.2
  changelogEntry:
    - summary: |
        Fix `explode: false` query parameter serialization for array types. When an OpenAPI spec
        sets `explode: false` on an array query parameter, the generated SDK now serializes values
        as comma-separated strings (e.g. `tags=A,B,C`) instead of repeated keys (e.g. `tags=A&tags=B&tags=C`).
        This applies to both regular and streaming endpoints.
      type: fix
  createdAt: "2026-02-26"
  irVersion: 65
- version: 4.60.1
  changelogEntry:
    - summary: |
        Use generator-cli JS API directly instead of subprocess spawning.
        Remove generator-cli from Docker image since it is now bundled via esbuild.
      type: chore
  createdAt: "2026-02-26"
  irVersion: 65

- version: 4.60.0
  changelogEntry:
    - summary: |
        Support `connectMethodName` on WebSocket channels. When a channel specifies a custom
        connection method name via `x-fern-sdk-method-name`, the generated SDK uses that name
        (converted to snake_case) instead of the default `connect`.
      type: feat
  createdAt: "2026-02-25"
  irVersion: 65
- version: 4.59.4
  changelogEntry:
    - summary: |
        Fix wire test import generation for organizations with hyphens in their name.
        Use `package_name` from custom config when available, and auto-convert hyphens
        to underscores in the fallback module path to produce valid Python import statements.
      type: fix
  createdAt: "2026-02-25"
  irVersion: 65

- version: 4.59.3
  changelogEntry:
    - summary: Fix bytes body snippet generation to use `request` parameter name instead of dynamic IR body key.
      type: fix
    - summary: Skip wire test generation for bytes request body endpoints, which lack IR example support.
      type: fix
  createdAt: "2026-02-24"
  irVersion: 65

- version: 4.59.2
  changelogEntry:
    - summary: |
        Generate an appropriate `client.py` file when `client.exported_filename` differs from `client.filename`.
        Previously, the `__init__.py` would import from the exported filename (e.g., `client.py`) but
        that file was never created, causing mypy `import-not-found` errors.
      type: fix
  createdAt: "2026-02-20"
  irVersion: 65

- version: 4.59.1
  changelogEntry:
    - summary: Fix wire test imports to respect package_name custom config, preventing import errors when users specify custom package names
      type: fix
  createdAt: "2026-02-23"
  irVersion: 65

- version: 4.59.0
  changelogEntry:
    - summary: |
        Add `offsetSemantics` custom config option. When set to `"page-index"`, offset pagination
        increments by 1 each page instead of by the number of items returned (`"item-index"`, the default).
      type: feat
  createdAt: "2026-02-17"
  irVersion: 65

- version: 4.58.1
  changelogEntry:
    - summary: |
        Export `ConsoleLogger` and `ILogger` from the `core` module, allowing users to import
        and use them directly:

        ```python
        from acme.core import ConsoleLogger, ILogger
        ```
      type: fix
  createdAt: "2026-02-18"
  irVersion: 65

- version: 4.58.0
  changelogEntry:
    - summary: |
        Add support for logging to the generated SDK.
        Users can configure the logger by passing in a `logging` parameter to the client constructor.

        ```python
        from acme import AcmeClient
        from acme.core import ConsoleLogger

        client = AcmeClient(
            token="YOUR_TOKEN",
            logging={
                "level": "debug",  # "info" is the default
                "logger": ConsoleLogger(),  # ConsoleLogger is the default
                "silent": False,  # True is the default, set to False to enable logging
            }
        )
        ```

        The `logging` parameter accepts a `LogConfig` dict with the following properties:
        - `level`: The log level to use. Defaults to `"info"`.
        - `logger`: The logger to use. Defaults to `ConsoleLogger`.
        - `silent`: Whether to silence the logger. Defaults to `True`.

        The `level` property can be one of the following values:
        - `"debug"`
        - `"info"`
        - `"warn"`
        - `"error"`

        To provide a custom logger, pass an object implementing the `ILogger` protocol
        with `debug`, `info`, `warn`, and `error` methods.

        Sensitive headers (`authorization`, `x-api-key`, `cookie`, etc.) are automatically
        redacted in logs.
      type: feat
  createdAt: "2026-02-10"
  irVersion: 65

- version: 4.57.3
  changelogEntry:
    - summary: |
        Handle optional access tokens in OAuth token provider by raising `RuntimeError`
        when the token is `None`. Fix wire test setup to use `client_id`/`client_secret`
        for OAuth client credentials and expect 2 requests when testing the token endpoint.
      type: fix
  createdAt: "2026-02-13"
  irVersion: 65

- version: 4.57.2
  changelogEntry:
    - summary: |
        Fix path-based pagination to pass the next page path as `path=` instead of `url=`
        in the generated HTTP client request call.
      type: fix
  createdAt: "2026-02-13"
  irVersion: 65

- version: 4.57.1
  changelogEntry:
    - summary: |
        Only copy `custom_pagination.py` into generated SDKs when custom pagination endpoints
        are present, and only copy `pagination.py` when standard pagination endpoints are present.
      type: fix
  createdAt: "2026-02-12"
  irVersion: 65

- version: 4.57.0
  changelogEntry:
    - summary: |
        Add `custom_transport: true` generator config option that exposes an `http_client` parameter
        on generated client constructors for custom httpx transport injection.

        **Primary use case:** Enables PKCE (Proof Key for Code Exchange) OAuth flows and other
        authentication schemes that require request interception at the transport layer.

        **Configuration:**
        ```yaml
        generators:
          - name: fernapi/fern-python-sdk
            config:
              custom_transport: true
        ```

        **Generated parameter types:**
        - Sync client: `http_client: typing.Optional[httpx.BaseTransport]`
        - Async client: `http_client: typing.Optional[httpx.AsyncBaseTransport]`

        **Use cases:**
        - PKCE OAuth authentication flows requiring code challenge/verifier injection
        - Custom request signing or authentication header manipulation
        - Request/response interception and modification
        - Mock transports for testing without network calls
        - Custom retry logic beyond the built-in exponential backoff

        **Example pattern (Twilio SDK style):**
        ```python
        # SDK developer provides a factory method in custom code
        class ValidationClient:
            @classmethod
            def create(cls, account_sid: str, auth_token: str) -> httpx.BaseTransport:
                # Custom transport with PKCE or validation logic
                return CustomValidationTransport(account_sid, auth_token)

        # End-user usage
        from myapi import MyClient, ValidationClient

        validation_transport = ValidationClient.create("account_sid", "auth_token")
        client = MyClient(http_client=validation_transport, base_url="https://api.example.com")
        ```

        This feature allows SDK developers to defer transport-specific logic to custom code while
        the generator simply threads the transport through to `httpx.Client`/`httpx.AsyncClient`.
      type: feat
  createdAt: "2026-02-12"
  irVersion: 65

- version: 4.56.0
  changelogEntry:
    - summary: |
        Add support for URI and path-based pagination.
      type: feat
  createdAt: "2026-02-11"
  irVersion: 65
- version: 4.55.5
  changelogEntry:
    - summary: |
        Compute Docker Compose project name during generation to avoid invalid characters from runtime directory names (e.g. `.seed`).
      type: fix
    - summary: |
        Cache client constructor signature check at module level and use httpx instead of requests for WireMock admin calls in generated wire test conftest.
      type: chore
  createdAt: "2026-02-11"
  irVersion: 63

- version: 4.55.4
  changelogEntry:
    - summary: |
        Fix Python 3.14 compatibility by replacing `pydantic.v1.datetime_parse` imports with
        Pydantic V2 `TypeAdapter`-based `parse_date`/`parse_datetime` implementations. Remaining
        `pydantic.v1` imports are wrapped with warning suppression to avoid the
        "Core Pydantic V1 functionality isn't compatible with Python 3.14" warning.
      type: fix
  createdAt: "2026-02-09"
  irVersion: 63

- version: 4.55.3
  changelogEntry:
    - summary: |
        Fix body property named `json` clashing with the `json` module import when generating
        `json.dumps(jsonable_encoder(...))` for multipart file upload requests. The `json` module
        is now aliased as `_json` when a body property named `json` is detected.
      type: fix
  createdAt: "2026-02-09"
  irVersion: 63

- version: 4.55.2
  changelogEntry:
    - summary: |
        Add websocket compatibility shim for websockets library v14. The generated SDK now
        uses a `core/websocket_compat.py` module that abstracts the `InvalidStatusCode` vs
        `InvalidStatus` exception difference, ensuring compatibility with both websockets
        v12-13 and v14+.
      type: fix
  createdAt: "2026-02-09"
  irVersion: 63

- version: 4.55.1
  changelogEntry:
    - summary: |
        Adds back intermediate raw_clients which were removed in 4.51.2.
      type: fix
  createdAt: "2026-02-06"
  irVersion: 63

- version: 4.55.0
  changelogEntry:
    - summary: |
        Add support for server URL templating with OpenAPI server variables. This enables
        dynamic base URL construction at runtime based on user-provided configuration.

        **OpenAPI definition example:**
        ```yaml
        servers:
          - url: https://api.{region}.{environment}.example.com/v1
            variables:
              region:
                default: us-east-1
                enum: [us-east-1, us-west-2, eu-west-1]
              environment:
                default: prod
                enum: [prod, staging, dev]
        ```

        **Generated constructor parameters:**
        Server variables are exposed as optional constructor parameters with their default values:
        - `region: typing.Optional[str]` - defaults to `"us-east-1"`
        - `server_url_environment: typing.Optional[str]` - defaults to `"prod"` (prefixed to avoid shadowing)

        **Runtime URL interpolation:**
        When server variables are provided, the SDK performs runtime URL template interpolation:
        ```python
        from seed import SeedApi

        # Uses default: https://api.us-east-1.prod.example.com/v1
        client = SeedApi()

        # Custom region: https://api.eu-west-1.prod.example.com/v1
        client = SeedApi(region="eu-west-1")

        # Custom region and environment: https://api.us-west-2.staging.example.com/v1
        client = SeedApi(region="us-west-2", server_url_environment="staging")
        ```

        **Multiple base URL environments:**
        For APIs with multiple base URLs (e.g., separate `base` and `auth` URLs), each URL
        template is interpolated independently with the same server variables.

        **`x-fern-default-url` extension:**
        When present in the OpenAPI spec, this extension specifies which server URL should
        be used as the default environment, overriding the first server in the list.
      type: feat
  createdAt: "2026-02-05"
  irVersion: 63

- version: 4.54.4
  changelogEntry:
    - summary: |
        The `use_provided_defaults` config option no longer applies defaults to
        inlined request body properties.
      type: fix
  createdAt: "2026-02-05"
  irVersion: 62
- version: 4.54.3
  changelogEntry:
    - summary: |
        Fix mypy type checking compatibility with pydantic field aliases. When fields have aliases
        (e.g., `bucket_id` with alias `bucketId`), the pydantic.Field(alias=...) is now placed inside
        the Annotated type hint instead of as the default value. This makes mypy see the Python field
        name in the constructor signature while Pydantic still uses the alias for JSON serialization.
      type: fix
  createdAt: "2026-02-03"
  irVersion: 62

- version: 4.54.2
  changelogEntry:
    - summary: |
        Generate CI workflow Python versions and PyPI trove classifiers dynamically based on the
        `pyproject_python_version` constraint.
      type: fix
  createdAt: "2026-01-29"
  irVersion: 62

- version: 4.54.1
  changelogEntry:
    - summary: |
        Switch from `poetry install` to `poetry lock` after SDK generation. This performs dependency
        resolution and saves the lockfile without installing packages, which avoids failures when
        transitive dependencies require custom build tools.
      type: fix
  createdAt: "2026-01-29"
  irVersion: 62

- version: 4.54.0
  changelogEntry:
    - summary: |
        Add `status_code` property to `HttpResponse` and `AsyncHttpResponse` classes.
        This allows users to access the HTTP status code when using `with_raw_response`.
      type: feat
  createdAt: "2026-01-29"
  irVersion: 62

- version: 4.53.1
  changelogEntry:
    - summary: |
        Fix literal and enum types being incorrectly JSON-serialized in multipart file upload requests.
      type: fix
  createdAt: "2026-01-28"
  irVersion: 62

- version: 4.53.0
  changelogEntry:
    - summary: |
        Add `import_paths` config option to auto-load user-defined files when the SDK is imported.
        This enables custom integrations (e.g., Sentry, logging) without modifying generated code.
        Files specified in the array (e.g., `["sentry_integration", "custom_logging"]`) are imported
        from the package root if they exist, using try/except to gracefully handle missing files.
      type: feat
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.52.0
  changelogEntry:
    - summary: |
        Add support for inferred authentication. Fixes for wire test generation with inferred auth.
      type: feat
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.51.3
  changelogEntry:
    - summary: |
        Fix WebSocket methods and iterators to avoid parsing binary messages as JSON.
      type: fix
  createdAt: "2026-01-27"
  irVersion: 62

- version: 4.51.2
  changelogEntry:
    - summary: |
        Skip generating raw client and `with_raw_response` property for intermediate clients that only
        have nested clients but no direct endpoints. This reduces unnecessary code generation and makes
        the SDK cleaner by only including raw client functionality where it's actually useful.
      type: fix
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.51.1
  changelogEntry:
    - summary: |
        Fix WebSocket connections to merge `additional_query_parameters` from `request_options`
        into the connection URL. Query params now use the same encoding pattern as HTTP endpoints.
      type: fix
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.51.0
  changelogEntry:
    - summary: |
        Add intelligent SSE parsing for discriminated unions via `parse_sse_obj()`. This function
        handles both data-level discrimination (discriminator inside JSON data payload) and
        event-level discrimination (discriminator at SSE envelope level). For event-level unions,
        it correctly parses the data field based on what the matching variant expects (string vs.
        complex object), enabling proper handling of streaming responses with mixed data types.
      type: feat
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.50.1
  changelogEntry:
    - summary: |
        Fix duplicate imports in __init__.py when using additional_init_exports. When the same
        symbol was exported from both the regular types module and additional_init_exports, the
        generator would produce duplicate imports causing F811 "Redefinition of unused" ruff errors.
        The generator now deduplicates exports, with additional_init_exports taking precedence.
      type: fix
  createdAt: "2026-01-26"
  irVersion: 62

- version: 4.50.0
  changelogEntry:
    - summary: |
        Add `wire_tests` config group with `enabled` and `exclusions` options. The `exclusions` option allows excluding specific endpoints/services from wire test generation using definition-level selectors. The existing `enable_wire_tests` option is now deprecated in favor of `wire_tests.enabled`.
      type: feat
  createdAt: "2026-01-25"
  irVersion: 62

- version: 4.49.0
  changelogEntry:
    - summary: |
        Add `mypy_exclude` custom config option to exclude directories from mypy type checking.
        This is useful when `.fernignore` preserves directories (like `legacy/` or `tests/integration/`)
        that contain code incompatible with the generated SDK.
      type: feat
  createdAt: "2026-01-20"
  irVersion: 62

- version: 4.48.1
  changelogEntry:
    - summary: |
        Fix WireMock stub generation for streaming endpoints. When an endpoint has both streaming
        and non-streaming variants (via x-fern-streaming with stream-condition), the generated
        WireMock stubs now include request body matching criteria to differentiate between them.
        SSE stubs match on `stream: true` in the request body and have higher priority, ensuring
        wire tests correctly route streaming requests to the SSE stub.
      type: fix
  createdAt: "2026-01-14"
  irVersion: 62

- version: 4.48.0
  changelogEntry:
    - summary: |
        Add opt-in `pydantic_config.positional_single_property_constructors` to allow `Wrapper("value")`
        for single-required-field models (excluding discriminator literals). Note: can break if the model
        later adds required fields; kwargs are more stable.
      type: feat
  createdAt: "2025-12-18"
  irVersion: 62

- version: 4.47.1
  changelogEntry:
    - summary: Update Dockerfile to use the latest generator-cli with improve reference.md generation.
      type: chore
  createdAt: "2026-01-13"
  irVersion: 62

- version: 4.47.0
  changelogEntry:
    - summary: |
        Add `X-Fern-Runtime` (e.g. `python/3.12.7`) and `X-Fern-Platform` (e.g. `darwin/25.2.0`) telemetry headers to all requests for better runtime/platform observability.
      type: feat
  createdAt: "2026-01-13"
  irVersion: 62

- version: 4.46.14
  changelogEntry:
    - summary: |
        Fix Python wire test generation/runtime robustness for missing examples, OMIT handling, client setup, and multipart file uploads.
      type: fix
  createdAt: "2026-01-10"
  irVersion: 62

- version: 4.46.13
  changelogEntry:
    - summary: |
        Fixes Python SDK import generation to avoid invalid `._` module segments by deriving type paths from canonical declarations.
      type: fix
  createdAt: "2026-01-09"
  irVersion: 62

- version: 4.46.12
  changelogEntry:
    - summary: |
        Support `bytes` as a response type for websocket channel methods.
      type: fix
  createdAt: "2026-01-09"
  irVersion: 62

- version: 4.46.11
  changelogEntry:
    - summary: |
        Wire test generator now skips undefined example values and injects `X-Test-Id` in a constructor-compatible way via `headers` or `httpx_client`.
      type: fix
  createdAt: "2026-01-09"
  irVersion: 62

- version: 4.46.10
  changelogEntry:
    - summary: |
        Fix wire test generation to use endpoint ID for lookup instead of path matching.
        This fixes a bug where wire tests would call the wrong client methods when multiple
        namespaces have endpoints with the same HTTP method and path pattern (e.g., POST /v2/Services).
      type: fix
  createdAt: "2026-01-08"
  irVersion: 62

- version: 4.46.9
  changelogEntry:
    - summary: |
        Fix wire test generation to filter out nop values when generating method arguments.
        This prevents invalid Python syntax like `param=` without a value when an example
        contains an invalid enum value or undefined property.
      type: fix
  createdAt: "2026-01-08"
  irVersion: 62

- version: 4.46.8
  changelogEntry:
    - summary: |
        Bump version to remove rc from version tag.
      type: fix
  createdAt: "2026-01-07"
  irVersion: 62

- version: 4.46.7-rc3
  changelogEntry:
    - summary: |
        Fix wire test generation for streaming endpoints. Streaming methods return lazy iterators
        (Iterator[bytes] or AsyncIterator[bytes]) that don't execute the HTTP request until iterated.
        Wire tests now wrap streaming endpoint calls in 'for _ in ...: pass' loops to ensure the
        HTTP request is actually made. This applies to streaming, streamParameter, and fileDownload
        response types.
      type: fix
  createdAt: "2026-01-07"
  irVersion: 62

- version: 4.46.7-rc2
  changelogEntry:
    - summary: Fixed Python SDK generation to use native Pydantic field aliases and improved core parsing so wire-key and nested/union validation works correctly across Pydantic v1/v2.
      type: fix
  createdAt: "2026-01-07"
  irVersion: 62

- version: 4.46.7-rc1
  changelogEntry:
    - summary: Update Dockerfile to use the latest generator-cli with improve reference.md generation.
      type: chore
  createdAt: "2026-01-05"
  irVersion: 62

- version: 4.46.7-rc0
  changelogEntry:
    - summary: Skip installation of generator-cli in Python SDK generator as it is already installed in the base image.
      type: chore
  createdAt: "2025-12-23"
  irVersion: 62

- version: 4.46.6
  changelogEntry:
    - summary: |
        Support custom `x-fern-sdk-method-name` on AsyncAPI operations.
      type: fix
  createdAt: "2025-12-19"
  irVersion: 62

- version: 4.46.5
  changelogEntry:
    - summary: |
        Update to support IR version 62.6.0 with new WebSocketMessage.methodName field,
        webhook response descriptions, and OpenAPI explode parameter support.
      type: chore
  createdAt: "2025-12-18"
  irVersion: 62

- version: 4.46.4-rc2
  changelogEntry:
    - summary: |
        Add sdkVersion as a top-level field in the generated metadata.json file.
      type: chore
  createdAt: "2025-12-18"
  irVersion: 61

- version: 4.46.4-rc1
  changelogEntry:
    - summary: |
        Fix URL path stripping when base URL contains path prefixes.
      type: fix
  createdAt: "2025-12-16"
  irVersion: 61

- version: 4.46.4-rc0
  changelogEntry:
    - summary: |
        Fix wire test generation to use `config.client.exported_class_name` for the client class name
        instead of deriving it from the organization and workspace names. This ensures wire tests
        import and instantiate the correct client class when a custom exported class name is configured.
      type: fix
  createdAt: "2025-12-18"
  irVersion: 61

- version: 4.46.3
  changelogEntry:
    - summary: |
        Fix empty request body issue where endpoints with all-optional fields would send an empty
        body instead of `{}`. When an endpoint has a request body type but all fields are optional,
        the SDK now correctly sends `{}` as valid JSON rather than omitting the body entirely.
      type: fix
  createdAt: "2025-12-17"
  irVersion: 61

- version: 4.46.2
  changelogEntry:
    - summary: |
        Fix handling of newlines in default values for strings when using `config.pydantic_config.use_provided_defaults`.
      type: fix
  createdAt: "2025-12-16"
  irVersion: 61

- version: 4.46.1
  changelogEntry:
    - summary: |
        Fix OAuth token handling for optional expires_in field with default fallback.
      type: fix
  createdAt: "2025-12-16"
  irVersion: 61

- version: 4.46.0
  changelogEntry:
    - summary: |
        FastAPI Python codegen now emits parameter markers via `typing.Annotated[...]` with standard Python defaults for better FastAPI/Pydantic compatibility.
      type: feat
  createdAt: "2025-12-16"
  irVersion: 61

- version: 4.45.10
  changelogEntry:
    - summary: |
        Fix retry logic "off-by-two" error. The internal `retries` counter now starts at 0
        instead of 2, and `max_retries` defaults to 2 when not specified. This ensures users
        get the expected number of retries (2 by default, or the configured `max_retries` value).
      type: fix
  createdAt: "2025-12-15"
  irVersion: 61

- version: 4.45.9
  changelogEntry:
    - summary: |
        Fix empty query params stripping existing URL query strings. When `params` and
        `additional_query_parameters` are both empty, httpx now receives `params=None` instead
        of `params=[]`, preserving any query parameters already present in the URL (e.g.,
        pagination cursors like `?after=123`).
      type: fix
  createdAt: "2025-12-12"
  irVersion: 61

- version: 4.45.8
  changelogEntry:
    - summary: Ensures the root client always exposes a headers parameter and forwards it to the underlying ClientWrapper.
      type: fix
  createdAt: "2025-12-12"
  irVersion: 61

- version: 4.45.7
  changelogEntry:
    - summary: Fix client wrapper instantiation to use the correct bearer token parameter name, preventing incorrect `token=` references when custom auth parameter names are configured.
      type: fix
  createdAt: "2025-12-12"
  irVersion: 61

- version: 4.45.6
  changelogEntry:
    - summary: Fix failing wire tests under `pytest-xdist` by using a single shared WireMock plugin.
      type: fix
  createdAt: "2025-12-11"
  irVersion: 61

- version: 4.45.5
  changelogEntry:
    - summary: |
        Fix file upload conditional check using wire_value instead of snake_case parameter name,
        which caused mypy "name not defined" errors when the API field name differed from the
        Python parameter name (e.g., `MyFile` vs `my_file`).
      type: fix
  createdAt: "2025-12-11"
  irVersion: 61

- version: 4.45.4
  changelogEntry:
    - summary: Fix offset pagination to handle None items when calculating next page offset.
      type: fix
  createdAt: "2025-12-11"
  irVersion: 61

- version: 4.45.3
  changelogEntry:
    - summary: Add return types to reference.md method signatures for consistency with other SDK generators.
      type: fix
  createdAt: "2025-12-10"
  irVersion: 61

- version: 4.45.2
  changelogEntry:
    - summary: Fix Python wire test generation by schema-based path/body name deconfliction and aligning client class resolution with the SDK's custom config rules.
      type: fix
  createdAt: "2025-12-10"
  irVersion: 61

- version: 4.45.1
  changelogEntry:
    - summary: Fix forward ref detection for complex circular type cycles.
      type: fix
  createdAt: "2025-12-10"
  irVersion: 61

- version: 4.45.0
  changelogEntry:
    - summary: |
        Add `coerce_numbers_to_str` option to `pydantic_config`. When enabled, numeric types (int, float, Decimal)
        will be coerced to strings during validation. This is useful for APIs that return numeric values as strings.
      type: feat
  createdAt: "2025-12-09"
  irVersion: 61

- version: 4.44.2
  changelogEntry:
    - summary: |
        Fix enum-typed headers to use `.value` instead of `str()` for consistent wire format across
        all Python versions. Previously, `str(enum)` returned the enum name (e.g., `Operand.GREATER_THAN`)
        on Python `< 3.11`, but the wire value (e.g., `>`) on Python `>= 3.11` with StrEnum.
      type: fix
  createdAt: "2025-12-09"
  irVersion: 61

- version: 4.44.1
  changelogEntry:
    - summary: |
        Remove `oauth-token-override` config flag. OAuth token override is now always enabled for OAuth client
        credentials flows, allowing users to authenticate with either client_id/client_secret OR a pre-generated
        bearer token directly via the `token` parameter without any configuration.
      type: fix
  createdAt: "2025-12-09"
  irVersion: 61

- version: 4.44.0
  changelogEntry:
    - summary: |
        Add Python 3.11+ StrEnum compatibility. Generated enums now use StrEnum for Python >= 3.11
        and the (str, Enum) mixin for older versions, fixing compatibility issues with Python 3.11's
        stricter enum mixin handling.
      type: feat
  createdAt: "2025-12-08"
  irVersion: 61

- version: 4.43.0
  changelogEntry:
    - summary: |
        Add OAuth token override support. When `oauth-token-override: true` is configured, users can authenticate
        with either OAuth client credentials or a pre-generated bearer token directly via the `token` parameter.
      type: feat
  createdAt: "2025-12-06"
  irVersion: 61

- version: 4.42.1
  changelogEntry:
    - summary: |
        Fix OAuth flow regression where `SyncClientWrapper` and `AsyncClientWrapper` required a `token` parameter.
        The token parameter is now optional only for OAuth flows (matching TypeScript's behavior), while plain
        bearer auth continues to require a token when `isAuthMandatory` is true.
      type: fix
  createdAt: "2025-12-05"
  irVersion: 61

- version: 4.42.0
  changelogEntry:
    - summary: |
        Add async support for OAuth token provider. The generated SDK now includes an AsyncOAuthTokenProvider
        class that uses asyncio.Lock for async-safe token refresh, alongside the existing sync OAuthTokenProvider
        that uses threading.Lock. The async client now uses the async token provider for proper async token management.
      type: feat
  createdAt: "2025-11-28"
  irVersion: 61

- version: 4.41.11
  changelogEntry:
    - summary: |
        Fix backslash escaping in endpoint and websocket docstrings. OpenAPI descriptions containing
        backslash sequences like `DOMAIN\username` now properly escape backslashes to avoid Python
        SyntaxError from invalid unicode escape sequences.
      type: fix
  createdAt: "2025-12-04"
  irVersion: 61

- version: 4.41.10
  changelogEntry:
    - summary: |
        Adds `dynamic = ["version"]` to `pyproject.toml`, allowing for `uv` commands such as `uv sync` to work out-of-the-box.
      type: fix
  createdAt: "2025-12-04"
  irVersion: 61

- version: 4.41.9
  changelogEntry:
    - summary: |
        Fix wire test WireMock container lifecycle to be compatible with pytest-xdist parallelization.
        The container is now started/stopped using pytest_configure/pytest_unconfigure hooks instead of
        a session-scoped fixture, ensuring only the controller process manages the container.
      type: fix
  createdAt: "2025-12-04"
  irVersion: 61

- version: 4.41.8
  changelogEntry:
    - summary: |
        Fix duplicate field names in discriminated union types.
      type: fix
  createdAt: "2025-12-03"
  irVersion: 61

- version: 4.41.7
  changelogEntry:
    - summary: |
        Fix paginated response handling when response type is optional or nullable.
      type: fix
  createdAt: "2025-12-03"
  irVersion: 61

- version: 4.41.6
  changelogEntry:
    - summary: |
        Fix Python wire test generation to drop literal-only params and fill in required file arguments so tests match the generated SDK signatures.
      type: fix
  createdAt: "2025-12-03"
  irVersion: 61

- version: 4.41.5
  changelogEntry:
    - summary: |
        The `package_path` configuration now works as a suffix within the module hierarchy instead of a prefix.
        For example, `package_path: sub/dir` now generates to `src/name/sub/dir/...` enabling imports like
        `from name.sub.dir import Client`.
      type: fix
  createdAt: "2025-12-03"
  irVersion: 61

- version: 4.41.4
  changelogEntry:
    - summary: |
        Ensure `UncheckedBaseModel.model_validate` in Pydantic v2 respects `FieldMetadata(alias=...)` so aliased fields validate correctly from JSON.
      type: fix
  createdAt: "2025-12-03"
  irVersion: 61

- version: 4.41.3
  changelogEntry:
    - summary: |
        Fix multipart form data requests to omit None values instead of converting them to empty strings.
        This prevents httpx from sending empty strings for optional parameters that should be absent.
      type: fix
  createdAt: "2025-11-28"
  irVersion: 61

- version: 4.41.2
  changelogEntry:
    - summary: More fixes and improvements to wire tests.
      type: fix
  createdAt: "2025-11-26"
  irVersion: 61

- version: 4.41.1
  changelogEntry:
    - summary: More fixes and improvements to wire tests.
      type: fix
  createdAt: "2025-11-26"
  irVersion: 61

- version: 4.41.0
  changelogEntry:
    - summary: |
        `package_path: sub/directory` generates the SDK into the specified subdirectory.
        Only top-level concerns (`pyproject.toml`, `README.md`, etc.) are exempt.
      type: feat
  createdAt: "2025-11-26"
  irVersion: 61

- version: 4.40.0
  changelogEntry:
    - summary: |
        Add support for X-RateLimit-Reset header
        Retry strategy matches other SDKs (1s initial delay, 60s max delay).
      type: feat
  createdAt: "2025-11-25"
  irVersion: 61

- version: 4.39.2
  changelogEntry:
    - summary: More fixes and improvements to wire tests.
      type: fix
  createdAt: "2025-11-25"
  irVersion: 61

- version: 4.39.1
  changelogEntry:
    - summary: Various fixes and improvements to wire tests.
      type: fix
  createdAt: "2025-11-25"
  irVersion: 61

- version: 4.39.0
  changelogEntry:
    - summary: Add environment_class_name config option to customize the environment class name. Default remains `{ClientName}Environment`.
      type: feat
  createdAt: "2025-11-25"
  irVersion: 61

- version: 4.38.5
  changelogEntry:
    - summary: Fix discriminated union Field(discriminator=...) and UnionMetadata(discriminant=...) to use Python field names instead of JSON aliases for Pydantic v2 compatibility.
      type: fix
  createdAt: "2025-11-24"
  irVersion: 61

- version: 4.38.4
  changelogEntry:
    - summary: |
        Remove using generator-cli to push to GitHub for self-hosted SDKs; this is now handled in the local workspace runner.
      type: fix
  createdAt: "2025-11-21"
  irVersion: 61

- version: 4.38.3-rc1
  changelogEntry:
    - summary: Add wire test generation behind `enable_wire_tests` flag.
      type: feat
  createdAt: "2025-11-20"
  irVersion: 61

- version: 4.38.3-rc0
  changelogEntry:
    - summary: Add support for custom pagination
      type: feat
  createdAt: "2025-11-20"
  irVersion: 61

- version: 4.38.2
  changelogEntry:
    - summary: Fix missing websocket services when using lazy imports
      type: fix
  createdAt: "2025-11-20"
  irVersion: 61

- version: 4.38.1
  changelogEntry:
    - summary: Add contents:read permission to generated publish workflow for OIDC authentication to fix actions/checkout@v4 requirements.
      type: fix
  createdAt: "2025-11-20"
  irVersion: 61

- version: 4.38.0
  changelogEntry:
    - summary: Add pytest-xdist for parallel test execution and upgrade CI Python version to 3.9 in generated SDKs.
      type: feat
  createdAt: "2025-11-19"
  irVersion: 61

- version: 4.37.1
  changelogEntry:
    - summary: Bump generator CLI version to publish new Docker image.
      type: chore
  createdAt: "2025-11-19"
  irVersion: 61

- version: 4.37.0
  changelogEntry:
    - summary: |
        Pagination: `page.response` is the typed API response object for each page (e.g., `ListUsersPaginationResponse`), not a raw HTTP wrapper. This is a typing-only improvement; no runtime behavior changes and existing code continues to work. If you explicitly type-annotate pagers, use two type parameters (`SyncPager[T, R]` / `AsyncPager[T, R]`).

        ```python
        # Iterate pages and access the typed response per page
        pager = client.users.list(...)
        for page in pager.iter_pages():
            print(page.response)  # typed response object
        ```
      type: feat
  createdAt: "2025-11-17"
  irVersion: 61

- version: 4.36.2
  changelogEntry:
    - summary: Fix circular reference issue for recursive types and unions.
      type: fix
  createdAt: "2025-11-14"
  irVersion: 61

- version: 4.36.1
  changelogEntry:
    - summary: Resolve PydanticUserError for mutually recursive models in Pydantic v2.
      type: fix
  createdAt: "2025-11-12"
  irVersion: 61

- version: 4.36.0
  changelogEntry:
    - summary: Add custom license file copying and GitHub installation token population for local generation workflows
      type: feat
  createdAt: "2025-11-11"
  irVersion: 61

- version: 4.35.3
  changelogEntry:
    - summary: Fix double Optional wrapping for unknown types in nullable fields by mapping unknown to Any instead of Optional[Any].
      type: fix
  createdAt: "2025-11-11"
  irVersion: 61

- version: 4.35.2
  changelogEntry:
    - summary: Add back F401-ignored imports for circular references.
      type: fix
  createdAt: "2025-11-10"
  irVersion: 61

- version: 4.35.1
  changelogEntry:
    - summary: Generated Python SDKs no longer show SyntaxWarnings when API docs or enum values include backslashes.
      type: fix
  createdAt: "2025-11-10"
  irVersion: 61

- version: 4.35.0
  changelogEntry:
    - summary: Add automatic discriminated union support using Pydantic's Field(discriminator=...) to improve serialization performance. Benchmarks show a 2x speedup by eliminating sequential variant attempts and enabling O(1) variant selection.
      type: feat
  createdAt: "2025-11-10"
  irVersion: 61

- version: 4.34.1
  changelogEntry:
    - summary: Fix websocket response type generation to use typing.Any when no server-to-client messages are defined, preventing mypy errors with empty Union types.
      type: fix
  createdAt: "2025-11-07"
  irVersion: 61

- version: 4.34.0
  changelogEntry:
    - summary: Add support for disabling retries on endpoints
      type: feat
  createdAt: "2025-11-05"
  irVersion: 61

- version: 4.33.0
  changelogEntry:
    - summary: Added Generation Metadata file to output
      type: feat
  createdAt: "2025-11-04"
  irVersion: 61

- version: 4.32.3-rc1
  changelogEntry:
    - summary: Added logging to debug 4.32.3-rc0
      type: feat
  createdAt: "2025-10-30"
  irVersion: 60

- version: 4.32.3-rc0
  changelogEntry:
    - summary: Add support for publishing to PyPI with attestations in auto-generated GHA ci.yml
      type: feat
  createdAt: "2025-10-30"
  irVersion: 60

- version: 4.32.2
  changelogEntry:
    - summary: Update pyproject.toml headers to propagate project urls to pypi metadata generation
      type: chore
  createdAt: "2025-10-29"
  irVersion: 60

- version: 4.32.1
  changelogEntry:
    - summary: Fix pydantic model alias generator to correctly serialize wrapped aliases in pydantic v2.
      type: fix
  createdAt: "2025-10-27"
  irVersion: 60

- version: 4.32.0
  changelogEntry:
    - summary: |
        Add support for setting the recursion limit above the default of 1000.
        Also removes unused imports that were previously F401-ignored.
      type: feat
  createdAt: "2025-10-24"
  irVersion: 60

- version: 4.31.2
  changelogEntry:
    - summary: Fix union type deserialization to properly match discriminated unions based on literal field values (e.g., type discriminators) when nested fields have validation errors.
      type: fix
  createdAt: "2025-10-23"
  irVersion: 60

- version: 4.31.1
  changelogEntry:
    - summary: Escape backslashes in docstrings to prevent SyntaxWarning for invalid escape sequences.
      type: fix
  createdAt: "2025-10-17"
  irVersion: 60

- version: 4.31.0
  changelogEntry:
    - summary: |
        - Removed external dependency on httpx-sse by bringing SSE handling in-house.
        - Fixed SSE handling of events longer than or containing escaped newlines.
      type: feat
  createdAt: "2025-10-06"
  irVersion: 60

- version: 4.30.4-rc1
  changelogEntry:
    - summary: |
        Cleared CVE-2025-27210
      type: fix
  createdAt: "2025-10-02"
  irVersion: 60

- version: 4.30.4-rc0
  changelogEntry:
    - summary: |
        Cleared CVEs in generator image
      type: fix
  createdAt: "2025-10-02"
  irVersion: 60

- version: 4.30.3
  changelogEntry:
    - summary: |
        Upgrade generator-cli dependency to fix local generation handling of .fernignore files.
      type: fix
  createdAt: "2025-09-29"
  irVersion: 60

- version: 4.30.2
  changelogEntry:
    - summary: Fix enum generation to properly escape quotes and backslashes in enum values.
      type: fix
  createdAt: "2025-09-27"
  irVersion: 60

- version: 4.30.1
  changelogEntry:
    - summary: Fix sdk `v1_on_v2` export of non-existent `IS_PYDANTIC_V2` variable.
      type: fix
  createdAt: "2025-09-25"
  irVersion: 60

- version: 4.30.0
  changelogEntry:
    - summary: |
        Add support for PR mode for self-hosted/local sdk generation
      type: feat
  createdAt: "2025-09-25"
  irVersion: 60

- version: 4.29.2
  changelogEntry:
    - summary: Added a note to the README on constructing Async httpx objects to pass into main Async clients.
      type: chore
  createdAt: "2025-09-23"
  irVersion: 59

- version: 4.29.2-rc0
  changelogEntry:
    - summary: |
        Exports in init files always reference the submodule instead of the current module.
        This should fix infinite recursion in libraries that inspect getattr, like freezegun.
      type: fix
  createdAt: "2025-09-22"
  irVersion: 59

- version: 4.29.1
  changelogEntry:
    - summary: Fixes issue where colliding classes were not lazily imported correctly.
      type: fix
  createdAt: "2025-09-18"
  irVersion: 59

- version: 4.29.0
  changelogEntry:
    - summary: |
        Add support for custom sections in the README.md via customSections config option
      type: feat
  createdAt: "2025-09-18"
  irVersion: 59

- version: 4.28.5
  changelogEntry:
    - summary: |
        Generator no longer fails on failed generator-cli installation
      type: fix
  createdAt: "2025-09-16"
  irVersion: 59

- version: 4.28.4
  changelogEntry:
    - summary: |
        Fix python sdk serialization to use dict instead of model_dump.
      type: fix
  createdAt: "2025-09-12"
  irVersion: 59

- version: 4.28.3
  changelogEntry:
    - summary: |
        Never duplicate parameters in client constructors
      type: fix
  createdAt: "2025-09-10"
  irVersion: 59

- version: 4.28.2
  changelogEntry:
    - summary: |
        Nit in custom client snippet generation.
      type: fix
  createdAt: "2025-09-09"
  irVersion: 59

- version: 4.28.1
  changelogEntry:
    - summary: |
        Union member self-referencing dependencies are now correctly imported and forward referenced.
        This fixes compatibility with Pydantic >=2.11.0.
      type: fix
  createdAt: "2025-09-05"
  irVersion: 59

- version: 4.28.0
  changelogEntry:
    - summary: Generator passes readme configs apiName, disabledSections, and whiteLabel.
      type: feat
  createdAt: "2025-08-29"
  irVersion: 59

- version: 4.27.0-rc0
  changelogEntry:
    - summary: |
        Client imports are now lazy loaded by default. This will greatly reduce memory footprint when using a small portion of a large API.
        The tradeoff is a latency penalty when first accessing a client.
        Users can opt in to eager loading (the old behavior) by setting the `lazy_imports` flag to `false` in their configuration.
      type: feat
  createdAt: "2025-08-27"
  irVersion: 59

- version: 4.26.2
  changelogEntry:
    - summary: |
        Upgrade docker image to use python 3.11.13 so that users can depend on packages that require python 3.11.
      type: fix
  createdAt: "2025-08-26"
  irVersion: 59

- version: 4.26.1
  changelogEntry:
    - summary: Additional handling of inferred auth
      type: chore
  createdAt: "2025-08-20"
  irVersion: 59

- version: 4.26.0
  changelogEntry:
    - summary: Bumped IR version to 59.
      type: chore
  createdAt: "2025-08-20"
  irVersion: 59

- version: 4.25.9
  changelogEntry:
    - summary: |
        Fix: allow setting of package name and version in local docker generation
      type: feat
  createdAt: "2025-08-05"
  irVersion: 58

- version: 4.25.7-rc2
  changelogEntry:
    - summary: |
        Minor bug fix: accessing version from publish config
      type: feat
  createdAt: "2025-08-05"
  irVersion: 58

- version: 4.25.7-rc1
  changelogEntry:
    - summary: |
        Attempt to plumb version in Abstract Generator
      type: feat
  createdAt: "2025-08-05"
  irVersion: 58

- version: 4.25.8
  changelogEntry:
    - summary: |
        Websocket patch: json load messages on dunder iter method
      type: feat
  createdAt: "2025-08-05"
  irVersion: 58

- version: 4.25.7-rc0
  changelogEntry:
    - summary: |
        Enforce nested folders for package names with a "." in them.
      type: feat
  createdAt: "2025-08-04"
  irVersion: 58

- version: 4.25.6
  changelogEntry:
    - summary: |
        Removed snippet generation
      type: feat
  createdAt: "2025-07-22"
  irVersion: 58

- version: 4.25.5
  changelogEntry:
    - summary: |
        Enabled "ignore" as an option for extra fields
      type: feat
  createdAt: "2025-07-17"
  irVersion: 58

- version: 4.25.4
  changelogEntry:
    - summary: |
        Updated construct_type function to handles undiscriminated unions with lists, sets, and dictionaries of objects.
      type: fix
  createdAt: "2025-07-15"
  irVersion: 58

- version: 4.25.3
  changelogEntry:
    - summary: |
        Fix websocket connect method generation for single base URL environments.
      type: fix
  createdAt: "2025-07-14"
  irVersion: 58

- version: 4.25.2
  changelogEntry:
    - summary: |
        Generator fix: automatically switch tabs to spaces, following PEP8 standards.
      type: fix
  createdAt: "2025-07-11"
  irVersion: 58

- version: 4.25.1
  changelogEntry:
    - summary: |
        Correctly import websockets exceptions.
      type: fix
  createdAt: "2025-07-10"
  irVersion: 58

- version: 4.25.0
  changelogEntry:
    - summary: |
        Support async functions as websocket callback handlers.
      type: feat
  createdAt: "2025-07-09"
  irVersion: 58

- version: 4.24.3
  changelogEntry:
    - summary: |
        Support websockets>=14 by using legacy client.
      type: fix
  createdAt: "2025-07-09"
  irVersion: 58

- version: 4.24.2
  changelogEntry:
    - summary: |
        Emit ERROR events for JSON parsing errors in websocket connections.
      type: fix
  createdAt: "2025-07-09"
  irVersion: 58

- version: 4.24.1
  changelogEntry:
    - summary: |
        Parse websocket messages as JSON before Pydantic parsing.
      type: fix
  createdAt: "2025-07-07"
  irVersion: 58

- version: 4.24.0
  changelogEntry:
    - summary: |
        Add support for path parameters backed by variables supplied to the client constructor.
      type: feat
  createdAt: "2025-07-03"
  irVersion: 58

- version: 4.23.2
  changelogEntry:
    - summary: |
        Bump websockets dependency to >=12.0.0 to ensure compatibility with newer websocket implementations and improve stability.
      type: chore
  createdAt: "2025-06-25"
  irVersion: 58

- version: 4.23.1
  changelogEntry:
    - summary: |
        Bump pydantic-core dependency to >=2.18.2 to ensure compatibility with newer pydantic versions and improve performance.
      type: chore
  createdAt: "2025-06-24"
  irVersion: 58

- version: 4.23.0
  changelogEntry:
    - summary: |
        Add support for custom headers parameter at the top level of the client constructor.

        ```python
        client = Client(
            headers={"X-Custom-Header": "custom-value"}
        )
        ```
      type: feat
  createdAt: "2025-06-24"
  irVersion: 58

- version: 4.22.1-rc0
  changelogEntry:
    - summary: |
        Lazily validate model serialization to reduce memory consumption. Pydantic 2.11.0 introduced an issue where the model_serializer
        decorator set to wrap mode forced it to eagerly do schema validation at import time. Because we had this decorator on the UniversalBaseModel,
        it would try to validate the schemas of all the Model types at import time. This caused massive memory spikes for more complex SDKs, up to 2.6GB
        in some cases. This change essentially accomplishes the same logic of wrapping the serialization process and modifying the serialization
        structure of datetime fields. The difference is that we manually wrap, so we're able to defer model validation until runtime, drastically
        reducing our memory consumption.
      type: feat
  createdAt: "2025-06-20"
  irVersion: 58

- version: 4.22.0
  changelogEntry:
    - summary: |
        Support wrapped aliases in python for pydantic v2.
      type: feat
  createdAt: "2025-06-11"
  irVersion: 58

- version: 4.21.5
  changelogEntry:
    - summary: |
        Generate README for github output mode.
      type: fix
  createdAt: "2025-06-11"
  irVersion: 58

- version: 4.21.4
  changelogEntry:
    - summary: |
        Add support for HEAD HTTP method in the generated client.
      type: feat
  createdAt: "2025-06-05"
  irVersion: 58

- version: 4.21.3
  changelogEntry:
    - summary: |
        Fix an issue where the websocket connect method did not correctly yield the websocket client.
      type: fix
  createdAt: "2025-06-04"
  irVersion: 58

- version: 4.21.2
  changelogEntry:
    - summary: |
        Handle HEAD HTTP method gracefully by treating it as a POST method when constructing the snippet registry, rather than failing.
      type: chore
  createdAt: "2025-05-27"
  irVersion: 58

- version: 4.21.1
  changelogEntry:
    - summary: |
        Make sure to generate README and Reference even when generating in local mode (if self hosting is enabled).
      type: chore
  createdAt: "2025-05-27"
  irVersion: 58

- version: 4.21.0
  changelogEntry:
    - summary: |
        Bump to v58 of IR.
      type: chore
  createdAt: "2025-05-27"
  irVersion: 58

- version: 4.20.3
  changelogEntry:
    - summary: |
        Fix handling of optional and unknown response types by not throwing errors when the response is empty.
      type: fix
  createdAt: "2025-05-20"
  irVersion: 57

- version: 4.20.2
  changelogEntry:
    - summary: |
        Support formatting the generated README.md and python code snippets.
      type: fix
  createdAt: "2025-05-13"
  irVersion: 57

- version: 4.20.1
  changelogEntry:
    - summary: |
        Add support for the custom introduction setting in the generated README.md.
      type: fix
  createdAt: "2025-05-13"
  irVersion: 57

- version: 4.20.0
  changelogEntry:
    - summary: |
        Generate standalone Pydantic models for each class definition for models that utilize the Fern `extends` keyword,
        as opposed to generating Pydantic models that implement inheritance.
      type: feat
  createdAt: "2025-05-13"
  irVersion: 57

- version: 4.19.7
  changelogEntry:
    - summary: |
        Fix mypy errors related to type-shadowing `data` variables in generated streaming endpoints.
      type: fix
  createdAt: "2025-05-13"
  irVersion: 57

- version: 4.19.6
  changelogEntry:
    - summary: |
        Fix mypy errors related to automatic pagination in the python client.
      type: fix
  createdAt: "2025-05-11"
  irVersion: 57

- version: 4.19.5
  changelogEntry:
    - summary: |
        Fix naming conflicts in streaming endpoints by renaming the stream method to _stream in raw clients,
        preventing collisions with endpoint parameters that might also be named "stream",
        while maintaining proper functionality for streaming responses.
      type: fix
  createdAt: "2025-05-11"
  irVersion: 57

- version: 4.19.4
  changelogEntry:
    - summary: |
        Fix handling of optional file parameters in multipart form data requests with httpx by properly checking
        for None values before attempting to include them in the request, preventing errors when optional file parameters are not provided.
      type: feat
  createdAt: "2025-05-11"
  irVersion: 57

- version: 4.19.3
  changelogEntry:
    - summary: |
        Fix pagination support in raw clients by properly indexing into response data, ensuring that raw client endpoints with pagination correctly iterate through paginated results.
      type: fix
  createdAt: "2025-05-09"
  irVersion: 57

- version: 4.19.2
  changelogEntry:
    - summary: |
        Fix SSE streaming response handling by adding proper type casting to sse.data, ensuring correct data type conversion during stream processing.
      type: fix
  createdAt: "2025-05-09"
  irVersion: 57

- version: 4.19.1
  changelogEntry:
    - summary: |
        Fix a mypy error in pydantic_utilities.py by properly handling type annotations for Pydantic v1 and v2 compatibility, ensuring type checking passes correctly across different Pydantic versions.
      type: fix
  createdAt: "2025-05-09"
  irVersion: 57

- version: 4.19.0
  changelogEntry:
    - summary: |
        Add support for generating proper Pydantic models that contain forward references wrapped in containers (e.g. list, optional, etc.)
      type: feat
  createdAt: "2025-05-09"
  irVersion: 57

- version: 4.18.6
  changelogEntry:
    - summary: |
        Fix string enum generation to properly handle enum values containing quotes by automatically escaping them,
        ensuring valid Python syntax for both single and double quoted string literals.
      type: fix
  createdAt: "2025-05-08"
  irVersion: 57

- version: 4.18.5
  changelogEntry:
    - summary: |
        Support application/x-www-form-urlencoded content type for requests, allowing proper encoding of form data in API calls.
      type: fix
  createdAt: "2025-05-08"
  irVersion: 57

- version: 4.18.4
  changelogEntry:
    - summary: |
        Fix requirements.txt generation to properly handle dependency version constraints, ensuring compatibility markers are correctly formatted.
      type: fix
  createdAt: "2025-05-08"
  irVersion: 57

- version: 4.18.3
  changelogEntry:
    - summary: |
        Install the generator-cli at build time as a fallback if runtime installation fails.
      type: fix
  createdAt: "2025-05-01"
  irVersion: 57

- version: 4.18.2
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fix README g

- version: 4.18.1
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Update python-v2 generator invocation so that all relevant files like pyproject.toml and poetry.lock are pushed
        to the GitHub repository.

- version: 4.18.0
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Update python-v2 generator invocation so that all relevant files like pyproject.toml and poetry.lock are pushed
        to the GitHub repository.

- version: 4.18.0
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Add support for self-hosted mode, allowing users to push generated SDKs to their own GitHub repositories.
        This feature enables organizations to maintain private SDK repositories with custom configurations.

- version: 4.17.1
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where response `headers` were not available in the strongly typed error classes.

- version: 4.17.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for retrieving response headers for each page of paginated responses, instead of just the first page.

- version: 4.16.2
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fixed an issue introduced in 4.14.0, where `bytes` and `text` responses were not handled correctly.

- version: 4.16.1
  irVersion: 57
  changelogEntry:
    - type: internal
      summary: |
        Fixes an internal release issue in `4.16.0`.

- version: 4.16.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for retrieving response headers from the generated `ApiError` class.

- version: 4.15.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for offset step pagination, where the offset position represents the element's index rather
        than the page number.
    - type: fix
      summary: |
        Fixed an issue introduced in 4.14.0, where paginated endpoints were not returning the underlying data.

- version: 4.14.6
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fixed an issue where multipart/form-data content types are now explicitly sent when configured in the API definition.

- version: 4.14.5
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fixed an issue introduced in 4.14.0, where SSE streaming responses were not yielded correctly.

- version: 4.14.4
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fixed an issue where filename and plain text content-type parameters were being incorrectly serialized.

- version: 4.14.3
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Add support for receiving raw responses from pagination endpoints.

- version: 4.14.2
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where TypedDicts with circular references were not correctly serialized.
        This issue only affected users that enabled `use_typeddict_requests`.

- version: 4.14.1
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        The generated GitHub workflow now uses `ubuntu-latest` instead of `ubuntu-20.04`

- version: 4.14.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for receiving raw responses from streaming endpoints.
    - type: feat
      summary: |
        Add support for excluding types from the generated `__init__.py` files.

        ```yaml
        config:
          exclude_types_from_init_exports: true
        ```

- version: 4.13.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Adds support for overriding literal global headers in the client constructor (e.g. `version`).

        ```python
        client = Acme(
          ...
          version="1.0.0",
        )
        ```

- version: 4.12.1
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fixes an issue where dictionary types defined within TypedDicts incorrectly used the
        `typing_extensions.NotRequired` type.
    - type: fix
      summary: |
        Fixes an issue where optional `core.File` parameters would cause `mypy` failures.
    - type: fix
      summary: |
        Fixes a regression introduced in 4.12.0, where the non raw response client endpoints
        did not respect the allowed method keywords (e.g. `list` was generated as `list_`).

- version: 4.12.0
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Resolve issues with paginated endpoints generating incorrect endpoint return types.

- version: 4.11.0
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Always represent nullable as Optional rather than NotRequired, only use
        NotRequired for optional in typeddicts.

- version: 4.10.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for using TypedDicts for file upload request parameters. This flag should
        be used in conjunction with the `use_typeddict_requests` flag like so:

        ```yaml
        config:
          use_typeddict_requests: true
          use_typeddict_requests_for_file_upload: true
        ```

- version: 4.9.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Implement raw client support for accessing response headers and data in unary endpoints.

- version: 4.8.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for inlining path parameters

- version: 4.7.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for user-agent header

- version: 4.6.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for generating legacy wire tests, and disable them by default. These tests will be restored and improved in the future.
        Users can opt-in to generating legacy wire tests by setting the `include_legacy_wire_tests` flag to `true` in their configuration.

        ```yaml
        config:
          include_legacy_wire_tests: true
        ```

- version: 4.5.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for websocket code generation.

- version: 4.4.0
  irVersion: 57
  changelogEntry:
    - type: feat
      summary: |
        Add support for raw bytes responses.

- version: 4.3.21
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where the default `timeout` was not being respected when a custom `httpx_client` was provided.

- version: 4.3.20
  irVersion: 57
  changelogEntry:
    - type: fix
      summary: |
        Update formatting across all generated files. There are no behavioral changes, but large diffs are expected.

- version: 4.3.19
  irVersion: 57
  changelogEntry:
    - type: internal
      summary: |
        Update the IR to v57.

- version: 4.3.18
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where the `request_options` parameter name is now properly respected when it's
        renamed due to conflicts with other parameter names. Previously, the code would still reference the
        original parameter name internally, causing errors.

- version: 4.3.17
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where parameter names that conflict with the `request_options` parameter are now properly deconflicted by
        prepending an underscore to the `request_options` parameter name.

- version: 4.3.16
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where GeneratorExit was unintentionally being swallowed by code blocks within the HttpClient.stream() contextmanager.

- version: 4.3.15
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix an issue where extraneous NameError-causing update_forward_refs invocations were being emitted.

- version: 4.3.14
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        Set the default number of retries to 2 (was 0) to align with the generated README.

- version: 4.3.13
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        The Python generator now supports conditioning dependencies on the Python version.

- version: 4.3.12
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        The Python generator now autogenerates a requirements.txt file.

- version: 4.3.11
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        pyproject.toml now has a `[project]` block making it Poetry v2 compatible.

- version: 4.3.10
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pagination correctly uses specified defaults to support custom schemes.

- version: 4.3.9
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix indentation in generated README.md sections to ensure proper formatting and readability.

- version: 4.3.8
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Include content-type headers when available as part of endpoint request generation.

- version: 4.3.7
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Update multipart endpoint generation to propertly omit optional body parameters.

- version: 4.3.6
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Fix README.md and reference.md generation.

- version: 4.3.5
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Update README.md snippet builder to omit invalid snippets during readme config generation.

- version: 4.3.4
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Update shared http_client.py to remove omitted entries during file upload requests.

- version: 4.3.3
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The generator now writes the reference.md configuration correctly, using `.dict()` instead of `.json()`.

- version: 4.3.2
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The generator will now correctly default to the configured global `default_bytes_stream_chunk_size` when the `request_options` parameter is not provided.

- version: 4.3.1
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        Requests for file download will now allow users to pass in a `chunk_size` option that allows them to receive chunks of a specific size
        from the resultant `iter_bytes` invocation on the response byte stream.

        Concretely, a user would leverage the following:
        ```python
        client.download(
          ...,
          request_options={
            "chunk_size": 1024    # 1MB
          }
        )
        ```

- version: 4.2.8
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The snippet writer now correctly handles base64 strings.

- version: 4.2.7
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The generated README will now have a section that links to the generated
        SDK Reference (in `reference.md`).

        ```md
        ## Reference

        A full reference for this library can be found [here](./reference.md).
        ```

- version: 4.2.7-rc4
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Generated readmes now include the parameter name required for the request options parameter within the example snippets.

- version: 4.2.7-rc3
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Now, when sending Snippet Templates back to Fern, the generator will not try to coerce a potentially missing ID into the `api_definition_id` field.
        This, had been a cause of the error log `Failed to upload snippet templates to FDR, this is ok: one of the hex, bytes, bytes_le, fields, or int arguments must be given`.

- version: 4.2.7-rc2
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic utilities now correctly handles cases where you have a Pydantic model, with a list of pydantic models as a field, where those models have literals.
        Effectively, `deep_union_pydantic_objects` now handles lists of objects and merges them appropriately.

- version: 4.2.7-rc1
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        When leveraging the `include_union_utils` configuration flag, the Pydantic models will no longer include transitive dependencies within
        `update_forward_ref` calls, since these should not be necessary. This effectively scopes back the changes introduced in 4.0.0-rc5, which included
        changes to improve circular reference handling in Pydantic models.

- version: 4.2.7-rc0
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Dynamic header suppliers, as used within the OAuth provider are now invoked on every request, not just the first.
        This was a regression introduced within an earlier version that is now fixed. As a results of this fix, the `refresh_token` is now correctly refreshed.

- version: 4.2.6
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Serialization utilities (necessary when pydantic aliases are removed) now respects dictionaries as well.

- version: 4.2.5
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Parameters of file upload functions now default to OMIT, not None, so that the SDK appropriately
        filters out unset parameters, while still allowing for user specified None values.

- version: 4.2.4
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Datetime examples are generated correctly once again.
        The `pydantic_utilities` file is python 3.8 compatible.

- version: 4.2.3
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The content type of file properties is now respected for multipart
        requests. For example, if you have a file property called `image` that has the
        content type `image/jpeg`, then it will be sent as:

        ```python
        "image": core.with_content_type(file=image, content_type="image/jpeg"),
        ````

- version: 4.2.2
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The content type of non-file properties is now respected for multipart
        requests. For example, if you have a type called `metadata` that has the
        content type `application/json`, then it will be sent as:

        ```python
        "metadata": (None, json.dumps(jsonable_encoder(metadata)), "application/json"),
        ```

- version: 4.2.1
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        When the generator runs bash commands such as `poetry install` and there is a failure,
        now the `stderr` and `stdout` is logged to help improve user debugging.

- version: 4.2.0
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        Allow specifying arbitrary configuration to your packages `pyproject.toml` by adding a `pyproject_toml` block to your configuration
        whatever you include in this block will be added as-is to the `pyproject.toml` file. The config, as an example is:

        ```yaml
        config:
          pyproject_toml: |
            [tool.covcheck.group.unit.coverage]
            branch = 26.0
            line = 62.0

            [tool.covcheck.group.service.coverage]
            branch = 30.0
            line = 67.0
        ```

- version: 4.1.0
  irVersion: 53
  changelogEntry:
    - type: feat
      summary: |
        Allow specifying pip extras within your `pyproject.toml`. The following config:

        ```yaml
        config:
          extra_dev_dependencies:
            covcheck:
              version: "^0.4.3"
              extras: ["toml"]
        ```

        would add the following to your `pyproject.toml`:

        ```toml
        [tool.poetry.dev-dependencies]
        covcheck = { version = "^0.4.3", extras = ["toml"] }
        ```

- version: 4.0.0
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Generated tests that expect an empty result when they are of type `text` (not JSON) now appropriately expect an empty string instead of `None` for async functions as well.
        Version 3.3.4 fixed this for sync functions only, which was a bug.

- version: 4.0.0-rc9
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: All Pydantic V2 warnings have been resolved
      fixed:
        - json_encoders have been removed from Pydantic V2, and replaced with a `model_serializer` method.
        - additional model construction functions have been added when not leveraging pydantic field aliases to allow users to construct a model from JSOn without the need for dealiasing the object themselves.

- version: 4.0.0-rc8
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic models that call `update_forward_refs` on non-union circular reference dependencies now pass in `localns` for
        the current member, a field in Pydantic V1 that provides object contexts to models in the event objects are not fully rebuilt.

- version: 4.0.0-rc7
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        The generator now respects the old use_str_enums flag again, a regression was introduced where only the new flag `enum_type`
        was respected.

- version: 4.0.0-rc6
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic models now call update forward refs on non-union circular references. This
        prevents runtime errors in certain cases where types self reference itself through
        a union.

- version: 4.0.0-rc5
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic models now call update forward refs on non-union circular references. This
        prevents runtime errors in certain cases where types self reference itself through
        a union.

- version: 4.0.0-rc4
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic models now call update forward refs on non-union circular references. This
        prevents runtime errors in certain cases where types self reference itself through
        a union.

- version: 4.0.0-rc3
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: |
        Pydantic models now call update forward refs on non-union circular references. This
        prevents runtime errors in certain cases where types self reference itself through
        a union.

- version: 4.0.0-rc2
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Update .dict calls in Pydantic V2 to be back to pre-3.10.4 logic for SDKs that continue using Pydantic aliases.

- version: 4.0.0-rc1
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Update .dict calls in Pydantic V2 to be back to pre-3.10.4 logic.
      fixed:
        - >-
          Pydantic V2 `.dict` calls are updated to be back to pre-3.10.4 logic.
          This is fix a regression where nested literals were being omitted due to the Pydantic V2 serializers not respecting the recursive .dict logic, as
          Pydantic V2 shells out `model_dump` calls to Rust library and serializers, as opposed to recursively calling `model_dump`.

          It is expected that performance will not be degraded given the Rust-based serializers have optimized performance, compared to the Pydantic V1 .dict approach.

- version: 4.0.0-rc0
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Rerelease 3.11.0-rc0 as a major version, with a configuration flag to disable the behavior (`use_pydantic_field_aliases`), defaulted to `true` to preserve existing behavior.
      fixed:
        - >-
          Rerelease 3.11.0-rc0 as a major version, with a configuration flag to
          disable the behavior (`use_pydantic_field_aliases`), defaulted to `false`
          to introduce the break on a major version.

          To maintain parity with pre-3.11.0 behavior, update the flag to `true`:

            ```yaml
            - name: fernapi/fern-python-sdk
              version: 4.0.0-rc0
              config:
                pydantic_config:
                  use_pydantic_field_aliases: true
            ```
    - type: internal
      summary: The generator now shares "as is" files with Pydantic and FastAPI generators.

- version: 3.11.0-rc0
  irVersion: 53
  changelogEntry:
    - type: chore
      summary: Remove Pydantic field aliases and leverage an internal representation.
      fixed:
        - >-
          Pydantic field aliases are removed and replaced with an internal
          representation. This allows for more robust handling of field aliases
          and prevents issues with Pydantic V2 and mypy.

          Previously, you'd have for V1 and V2 compatibility in Pydantic, you'd want to conditionally apply the config class within
          the base model, however this would lead to mypy errors when filling out a model with it's field alias. To solve this, We
          used the deprecated `class Config`, regardless of the Pydantic version to satisfy mypy, which lead to warnings in the console.

          Now, we've removed the field aliases and replaced them with an internal representation, which allows us to avoid pydantic config altogether.

- version: 3.10.8
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Allow for fields prefixed with the name `model`, a silent break introduced in Pydantic V2.

- version: 3.10.7
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: When not leveraging mock integration tests, still run pytest over everything, not a specific directory.

# ===== Migrated versions =====

# TODO: It'd be great if we generated YAML schemas so people had validation on these files
- version: 3.10.6
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Pagination utilities assume `""` is a terminal signal for pagination.
      fixed:
        - >-
          Cursor-based pagination also assumes `""` is a terminal signal for
          pagination, same as if the next cursor were `None`.
  # This field is optional and can be omitted outside of the backfilling usecase
  # here it will default to the day the record was written to the DB
  createdAt: "2024-08-16"

- version: 3.10.3
  createdAt: "2024-08-16"
  irVersion: 53
  changelogEntry:
    - type: fix
      summary: Upgrade intermediate representation dependency to safely parse null unknown types.

- version: 3.10.4
  createdAt: "2024-08-14"
  changelogEntry:
    - type: chore
      summary: Improve performance of Pydantic `.dict` calls
      changed:
        - "`.dict` performance is improved, consolidating to a single call to Pydantic's `.dict` instead of 2 in attempts to remove unset optional values."
  irVersion: 53

- version: 3.10.3
  createdAt: "2024-08-14"
  changelogEntry:
    - type: fix
      summary: Query encoding now appropriately takes arrays of deep objects into account.
  irVersion: 53

- version: 3.10.2
  createdAt: "2024-08-13"
  changelogEntry:
    - type: fix
      summary: Unions with utils now update forward refs again, a regression that was introduced in version 3.7.0
  irVersion: 53

- version: 3.10.1
  createdAt: "2024-08-13"
  changelogEntry:
    - type: fix
      summary: If there are no autogenerated examples present, the Python SDK generator no longer fails.
  irVersion: 53

- version: 3.10.0
  createdAt: "2024-08-09"
  changelogEntry:
    - type: feat
      summary: Introduce forward compatible Python enums
      added:
        - >-
          Adds a new flag to generate forward compatible Python enums, as opposed
          to leveraging raw string enums as literals. This works through addding
          an "_UNKNOWN" member to your enum set, the value of which is the raw
          value of the unrecognized enum.
  irVersion: 53

- version: 3.9.0
  createdAt: "2024-08-09"
  changelogEntry:
    - type: feat
      summary: Introduce Pythonic naming for discriminated union members through `union_naming` configuration flag.
      added:
        - >-
          A new configuration is introduced to make discriminated union member
          naming more Pythonic. With V1 union naming, member names change from
          `<UnionName>_<DiscriminantValue>` to `<DiscriminantValue><UnionName>`.
          Concretely, union members previously named `Chat_User` will now be named
          `UserChat` under the new configuration.
  irVersion: 53

- version: 3.8.0
  createdAt: "2024-08-09"
  changelogEntry:
    - type: chore
      summary: Generated SDKs now use ruff for linting and formatting instead of Black.
  irVersion: 53

- version: 3.7.0
  createdAt: "2024-08-08"
  changelogEntry:
    - type: chore
      summary: Python circular referencing types are more robust.
  irVersion: 53

- version: 3.6.0
  createdAt: "2024-08-08"
  changelogEntry:
    - type: feat
      summary: The generator now respects returning nested properties from the returned object
  irVersion: 53

- version: 3.5.1
  createdAt: "2024-08-05"
  changelogEntry:
    - type: fix
      summary: Auto-completion for unions leveraging union utils now works as expected.
      fixed:
        - >-
          The root type for unions with visitors now has it's parent typed
          correctly. This allows auto-complete to work once again on the union
          when it's nested within other pydantic models.
  irVersion: 53

- version: 3.5.0
  createdAt: "2024-08-05"
  changelogEntry:
    - type: chore
      summary: Generated code now respects the pydantic version configuration flag.
      changed:
        - >-
          Improvement: The generated SDK now respects the pydantic version flag,
          generating V1 only code and V2 only code if specified. If not, the SDK
          is generated as it is today, with compatibility for BOTH Pydantic
          versions. This cleans up the generated code, and brings back features
          liked wrapped aliases for V1-only SDKs.
  irVersion: 53

- version: 3.4.2
  createdAt: "2024-08-05"
  changelogEntry:
    - type: fix
      summary: The Python generator now instantiates `Any` types as `Optional[Any]` to be able to mitigate breaks in Pydantic V2.
  irVersion: 53

- version: 3.4.1
  createdAt: "2024-08-04"
  changelogEntry:
    - type: chore
      summary: Literal templates are generated if they are union members
  irVersion: 53

- version: 3.4.0
  createdAt: "2024-08-02"
  changelogEntry:
    - type: internal
      summary: Generator code now uses Pydantic V2, no changes to generated code.
      changed:
        - >-
          Internal: The SDK generator has now been upgraded to use Pydantic V2
          internally. Note that there is no change to the generated code, however
          by leveraging Pydantic V2 you should notice an improvement in `fern
          generate` times.
  irVersion: 53

- version: 3.3.4
  createdAt: "2024-08-02"
  changelogEntry:
    - type: chore
      summary: Address a number of issues within generated unit tests.
      changed:
        - >-
          Improvement: Aliased literals are also defaulted within Pydantic models,
          whereas previously only direct literals were defaulted.
        - >-
          Improvement: Snippets now provide optional literals in functions and
          models.
      fixed:
        - >-
          Generated tests that expect an empty result when they are of type `text`
          (not JSON) now appropriately expect an empty string instead of `None`.
  irVersion: 53

- version: 3.3.3
  createdAt: "2024-08-02"
  changelogEntry:
    - type: fix
      summary: The generator now allows you to extend aliased types (as long as they're objects).
  irVersion: 53

- version: 3.3.2
  createdAt: "2024-08-02"
  changelogEntry:
    - type: fix
      summary: Regression in readme generation introduced in 3.3.1
  irVersion: 53

- version: 3.3.1
  createdAt: "2024-08-02"
  changelogEntry:
    - type: fix
      summary: Generated READMEs now reference RequestOptions as TypedDicts correctly.
  irVersion: 53

- version: 3.3.0-rc1
  createdAt: "2024-08-01"
  changelogEntry:
    - type: fix
      summary: TypedDict snippets now include literals where available.
  irVersion: 53

- version: 3.3.0-rc0
  createdAt: "2024-07-31"
  changelogEntry:
    - type: internal
      summary: Upgrade to IR 53.1.0
      changed:
        - "Upgrade to IR 53.1.0"
        - The Python generator now creates snippet templates for undiscriminated unions.
  irVersion: 53

- version: 3.2.0-rc1
  createdAt: "2024-07-29"
  changelogEntry:
    - type: fix
      summary: The generated README now imports `ApiError` as if it were from outside the module.
  irVersion: 49

- version: 3.2.0-rc0
  createdAt: "2024-07-25"
  changelogEntry:
    - type: feat
      summary: The Python SDK can now be generated with TypedDicts as inputs.
      added:
        - >-
          The Python SDK can now be generated such that inputs to requests are
          TypedDicts, instead of Pydantic models. This allows for consumers of the
          SDK to continue to have type hinting and autocomplete, but not need to
          import new object types when creating requests.
  irVersion: 49

- version: 3.1.0-rc0
  createdAt: "2024-07-24"
  changelogEntry:
    - type: chore
      summary: The root client is now exported from the main `__init__.py`.
      changed:
        - >-
          Improvement: The root client users interact with is now exported from
          the main `__init__.py`, this allows users to access the client via `from
          my_sdk import my_sdk_client` as opposed to `from my_sdk.client import
          my_sdk_client`.
      removed:
        - >-
          Note this comes with an edge-case break. In the unlikely event you have
          a type that conflicts in naming with the exported root client, that type
          model is post-fixed with "Model". e.g. a type `Merge` in an SDK
          exporting a client `Merge` becomes `MergeModel`.
  irVersion: 49

- version: 3.0.0-rc2
  createdAt: "2024-07-24"
  changelogEntry:
    - type: fix
      summary: "`update_forward_refs` no longer raises errors, preserving original behavior, pre-3.x."
  irVersion: 49

- version: 3.0.0-rc1
  createdAt: "2024-07-23"
  changelogEntry:
    - type: fix
      summary: "`expected_types` within our test suite are now typed as `Tuple[typing.Any, typing.Any]`."
      fixed:
        - >-
          Sometimes mypy will error on the typing of `expected_types` within our
          test suite, despite them being labeled as `typing.Any`. This updates the
          types for tuples to `typing.Tuple[tying.Any, typing.Any]` to appease
          mypy.
  irVersion: 49

- version: 3.0.0-rc0
  createdAt: "2024-07-23"
  changelogEntry:
    - type: break
      summary: The generated models now support Pydantic V2 outright, it no longer uses `pydantic.v1` models.
      changed:
        - The generated models now support Pydantic V2 outright, it no longer uses `pydantic.v1` models.
        - Public fields previously prefixed with `_` are now prefixed with `f_` (Pydantic V2 does not allow for `_` prefixes on public fields and Python does not allow for a numeric prefix)
      removed:
        - wrapped aliases outside of Pydantic V1
        - custom root validators outside of Pydantic V1
  irVersion: 49

- version: 2.16.0
  createdAt: "2024-07-16"
  changelogEntry:
    - type: feat
      summary: The generated SDK now allows for specifying whether or not to generate `streaming` functions as overloaded functions or separate functions.
  irVersion: 49

- version: 2.15.6
  createdAt: "2024-07-17"
  changelogEntry:
    - type: fix
      summary: The generated python SDK now requires an environment be specified if a default is not provided.
  irVersion: 49

- version: 2.15.5
  createdAt: "2024-07-17"
  changelogEntry:
    - type: fix
      summary: The generated python SDK Oauth client now no longer checks for an expiry when getting the access token if an expiry field is not configured.
  irVersion: 49

- version: 2.15.4
  createdAt: "2024-07-10"
  changelogEntry:
    - type: fix
      summary: The generated python SDK now serializes bytes within JSON as a utf-8 encoded string.
  irVersion: 49

- version: 2.15.3
  createdAt: "2024-07-10"
  changelogEntry:
    - type: fix
      summary: The generated python SDK no longer runs into a recursion error during snippet generation.
  irVersion: 49

- version: 2.15.2
  createdAt: "2024-07-10"
  changelogEntry:
    - type: fix
      summary: The generated python SDK no longer treats `set` as a reserved word for method names.
  irVersion: 49

- version: 2.15.1
  createdAt: "2024-07-09"
  changelogEntry:
    - type: fix
      summary: The unchecked base model no longer coerces None to a type.
      fixed:
        - The unchecked base model no longer coerces None to a type.
        - >-
          The http client appropriately defaults empty fields within
          RequestOptions.
  irVersion: 49

- version: 2.15.0
  createdAt: "2024-07-03"
  changelogEntry:
    - type: feat
      summary: The generated python SDK now respects configured defaults from the API spec.
  irVersion: 49

- version: 2.14.1
  createdAt: "2024-07-01"
  changelogEntry:
    - type: fix
      summary: typing within the Sync and AsyncPagers is now correctly passed through to the BasePager.
      fixed:
        - >-
          Sync and AsyncPage now pass through the generic type to BasePage,
          allowing the use of `.items`, etc. to be appropriately typed within your
          type checking system.
  irVersion: 49

- version: 2.14.0
  createdAt: "2024-07-01"
  changelogEntry:
    - type: fix
      summary: The offset page now allows for the usage of 0 as a page start.
      fixed:
        - >-
          offset page now allows for the usage of 0 as a page start, previously
          the use of `page or 1` made Python coerce booleans and become 1,
          ignoring the user-provided 0.
  irVersion: 49

- version: 2.14.0-rc3
  createdAt: "2024-07-01"
  changelogEntry:
    - type: feat
      summary: Generated readmes now include an "advanced" section.
      changed:
        - >-
          Generated readmes now include an "advanced" section,
          outlining usage of retries, timeouts, error handling and usage of a
          custom client.
  irVersion: 49

- version: 2.14.0-rc2
  createdAt: "2024-07-01"
  changelogEntry:
    - type: chore
      summary: Async snippets now run the async function leveraging asyncio.run to be more copy-pastable.
  irVersion: 49

- version: 2.14.0-rc1
  createdAt: "2024-06-27"
  changelogEntry:
    - type: fix
      summary: The fix from 2.5.2 is now case-insensitive
      fixed:
        - >-
          the fix from 2.5.2 is now case-insensitive Recap of 2.5.2: `Fix: Support
          `list`SDK method names instead of defaulting to`list\_`.`
  irVersion: 49

- version: 2.14.0-rc0
  createdAt: "2024-06-26"
  changelogEntry:
    - type: feat
      summary: The Python SDK now generates an accompanying SDK reference (`reference.md`) for users to review the SDK methods at a glance within the SDK's GitHub repository.
  irVersion: 49

- version: 2.13.1-rc0
  createdAt: "2024-06-20"
  changelogEntry:
    - type: fix
      summary: The Python SDK now does not send additional properties via JSON or data if the request is leveraging the other field.
      fixed:
        - >-
          the Python SDK now does not send additional properties via JSON or data
          if the request is leveraging the other field.
      changed:
        - >-
          Improvement: the Python SDK now copies unit tests over to the generated
          SDK for additional unit testing (separate from wire-format testing).
  irVersion: 49

- version: 2.13.0-rc0
  createdAt: "2024-06-20"
  changelogEntry:
    - type: internal
      summary: The Python SDK generator is now upgraded to IR V49.
  irVersion: 49

- version: 2.12.0-rc0
  createdAt: "2024-06-25"
  changelogEntry:
    - type: feat
      summary: README generation now supports a section dedicated to streaming usage, as well as one for paginated endpoints.
      added:
        - >-
          Feature: README generation now supports a section dedicated to streaming
          usage, as well as one for paginated endpoints.
      changed:
        - "Improvement: Paginated endpoint snippets now show using an iterator:"
  irVersion: 49

- version: 2.11.0-rc0
  createdAt: "2024-06-25"
  changelogEntry:
    - type: chore
      summary: Snippet templates now support auth variables within the root client.
      changed:
        - >-
          Improvement: The SDK now produces templates for the root clients within
          snippet-template.json. This allows users of the Templates API to pass in
          data for the auth variables present within the root client.
  irVersion: 49

- version: 2.10.2
  createdAt: "2024-06-20"
  changelogEntry:
    - type: fix
      summary: The SDK now handles stream termination sequences like `[DONE]`.
      fixed:
        - >-
          The SDK now handles stream termination sequences like `[DONE]`. This is
          a typical way for LLM providers to communicate when the stream has
          ended.
  irVersion: 46

- version: 2.10.1
  createdAt: "2024-06-20"
  changelogEntry:
    - type: fix
      summary: Improve the SDK to not leak `JSONDecodeError` to SDK users. Instead, an `ApiError` will be thrown with the text content of the response.
  irVersion: 46

- version: 2.10.0
  createdAt: "2024-06-20"
  changelogEntry:
    - type: feat
      summary: Add support for higher quality `README.md` generation.
  irVersion: 46

- version: 2.9.10
  createdAt: "2024-06-20"
  changelogEntry:
    - type: fix
      summary: The generator now only specifies the readme location within pyproject.toml if one was successfully created.
  irVersion: 46

- version: 2.9.9
  createdAt: "2024-06-19"
  changelogEntry:
    - type: internal
      summary: The generator now consumes IRv46.
  irVersion: 46

- version: 2.9.8
  createdAt: "2024-06-18"
  changelogEntry:
    - type: chore
      summary: The python generator only adds a publish step in github actions if credentials are specified.
  irVersion: 39

- version: 2.9.7
  createdAt: "2024-06-12"
  changelogEntry:
    - type: fix
      summary: The unchecked base model stops special casing defaults and pydantic v2.
  irVersion: 39

- version: 2.9.6
  createdAt: "2024-06-11"
  changelogEntry:
    - type: fix
      summary: Offset based pagination is now 1-based, as opposed to 0 based
      fixed:
        - Offset based pagination is now 1-based, as opposed to 0 based
        - >-
          The HTTP client now passes in additional body properties from the
          request options, even if the body is empty (regression from the client
          migration in 2.8.0)
  irVersion: 39

- version: 2.9.5
  createdAt: "2024-06-10"
  changelogEntry:
    - type: fix
      summary: Unions with elements that specify no properties are generated correctly.
      fixed:
        - Unions with elements that specify no properties are generated correctly.
        - >-
          Unions with a single type now have a valid type alias (rather than an
          invalid `typing.Union`).
  irVersion: 39

- version: 2.9.4
  createdAt: "2024-06-07"
  changelogEntry:
    - type: fix
      summary: The unchecked base model now handles pulling the discriminant from a dict, not just a model/object.
  irVersion: 39

- version: 2.9.3
  createdAt: "2024-06-06"
  changelogEntry:
    - type: fix
      summary: Snippet templates for discriminated unions now specify the `template_input` property which is required to actually see snippets of instantiating discriminated unions.
  irVersion: 39

- version: 2.9.2
  createdAt: "2024-06-06"
  changelogEntry:
    - type: fix
      summary: downgrades mypy so we can run it over all our files without concern for their pydantic bug
      fixed:
        - >-
          downgrades mypy so we can run it over all our files without concern for
          their pydantic bug
        - adds typehint to the response variable
  irVersion: 39

- version: 2.9.1
  createdAt: "2024-06-06"
  changelogEntry:
    - type: fix
      summary: The SDK removes unset query parameters from requests (regression from the client migration in 2.8.0)
      fixed:
        - >-
          The SDK removes unset query parameters from requests (regression from
          the client migration in 2.8.0)
        - >-
          The SDK fixes it's type for `files` parameters to the http client
          (regression from the client migration in 2.8.0)
  irVersion: 39

- version: 2.9.0
  createdAt: "2024-06-05"
  changelogEntry:
    - type: fix
      summary: Snippets preserve trailing slashes
  irVersion: 39

- version: 2.9.0-rc1
  createdAt: "2024-06-05"
  changelogEntry:
    - type: fix
      summary: The new http client abstraction ensures a slash is postfixed to the baseurl
  irVersion: 39

- version: 2.9.0-rc0
  createdAt: "2024-06-04"
  changelogEntry:
    - type: chore
      summary: The Python generator now runs custom unit tests in CI if configured.
  irVersion: 39

- version: 2.8.2
  createdAt: "2024-06-04"
  changelogEntry:
    - type: fix
      summary: The none-filtering function now supports mypy's invariance check.
  irVersion: 39

- version: 2.8.1
  createdAt: "2024-06-04"
  changelogEntry:
    - type: fix
      summary: The parameter comment/documentation for timeouts on the root client now reflects the custom timeout passed through within configuration.
  irVersion: 39

- version: 2.8.0
  createdAt: "2024-06-03"
  changelogEntry:
    - type: chore
      summary: >-
        Endpoint function request logic has been abstracted into
        the request function of the wrapped httpx client.
  irVersion: 39

- version: 2.7.0
  createdAt: "2024-05-30"
  changelogEntry:
    - type: internal
      summary: >-
        Improvement: The generator now outputs an `exampleId` alongside each
        generated snippet so that we can correlate snippets with the relevant
        examples. This is useful for retrieving examples from Fern's API and
        making sure that you can show multiple snippets in the generated docs.
  irVersion: 39

- version: 2.6.1
  createdAt: "2024-05-31"
  changelogEntry:
    - type: internal
      summary: >-
        this adds a back door token getter function to OAuth clients to better
        test the functionality.
  irVersion: 39

- version: 2.6.0
  createdAt: "2024-05-30"
  changelogEntry:
    - type: chore
      summary: Support adding optional dependencies and extras to your generated `pyproject.toml`.
      changed:
        - >-
          Improvement: Support adding optional dependencies and extras to your
          generated `pyproject.toml`. To use this configuration, please add the
          following:
  irVersion: 39

- version: 2.5.7
  createdAt: "2024-05-30"
  changelogEntry:
    - type: fix
      summary: tests now carry a type annotation for `expected_types` variable.
  irVersion: 39

- version: 2.5.6
  createdAt: "2024-05-29"
  changelogEntry:
    - type: chore
      summary: >-
        Literal values are now all defaulted such that users are
        not required to plug in a redundant value.
  irVersion: 39

- version: 2.5.5
  createdAt: "2024-05-29"
  changelogEntry:
    - type: fix
      summary: Auto-Pagination now respects optional return values
      fixed:
        - >-
          Optional lists returned from pagination endpoints are now appropriately
          flattened such that the `Pager` return types are correctly
          `Pager[ListItem]` as opposed to `Pager[List[ListItem]]`.
  irVersion: 39

- version: 2.5.4
  createdAt: "2024-05-28"
  changelogEntry:
    - type: internal
      summary: Add typing library for dateutils in testing lib to satisfy mypy errors.
  irVersion: 39

- version: 2.5.3
  createdAt: "2024-05-24"
  changelogEntry:
    - type: chore
      summary: Stops specifying custom licenses manually, lets poetry handle adding them.
  irVersion: 39

- version: 2.5.2
  createdAt: "2024-05-23"
  changelogEntry:
    - type: feat
      summary: Support `list` SDK method names instead of defaulting to `list_`.
  irVersion: 39

- version: 2.5.1-rc0
  createdAt: "2024-05-23"
  changelogEntry:
    - type: fix
      summary: Literal parameters are added back to the request body.
  irVersion: 39

- version: 2.5.0-rc2
  createdAt: "2024-05-23"
  changelogEntry:
    - type: fix
      summary: Do not attempt to run `fern test` in CI until the command is more widely rolled out.
  irVersion: 39

- version: 2.5.0-rc1
  createdAt: "2024-05-22"
  changelogEntry:
    - type: chore
      summary: Address `propogate` -> `propagate` typo in python codegen.
  irVersion: 39

- version: 2.5.0-rc0
  createdAt: "2024-05-22"
  changelogEntry:
    - type: fix
      summary: This version addresses issues in unit test generation and reenables the creation of unit tests.
  irVersion: 39

- version: 2.4.0-rc0
  createdAt: "2024-05-21"
  changelogEntry:
    - type: fix
      summary: >-
        The Python SDK generator now uses safe names wherever string concat is
        not used (like in client generation naming), so this will update module
        and parameter names.
  irVersion: 39

- version: 2.3.4
  createdAt: "2024-05-21"
  changelogEntry:
    - type: fix
      summary: >-
        Snippets and unit tests now correctly write optional request bodies when
        `inline_request_params` is set to `True`.
      fixed:
        - >-
          Snippets and unit tests now correctly write optional request bodies when
          `inline_request_params` is set to `True`. Previously the generator wrote
          snippets that inlined these parameters, which does not match the
          generated SDK itself.
  irVersion: 39

- version: 2.3.3
  createdAt: "2024-05-21"
  changelogEntry:
    - type: fix
      summary: Inlined body parameters now deconflict in naming with header and query parameters by prefixing the request objects name.
  irVersion: 39

- version: 2.3.2
  createdAt: "2024-05-21"
  changelogEntry:
    - type: fix
      summary: The query encoder now correctly handles none values
      fixed:
        - >-
          The `pyproject.toml` generator now writes authors in a valid format for
          `tool.poetry`, not just `project`
        - The query encoder now correctly handles none values
  irVersion: 39

- version: 2.3.1
  createdAt: "2024-05-21"
  changelogEntry:
    - type: fix
      summary: The `pyproject.toml` generator now includes project URLs when specified.
  irVersion: 39

- version: 2.3.0
  createdAt: "2024-05-21"
  changelogEntry:
    - type: chore
      summary: Users can now specify information that will appear in their pypi record.
  irVersion: 39

- version: 2.2.2
  createdAt: "2024-05-20"
  changelogEntry:
    - type: fix
      summary: Inline request parameters now deconflict in naming with the unnamed path parameter arguments.
      fixed:
        - >-
          Inline request parameters now deconflict in naming with the unnamed path
          parameter arguments. Previously, when inlining request parameters into
          the method signature, we would not deconflict naming with the unnamed
          args preceding them. Now, conflicting unnamed parameters are post-fixed
          with an "_".
  irVersion: 39

- version: 2.2.1
  createdAt: "2024-05-17"
  changelogEntry:
    - type: internal
      summary: The generator now uses the latest FDR SDK.
  irVersion: 39

- version: 2.2.0
  createdAt: "2024-05-16"
  changelogEntry:
    - type: chore
      summary: The generated SDK will now correctly encode deep object query parameters
      changed:
        - >-
          The generated SDK will now correctly encode deep object
          query parameters. For example, if you have an object `{"test":
          {"nested": "object"}}` as a query parameter, we will now encode it as
          `test[nested]=object`.
  irVersion: 39

- version: 2.1.1
  createdAt: "2024-05-15"
  changelogEntry:
    - type: chore
      summary: add enhanced snippet support for streaming endpoints.
  irVersion: 39

- version: 2.1.0
  createdAt: "2024-05-14"
  changelogEntry:
    - type: feat
      summary: Add support for cursor and offset pagination ("auto-pagination").
  irVersion: 39

- version: 2.0.1
  createdAt: "2024-05-14"
  changelogEntry:
    - type: fix
      summary: The python generator now only excludes unset fields that are not required.
      fixed:
        - >-
          the python generator previously used `exclude_unset` on pydantic models,
          however this would remove defaulted values. This change updates this to
          only exclude none fields that were not required.
  irVersion: 39

- version: 2.0.0
  createdAt: "2024-05-09"
  changelogEntry:
    - type: break
      summary: Release of the Python SDK generator version 2, updating default configuration.
      changed:
        - >-
          The python SDK is now on major version 2, there are no
          substantial logic changes, however default configuration has changed. To
          take this upgrade without any breaks, please add the below configuration
          to your `generators.yml` file:
  irVersion: 39

- version: 1.7.0-rc0
  createdAt: "2024-05-09"
  changelogEntry:
    - type: chore
      summary: you can now declare a new python version range for your `pyproject.toml`, which will declare a new version range for your pip package.
  irVersion: 39

- version: 1.6.0-rc0
  createdAt: "2024-05-09"
  changelogEntry:
    - type: chore
      summary: You can now specify dev dependencies from your `generators.yml` file
  irVersion: 39

- version: 1.5.3-rc0
  createdAt: "2024-05-02"
  changelogEntry:
    - type: fix
      summary: the unchecked basemodel no longer tries to dereference an object if it's null.
  irVersion: 39

- version: 1.5.2-rc0
  createdAt: "2024-05-02"
  changelogEntry:
    - type: chore
      summary: The python generator now produces sync snippet templates, as opposed to just async templates as it was before
  irVersion: 39

- version: 1.5.1-rc5
  createdAt: "2024-05-01"
  changelogEntry:
    - type: fix
      summary: Snippet templates now generate the correct imports for object types.
  irVersion: 39

- version: 1.5.1-rc4
  createdAt: "2024-05-01"
  changelogEntry:
    - type: fix
      summary: The SDK now generates discriminated union snippet templates correctly.
  irVersion: 39

- version: 1.5.1-rc3
  createdAt: "2024-05-01"
  changelogEntry:
    - type: chore
      summary: Union types leverage the fern aware base model to include JSON and Dict function overrides.
  irVersion: 39

- version: 1.5.1-rc2
  createdAt: "2024-05-01"
  changelogEntry:
    - type: fix
      summary: The vanilla pydantic base model now respects the `require_optional_fields`
      fixed:
        - >-
          The vanilla pydantic base model now respects the
          `require_optional_fields`, this became a regression in 1.5.1-rc0 when we
          started to inline union properties which leverages the vanilla base
          model.
  irVersion: 39

- version: 1.5.1-rc1
  createdAt: "2024-05-01"
  changelogEntry:
    - type: fix
      summary: Improve formatting within snippet templates.
      fixed:
        - >-
          Address formatting issues with snippet templates, we now strip newlines
          off OG snippets as well as plumb through indentation metadata to places
          that were previously missing it.
  irVersion: 39

- version: 1.5.1-rc0
  createdAt: "2024-04-26"
  changelogEntry:
    - type: fix
      summary: Discriminated union variants that are objects now have inlined properties instead of extending a base type.
  irVersion: 39

- version: 1.5.0-rc0
  createdAt: "2024-04-30"
  changelogEntry:
    - type: feat
      summary: The generator now supports inlining top-level request parameters instead of requiring users create a request object.
  irVersion: 39

- version: 1.4.0
  createdAt: "2024-04-29"
  changelogEntry:
    - type: feat
      summary: keyword arguments are now ordered such that required params are ordered before optional params
      changed:
        - >-
          keyword arguments are now ordered such that required params
          are ordered before optional params. Note that since these are kwargs,
          this is a non-breaking change.
        - "docstrings now match numpydoc/PEP257 format"
  irVersion: 39

- version: 1.4.0-rc3
  createdAt: "2024-04-24"
  changelogEntry:
    - type: fix
      summary: pin mypy dependency to 1.9.0 to prevent introducing upstream bugs
      fixed:
        - >-
          Set `mypy` dev dependency in generated `pyproject.toml` to `1.9.0`. This
          prevents upstream `mypy` bugs from affecting user builds. Note that this
          is only a dev dependency, so it does not affect the behavior of the SDK.
        - Temporarily disable unit test generation.
      changed:
        - "Improvement: Use named parameters for all `httpx` request params."
  irVersion: 39

- version: 1.4.0-rc2
  createdAt: "2024-04-23"
  changelogEntry:
    - type: fix
      summary: Initialize the OAuth token provider member variables to their default values before they are set.
  irVersion: 39

- version: 1.4.0-rc1
  createdAt: "2024-04-22"
  changelogEntry:
    - type: feat
      summary: The python SDK generator now supports OAuth client generation for the client-credentials flow.
  irVersion: 39

- version: 1.4.0-rc0
  createdAt: "2024-04-22"
  changelogEntry:
    - type: chore
      summary: Generated clients now follow redirects by default.
      changed:
        - >-
          Default generated clients to follow redirects by default, this
          effectively flips the `follow_redirects_by_default` flag to `True` and
          can be reverted with the following configuration:
  irVersion: 38

- version: 1.3.1-rc0
  createdAt: "2024-04-22"
  changelogEntry:
    - type: fix
      summary: the python SDK generator now checks to make sure a header is not null before casting it to a string.
  irVersion: 38

- version: 1.3.0-rc1
  createdAt: "2024-04-22"
  changelogEntry:
    - type: internal
      summary: add logging for python snippet template generation.
  irVersion: 38

- version: 1.3.0-rc0
  createdAt: "2024-04-21"
  changelogEntry:
    - type: feat
      summary: "Beta: The generator now registers snippet templates which can be used for dynamic SDK code snippet generation."
  irVersion: 38

- version: 1.2.0-rc2
  createdAt: "2024-04-10"
  changelogEntry:
    - type: fix
      summary: The generator now correctly imports `json` when deserializing server sent events.
  irVersion: 38

- version: 1.2.0-rc0
  createdAt: "2024-04-10"
  changelogEntry:
    - type: internal
      summary: Consume IR v38
      added:
        - >-
          The generator now depends on v38 of Intermediate Representation which
          requires the latest CLI. As part of this, the generator now supports
          server sent events using `httpx-sse`.
  irVersion: 38

- version: 1.1.0-rc3
  createdAt: "2024-04-04"
  changelogEntry:
    - type: fix
      summary: The skip validation code now works as expected.
      fixed:
        - >-
          There are a number of fixes to the skip validation code as well as tests
          to reflect those updates.
  irVersion: 37

- version: 1.1.0-rc2
  createdAt: "2024-04-04"
  changelogEntry:
    - type: fix
      summary: The generator now writes the skipped-validation `cast` with a suffixing new line so that the code compiles.
  irVersion: 37

- version: 1.1.0-rc1
  createdAt: "2024-04-04"
  changelogEntry:
    - type: fix
      summary: The generator no longer attempts to create a version file if Fern does not own generating the full package (e.g. in local generation).
      fixed:
        - >-
          The generator no longer attempts to create a version file if Fern does
          not own generating the full package (e.g. in local generation). It's too
          confusing for to make the relevant changes to the package set up, and is
          also arguably not even needed in local generation.
  irVersion: 37

- version: 1.1.0-rc0
  createdAt: "2024-04-03"
  changelogEntry:
    - type: feat
      summary: The python SDK now includes a configuration option to skip pydantic validation.
      added:
        - >-
          [EXPERIMENTAL]: The python SDK now includes a configuration
          option to skip pydantic validation. This ensures that Pydantic does not
          immediately fail if the model being returned from an API does not
          exactly match the Pydantic model. This is meant to add flexibility,
          should your SDK fall behind your API, but should be used sparingly, as
          the type-hinting for users will still reflect the Pydantic model
          exactly.
  irVersion: 37

- version: 1.0.1
  createdAt: "2024-04-03"
  changelogEntry:
    - type: fix
      summary: Address Pydantic break when introducing `pydantic.v1` import within Pydantic V1
      fixed:
        - >-
          Pydantic introduced a "break" to their 1.x libs by adding in a .v1
          submodule that does not mirror the one that comes with pydantic v2. To
          get around this we now force the usage of the v1 submodule only if the
          pydantic version is v2.
  irVersion: 37

- version: 1.0.0
  createdAt: "2024-04-02"
  changelogEntry:
    - type: break
      summary: The python SDK now defaults new (breaking configuration) to introduce general improvements.
      changed:
        - >-
          Break: The python SDK now defaults new (breaking configuration) to
          introduce general improvements.
        - >-
          Improvement: The python SDK now supports specifying whether or not to
          follow redirects in requests by default, and exposes an option to
          override that functionality for consumers.
  irVersion: 37

- version: 0.13.4
  createdAt: "2024-04-03"
  changelogEntry:
    - type: fix
      summary: revert changes introduced within 0.12.2
      fixed:
        - >-
          revert the change from 0.13.2, the stream call returns a context
          manager, which is not awaited. The issue that this was meant to solve
          was actually fixed in version `0.12.2`.
  irVersion: 37

- version: 0.13.3
  createdAt: "2024-03-28"
  changelogEntry:
    - type: fix
      summary: Github workflows for publishing now work again (previously the trigger was incorrect).
  irVersion: 37

- version: 0.13.2
  createdAt: "2024-03-28"
  changelogEntry:
    - type: fix
      summary: Asynchronous calls to `httpx.stream` are now awaited. This is applicable to any file download or JSON streaming (chat completion) endpoints.
  irVersion: 37

- version: 0.13.1
  createdAt: "2024-03-26"
  changelogEntry:
    - type: feat
      summary: discriminant values in unions are now defaulted such that callers no longer need to specify the discriminant
  irVersion: 37

- version: 0.13.0
  createdAt: "2024-03-25"
  changelogEntry:
    - type: feat
      summary: the python SDK now exposes it's version through `__version__` to match module standards and expectations.
  irVersion: 37

- version: 0.12.5
  createdAt: "2024-03-22"
  changelogEntry:
    - type: fix
      summary: the python SDK uses the timeout provided to the top level client as the default per-request
      fixed:
        - >-
          the python SDK uses the timeout provided to the top level client as the
          default per-request, previously if there was no timeout override in the
          RequestOptions, we'd default to 60s, even if a timeout was provided at
          the client level.
  irVersion: 37

- version: 0.12.4
  createdAt: "2024-03-19"
  changelogEntry:
    - type: chore
      summary: Allow full forward compat with enums while keeping intellisense by unioning enum literals with `typing.AnyStr`.
  irVersion: 37

- version: 0.12.3
  createdAt: "2024-03-18"
  changelogEntry:
    - type: feat
      summary: Allow bytes requests to take in iterators of bytes, mirroring the types allowed by HTTPX.
  irVersion: 37

- version: 0.12.2
  createdAt: "2024-03-18"
  changelogEntry:
    - type: fix
      summary: Fix the returned type and value contained within the retrying wrapper for the HTTPX client (http_client.py).
  irVersion: 37

- version: 0.12.1
  createdAt: "2024-03-14"
  changelogEntry:
    - type: chore
      summary: Improves example generation and snippets for union types, as well as multi-url environments.
      changed:
        - >-
          Improves example generation and snippets for union types, as well as
          multi-url environments.
      fixed:
        - >-
          Stringifies header arguments, HTTPX was previously hard failing for
          certain types
  irVersion: 37

- version: 0.12.0
  createdAt: "2024-03-11"
  changelogEntry:
    - type: feat
      summary: Auto-generated unit and integration tests against a mock server.
      added:
        - >-
          Beta: The SDK now generates tests leveraging auto-generated
          data to test typing, as well as wire-formatting (e.g. the SDKs are
          sending and receiving data as expected). This comes out of the box
          within the generated github workflow, as well as through the fern cli:
          `fern test --command "your test command"`.
  irVersion: 37

- version: 0.11.10
  createdAt: "2024-03-08"
  changelogEntry:
    - type: feat
      summary: Expose a feature flag to pass through additional properties not specified within your pydantic model from your SDK.
      added:
        - >-
          Expose a feature flag to pass through additional properties not
          specified within your pydantic model from your SDK. This allows for
          easier forward compatibility should your SDK drift behind your spec.
  irVersion: 36

- version: 0.11.9
  createdAt: "2024-03-04"
  changelogEntry:
    - type: chore
      summary: use docstrings instead of Pydantic field descriptions.
  irVersion: 36

- version: 0.11.8-rc1
  createdAt: "2024-03-02"
  changelogEntry:
    - type: feat
      summary: Introduces a `max_retries` parameter to the RequestOptions dict accepted by all requests.
      changed:
        - >-
          Beta: Introduces a `max_retries` parameter to the
          RequestOptions dict accepted by all requests. This parameter will retry
          requests automatically, with exponential backoff and a jitter. The
          client will automatically retry requests of a 5XX status code, or
          certain 4XX codes (429, 408, 409).
  irVersion: 36

- version: 0.11.8-rc0
  createdAt: "2024-02-27"
  changelogEntry:
    - type: feat
      summary: introduces additional configuration to customize the client class and file name.
      changed:
        - >-
          Beta: Introduce a `client` custom config that allows you to specify
          class_name and filename for the client. This configuration can be used
          in several ways:
  irVersion: 36

- version: 0.11.7
  createdAt: "2024-02-27"
  changelogEntry:
    - type: feat
      summary: Introduces a flag `use_str_enums` to swap from using proper Enum classes to using Literals to represent enums.
      changed:
        - >-
          Introduces a flag `use_str_enums` to swap from using proper
          Enum classes to using Literals to represent enums. This change allows
          for forward compatibility of enums, since the user will receive the
          string back.
  irVersion: 36

- version: 0.11.6
  createdAt: "2024-02-26"
  changelogEntry:
    - type: feat
      summary: You can now specify envvars to scan for headers, not just auth scheme headers.
  irVersion: 36

- version: 0.11.5
  createdAt: "2024-02-23"
  changelogEntry:
    - type: fix
      summary: Fix the usage of ApiError when leveraging auth envvars, when the schema for ApiError was changed, this usage was missed in the update.
  irVersion: 34

- version: 0.11.4
  createdAt: "2024-02-23"
  changelogEntry:
    - type: fix
      summary: We now grab enum values appropriately when enums are within unions.
  irVersion: 34

- version: 0.11.3
  createdAt: "2024-02-22"
  changelogEntry:
    - type: fix
      summary: Transition from lists to sequences within function calls
      fixed:
        - >-
          Transition from lists to sequences within function calls, this is a fix
          as a result of how mypy handles type variance. This fix is only for
          function calls as testing shows that we do not hit the same issue within
          mypy with list[union[*]] fields on pydantic objects.
      changed:
        - >-
          Improvement: The Python SDK generator now defaults to
          `require_optional_fields = False`. This means that any requests that
          have optional fields no longer require a user to input data (or a `None`
          value) in.
  irVersion: 34

- version: 0.11.2
  createdAt: "2024-02-21"
  changelogEntry:
    - type: feat
      summary: introduce configuration to flatten the directory structure
      changed:
        - >-
          Improvement (Beta): The Python generator now supports a configuration
          option called `improved_imports`.
  irVersion: 34

- version: 0.11.1
  createdAt: "2024-02-20"
  changelogEntry:
    - type: feat
      summary: Python now supports specifying files to auto-export from the root `__init__.py` file
      changed:
        - >-
          Python now supports specifying files to auto-export from
          the root `__init__.py` file, this means you can export custom classes
          and functions from your package for users to access like so:
        - "Add a docstring for base clients to explain usage, example:"
  irVersion: 34

- version: 0.11.0
  createdAt: "2024-02-19"
  changelogEntry:
    - type: feat
      summary: Python now supports a wider range of types for file upload
      changed:
        - >-
          Python now supports a wider range of types for file upload,
          mirroring the `httpx` library used under the hood, these are grouped
          under a new type `File`:
      fixed:
        - >-
          Python now supports API specifications that leverage lists for file
          upload. Previously, Fern incorrectly made all `list<file>` type requests
          simply `file`.
  irVersion: 34

- version: 0.10.3
  createdAt: "2024-02-19"
  changelogEntry:
    - type: fix
      summary: Several bugfixes were made to related to literal properties
      fixed:
        - >-
          Several bugfixes were made to related to literal properties. If a
          literal is used as a query parameeter, header, path parameter, or
          request parameter, the user no longer has to explicitly pass it in.
  irVersion: 31

- version: 0.10.2
  createdAt: "2024-02-18"
  changelogEntry:
    - type: fix
      summary: The SDK always sends the enum wire value instead of the name of the enum.
      fixed:
        - >-
          The SDK always sends the enum wire value instead of the name of the
          enum.
        - >-
          Revert #2719 which introduced additional issues with circular references
          within our Python types.
  irVersion: 31

- version: 0.10.1
  createdAt: "2024-02-14"
  changelogEntry:
    - type: feat
      summary: Add support for a RequestOptions object for each generated function within Python SDKs
      changed:
        - >-
          Add support for a RequestOptions object for each generated
          function within Python SDKs. This parameter is an optional final
          parameter that allows for configuring timeout, as well as pass in
          arbitrary data through to the request. RequestOptions is a TypedDict,
          with optional fields, so there's no need to instantiate an object, just
          pass in the relevant keys within a dict!
  irVersion: 31

- version: 0.10.0
  createdAt: "2024-02-13"
  changelogEntry:
    - type: break
      summary: The generator no longer supports Python 3.7
      removed:
        - The generator no longer supports Python 3.7
        - The `backports` dependency has been removed
  irVersion: 31

- version: 0.9.1
  createdAt: "2024-02-11"
  changelogEntry:
    - type: fix
      summary: Remove literals from SDK function signatures, as they are not modifiable for end users
      fixed:
        - >-
          Remove literals from SDK function signatures, as they are not modifiable
          for end users.
        - >-
          Acknowledge the optionality of a `File` property, previously we were
          requiring all `File` type inputs, even if they were specified as
          optional within the OpenAPI or Fern definition. Now, we check if the
          parameter is required and make the parameter optional if it is not.
  irVersion: 31

- version: 0.9.0
  createdAt: "2024-02-11"
  changelogEntry:
    - type: feat
      summary: The SDK generator now supports whitelabelling
      added:
        - >-
          The SDK generator now supports whitelabelling. When this is turned on,
          there will be no mention of Fern in the generated code.
  irVersion: 31

- version: 0.8.3-rc0
  createdAt: "2024-01-29"
  changelogEntry:
    - type: fix
      summary: Increase recursion depth to allow for highly nested and complex examples
      fixed:
        - >-
          Increase recursion depth to allow for highly nested and complex
          examples, this is a temporary solution while the example datamodel is
          further refined.
  irVersion: 31

- version: 0.8.2-rc0
  createdAt: "2024-01-28"
  changelogEntry:
    - type: fix
      summary: The Python SDK better handles cyclical references
      fixed:
        - >-
          The Python SDK better handles cyclical references. In particular,
          cyclical references are tracked for undiscriminated unions, and
          update_forward_refs is always called with object references.
  irVersion: 31

- version: 0.8.1
  createdAt: "2024-01-26"
  changelogEntry:
    - type: feat
      summary: The generated SDK respects environment variables for authentication if specified
      added:
        - >-
          If the auth scheme has environment variables specified, the generated
          python client will scan those environment variables.
  irVersion: 31

- version: 0.8.0
  createdAt: "2024-01-25"
  changelogEntry:
    - type: fix
      summary: Enums in inlined requests send the appropriate value.
  irVersion: 31

- version: 0.7.7
  createdAt: "2024-01-21"
  changelogEntry:
    - type: internal
      summary: Initialize the changelog
  irVersion: 31