From caea803e4fc873ade6fbc9b9b66ff67938780f65 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 25 Feb 2026 03:57:32 +0000 Subject: [PATCH 01/46] chore(internal): make `test_proxy_environment_variables` more resilient to env --- tests/test_client.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/tests/test_client.py b/tests/test_client.py index 071a7bc..61e5adb 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -927,8 +927,14 @@ def retry_handler(_request: httpx.Request) -> httpx.Response: def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None: # Test that the proxy environment variables are set correctly monkeypatch.setenv("HTTPS_PROXY", "https://example.org") - # Delete in case our environment has this set + # Delete in case our environment has any proxy env vars set monkeypatch.delenv("HTTP_PROXY", raising=False) + monkeypatch.delenv("ALL_PROXY", raising=False) + monkeypatch.delenv("NO_PROXY", raising=False) + monkeypatch.delenv("http_proxy", raising=False) + monkeypatch.delenv("https_proxy", raising=False) + monkeypatch.delenv("all_proxy", raising=False) + monkeypatch.delenv("no_proxy", raising=False) client = DefaultHttpxClient() @@ -1821,8 +1827,14 @@ async def test_get_platform(self) -> None: async def test_proxy_environment_variables(self, monkeypatch: pytest.MonkeyPatch) -> None: # Test that the proxy environment variables are set correctly monkeypatch.setenv("HTTPS_PROXY", "https://example.org") - # Delete in case our environment has this set + # Delete in case our environment has any proxy env vars set monkeypatch.delenv("HTTP_PROXY", raising=False) + monkeypatch.delenv("ALL_PROXY", raising=False) + monkeypatch.delenv("NO_PROXY", raising=False) + monkeypatch.delenv("http_proxy", raising=False) + monkeypatch.delenv("https_proxy", raising=False) + monkeypatch.delenv("all_proxy", raising=False) + monkeypatch.delenv("no_proxy", raising=False) client = DefaultAsyncHttpxClient() From 39d55bd0441b3ab5220f130abd12dad63adecef2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 25 Feb 2026 21:27:10 +0000 Subject: [PATCH 02/46] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 2702d73..3004020 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 7 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer%2Funlayer-48f00d1c04c23fb4d1cb7cf4af4f56b0c920d758c1f06e06e5373e5b15e9c27d.yml openapi_spec_hash: 6ee2a94bb9840aceb4a6161c724ce46c -config_hash: 249869757b6eb98ae3d58f2a47ce21e2 +config_hash: c8d97d58d67dad9eeb65eb58fc781724 From d58e1b80f026a3fbb93c51e57af8afedcdb866e9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 05:10:26 +0000 Subject: [PATCH 03/46] chore(internal): codegen related update --- src/unlayer/_client.py | 18 ++++++++++++++++++ src/unlayer/resources/convert/convert.py | 12 ++++++++++++ .../resources/convert/full_to_simple.py | 4 ++++ .../resources/convert/simple_to_full.py | 4 ++++ src/unlayer/resources/projects.py | 4 ++++ src/unlayer/resources/templates.py | 4 ++++ src/unlayer/resources/workspaces.py | 4 ++++ 7 files changed, 50 insertions(+) diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 08f7fef..2c20382 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -115,18 +115,21 @@ def convert(self) -> ConvertResource: @cached_property def projects(self) -> ProjectsResource: + """Project details and configuration.""" from .resources.projects import ProjectsResource return ProjectsResource(self) @cached_property def templates(self) -> TemplatesResource: + """Template management and retrieval.""" from .resources.templates import TemplatesResource return TemplatesResource(self) @cached_property def workspaces(self) -> WorkspacesResource: + """Workspace access and management.""" from .resources.workspaces import WorkspacesResource return WorkspacesResource(self) @@ -345,18 +348,21 @@ def convert(self) -> AsyncConvertResource: @cached_property def projects(self) -> AsyncProjectsResource: + """Project details and configuration.""" from .resources.projects import AsyncProjectsResource return AsyncProjectsResource(self) @cached_property def templates(self) -> AsyncTemplatesResource: + """Template management and retrieval.""" from .resources.templates import AsyncTemplatesResource return AsyncTemplatesResource(self) @cached_property def workspaces(self) -> AsyncWorkspacesResource: + """Workspace access and management.""" from .resources.workspaces import AsyncWorkspacesResource return AsyncWorkspacesResource(self) @@ -515,18 +521,21 @@ def convert(self) -> convert.ConvertResourceWithRawResponse: @cached_property def projects(self) -> projects.ProjectsResourceWithRawResponse: + """Project details and configuration.""" from .resources.projects import ProjectsResourceWithRawResponse return ProjectsResourceWithRawResponse(self._client.projects) @cached_property def templates(self) -> templates.TemplatesResourceWithRawResponse: + """Template management and retrieval.""" from .resources.templates import TemplatesResourceWithRawResponse return TemplatesResourceWithRawResponse(self._client.templates) @cached_property def workspaces(self) -> workspaces.WorkspacesResourceWithRawResponse: + """Workspace access and management.""" from .resources.workspaces import WorkspacesResourceWithRawResponse return WorkspacesResourceWithRawResponse(self._client.workspaces) @@ -546,18 +555,21 @@ def convert(self) -> convert.AsyncConvertResourceWithRawResponse: @cached_property def projects(self) -> projects.AsyncProjectsResourceWithRawResponse: + """Project details and configuration.""" from .resources.projects import AsyncProjectsResourceWithRawResponse return AsyncProjectsResourceWithRawResponse(self._client.projects) @cached_property def templates(self) -> templates.AsyncTemplatesResourceWithRawResponse: + """Template management and retrieval.""" from .resources.templates import AsyncTemplatesResourceWithRawResponse return AsyncTemplatesResourceWithRawResponse(self._client.templates) @cached_property def workspaces(self) -> workspaces.AsyncWorkspacesResourceWithRawResponse: + """Workspace access and management.""" from .resources.workspaces import AsyncWorkspacesResourceWithRawResponse return AsyncWorkspacesResourceWithRawResponse(self._client.workspaces) @@ -577,18 +589,21 @@ def convert(self) -> convert.ConvertResourceWithStreamingResponse: @cached_property def projects(self) -> projects.ProjectsResourceWithStreamingResponse: + """Project details and configuration.""" from .resources.projects import ProjectsResourceWithStreamingResponse return ProjectsResourceWithStreamingResponse(self._client.projects) @cached_property def templates(self) -> templates.TemplatesResourceWithStreamingResponse: + """Template management and retrieval.""" from .resources.templates import TemplatesResourceWithStreamingResponse return TemplatesResourceWithStreamingResponse(self._client.templates) @cached_property def workspaces(self) -> workspaces.WorkspacesResourceWithStreamingResponse: + """Workspace access and management.""" from .resources.workspaces import WorkspacesResourceWithStreamingResponse return WorkspacesResourceWithStreamingResponse(self._client.workspaces) @@ -608,18 +623,21 @@ def convert(self) -> convert.AsyncConvertResourceWithStreamingResponse: @cached_property def projects(self) -> projects.AsyncProjectsResourceWithStreamingResponse: + """Project details and configuration.""" from .resources.projects import AsyncProjectsResourceWithStreamingResponse return AsyncProjectsResourceWithStreamingResponse(self._client.projects) @cached_property def templates(self) -> templates.AsyncTemplatesResourceWithStreamingResponse: + """Template management and retrieval.""" from .resources.templates import AsyncTemplatesResourceWithStreamingResponse return AsyncTemplatesResourceWithStreamingResponse(self._client.templates) @cached_property def workspaces(self) -> workspaces.AsyncWorkspacesResourceWithStreamingResponse: + """Workspace access and management.""" from .resources.workspaces import AsyncWorkspacesResourceWithStreamingResponse return AsyncWorkspacesResourceWithStreamingResponse(self._client.workspaces) diff --git a/src/unlayer/resources/convert/convert.py b/src/unlayer/resources/convert/convert.py index 08eee7c..e4fdfc7 100644 --- a/src/unlayer/resources/convert/convert.py +++ b/src/unlayer/resources/convert/convert.py @@ -27,10 +27,12 @@ class ConvertResource(SyncAPIResource): @cached_property def full_to_simple(self) -> FullToSimpleResource: + """Design schema conversion between Full and Simple formats.""" return FullToSimpleResource(self._client) @cached_property def simple_to_full(self) -> SimpleToFullResource: + """Design schema conversion between Full and Simple formats.""" return SimpleToFullResource(self._client) @cached_property @@ -56,10 +58,12 @@ def with_streaming_response(self) -> ConvertResourceWithStreamingResponse: class AsyncConvertResource(AsyncAPIResource): @cached_property def full_to_simple(self) -> AsyncFullToSimpleResource: + """Design schema conversion between Full and Simple formats.""" return AsyncFullToSimpleResource(self._client) @cached_property def simple_to_full(self) -> AsyncSimpleToFullResource: + """Design schema conversion between Full and Simple formats.""" return AsyncSimpleToFullResource(self._client) @cached_property @@ -88,10 +92,12 @@ def __init__(self, convert: ConvertResource) -> None: @cached_property def full_to_simple(self) -> FullToSimpleResourceWithRawResponse: + """Design schema conversion between Full and Simple formats.""" return FullToSimpleResourceWithRawResponse(self._convert.full_to_simple) @cached_property def simple_to_full(self) -> SimpleToFullResourceWithRawResponse: + """Design schema conversion between Full and Simple formats.""" return SimpleToFullResourceWithRawResponse(self._convert.simple_to_full) @@ -101,10 +107,12 @@ def __init__(self, convert: AsyncConvertResource) -> None: @cached_property def full_to_simple(self) -> AsyncFullToSimpleResourceWithRawResponse: + """Design schema conversion between Full and Simple formats.""" return AsyncFullToSimpleResourceWithRawResponse(self._convert.full_to_simple) @cached_property def simple_to_full(self) -> AsyncSimpleToFullResourceWithRawResponse: + """Design schema conversion between Full and Simple formats.""" return AsyncSimpleToFullResourceWithRawResponse(self._convert.simple_to_full) @@ -114,10 +122,12 @@ def __init__(self, convert: ConvertResource) -> None: @cached_property def full_to_simple(self) -> FullToSimpleResourceWithStreamingResponse: + """Design schema conversion between Full and Simple formats.""" return FullToSimpleResourceWithStreamingResponse(self._convert.full_to_simple) @cached_property def simple_to_full(self) -> SimpleToFullResourceWithStreamingResponse: + """Design schema conversion between Full and Simple formats.""" return SimpleToFullResourceWithStreamingResponse(self._convert.simple_to_full) @@ -127,8 +137,10 @@ def __init__(self, convert: AsyncConvertResource) -> None: @cached_property def full_to_simple(self) -> AsyncFullToSimpleResourceWithStreamingResponse: + """Design schema conversion between Full and Simple formats.""" return AsyncFullToSimpleResourceWithStreamingResponse(self._convert.full_to_simple) @cached_property def simple_to_full(self) -> AsyncSimpleToFullResourceWithStreamingResponse: + """Design schema conversion between Full and Simple formats.""" return AsyncSimpleToFullResourceWithStreamingResponse(self._convert.simple_to_full) diff --git a/src/unlayer/resources/convert/full_to_simple.py b/src/unlayer/resources/convert/full_to_simple.py index d5901f4..35ea241 100644 --- a/src/unlayer/resources/convert/full_to_simple.py +++ b/src/unlayer/resources/convert/full_to_simple.py @@ -24,6 +24,8 @@ class FullToSimpleResource(SyncAPIResource): + """Design schema conversion between Full and Simple formats.""" + @cached_property def with_raw_response(self) -> FullToSimpleResourceWithRawResponse: """ @@ -91,6 +93,8 @@ def create( class AsyncFullToSimpleResource(AsyncAPIResource): + """Design schema conversion between Full and Simple formats.""" + @cached_property def with_raw_response(self) -> AsyncFullToSimpleResourceWithRawResponse: """ diff --git a/src/unlayer/resources/convert/simple_to_full.py b/src/unlayer/resources/convert/simple_to_full.py index d9b634f..5f22bb0 100644 --- a/src/unlayer/resources/convert/simple_to_full.py +++ b/src/unlayer/resources/convert/simple_to_full.py @@ -24,6 +24,8 @@ class SimpleToFullResource(SyncAPIResource): + """Design schema conversion between Full and Simple formats.""" + @cached_property def with_raw_response(self) -> SimpleToFullResourceWithRawResponse: """ @@ -86,6 +88,8 @@ def create( class AsyncSimpleToFullResource(AsyncAPIResource): + """Design schema conversion between Full and Simple formats.""" + @cached_property def with_raw_response(self) -> AsyncSimpleToFullResourceWithRawResponse: """ diff --git a/src/unlayer/resources/projects.py b/src/unlayer/resources/projects.py index 59073ac..4025c8c 100644 --- a/src/unlayer/resources/projects.py +++ b/src/unlayer/resources/projects.py @@ -20,6 +20,8 @@ class ProjectsResource(SyncAPIResource): + """Project details and configuration.""" + @cached_property def with_raw_response(self) -> ProjectsResourceWithRawResponse: """ @@ -74,6 +76,8 @@ def retrieve( class AsyncProjectsResource(AsyncAPIResource): + """Project details and configuration.""" + @cached_property def with_raw_response(self) -> AsyncProjectsResourceWithRawResponse: """ diff --git a/src/unlayer/resources/templates.py b/src/unlayer/resources/templates.py index e41c931..ebfb4a0 100644 --- a/src/unlayer/resources/templates.py +++ b/src/unlayer/resources/templates.py @@ -26,6 +26,8 @@ class TemplatesResource(SyncAPIResource): + """Template management and retrieval.""" + @cached_property def with_raw_response(self) -> TemplatesResourceWithRawResponse: """ @@ -148,6 +150,8 @@ def list( class AsyncTemplatesResource(AsyncAPIResource): + """Template management and retrieval.""" + @cached_property def with_raw_response(self) -> AsyncTemplatesResourceWithRawResponse: """ diff --git a/src/unlayer/resources/workspaces.py b/src/unlayer/resources/workspaces.py index 3bce476..be859fc 100644 --- a/src/unlayer/resources/workspaces.py +++ b/src/unlayer/resources/workspaces.py @@ -21,6 +21,8 @@ class WorkspacesResource(SyncAPIResource): + """Workspace access and management.""" + @cached_property def with_raw_response(self) -> WorkspacesResourceWithRawResponse: """ @@ -100,6 +102,8 @@ def list( class AsyncWorkspacesResource(AsyncAPIResource): + """Workspace access and management.""" + @cached_property def with_raw_response(self) -> AsyncWorkspacesResourceWithRawResponse: """ From 19677f4a04cd989500eecce93cbb0506cf1ebf32 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 6 Mar 2026 05:12:47 +0000 Subject: [PATCH 04/46] refactor(types): use `extra_items` from PEP 728 --- .../types/convert/full_to_simple_create_params.py | 9 +++------ .../types/convert/simple_to_full_create_params.py | 9 +++------ 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/src/unlayer/types/convert/full_to_simple_create_params.py b/src/unlayer/types/convert/full_to_simple_create_params.py index 7038dcf..5d70ae7 100644 --- a/src/unlayer/types/convert/full_to_simple_create_params.py +++ b/src/unlayer/types/convert/full_to_simple_create_params.py @@ -2,8 +2,8 @@ from __future__ import annotations -from typing import Dict, Union -from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict +from typing import Dict +from typing_extensions import Literal, Required, Annotated, TypedDict from ..._utils import PropertyInfo @@ -25,12 +25,9 @@ class FullToSimpleCreateParams(TypedDict, total=False): include_default_values: Annotated[bool, PropertyInfo(alias="includeDefaultValues")] -class DesignTyped(TypedDict, total=False): +class Design(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] body: Required[Dict[str, object]] counters: Dict[str, object] schema_version: Annotated[float, PropertyInfo(alias="schemaVersion")] - - -Design: TypeAlias = Union[DesignTyped, Dict[str, object]] diff --git a/src/unlayer/types/convert/simple_to_full_create_params.py b/src/unlayer/types/convert/simple_to_full_create_params.py index 247905e..b973376 100644 --- a/src/unlayer/types/convert/simple_to_full_create_params.py +++ b/src/unlayer/types/convert/simple_to_full_create_params.py @@ -2,8 +2,8 @@ from __future__ import annotations -from typing import Dict, Union -from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict +from typing import Dict +from typing_extensions import Literal, Required, Annotated, TypedDict from ..._utils import PropertyInfo @@ -24,7 +24,7 @@ class Design_Conversion(TypedDict, total=False): version: float -class DesignTyped(TypedDict, total=False): +class Design(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] body: Required[Dict[str, object]] _conversion: Design_Conversion @@ -32,6 +32,3 @@ class DesignTyped(TypedDict, total=False): counters: Dict[str, object] schema_version: Annotated[float, PropertyInfo(alias="schemaVersion")] - - -Design: TypeAlias = Union[DesignTyped, Dict[str, object]] From 3ad7bbb203d27a7b7f69fda2d0f3aebea329c49e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 6 Mar 2026 05:30:01 +0000 Subject: [PATCH 05/46] chore(test): do not count install time for mock server timeout --- scripts/mock | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/scripts/mock b/scripts/mock index 0b28f6e..bcf3b39 100755 --- a/scripts/mock +++ b/scripts/mock @@ -21,11 +21,22 @@ echo "==> Starting mock server with URL ${URL}" # Run prism mock on the given spec if [ "$1" == "--daemon" ]; then + # Pre-install the package so the download doesn't eat into the startup timeout + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism --version + npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log & - # Wait for server to come online + # Wait for server to come online (max 30s) echo -n "Waiting for server" + attempts=0 while ! grep -q "✖ fatal\|Prism is listening" ".prism.log" ; do + attempts=$((attempts + 1)) + if [ "$attempts" -ge 300 ]; then + echo + echo "Timed out waiting for Prism server to start" + cat .prism.log + exit 1 + fi echo -n "." sleep 0.1 done From 907041a9070f3c4a86605a21c9ab9a004a9bf553 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 7 Mar 2026 16:13:42 +0000 Subject: [PATCH 06/46] chore(ci): skip uploading artifacts on stainless-internal branches --- .github/workflows/ci.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e5caf73..55b6ef5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -61,14 +61,18 @@ jobs: run: rye build - name: Get GitHub OIDC Token - if: github.repository == 'stainless-sdks/unlayer-python' + if: |- + github.repository == 'stainless-sdks/unlayer-python' && + !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc uses: actions/github-script@v8 with: script: core.setOutput('github_token', await core.getIDToken()); - name: Upload tarball - if: github.repository == 'stainless-sdks/unlayer-python' + if: |- + github.repository == 'stainless-sdks/unlayer-python' && + !startsWith(github.ref, 'refs/heads/stl/') env: URL: https://pkg.stainless.com/s AUTH: ${{ steps.github-oidc.outputs.github_token }} From d31637bd182be359df4af936cb715cc554d9a14b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 10:10:56 +0000 Subject: [PATCH 07/46] fix(pydantic): do not pass `by_alias` unless set --- src/unlayer/_compat.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/unlayer/_compat.py b/src/unlayer/_compat.py index 786ff42..e6690a4 100644 --- a/src/unlayer/_compat.py +++ b/src/unlayer/_compat.py @@ -2,7 +2,7 @@ from typing import TYPE_CHECKING, Any, Union, Generic, TypeVar, Callable, cast, overload from datetime import date, datetime -from typing_extensions import Self, Literal +from typing_extensions import Self, Literal, TypedDict import pydantic from pydantic.fields import FieldInfo @@ -131,6 +131,10 @@ def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str: return model.model_dump_json(indent=indent) +class _ModelDumpKwargs(TypedDict, total=False): + by_alias: bool + + def model_dump( model: pydantic.BaseModel, *, @@ -142,6 +146,9 @@ def model_dump( by_alias: bool | None = None, ) -> dict[str, Any]: if (not PYDANTIC_V1) or hasattr(model, "model_dump"): + kwargs: _ModelDumpKwargs = {} + if by_alias is not None: + kwargs["by_alias"] = by_alias return model.model_dump( mode=mode, exclude=exclude, @@ -149,7 +156,7 @@ def model_dump( exclude_defaults=exclude_defaults, # warnings are not supported in Pydantic v1 warnings=True if PYDANTIC_V1 else warnings, - by_alias=by_alias, + **kwargs, ) return cast( "dict[str, Any]", From b7baa1e5d138b5a33b63bed9dae37bfabb6d968d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 10:16:28 +0000 Subject: [PATCH 08/46] fix(deps): bump minimum typing-extensions version --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index cbb8b33..967cabc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -11,7 +11,7 @@ authors = [ dependencies = [ "httpx>=0.23.0, <1", "pydantic>=1.9.0, <3", - "typing-extensions>=4.10, <5", + "typing-extensions>=4.14, <5", "anyio>=3.5.0, <5", "distro>=1.7.0, <2", "sniffio", From 4e152dccd0191c2dd4d321e8ca7b6550dc6bc3f0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 17 Mar 2026 10:20:31 +0000 Subject: [PATCH 09/46] chore(internal): tweak CI branches --- .github/workflows/ci.yml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 55b6ef5..581125c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,12 +1,14 @@ name: CI on: push: - branches-ignore: - - 'generated' - - 'codegen/**' - - 'integrated/**' - - 'stl-preview-head/**' - - 'stl-preview-base/**' + branches: + - '**' + - '!integrated/**' + - '!stl-preview-head/**' + - '!stl-preview-base/**' + - '!generated' + - '!codegen/**' + - 'codegen/stl/**' pull_request: branches-ignore: - 'stl-preview-head/**' From bc0d6b6b147d33cd2f65855284e7f435bdee09f9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 20 Mar 2026 03:23:13 +0000 Subject: [PATCH 10/46] fix: sanitize endpoint path params --- src/unlayer/_utils/__init__.py | 1 + src/unlayer/_utils/_path.py | 127 ++++++++++++++++++++++++++++ src/unlayer/resources/projects.py | 5 +- src/unlayer/resources/templates.py | 6 +- src/unlayer/resources/workspaces.py | 5 +- tests/test_utils/test_path.py | 89 +++++++++++++++++++ 6 files changed, 226 insertions(+), 7 deletions(-) create mode 100644 src/unlayer/_utils/_path.py create mode 100644 tests/test_utils/test_path.py diff --git a/src/unlayer/_utils/__init__.py b/src/unlayer/_utils/__init__.py index dc64e29..10cb66d 100644 --- a/src/unlayer/_utils/__init__.py +++ b/src/unlayer/_utils/__init__.py @@ -1,3 +1,4 @@ +from ._path import path_template as path_template from ._sync import asyncify as asyncify from ._proxy import LazyProxy as LazyProxy from ._utils import ( diff --git a/src/unlayer/_utils/_path.py b/src/unlayer/_utils/_path.py new file mode 100644 index 0000000..4d6e1e4 --- /dev/null +++ b/src/unlayer/_utils/_path.py @@ -0,0 +1,127 @@ +from __future__ import annotations + +import re +from typing import ( + Any, + Mapping, + Callable, +) +from urllib.parse import quote + +# Matches '.' or '..' where each dot is either literal or percent-encoded (%2e / %2E). +_DOT_SEGMENT_RE = re.compile(r"^(?:\.|%2[eE]){1,2}$") + +_PLACEHOLDER_RE = re.compile(r"\{(\w+)\}") + + +def _quote_path_segment_part(value: str) -> str: + """Percent-encode `value` for use in a URI path segment. + + Considers characters not in `pchar` set from RFC 3986 §3.3 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.3 + """ + # quote() already treats unreserved characters (letters, digits, and -._~) + # as safe, so we only need to add sub-delims, ':', and '@'. + # Notably, unlike the default `safe` for quote(), / is unsafe and must be quoted. + return quote(value, safe="!$&'()*+,;=:@") + + +def _quote_query_part(value: str) -> str: + """Percent-encode `value` for use in a URI query string. + + Considers &, = and characters not in `query` set from RFC 3986 §3.4 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.4 + """ + return quote(value, safe="!$'()*+,;:@/?") + + +def _quote_fragment_part(value: str) -> str: + """Percent-encode `value` for use in a URI fragment. + + Considers characters not in `fragment` set from RFC 3986 §3.5 to be unsafe. + https://datatracker.ietf.org/doc/html/rfc3986#section-3.5 + """ + return quote(value, safe="!$&'()*+,;=:@/?") + + +def _interpolate( + template: str, + values: Mapping[str, Any], + quoter: Callable[[str], str], +) -> str: + """Replace {name} placeholders in `template`, quoting each value with `quoter`. + + Placeholder names are looked up in `values`. + + Raises: + KeyError: If a placeholder is not found in `values`. + """ + # re.split with a capturing group returns alternating + # [text, name, text, name, ..., text] elements. + parts = _PLACEHOLDER_RE.split(template) + + for i in range(1, len(parts), 2): + name = parts[i] + if name not in values: + raise KeyError(f"a value for placeholder {{{name}}} was not provided") + val = values[name] + if val is None: + parts[i] = "null" + elif isinstance(val, bool): + parts[i] = "true" if val else "false" + else: + parts[i] = quoter(str(values[name])) + + return "".join(parts) + + +def path_template(template: str, /, **kwargs: Any) -> str: + """Interpolate {name} placeholders in `template` from keyword arguments. + + Args: + template: The template string containing {name} placeholders. + **kwargs: Keyword arguments to interpolate into the template. + + Returns: + The template with placeholders interpolated and percent-encoded. + + Safe characters for percent-encoding are dependent on the URI component. + Placeholders in path and fragment portions are percent-encoded where the `segment` + and `fragment` sets from RFC 3986 respectively are considered safe. + Placeholders in the query portion are percent-encoded where the `query` set from + RFC 3986 §3.3 is considered safe except for = and & characters. + + Raises: + KeyError: If a placeholder is not found in `kwargs`. + ValueError: If resulting path contains /./ or /../ segments (including percent-encoded dot-segments). + """ + # Split the template into path, query, and fragment portions. + fragment_template: str | None = None + query_template: str | None = None + + rest = template + if "#" in rest: + rest, fragment_template = rest.split("#", 1) + if "?" in rest: + rest, query_template = rest.split("?", 1) + path_template = rest + + # Interpolate each portion with the appropriate quoting rules. + path_result = _interpolate(path_template, kwargs, _quote_path_segment_part) + + # Reject dot-segments (. and ..) in the final assembled path. The check + # runs after interpolation so that adjacent placeholders or a mix of static + # text and placeholders that together form a dot-segment are caught. + # Also reject percent-encoded dot-segments to protect against incorrectly + # implemented normalization in servers/proxies. + for segment in path_result.split("/"): + if _DOT_SEGMENT_RE.match(segment): + raise ValueError(f"Constructed path {path_result!r} contains dot-segment {segment!r} which is not allowed") + + result = path_result + if query_template is not None: + result += "?" + _interpolate(query_template, kwargs, _quote_query_part) + if fragment_template is not None: + result += "#" + _interpolate(fragment_template, kwargs, _quote_fragment_part) + + return result diff --git a/src/unlayer/resources/projects.py b/src/unlayer/resources/projects.py index 4025c8c..f842cfe 100644 --- a/src/unlayer/resources/projects.py +++ b/src/unlayer/resources/projects.py @@ -5,6 +5,7 @@ import httpx from .._types import Body, Query, Headers, NotGiven, not_given +from .._utils import path_template from .._compat import cached_property from .._resource import SyncAPIResource, AsyncAPIResource from .._response import ( @@ -67,7 +68,7 @@ def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return self._get( - f"/v3/projects/{id}", + path_template("/v3/projects/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -123,7 +124,7 @@ async def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return await self._get( - f"/v3/projects/{id}", + path_template("/v3/projects/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), diff --git a/src/unlayer/resources/templates.py b/src/unlayer/resources/templates.py index ebfb4a0..75fcee7 100644 --- a/src/unlayer/resources/templates.py +++ b/src/unlayer/resources/templates.py @@ -8,7 +8,7 @@ from ..types import template_list_params, template_retrieve_params from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given -from .._utils import maybe_transform, async_maybe_transform +from .._utils import path_template, maybe_transform, async_maybe_transform from .._compat import cached_property from .._resource import SyncAPIResource, AsyncAPIResource from .._response import ( @@ -76,7 +76,7 @@ def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return self._get( - f"/v3/templates/{id}", + path_template("/v3/templates/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, @@ -200,7 +200,7 @@ async def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return await self._get( - f"/v3/templates/{id}", + path_template("/v3/templates/{id}", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, diff --git a/src/unlayer/resources/workspaces.py b/src/unlayer/resources/workspaces.py index be859fc..3ad5619 100644 --- a/src/unlayer/resources/workspaces.py +++ b/src/unlayer/resources/workspaces.py @@ -5,6 +5,7 @@ import httpx from .._types import Body, Query, Headers, NotGiven, not_given +from .._utils import path_template from .._compat import cached_property from .._resource import SyncAPIResource, AsyncAPIResource from .._response import ( @@ -70,7 +71,7 @@ def retrieve( if not workspace_id: raise ValueError(f"Expected a non-empty value for `workspace_id` but received {workspace_id!r}") return self._get( - f"/v3/workspaces/{workspace_id}", + path_template("/v3/workspaces/{workspace_id}", workspace_id=workspace_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), @@ -151,7 +152,7 @@ async def retrieve( if not workspace_id: raise ValueError(f"Expected a non-empty value for `workspace_id` but received {workspace_id!r}") return await self._get( - f"/v3/workspaces/{workspace_id}", + path_template("/v3/workspaces/{workspace_id}", workspace_id=workspace_id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), diff --git a/tests/test_utils/test_path.py b/tests/test_utils/test_path.py new file mode 100644 index 0000000..8d48732 --- /dev/null +++ b/tests/test_utils/test_path.py @@ -0,0 +1,89 @@ +from __future__ import annotations + +from typing import Any + +import pytest + +from unlayer._utils._path import path_template + + +@pytest.mark.parametrize( + "template, kwargs, expected", + [ + ("/v1/{id}", dict(id="abc"), "/v1/abc"), + ("/v1/{a}/{b}", dict(a="x", b="y"), "/v1/x/y"), + ("/v1/{a}{b}/path/{c}?val={d}#{e}", dict(a="x", b="y", c="z", d="u", e="v"), "/v1/xy/path/z?val=u#v"), + ("/{w}/{w}", dict(w="echo"), "/echo/echo"), + ("/v1/static", {}, "/v1/static"), + ("", {}, ""), + ("/v1/?q={n}&count=10", dict(n=42), "/v1/?q=42&count=10"), + ("/v1/{v}", dict(v=None), "/v1/null"), + ("/v1/{v}", dict(v=True), "/v1/true"), + ("/v1/{v}", dict(v=False), "/v1/false"), + ("/v1/{v}", dict(v=".hidden"), "/v1/.hidden"), # dot prefix ok + ("/v1/{v}", dict(v="file.txt"), "/v1/file.txt"), # dot in middle ok + ("/v1/{v}", dict(v="..."), "/v1/..."), # triple dot ok + ("/v1/{a}{b}", dict(a=".", b="txt"), "/v1/.txt"), # dot var combining with adjacent to be ok + ("/items?q={v}#{f}", dict(v=".", f=".."), "/items?q=.#.."), # dots in query/fragment are fine + ( + "/v1/{a}?query={b}", + dict(a="../../other/endpoint", b="a&bad=true"), + "/v1/..%2F..%2Fother%2Fendpoint?query=a%26bad%3Dtrue", + ), + ("/v1/{val}", dict(val="a/b/c"), "/v1/a%2Fb%2Fc"), + ("/v1/{val}", dict(val="a/b/c?query=value"), "/v1/a%2Fb%2Fc%3Fquery=value"), + ("/v1/{val}", dict(val="a/b/c?query=value&bad=true"), "/v1/a%2Fb%2Fc%3Fquery=value&bad=true"), + ("/v1/{val}", dict(val="%20"), "/v1/%2520"), # escapes escape sequences in input + # Query: slash and ? are safe, # is not + ("/items?q={v}", dict(v="a/b"), "/items?q=a/b"), + ("/items?q={v}", dict(v="a?b"), "/items?q=a?b"), + ("/items?q={v}", dict(v="a#b"), "/items?q=a%23b"), + ("/items?q={v}", dict(v="a b"), "/items?q=a%20b"), + # Fragment: slash and ? are safe + ("/docs#{v}", dict(v="a/b"), "/docs#a/b"), + ("/docs#{v}", dict(v="a?b"), "/docs#a?b"), + # Path: slash, ? and # are all encoded + ("/v1/{v}", dict(v="a/b"), "/v1/a%2Fb"), + ("/v1/{v}", dict(v="a?b"), "/v1/a%3Fb"), + ("/v1/{v}", dict(v="a#b"), "/v1/a%23b"), + # same var encoded differently by component + ( + "/v1/{v}?q={v}#{v}", + dict(v="a/b?c#d"), + "/v1/a%2Fb%3Fc%23d?q=a/b?c%23d#a/b?c%23d", + ), + ("/v1/{val}", dict(val="x?admin=true"), "/v1/x%3Fadmin=true"), # query injection + ("/v1/{val}", dict(val="x#admin"), "/v1/x%23admin"), # fragment injection + ], +) +def test_interpolation(template: str, kwargs: dict[str, Any], expected: str) -> None: + assert path_template(template, **kwargs) == expected + + +def test_missing_kwarg_raises_key_error() -> None: + with pytest.raises(KeyError, match="org_id"): + path_template("/v1/{org_id}") + + +@pytest.mark.parametrize( + "template, kwargs", + [ + ("{a}/path", dict(a=".")), + ("{a}/path", dict(a="..")), + ("/v1/{a}", dict(a=".")), + ("/v1/{a}", dict(a="..")), + ("/v1/{a}/path", dict(a=".")), + ("/v1/{a}/path", dict(a="..")), + ("/v1/{a}{b}", dict(a=".", b=".")), # adjacent vars → ".." + ("/v1/{a}.", dict(a=".")), # var + static → ".." + ("/v1/{a}{b}", dict(a="", b=".")), # empty + dot → "." + ("/v1/%2e/{x}", dict(x="ok")), # encoded dot in static text + ("/v1/%2e./{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/.%2E/{x}", dict(x="ok")), # mixed encoded ".." in static + ("/v1/{v}?q=1", dict(v="..")), + ("/v1/{v}#frag", dict(v="..")), + ], +) +def test_dot_segment_rejected(template: str, kwargs: dict[str, Any]) -> None: + with pytest.raises(ValueError, match="dot-segment"): + path_template(template, **kwargs) From d2618bd109fcd053b5845009bc8221090930a369 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 20 Mar 2026 03:24:04 +0000 Subject: [PATCH 11/46] refactor(tests): switch from prism to steady --- CONTRIBUTING.md | 2 +- scripts/mock | 26 +++++++++++++------------- scripts/test | 16 ++++++++-------- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f8a253..38563d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,7 +85,7 @@ $ pip install ./path-to-wheel-file.whl ## Running tests -Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests. +Most tests require you to [set up a mock server](https://github.com/dgellow/steady) against the OpenAPI spec to run the tests. ```sh $ ./scripts/mock diff --git a/scripts/mock b/scripts/mock index bcf3b39..38201de 100755 --- a/scripts/mock +++ b/scripts/mock @@ -19,34 +19,34 @@ fi echo "==> Starting mock server with URL ${URL}" -# Run prism mock on the given spec +# Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism --version + npm exec --package=@stdy/cli@0.19.3 -- steady --version - npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log & + npm exec --package=@stdy/cli@0.19.3 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets "$URL" &> .stdy.log & - # Wait for server to come online (max 30s) + # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" attempts=0 - while ! grep -q "✖ fatal\|Prism is listening" ".prism.log" ; do + while ! curl --silent --fail "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1; do + if ! kill -0 $! 2>/dev/null; then + echo + cat .stdy.log + exit 1 + fi attempts=$((attempts + 1)) if [ "$attempts" -ge 300 ]; then echo - echo "Timed out waiting for Prism server to start" - cat .prism.log + echo "Timed out waiting for Steady server to start" + cat .stdy.log exit 1 fi echo -n "." sleep 0.1 done - if grep -q "✖ fatal" ".prism.log"; then - cat .prism.log - exit 1 - fi - echo else - npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" + npm exec --package=@stdy/cli@0.19.3 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index dbeda2d..2dfdc40 100755 --- a/scripts/test +++ b/scripts/test @@ -9,8 +9,8 @@ GREEN='\033[0;32m' YELLOW='\033[0;33m' NC='\033[0m' # No Color -function prism_is_running() { - curl --silent "http://localhost:4010" >/dev/null 2>&1 +function steady_is_running() { + curl --silent "http://127.0.0.1:4010/_x-steady/health" >/dev/null 2>&1 } kill_server_on_port() { @@ -25,7 +25,7 @@ function is_overriding_api_base_url() { [ -n "$TEST_API_BASE_URL" ] } -if ! is_overriding_api_base_url && ! prism_is_running ; then +if ! is_overriding_api_base_url && ! steady_is_running ; then # When we exit this script, make sure to kill the background mock server process trap 'kill_server_on_port 4010' EXIT @@ -36,19 +36,19 @@ fi if is_overriding_api_base_url ; then echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}" echo -elif ! prism_is_running ; then - echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server" +elif ! steady_is_running ; then + echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Steady server" echo -e "running against your OpenAPI spec." echo echo -e "To run the server, pass in the path or url of your OpenAPI" - echo -e "spec to the prism command:" + echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.3 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets${NC}" echo exit 1 else - echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}" + echo -e "${GREEN}✔ Mock steady server is running with your OpenAPI spec${NC}" echo fi From 775fe461f02f96ebc4b7cd6ff2d8cab4c52d291d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 21 Mar 2026 04:17:12 +0000 Subject: [PATCH 12/46] chore(tests): bump steady to v0.19.4 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 38201de..e1c19e8 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.19.3 -- steady --version + npm exec --package=@stdy/cli@0.19.4 -- steady --version - npm exec --package=@stdy/cli@0.19.3 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.19.4 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.3 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.19.4 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index 2dfdc40..36fab0a 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.3 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-query-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.4 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" echo exit 1 From 9ef3615041ea171a462a29f8cfd268133df0c6fc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 21 Mar 2026 04:21:49 +0000 Subject: [PATCH 13/46] chore(tests): bump steady to v0.19.5 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index e1c19e8..ab814d3 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.19.4 -- steady --version + npm exec --package=@stdy/cli@0.19.5 -- steady --version - npm exec --package=@stdy/cli@0.19.4 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.19.5 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.4 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.19.5 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index 36fab0a..d1c8e1a 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.4 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.5 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" echo exit 1 From 5a510e6edf2e26d612be067b6c95e70780d01d57 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 24 Mar 2026 04:19:54 +0000 Subject: [PATCH 14/46] chore(internal): update gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 95ceb18..3824f4c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .prism.log +.stdy.log _dev __pycache__ From 33d721e46826c23bf5b1ce78477d003cb9cd83da Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 24 Mar 2026 04:25:10 +0000 Subject: [PATCH 15/46] chore(tests): bump steady to v0.19.6 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index ab814d3..b319bdf 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.19.5 -- steady --version + npm exec --package=@stdy/cli@0.19.6 -- steady --version - npm exec --package=@stdy/cli@0.19.5 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.19.6 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.5 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.19.6 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index d1c8e1a..ab01948 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.5 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.6 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" echo exit 1 From 33434927ad6ab7c508d758335944cdc4123a5e17 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 25 Mar 2026 03:05:16 +0000 Subject: [PATCH 16/46] chore(ci): skip lint on metadata-only changes Note that we still want to run tests, as these depend on the metadata. --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 581125c..cb10d13 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,7 +19,7 @@ jobs: timeout-minutes: 10 name: lint runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} - if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - uses: actions/checkout@v6 @@ -38,7 +38,7 @@ jobs: run: ./scripts/lint build: - if: github.event_name == 'push' || github.event.pull_request.head.repo.fork + if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') timeout-minutes: 10 name: build permissions: From 3d09621f6d61c74d431b9af1336c6c51d8396d4f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 25 Mar 2026 03:05:49 +0000 Subject: [PATCH 17/46] chore(tests): bump steady to v0.19.7 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index b319bdf..09eb49f 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.19.6 -- steady --version + npm exec --package=@stdy/cli@0.19.7 -- steady --version - npm exec --package=@stdy/cli@0.19.6 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.6 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index ab01948..e46b9b5 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.6 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.7 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" echo exit 1 From e8555c785eb5ac3fd4f46eba86514c83279c8455 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 27 Mar 2026 05:32:30 +0000 Subject: [PATCH 18/46] feat(internal): implement indices array format for query and form serialization --- scripts/mock | 4 ++-- scripts/test | 2 +- src/unlayer/_qs.py | 5 ++++- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 09eb49f..290e21b 100755 --- a/scripts/mock +++ b/scripts/mock @@ -24,7 +24,7 @@ if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout npm exec --package=@stdy/cli@0.19.7 -- steady --version - npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index e46b9b5..661f9bf 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.7 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-form-array-format=comma --validator-query-array-format=comma --validator-form-object-format=brackets --validator-query-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.7 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" echo exit 1 diff --git a/src/unlayer/_qs.py b/src/unlayer/_qs.py index ada6fd3..de8c99b 100644 --- a/src/unlayer/_qs.py +++ b/src/unlayer/_qs.py @@ -101,7 +101,10 @@ def _stringify_item( items.extend(self._stringify_item(key, item, opts)) return items elif array_format == "indices": - raise NotImplementedError("The array indices format is not supported yet") + items = [] + for i, item in enumerate(value): + items.extend(self._stringify_item(f"{key}[{i}]", item, opts)) + return items elif array_format == "brackets": items = [] key = key + "[]" From 649317dda33455a5b5e25aedeb0210a746b767f2 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 1 Apr 2026 07:20:08 +0000 Subject: [PATCH 19/46] chore(tests): bump steady to v0.20.1 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 290e21b..15c2994 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.19.7 -- steady --version + npm exec --package=@stdy/cli@0.20.1 -- steady --version - npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.20.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.19.7 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.20.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index 661f9bf..c8e2e9d 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.19.7 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.1 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" echo exit 1 From 2c51cba746385da9a9e5ec0ea00bf6c4cdee2bbd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 1 Apr 2026 07:23:16 +0000 Subject: [PATCH 20/46] chore(tests): bump steady to v0.20.2 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 15c2994..5cd7c15 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.20.1 -- steady --version + npm exec --package=@stdy/cli@0.20.2 -- steady --version - npm exec --package=@stdy/cli@0.20.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.20.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index c8e2e9d..b8143aa 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.1 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.2 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" echo exit 1 From 75acb50baa973b93439b0e1e803e34ec5ea0f891 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 8 Apr 2026 04:29:20 +0000 Subject: [PATCH 21/46] fix(client): preserve hardcoded query params when merging with user params --- src/unlayer/_base_client.py | 4 ++++ tests/test_client.py | 48 +++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) diff --git a/src/unlayer/_base_client.py b/src/unlayer/_base_client.py index c199ad7..21b1255 100644 --- a/src/unlayer/_base_client.py +++ b/src/unlayer/_base_client.py @@ -540,6 +540,10 @@ def _build_request( files = cast(HttpxRequestFiles, ForceMultipartDict()) prepared_url = self._prepare_url(options.url) + # preserve hard-coded query params from the url + if params and prepared_url.query: + params = {**dict(prepared_url.params.items()), **params} + prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0]) if "_" in prepared_url.host: # work around https://github.com/encode/httpx/discussions/2880 kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")} diff --git a/tests/test_client.py b/tests/test_client.py index 61e5adb..7137115 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -428,6 +428,30 @@ def test_default_query_option(self) -> None: client.close() + def test_hardcoded_query_params_in_url(self, client: Unlayer) -> None: + request = client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true")) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/foo?beta=true", + params={"limit": "10", "page": "abc"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"} + + request = client._build_request( + FinalRequestOptions( + method="get", + url="/files/a%2Fb?beta=true", + params={"limit": "10"}, + ) + ) + assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10" + def test_request_extra_json(self, client: Unlayer) -> None: request = client._build_request( FinalRequestOptions( @@ -1309,6 +1333,30 @@ async def test_default_query_option(self) -> None: await client.close() + async def test_hardcoded_query_params_in_url(self, async_client: AsyncUnlayer) -> None: + request = async_client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true")) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true"} + + request = async_client._build_request( + FinalRequestOptions( + method="get", + url="/foo?beta=true", + params={"limit": "10", "page": "abc"}, + ) + ) + url = httpx.URL(request.url) + assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"} + + request = async_client._build_request( + FinalRequestOptions( + method="get", + url="/files/a%2Fb?beta=true", + params={"limit": "10"}, + ) + ) + assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10" + def test_request_extra_json(self, client: Unlayer) -> None: request = client._build_request( FinalRequestOptions( From 16c4a958a038f89843bfd0287656f14c222bbc9a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 11 Apr 2026 07:30:03 +0000 Subject: [PATCH 22/46] fix: ensure file data are only sent as 1 parameter --- src/unlayer/_utils/_utils.py | 5 +++-- tests/test_extract_files.py | 9 +++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/unlayer/_utils/_utils.py b/src/unlayer/_utils/_utils.py index eec7f4a..63b8cd6 100644 --- a/src/unlayer/_utils/_utils.py +++ b/src/unlayer/_utils/_utils.py @@ -86,8 +86,9 @@ def _extract_items( index += 1 if is_dict(obj): try: - # We are at the last entry in the path so we must remove the field - if (len(path)) == index: + # Remove the field if there are no more dict keys in the path, + # only "" traversal markers or end. + if all(p == "" for p in path[index:]): item = obj.pop(key) else: item = obj[key] diff --git a/tests/test_extract_files.py b/tests/test_extract_files.py index 9f2cae2..9bf5e2d 100644 --- a/tests/test_extract_files.py +++ b/tests/test_extract_files.py @@ -35,6 +35,15 @@ def test_multiple_files() -> None: assert query == {"documents": [{}, {}]} +def test_top_level_file_array() -> None: + query = {"files": [b"file one", b"file two"], "title": "hello"} + assert extract_files(query, paths=[["files", ""]]) == [ + ("files[]", b"file one"), + ("files[]", b"file two"), + ] + assert query == {"title": "hello"} + + @pytest.mark.parametrize( "query,paths,expected", [ From 9e8bba9900b5252766dae4d7cd835fb264136ed4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 18 Apr 2026 07:01:27 +0000 Subject: [PATCH 23/46] perf(client): optimize file structure copying in multipart requests --- src/unlayer/_files.py | 56 +++++++++++++++++-- src/unlayer/_utils/__init__.py | 1 - src/unlayer/_utils/_utils.py | 15 ------ tests/test_deepcopy.py | 58 -------------------- tests/test_files.py | 99 +++++++++++++++++++++++++++++++++- 5 files changed, 151 insertions(+), 78 deletions(-) delete mode 100644 tests/test_deepcopy.py diff --git a/src/unlayer/_files.py b/src/unlayer/_files.py index cc14c14..0fdce17 100644 --- a/src/unlayer/_files.py +++ b/src/unlayer/_files.py @@ -3,8 +3,8 @@ import io import os import pathlib -from typing import overload -from typing_extensions import TypeGuard +from typing import Sequence, cast, overload +from typing_extensions import TypeVar, TypeGuard import anyio @@ -17,7 +17,9 @@ HttpxFileContent, HttpxRequestFiles, ) -from ._utils import is_tuple_t, is_mapping_t, is_sequence_t +from ._utils import is_list, is_mapping, is_tuple_t, is_mapping_t, is_sequence_t + +_T = TypeVar("_T") def is_base64_file_input(obj: object) -> TypeGuard[Base64FileInput]: @@ -121,3 +123,51 @@ async def async_read_file_content(file: FileContent) -> HttpxFileContent: return await anyio.Path(file).read_bytes() return file + + +def deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]]) -> _T: + """Copy only the containers along the given paths. + + Used to guard against mutation by extract_files without copying the entire structure. + Only dicts and lists that lie on a path are copied; everything else + is returned by reference. + + For example, given paths=[["foo", "files", "file"]] and the structure: + { + "foo": { + "bar": {"baz": {}}, + "files": {"file": } + } + } + The root dict, "foo", and "files" are copied (they lie on the path). + "bar" and "baz" are returned by reference (off the path). + """ + return _deepcopy_with_paths(item, paths, 0) + + +def _deepcopy_with_paths(item: _T, paths: Sequence[Sequence[str]], index: int) -> _T: + if not paths: + return item + if is_mapping(item): + key_to_paths: dict[str, list[Sequence[str]]] = {} + for path in paths: + if index < len(path): + key_to_paths.setdefault(path[index], []).append(path) + + # if no path continues through this mapping, it won't be mutated and copying it is redundant + if not key_to_paths: + return item + + result = dict(item) + for key, subpaths in key_to_paths.items(): + if key in result: + result[key] = _deepcopy_with_paths(result[key], subpaths, index + 1) + return cast(_T, result) + if is_list(item): + array_paths = [path for path in paths if index < len(path) and path[index] == ""] + + # if no path expects a list here, nothing will be mutated inside it - return by reference + if not array_paths: + return cast(_T, item) + return cast(_T, [_deepcopy_with_paths(entry, array_paths, index + 1) for entry in item]) + return item diff --git a/src/unlayer/_utils/__init__.py b/src/unlayer/_utils/__init__.py index 10cb66d..1c090e5 100644 --- a/src/unlayer/_utils/__init__.py +++ b/src/unlayer/_utils/__init__.py @@ -24,7 +24,6 @@ coerce_integer as coerce_integer, file_from_path as file_from_path, strip_not_given as strip_not_given, - deepcopy_minimal as deepcopy_minimal, get_async_library as get_async_library, maybe_coerce_float as maybe_coerce_float, get_required_header as get_required_header, diff --git a/src/unlayer/_utils/_utils.py b/src/unlayer/_utils/_utils.py index 63b8cd6..771859f 100644 --- a/src/unlayer/_utils/_utils.py +++ b/src/unlayer/_utils/_utils.py @@ -177,21 +177,6 @@ def is_iterable(obj: object) -> TypeGuard[Iterable[object]]: return isinstance(obj, Iterable) -def deepcopy_minimal(item: _T) -> _T: - """Minimal reimplementation of copy.deepcopy() that will only copy certain object types: - - - mappings, e.g. `dict` - - list - - This is done for performance reasons. - """ - if is_mapping(item): - return cast(_T, {k: deepcopy_minimal(v) for k, v in item.items()}) - if is_list(item): - return cast(_T, [deepcopy_minimal(entry) for entry in item]) - return item - - # copied from https://github.com/Rapptz/RoboDanny def human_join(seq: Sequence[str], *, delim: str = ", ", final: str = "or") -> str: size = len(seq) diff --git a/tests/test_deepcopy.py b/tests/test_deepcopy.py deleted file mode 100644 index f308857..0000000 --- a/tests/test_deepcopy.py +++ /dev/null @@ -1,58 +0,0 @@ -from unlayer._utils import deepcopy_minimal - - -def assert_different_identities(obj1: object, obj2: object) -> None: - assert obj1 == obj2 - assert id(obj1) != id(obj2) - - -def test_simple_dict() -> None: - obj1 = {"foo": "bar"} - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - - -def test_nested_dict() -> None: - obj1 = {"foo": {"bar": True}} - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - assert_different_identities(obj1["foo"], obj2["foo"]) - - -def test_complex_nested_dict() -> None: - obj1 = {"foo": {"bar": [{"hello": "world"}]}} - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - assert_different_identities(obj1["foo"], obj2["foo"]) - assert_different_identities(obj1["foo"]["bar"], obj2["foo"]["bar"]) - assert_different_identities(obj1["foo"]["bar"][0], obj2["foo"]["bar"][0]) - - -def test_simple_list() -> None: - obj1 = ["a", "b", "c"] - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - - -def test_nested_list() -> None: - obj1 = ["a", [1, 2, 3]] - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - assert_different_identities(obj1[1], obj2[1]) - - -class MyObject: ... - - -def test_ignores_other_types() -> None: - # custom classes - my_obj = MyObject() - obj1 = {"foo": my_obj} - obj2 = deepcopy_minimal(obj1) - assert_different_identities(obj1, obj2) - assert obj1["foo"] is my_obj - - # tuples - obj3 = ("a", "b") - obj4 = deepcopy_minimal(obj3) - assert obj3 is obj4 diff --git a/tests/test_files.py b/tests/test_files.py index f1e9f25..e7c851e 100644 --- a/tests/test_files.py +++ b/tests/test_files.py @@ -4,7 +4,8 @@ import pytest from dirty_equals import IsDict, IsList, IsBytes, IsTuple -from unlayer._files import to_httpx_files, async_to_httpx_files +from unlayer._files import to_httpx_files, deepcopy_with_paths, async_to_httpx_files +from unlayer._utils import extract_files readme_path = Path(__file__).parent.parent.joinpath("README.md") @@ -49,3 +50,99 @@ def test_string_not_allowed() -> None: "file": "foo", # type: ignore } ) + + +def assert_different_identities(obj1: object, obj2: object) -> None: + assert obj1 == obj2 + assert obj1 is not obj2 + + +class TestDeepcopyWithPaths: + def test_copies_top_level_dict(self) -> None: + original = {"file": b"data", "other": "value"} + result = deepcopy_with_paths(original, [["file"]]) + assert_different_identities(result, original) + + def test_file_value_is_same_reference(self) -> None: + file_bytes = b"contents" + original = {"file": file_bytes} + result = deepcopy_with_paths(original, [["file"]]) + assert_different_identities(result, original) + assert result["file"] is file_bytes + + def test_list_popped_wholesale(self) -> None: + files = [b"f1", b"f2"] + original = {"files": files, "title": "t"} + result = deepcopy_with_paths(original, [["files", ""]]) + assert_different_identities(result, original) + result_files = result["files"] + assert isinstance(result_files, list) + assert_different_identities(result_files, files) + + def test_nested_array_path_copies_list_and_elements(self) -> None: + elem1 = {"file": b"f1", "extra": 1} + elem2 = {"file": b"f2", "extra": 2} + original = {"items": [elem1, elem2]} + result = deepcopy_with_paths(original, [["items", "", "file"]]) + assert_different_identities(result, original) + result_items = result["items"] + assert isinstance(result_items, list) + assert_different_identities(result_items, original["items"]) + assert_different_identities(result_items[0], elem1) + assert_different_identities(result_items[1], elem2) + + def test_empty_paths_returns_same_object(self) -> None: + original = {"foo": "bar"} + result = deepcopy_with_paths(original, []) + assert result is original + + def test_multiple_paths(self) -> None: + f1 = b"file1" + f2 = b"file2" + original = {"a": f1, "b": f2, "c": "unchanged"} + result = deepcopy_with_paths(original, [["a"], ["b"]]) + assert_different_identities(result, original) + assert result["a"] is f1 + assert result["b"] is f2 + assert result["c"] is original["c"] + + def test_extract_files_does_not_mutate_original_top_level(self) -> None: + file_bytes = b"contents" + original = {"file": file_bytes, "other": "value"} + + copied = deepcopy_with_paths(original, [["file"]]) + extracted = extract_files(copied, paths=[["file"]]) + + assert extracted == [("file", file_bytes)] + assert original == {"file": file_bytes, "other": "value"} + assert copied == {"other": "value"} + + def test_extract_files_does_not_mutate_original_nested_array_path(self) -> None: + file1 = b"f1" + file2 = b"f2" + original = { + "items": [ + {"file": file1, "extra": 1}, + {"file": file2, "extra": 2}, + ], + "title": "example", + } + + copied = deepcopy_with_paths(original, [["items", "", "file"]]) + extracted = extract_files(copied, paths=[["items", "", "file"]]) + + assert extracted == [("items[][file]", file1), ("items[][file]", file2)] + assert original == { + "items": [ + {"file": file1, "extra": 1}, + {"file": file2, "extra": 2}, + ], + "title": "example", + } + assert copied == { + "items": [ + {"extra": 1}, + {"extra": 2}, + ], + "title": "example", + } From 0a6f60a8acb8c85a937166884ba523cc59821b8f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 18 Apr 2026 07:03:19 +0000 Subject: [PATCH 24/46] chore(tests): bump steady to v0.22.1 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 5cd7c15..feebe5e 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.20.2 -- steady --version + npm exec --package=@stdy/cli@0.22.1 -- steady --version - npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index b8143aa..19acc91 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.2 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.22.1 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=comma --validator-form-array-format=comma --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" echo exit 1 From d8c02a28202f28aff216e1c51b4dc183bf758246 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 13:28:04 +0000 Subject: [PATCH 25/46] feat(api): api update --- .stats.yml | 8 +- README.md | 11 +- api.md | 14 ++ src/unlayer/_client.py | 39 ++- src/unlayer/resources/__init__.py | 14 ++ src/unlayer/resources/ai/__init__.py | 33 +++ src/unlayer/resources/ai/ai.py | 102 ++++++++ src/unlayer/resources/ai/generate.py | 234 ++++++++++++++++++ src/unlayer/types/ai/__init__.py | 6 + .../types/ai/generate_create_params.py | 94 +++++++ .../types/ai/generate_create_response.py | 45 ++++ tests/api_resources/ai/__init__.py | 1 + tests/api_resources/ai/test_generate.py | 184 ++++++++++++++ 13 files changed, 777 insertions(+), 8 deletions(-) create mode 100644 src/unlayer/resources/ai/__init__.py create mode 100644 src/unlayer/resources/ai/ai.py create mode 100644 src/unlayer/resources/ai/generate.py create mode 100644 src/unlayer/types/ai/__init__.py create mode 100644 src/unlayer/types/ai/generate_create_params.py create mode 100644 src/unlayer/types/ai/generate_create_response.py create mode 100644 tests/api_resources/ai/__init__.py create mode 100644 tests/api_resources/ai/test_generate.py diff --git a/.stats.yml b/.stats.yml index 3004020..2750c56 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 7 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer%2Funlayer-48f00d1c04c23fb4d1cb7cf4af4f56b0c920d758c1f06e06e5373e5b15e9c27d.yml -openapi_spec_hash: 6ee2a94bb9840aceb4a6161c724ce46c -config_hash: c8d97d58d67dad9eeb65eb58fc781724 +configured_endpoints: 8 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer%2Funlayer-a1351fe18005248184e11e2c1d6e4a8df7ecfd0092f9fcfeabaa025a2c5b4986.yml +openapi_spec_hash: 3633a7fdec0e4c3d72dcbadeebaea907 +config_hash: 6f1858ca62cea01f7c1c4427b9263c25 diff --git a/README.md b/README.md index f4c8537..77b79ae 100644 --- a/README.md +++ b/README.md @@ -199,10 +199,15 @@ from unlayer import Unlayer client = Unlayer() -full_to_simple = client.convert.full_to_simple.create( - design={"body": {"foo": "bar"}}, +generate = client.ai.generate.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, ) -print(full_to_simple.design) +print(generate.output) ``` ## Handling errors diff --git a/api.md b/api.md index 4166417..3c78314 100644 --- a/api.md +++ b/api.md @@ -1,3 +1,17 @@ +# AI + +## Generate + +Types: + +```python +from unlayer.types.ai import GenerateCreateResponse +``` + +Methods: + +- client.ai.generate.create(\*\*params) -> GenerateCreateResponse + # Convert ## FullToSimple diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 2c20382..09dd3fd 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -32,7 +32,8 @@ ) if TYPE_CHECKING: - from .resources import convert, projects, templates, workspaces + from .resources import ai, convert, projects, templates, workspaces + from .resources.ai.ai import AIResource, AsyncAIResource from .resources.projects import ProjectsResource, AsyncProjectsResource from .resources.templates import TemplatesResource, AsyncTemplatesResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource @@ -107,6 +108,12 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def ai(self) -> AIResource: + from .resources.ai import AIResource + + return AIResource(self) + @cached_property def convert(self) -> ConvertResource: from .resources.convert import ConvertResource @@ -340,6 +347,12 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def ai(self) -> AsyncAIResource: + from .resources.ai import AsyncAIResource + + return AsyncAIResource(self) + @cached_property def convert(self) -> AsyncConvertResource: from .resources.convert import AsyncConvertResource @@ -513,6 +526,12 @@ class UnlayerWithRawResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def ai(self) -> ai.AIResourceWithRawResponse: + from .resources.ai import AIResourceWithRawResponse + + return AIResourceWithRawResponse(self._client.ai) + @cached_property def convert(self) -> convert.ConvertResourceWithRawResponse: from .resources.convert import ConvertResourceWithRawResponse @@ -547,6 +566,12 @@ class AsyncUnlayerWithRawResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def ai(self) -> ai.AsyncAIResourceWithRawResponse: + from .resources.ai import AsyncAIResourceWithRawResponse + + return AsyncAIResourceWithRawResponse(self._client.ai) + @cached_property def convert(self) -> convert.AsyncConvertResourceWithRawResponse: from .resources.convert import AsyncConvertResourceWithRawResponse @@ -581,6 +606,12 @@ class UnlayerWithStreamedResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def ai(self) -> ai.AIResourceWithStreamingResponse: + from .resources.ai import AIResourceWithStreamingResponse + + return AIResourceWithStreamingResponse(self._client.ai) + @cached_property def convert(self) -> convert.ConvertResourceWithStreamingResponse: from .resources.convert import ConvertResourceWithStreamingResponse @@ -615,6 +646,12 @@ class AsyncUnlayerWithStreamedResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def ai(self) -> ai.AsyncAIResourceWithStreamingResponse: + from .resources.ai import AsyncAIResourceWithStreamingResponse + + return AsyncAIResourceWithStreamingResponse(self._client.ai) + @cached_property def convert(self) -> convert.AsyncConvertResourceWithStreamingResponse: from .resources.convert import AsyncConvertResourceWithStreamingResponse diff --git a/src/unlayer/resources/__init__.py b/src/unlayer/resources/__init__.py index 1de5370..9d521b2 100644 --- a/src/unlayer/resources/__init__.py +++ b/src/unlayer/resources/__init__.py @@ -1,5 +1,13 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +from .ai import ( + AIResource, + AsyncAIResource, + AIResourceWithRawResponse, + AsyncAIResourceWithRawResponse, + AIResourceWithStreamingResponse, + AsyncAIResourceWithStreamingResponse, +) from .convert import ( ConvertResource, AsyncConvertResource, @@ -34,6 +42,12 @@ ) __all__ = [ + "AIResource", + "AsyncAIResource", + "AIResourceWithRawResponse", + "AsyncAIResourceWithRawResponse", + "AIResourceWithStreamingResponse", + "AsyncAIResourceWithStreamingResponse", "ConvertResource", "AsyncConvertResource", "ConvertResourceWithRawResponse", diff --git a/src/unlayer/resources/ai/__init__.py b/src/unlayer/resources/ai/__init__.py new file mode 100644 index 0000000..2f677f9 --- /dev/null +++ b/src/unlayer/resources/ai/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .ai import ( + AIResource, + AsyncAIResource, + AIResourceWithRawResponse, + AsyncAIResourceWithRawResponse, + AIResourceWithStreamingResponse, + AsyncAIResourceWithStreamingResponse, +) +from .generate import ( + GenerateResource, + AsyncGenerateResource, + GenerateResourceWithRawResponse, + AsyncGenerateResourceWithRawResponse, + GenerateResourceWithStreamingResponse, + AsyncGenerateResourceWithStreamingResponse, +) + +__all__ = [ + "GenerateResource", + "AsyncGenerateResource", + "GenerateResourceWithRawResponse", + "AsyncGenerateResourceWithRawResponse", + "GenerateResourceWithStreamingResponse", + "AsyncGenerateResourceWithStreamingResponse", + "AIResource", + "AsyncAIResource", + "AIResourceWithRawResponse", + "AsyncAIResourceWithRawResponse", + "AIResourceWithStreamingResponse", + "AsyncAIResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/ai/ai.py b/src/unlayer/resources/ai/ai.py new file mode 100644 index 0000000..503a4f1 --- /dev/null +++ b/src/unlayer/resources/ai/ai.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .generate import ( + GenerateResource, + AsyncGenerateResource, + GenerateResourceWithRawResponse, + AsyncGenerateResourceWithRawResponse, + GenerateResourceWithStreamingResponse, + AsyncGenerateResourceWithStreamingResponse, +) +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource + +__all__ = ["AIResource", "AsyncAIResource"] + + +class AIResource(SyncAPIResource): + @cached_property + def generate(self) -> GenerateResource: + return GenerateResource(self._client) + + @cached_property + def with_raw_response(self) -> AIResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AIResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AIResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AIResourceWithStreamingResponse(self) + + +class AsyncAIResource(AsyncAPIResource): + @cached_property + def generate(self) -> AsyncGenerateResource: + return AsyncGenerateResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncAIResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAIResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAIResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAIResourceWithStreamingResponse(self) + + +class AIResourceWithRawResponse: + def __init__(self, ai: AIResource) -> None: + self._ai = ai + + @cached_property + def generate(self) -> GenerateResourceWithRawResponse: + return GenerateResourceWithRawResponse(self._ai.generate) + + +class AsyncAIResourceWithRawResponse: + def __init__(self, ai: AsyncAIResource) -> None: + self._ai = ai + + @cached_property + def generate(self) -> AsyncGenerateResourceWithRawResponse: + return AsyncGenerateResourceWithRawResponse(self._ai.generate) + + +class AIResourceWithStreamingResponse: + def __init__(self, ai: AIResource) -> None: + self._ai = ai + + @cached_property + def generate(self) -> GenerateResourceWithStreamingResponse: + return GenerateResourceWithStreamingResponse(self._ai.generate) + + +class AsyncAIResourceWithStreamingResponse: + def __init__(self, ai: AsyncAIResource) -> None: + self._ai = ai + + @cached_property + def generate(self) -> AsyncGenerateResourceWithStreamingResponse: + return AsyncGenerateResourceWithStreamingResponse(self._ai.generate) diff --git a/src/unlayer/resources/ai/generate.py b/src/unlayer/resources/ai/generate.py new file mode 100644 index 0000000..df4acad --- /dev/null +++ b/src/unlayer/resources/ai/generate.py @@ -0,0 +1,234 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Iterable +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ...types.ai import generate_create_params +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.ai.generate_create_response import GenerateCreateResponse + +__all__ = ["GenerateResource", "AsyncGenerateResource"] + + +class GenerateResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> GenerateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return GenerateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> GenerateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return GenerateResourceWithStreamingResponse(self) + + def create( + self, + *, + display_mode: Literal["email", "web", "popup", "document"], + input: Iterable[generate_create_params.Input], + output: generate_create_params.Output, + project_id: str | Omit = omit, + context: generate_create_params.Context | Omit = omit, + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> GenerateCreateResponse: + """Generate, modify, or import an Unlayer design using AI. + + Provide typed input + parts to describe what to generate. + + Args: + display_mode: Display mode for the design + + input: Array of typed input parts (max 50) + + output: What to generate + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + context: Editor environment context + + model: AI model to use, in provider/model format. Optional — defaults to + anthropic/claude-opus-4-6. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/ai/generate", + body=maybe_transform( + { + "display_mode": display_mode, + "input": input, + "output": output, + "context": context, + "model": model, + }, + generate_create_params.GenerateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, generate_create_params.GenerateCreateParams), + ), + cast_to=GenerateCreateResponse, + ) + + +class AsyncGenerateResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncGenerateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncGenerateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncGenerateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncGenerateResourceWithStreamingResponse(self) + + async def create( + self, + *, + display_mode: Literal["email", "web", "popup", "document"], + input: Iterable[generate_create_params.Input], + output: generate_create_params.Output, + project_id: str | Omit = omit, + context: generate_create_params.Context | Omit = omit, + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> GenerateCreateResponse: + """Generate, modify, or import an Unlayer design using AI. + + Provide typed input + parts to describe what to generate. + + Args: + display_mode: Display mode for the design + + input: Array of typed input parts (max 50) + + output: What to generate + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + context: Editor environment context + + model: AI model to use, in provider/model format. Optional — defaults to + anthropic/claude-opus-4-6. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/ai/generate", + body=await async_maybe_transform( + { + "display_mode": display_mode, + "input": input, + "output": output, + "context": context, + "model": model, + }, + generate_create_params.GenerateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, generate_create_params.GenerateCreateParams + ), + ), + cast_to=GenerateCreateResponse, + ) + + +class GenerateResourceWithRawResponse: + def __init__(self, generate: GenerateResource) -> None: + self._generate = generate + + self.create = to_raw_response_wrapper( + generate.create, + ) + + +class AsyncGenerateResourceWithRawResponse: + def __init__(self, generate: AsyncGenerateResource) -> None: + self._generate = generate + + self.create = async_to_raw_response_wrapper( + generate.create, + ) + + +class GenerateResourceWithStreamingResponse: + def __init__(self, generate: GenerateResource) -> None: + self._generate = generate + + self.create = to_streamed_response_wrapper( + generate.create, + ) + + +class AsyncGenerateResourceWithStreamingResponse: + def __init__(self, generate: AsyncGenerateResource) -> None: + self._generate = generate + + self.create = async_to_streamed_response_wrapper( + generate.create, + ) diff --git a/src/unlayer/types/ai/__init__.py b/src/unlayer/types/ai/__init__.py new file mode 100644 index 0000000..199ad74 --- /dev/null +++ b/src/unlayer/types/ai/__init__.py @@ -0,0 +1,6 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .generate_create_params import GenerateCreateParams as GenerateCreateParams +from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse diff --git a/src/unlayer/types/ai/generate_create_params.py b/src/unlayer/types/ai/generate_create_params.py new file mode 100644 index 0000000..e779f52 --- /dev/null +++ b/src/unlayer/types/ai/generate_create_params.py @@ -0,0 +1,94 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Union, Iterable +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["GenerateCreateParams", "Input", "Output", "Context", "ContextCustomTool"] + + +class GenerateCreateParams(TypedDict, total=False): + display_mode: Required[Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")]] + """Display mode for the design""" + + input: Required[Iterable[Input]] + """Array of typed input parts (max 50)""" + + output: Required[Output] + """What to generate""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + context: Context + """Editor environment context""" + + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] + """AI model to use, in provider/model format. + + Optional — defaults to anthropic/claude-opus-4-6. + """ + + +class Input(TypedDict, total=False): + type: Required[Literal["text", "prompt", "json", "html", "image"]] + """The type of input part""" + + id: str + """ + Predefined prompt ID: SPELLING, EXPAND, SUMMARIZE, REPHRASE, FRIENDLY, FORMAL + (for type: "prompt") + """ + + block_type: Annotated[str, PropertyInfo(alias="blockType")] + """Block type of the design data (for type: "json")""" + + data: Union[Dict[str, object], str] + """ + Existing design data (object, for type: "json") or base64 image data (string, + for type: "image") + """ + + html: str + """HTML string to import (for type: "html")""" + + schema_version: Annotated[int, PropertyInfo(alias="schemaVersion")] + """Design schema version (for type: "json")""" + + text: str + """Natural language prompt (for type: "text")""" + + url: str + """Image URL to import (for type: "image")""" + + +class Output(TypedDict, total=False): + """What to generate""" + + block_type: Required[ + Annotated[Literal["template", "page", "body", "content", "row", "column"], PropertyInfo(alias="blockType")] + ] + """The type of design block to generate""" + + type: Required[Literal["json"]] + """Output format — currently only "json" is supported""" + + +class ContextCustomTool(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + options: Required[Dict[str, object]] + + slug: Required[str] + + +class Context(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + """Editor environment context""" + + available_tools: Annotated[SequenceNotStr[str], PropertyInfo(alias="availableTools")] + """Filter content types available in the generated design""" + + custom_tools: Annotated[Iterable[ContextCustomTool], PropertyInfo(alias="customTools")] + """Custom tool declarations with their options""" diff --git a/src/unlayer/types/ai/generate_create_response.py b/src/unlayer/types/ai/generate_create_response.py new file mode 100644 index 0000000..669e741 --- /dev/null +++ b/src/unlayer/types/ai/generate_create_response.py @@ -0,0 +1,45 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["GenerateCreateResponse", "Output", "Usage"] + + +class Output(BaseModel): + block_type: Optional[str] = FieldInfo(alias="blockType", default=None) + + data: Optional[Dict[str, object]] = None + """Generated design data""" + + type: Optional[str] = None + + +class Usage(BaseModel): + cached_input_tokens: Optional[int] = FieldInfo(alias="cachedInputTokens", default=None) + + input_tokens: Optional[int] = FieldInfo(alias="inputTokens", default=None) + + output_tokens: Optional[int] = FieldInfo(alias="outputTokens", default=None) + + reasoning_tokens: Optional[int] = FieldInfo(alias="reasoningTokens", default=None) + + total_tokens: Optional[int] = FieldInfo(alias="totalTokens", default=None) + + +class GenerateCreateResponse(BaseModel): + """Successfully generated design""" + + id: Optional[str] = None + """AI response ID""" + + model: Optional[str] = None + + output: Optional[Output] = None + + provider: Optional[str] = None + + usage: Optional[Usage] = None diff --git a/tests/api_resources/ai/__init__.py b/tests/api_resources/ai/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/ai/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/ai/test_generate.py b/tests/api_resources/ai/test_generate.py new file mode 100644 index 0000000..c504af0 --- /dev/null +++ b/tests/api_resources/ai/test_generate.py @@ -0,0 +1,184 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.ai import GenerateCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestGenerate: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + generate = client.ai.generate.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + generate = client.ai.generate.create( + display_mode="email", + input=[ + { + "type": "text", + "id": "id", + "block_type": "blockType", + "data": {"foo": "bar"}, + "html": "html", + "schema_version": 0, + "text": "text", + "url": "url", + } + ], + output={ + "block_type": "template", + "type": "json", + }, + project_id="projectId", + context={ + "available_tools": ["string"], + "custom_tools": [ + { + "options": {"foo": "bar"}, + "slug": "slug", + } + ], + }, + model="anthropic/claude-opus-4-6", + ) + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.ai.generate.with_raw_response.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + generate = response.parse() + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.ai.generate.with_streaming_response.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + generate = response.parse() + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncGenerate: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + generate = await async_client.ai.generate.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + generate = await async_client.ai.generate.create( + display_mode="email", + input=[ + { + "type": "text", + "id": "id", + "block_type": "blockType", + "data": {"foo": "bar"}, + "html": "html", + "schema_version": 0, + "text": "text", + "url": "url", + } + ], + output={ + "block_type": "template", + "type": "json", + }, + project_id="projectId", + context={ + "available_tools": ["string"], + "custom_tools": [ + { + "options": {"foo": "bar"}, + "slug": "slug", + } + ], + }, + model="anthropic/claude-opus-4-6", + ) + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.ai.generate.with_raw_response.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + generate = await response.parse() + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.ai.generate.with_streaming_response.create( + display_mode="email", + input=[{"type": "text"}], + output={ + "block_type": "template", + "type": "json", + }, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + generate = await response.parse() + assert_matches_type(GenerateCreateResponse, generate, path=["response"]) + + assert cast(Any, response.is_closed) is True From 2543d0b9a29711c39f5b8b5bfeac15dfc66b79b3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 23 Apr 2026 03:42:29 +0000 Subject: [PATCH 26/46] chore(internal): more robust bootstrap script --- scripts/bootstrap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/bootstrap b/scripts/bootstrap index b430fee..fe8451e 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -4,7 +4,7 @@ set -e cd "$(dirname "$0")/.." -if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ] && [ -t 0 ]; then +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "${SKIP_BREW:-}" != "1" ] && [ -t 0 ]; then brew bundle check >/dev/null 2>&1 || { echo -n "==> Install Homebrew dependencies? (y/N): " read -r response From c76b3685383f50f9446c8d0c6844aed7ad8f3696 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 28 Apr 2026 03:44:11 +0000 Subject: [PATCH 27/46] chore(internal): codegen related update --- src/unlayer/_client.py | 24 ++++++++++++++++++++- src/unlayer/_qs.py | 8 ++----- src/unlayer/_types.py | 3 +++ src/unlayer/_utils/_utils.py | 42 +++++++++++++++++++++++++++++------- tests/test_extract_files.py | 28 +++++++++++++++++++----- tests/test_files.py | 2 +- 6 files changed, 86 insertions(+), 21 deletions(-) diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 09dd3fd..57ea61e 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -20,7 +20,11 @@ RequestOptions, not_given, ) -from ._utils import is_given, get_async_library +from ._utils import ( + is_given, + is_mapping_t, + get_async_library, +) from ._compat import cached_property from ._version import __version__ from ._streaming import Stream as Stream, AsyncStream as AsyncStream @@ -97,6 +101,15 @@ def __init__( if base_url is None: base_url = f"https://api.unlayer.com" + custom_headers_env = os.environ.get("UNLAYER_CUSTOM_HEADERS") + if custom_headers_env is not None: + parsed: dict[str, str] = {} + for line in custom_headers_env.split("\n"): + colon = line.find(":") + if colon >= 0: + parsed[line[:colon].strip()] = line[colon + 1 :].strip() + default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})} + super().__init__( version=__version__, base_url=base_url, @@ -336,6 +349,15 @@ def __init__( if base_url is None: base_url = f"https://api.unlayer.com" + custom_headers_env = os.environ.get("UNLAYER_CUSTOM_HEADERS") + if custom_headers_env is not None: + parsed: dict[str, str] = {} + for line in custom_headers_env.split("\n"): + colon = line.find(":") + if colon >= 0: + parsed[line[:colon].strip()] = line[colon + 1 :].strip() + default_headers = {**parsed, **(default_headers if is_mapping_t(default_headers) else {})} + super().__init__( version=__version__, base_url=base_url, diff --git a/src/unlayer/_qs.py b/src/unlayer/_qs.py index de8c99b..4127c19 100644 --- a/src/unlayer/_qs.py +++ b/src/unlayer/_qs.py @@ -2,17 +2,13 @@ from typing import Any, List, Tuple, Union, Mapping, TypeVar from urllib.parse import parse_qs, urlencode -from typing_extensions import Literal, get_args +from typing_extensions import get_args -from ._types import NotGiven, not_given +from ._types import NotGiven, ArrayFormat, NestedFormat, not_given from ._utils import flatten _T = TypeVar("_T") - -ArrayFormat = Literal["comma", "repeat", "indices", "brackets"] -NestedFormat = Literal["dots", "brackets"] - PrimitiveData = Union[str, int, float, bool, None] # this should be Data = Union[PrimitiveData, "List[Data]", "Tuple[Data]", "Mapping[str, Data]"] # https://github.com/microsoft/pyright/issues/3555 diff --git a/src/unlayer/_types.py b/src/unlayer/_types.py index a25667d..b7b3cc5 100644 --- a/src/unlayer/_types.py +++ b/src/unlayer/_types.py @@ -47,6 +47,9 @@ ModelT = TypeVar("ModelT", bound=pydantic.BaseModel) _T = TypeVar("_T") +ArrayFormat = Literal["comma", "repeat", "indices", "brackets"] +NestedFormat = Literal["dots", "brackets"] + # Approximates httpx internal ProxiesTypes and RequestFiles types # while adding support for `PathLike` instances diff --git a/src/unlayer/_utils/_utils.py b/src/unlayer/_utils/_utils.py index 771859f..199cd23 100644 --- a/src/unlayer/_utils/_utils.py +++ b/src/unlayer/_utils/_utils.py @@ -17,11 +17,11 @@ ) from pathlib import Path from datetime import date, datetime -from typing_extensions import TypeGuard +from typing_extensions import TypeGuard, get_args import sniffio -from .._types import Omit, NotGiven, FileTypes, HeadersLike +from .._types import Omit, NotGiven, FileTypes, ArrayFormat, HeadersLike _T = TypeVar("_T") _TupleT = TypeVar("_TupleT", bound=Tuple[object, ...]) @@ -40,25 +40,45 @@ def extract_files( query: Mapping[str, object], *, paths: Sequence[Sequence[str]], + array_format: ArrayFormat = "brackets", ) -> list[tuple[str, FileTypes]]: """Recursively extract files from the given dictionary based on specified paths. A path may look like this ['foo', 'files', '', 'data']. + ``array_format`` controls how ```` segments contribute to the emitted + field name. Supported values: ``"brackets"`` (``foo[]``), ``"repeat"`` and + ``"comma"`` (``foo``), ``"indices"`` (``foo[0]``, ``foo[1]``). + Note: this mutates the given dictionary. """ files: list[tuple[str, FileTypes]] = [] for path in paths: - files.extend(_extract_items(query, path, index=0, flattened_key=None)) + files.extend(_extract_items(query, path, index=0, flattened_key=None, array_format=array_format)) return files +def _array_suffix(array_format: ArrayFormat, array_index: int) -> str: + if array_format == "brackets": + return "[]" + if array_format == "indices": + return f"[{array_index}]" + if array_format == "repeat" or array_format == "comma": + # Both repeat the bare field name for each file part; there is no + # meaningful way to comma-join binary parts. + return "" + raise NotImplementedError( + f"Unknown array_format value: {array_format}, choose from {', '.join(get_args(ArrayFormat))}" + ) + + def _extract_items( obj: object, path: Sequence[str], *, index: int, flattened_key: str | None, + array_format: ArrayFormat, ) -> list[tuple[str, FileTypes]]: try: key = path[index] @@ -75,9 +95,11 @@ def _extract_items( if is_list(obj): files: list[tuple[str, FileTypes]] = [] - for entry in obj: - assert_is_file_content(entry, key=flattened_key + "[]" if flattened_key else "") - files.append((flattened_key + "[]", cast(FileTypes, entry))) + for array_index, entry in enumerate(obj): + suffix = _array_suffix(array_format, array_index) + emitted_key = (flattened_key + suffix) if flattened_key else suffix + assert_is_file_content(entry, key=emitted_key) + files.append((emitted_key, cast(FileTypes, entry))) return files assert_is_file_content(obj, key=flattened_key) @@ -106,6 +128,7 @@ def _extract_items( path, index=index, flattened_key=flattened_key, + array_format=array_format, ) elif is_list(obj): if key != "": @@ -117,9 +140,12 @@ def _extract_items( item, path, index=index, - flattened_key=flattened_key + "[]" if flattened_key is not None else "[]", + flattened_key=( + (flattened_key if flattened_key is not None else "") + _array_suffix(array_format, array_index) + ), + array_format=array_format, ) - for item in obj + for array_index, item in enumerate(obj) ] ) diff --git a/tests/test_extract_files.py b/tests/test_extract_files.py index 9bf5e2d..0598daa 100644 --- a/tests/test_extract_files.py +++ b/tests/test_extract_files.py @@ -4,7 +4,7 @@ import pytest -from unlayer._types import FileTypes +from unlayer._types import FileTypes, ArrayFormat from unlayer._utils import extract_files @@ -37,10 +37,7 @@ def test_multiple_files() -> None: def test_top_level_file_array() -> None: query = {"files": [b"file one", b"file two"], "title": "hello"} - assert extract_files(query, paths=[["files", ""]]) == [ - ("files[]", b"file one"), - ("files[]", b"file two"), - ] + assert extract_files(query, paths=[["files", ""]]) == [("files[]", b"file one"), ("files[]", b"file two")] assert query == {"title": "hello"} @@ -71,3 +68,24 @@ def test_ignores_incorrect_paths( expected: list[tuple[str, FileTypes]], ) -> None: assert extract_files(query, paths=paths) == expected + + +@pytest.mark.parametrize( + "array_format,expected_top_level,expected_nested", + [ + ("brackets", [("files[]", b"a"), ("files[]", b"b")], [("items[][file]", b"a"), ("items[][file]", b"b")]), + ("repeat", [("files", b"a"), ("files", b"b")], [("items[file]", b"a"), ("items[file]", b"b")]), + ("comma", [("files", b"a"), ("files", b"b")], [("items[file]", b"a"), ("items[file]", b"b")]), + ("indices", [("files[0]", b"a"), ("files[1]", b"b")], [("items[0][file]", b"a"), ("items[1][file]", b"b")]), + ], +) +def test_array_format_controls_file_field_names( + array_format: ArrayFormat, + expected_top_level: list[tuple[str, FileTypes]], + expected_nested: list[tuple[str, FileTypes]], +) -> None: + top_level = {"files": [b"a", b"b"]} + assert extract_files(top_level, paths=[["files", ""]], array_format=array_format) == expected_top_level + + nested = {"items": [{"file": b"a"}, {"file": b"b"}]} + assert extract_files(nested, paths=[["items", "", "file"]], array_format=array_format) == expected_nested diff --git a/tests/test_files.py b/tests/test_files.py index e7c851e..99c321f 100644 --- a/tests/test_files.py +++ b/tests/test_files.py @@ -131,7 +131,7 @@ def test_extract_files_does_not_mutate_original_nested_array_path(self) -> None: copied = deepcopy_with_paths(original, [["items", "", "file"]]) extracted = extract_files(copied, paths=[["items", "", "file"]]) - assert extracted == [("items[][file]", file1), ("items[][file]", file2)] + assert [entry for _, entry in extracted] == [file1, file2] assert original == { "items": [ {"file": file1, "extra": 1}, From c5d7b06d9730ea30d83f05611182cb5d23b61dcc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 07:41:22 +0000 Subject: [PATCH 28/46] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 2750c56..ebf5bb6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 8 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer%2Funlayer-a1351fe18005248184e11e2c1d6e4a8df7ecfd0092f9fcfeabaa025a2c5b4986.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-a1351fe18005248184e11e2c1d6e4a8df7ecfd0092f9fcfeabaa025a2c5b4986.yml openapi_spec_hash: 3633a7fdec0e4c3d72dcbadeebaea907 config_hash: 6f1858ca62cea01f7c1c4427b9263c25 From 59d0d244b61420a3358eef33ace74de3c8c3bda3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 1 May 2026 04:38:42 +0000 Subject: [PATCH 29/46] chore(internal): codegen related update --- .stats.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index ebf5bb6..740f0ed 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 8 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-a1351fe18005248184e11e2c1d6e4a8df7ecfd0092f9fcfeabaa025a2c5b4986.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-2f1a1daca1014db99ea15fb1caa33e8c7bbeb5ce8dfe3c438f54f85994d16cb3.yml openapi_spec_hash: 3633a7fdec0e4c3d72dcbadeebaea907 config_hash: 6f1858ca62cea01f7c1c4427b9263c25 diff --git a/pyproject.toml b/pyproject.toml index 967cabc..b650df0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -168,7 +168,7 @@ show_error_codes = true # # We also exclude our `tests` as mypy doesn't always infer # types correctly and Pyright will still catch any type errors. -exclude = ['src/unlayer/_files.py', '_dev/.*.py', 'tests/.*'] +exclude = ["src/unlayer/_files.py", "_dev/.*.py", "tests/.*"] strict_equality = true implicit_reexport = true From 1dba76db8a851e3f2e0e7268cb3b312767ea6d33 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 8 May 2026 08:27:51 +0000 Subject: [PATCH 30/46] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 740f0ed..0f2f691 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 8 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-2f1a1daca1014db99ea15fb1caa33e8c7bbeb5ce8dfe3c438f54f85994d16cb3.yml -openapi_spec_hash: 3633a7fdec0e4c3d72dcbadeebaea907 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-b4c4ec2aa5631a32336e52d2c64dc8dc5bfe262f8630e21900ccbab702071d50.yml +openapi_spec_hash: 12a39212e6991daf3731f164dad85455 config_hash: 6f1858ca62cea01f7c1c4427b9263c25 From 0e34552078692776f7e709082aba188a8609f37f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 9 May 2026 03:51:51 +0000 Subject: [PATCH 31/46] chore(internal): codegen related update --- src/unlayer/_files.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/unlayer/_files.py b/src/unlayer/_files.py index 0fdce17..76da9e0 100644 --- a/src/unlayer/_files.py +++ b/src/unlayer/_files.py @@ -99,7 +99,7 @@ async def async_to_httpx_files(files: RequestFiles | None) -> HttpxRequestFiles elif is_sequence_t(files): files = [(key, await _async_transform_file(file)) for key, file in files] else: - raise TypeError("Unexpected file type input {type(files)}, expected mapping or sequence") + raise TypeError(f"Unexpected file type input {type(files)}, expected mapping or sequence") return files From 65987ba2ea7ff4f674f3fca91869b3685af4fc55 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 12 May 2026 03:42:54 +0000 Subject: [PATCH 32/46] feat(client): add compatibility aliases for old type names --- src/unlayer/_models.py | 80 ++++++++++++++++++++++++++++++++++++++++++ tests/test_models.py | 60 +++++++++++++++++++++++++++++-- 2 files changed, 137 insertions(+), 3 deletions(-) diff --git a/src/unlayer/_models.py b/src/unlayer/_models.py index 29070e0..8c5ab26 100644 --- a/src/unlayer/_models.py +++ b/src/unlayer/_models.py @@ -25,7 +25,9 @@ ClassVar, Protocol, Required, + Annotated, ParamSpec, + TypeAlias, TypedDict, TypeGuard, final, @@ -79,7 +81,15 @@ from ._constants import RAW_RESPONSE_HEADER if TYPE_CHECKING: + from pydantic import GetCoreSchemaHandler, ValidatorFunctionWrapHandler + from pydantic_core import CoreSchema, core_schema from pydantic_core.core_schema import ModelField, ModelSchema, LiteralSchema, ModelFieldsSchema +else: + try: + from pydantic_core import CoreSchema, core_schema + except ImportError: + CoreSchema = None + core_schema = None __all__ = ["BaseModel", "GenericModel"] @@ -396,6 +406,76 @@ def model_dump_json( ) +class _EagerIterable(list[_T], Generic[_T]): + """ + Accepts any Iterable[T] input (including generators), consumes it + eagerly, and validates all items upfront. + + Validation preserves the original container type where possible + (e.g. a set[T] stays a set[T]). Serialization (model_dump / JSON) + always emits a list — round-tripping through model_dump() will not + restore the original container type. + """ + + @classmethod + def __get_pydantic_core_schema__( + cls, + source_type: Any, + handler: GetCoreSchemaHandler, + ) -> CoreSchema: + (item_type,) = get_args(source_type) or (Any,) + item_schema: CoreSchema = handler.generate_schema(item_type) + list_of_items_schema: CoreSchema = core_schema.list_schema(item_schema) + + return core_schema.no_info_wrap_validator_function( + cls._validate, + list_of_items_schema, + serialization=core_schema.plain_serializer_function_ser_schema( + cls._serialize, + info_arg=False, + ), + ) + + @staticmethod + def _validate(v: Iterable[_T], handler: "ValidatorFunctionWrapHandler") -> Any: + original_type: type[Any] = type(v) + + # Normalize to list so list_schema can validate each item + if isinstance(v, list): + items: list[_T] = v + else: + try: + items = list(v) + except TypeError as e: + raise TypeError("Value is not iterable") from e + + # Validate items against the inner schema + validated: list[_T] = handler(items) + + # Reconstruct original container type + if original_type is list: + return validated + # str(list) produces the list's repr, not a string built from items, + # so skip reconstruction for str and its subclasses. + if issubclass(original_type, str): + return validated + try: + return original_type(validated) + except (TypeError, ValueError): + # If the type cannot be reconstructed, just return the validated list + return validated + + @staticmethod + def _serialize(v: Iterable[_T]) -> list[_T]: + """Always serialize as a list so Pydantic's JSON encoder is happy.""" + if isinstance(v, list): + return v + return list(v) + + +EagerIterable: TypeAlias = Annotated[Iterable[_T], _EagerIterable] + + def _construct_field(value: object, field: FieldInfo, key: str) -> object: if value is None: return field_get_default(field) diff --git a/tests/test_models.py b/tests/test_models.py index f6bd612..1a6e3bc 100644 --- a/tests/test_models.py +++ b/tests/test_models.py @@ -1,7 +1,8 @@ import json -from typing import TYPE_CHECKING, Any, Dict, List, Union, Optional, cast +from typing import TYPE_CHECKING, Any, Dict, List, Union, Iterable, Optional, cast from datetime import datetime, timezone -from typing_extensions import Literal, Annotated, TypeAliasType +from collections import deque +from typing_extensions import Literal, Annotated, TypedDict, TypeAliasType import pytest import pydantic @@ -9,7 +10,7 @@ from unlayer._utils import PropertyInfo from unlayer._compat import PYDANTIC_V1, parse_obj, model_dump, model_json -from unlayer._models import DISCRIMINATOR_CACHE, BaseModel, construct_type +from unlayer._models import DISCRIMINATOR_CACHE, BaseModel, EagerIterable, construct_type class BasicModel(BaseModel): @@ -961,3 +962,56 @@ def __getattr__(self, attr: str) -> Item: ... assert model.a.prop == 1 assert isinstance(model.a, Item) assert model.other == "foo" + + +# NOTE: Workaround for Pydantic Iterable behavior. +# Iterable fields are replaced with a ValidatorIterator and may be consumed +# during serialization, which can cause subsequent dumps to return empty data. +# See: https://github.com/pydantic/pydantic/issues/9541 +@pytest.mark.parametrize( + "data, expected_validated", + [ + ([1, 2, 3], [1, 2, 3]), + ((1, 2, 3), (1, 2, 3)), + (set([1, 2, 3]), set([1, 2, 3])), + (iter([1, 2, 3]), [1, 2, 3]), + ([], []), + ((x for x in [1, 2, 3]), [1, 2, 3]), + (map(lambda x: x, [1, 2, 3]), [1, 2, 3]), + (frozenset([1, 2, 3]), frozenset([1, 2, 3])), + (deque([1, 2, 3]), deque([1, 2, 3])), + ], + ids=["list", "tuple", "set", "iterator", "empty", "generator", "map", "frozenset", "deque"], +) +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction(data: Iterable[int], expected_validated: Iterable[int]) -> None: + class TypeWithIterable(TypedDict): + items: EagerIterable[int] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": data}}) + assert m.data["items"] == expected_validated + + # Verify repeated dumps don't lose data (the original bug) + assert m.model_dump()["data"]["items"] == list(expected_validated) + assert m.model_dump()["data"]["items"] == list(expected_validated) + + +@pytest.mark.skipif(PYDANTIC_V1, reason="this is only supported in pydantic v2") +def test_iterable_construction_str_falls_back_to_list() -> None: + # str is iterable (over chars), but str(list_of_chars) produces the list's repr + # rather than reconstructing a string from items. We special-case str to fall + # back to list instead of attempting reconstruction. + class TypeWithIterable(TypedDict): + items: EagerIterable[str] + + class Model(BaseModel): + data: TypeWithIterable + + m = Model.model_validate({"data": {"items": "hello"}}) + + # falls back to list of chars rather than calling str(["h", "e", "l", "l", "o"]) + assert m.data["items"] == ["h", "e", "l", "l", "o"] + assert m.model_dump()["data"]["items"] == ["h", "e", "l", "l", "o"] From f6dbe33abfbb2b8231e0ffc0250e426e0e26f14c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 02:58:40 +0000 Subject: [PATCH 33/46] chore(internal): codegen related update --- .github/workflows/ci.yml | 8 ++++---- .github/workflows/publish-pypi.yml | 2 +- .github/workflows/release-doctor.yml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cb10d13..342d2cd 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,7 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | @@ -46,7 +46,7 @@ jobs: id-token: write runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | @@ -67,7 +67,7 @@ jobs: github.repository == 'stainless-sdks/unlayer-python' && !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc - uses: actions/github-script@v8 + uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0 with: script: core.setOutput('github_token', await core.getIDToken()); @@ -87,7 +87,7 @@ jobs: runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml index 44450e0..67f9b06 100644 --- a/.github/workflows/publish-pypi.yml +++ b/.github/workflows/publish-pypi.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Install Rye run: | diff --git a/.github/workflows/release-doctor.yml b/.github/workflows/release-doctor.yml index 746dab3..46013a6 100644 --- a/.github/workflows/release-doctor.yml +++ b/.github/workflows/release-doctor.yml @@ -12,7 +12,7 @@ jobs: if: github.repository == 'unlayer/unlayer-python' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next') steps: - - uses: actions/checkout@v6 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - name: Check release environment run: | From 167b11e590fda9652ca3f3c798b9d0c90c6b2ce1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 22 May 2026 13:19:51 +0000 Subject: [PATCH 34/46] feat(api): api update --- .stats.yml | 8 +- README.md | 11 +- api.md | 46 ++-- src/unlayer/_client.py | 102 ++------ src/unlayer/resources/__init__.py | 28 --- src/unlayer/resources/ai/__init__.py | 33 --- src/unlayer/resources/ai/ai.py | 102 -------- src/unlayer/resources/convert/__init__.py | 47 ---- src/unlayer/resources/convert/convert.py | 146 ----------- src/unlayer/resources/templates/__init__.py | 75 ++++++ .../convert_full_to_simple.py} | 86 +++---- .../convert_simple_to_full.py} | 86 +++---- .../resources/{ai => templates}/generate.py | 16 +- src/unlayer/resources/templates/import_.py | 224 +++++++++++++++++ .../resources/{ => templates}/templates.py | 228 +++++++++++++++++- src/unlayer/types/ai/__init__.py | 6 - src/unlayer/types/convert/__init__.py | 8 - src/unlayer/types/templates/__init__.py | 16 ++ .../convert_full_to_simple_create_params.py} | 4 +- ...convert_full_to_simple_create_response.py} | 4 +- .../convert_simple_to_full_create_params.py} | 4 +- ...convert_simple_to_full_create_response.py} | 4 +- .../generate_create_params.py | 0 .../generate_create_response.py | 0 .../types/templates/import_create_params.py | 54 +++++ .../types/templates/import_create_response.py | 44 ++++ tests/api_resources/convert/__init__.py | 1 - .../{ai => templates}/__init__.py | 0 .../test_convert_full_to_simple.py} | 46 ++-- .../test_convert_simple_to_full.py} | 46 ++-- .../{ai => templates}/test_generate.py | 18 +- tests/api_resources/templates/test_import_.py | 128 ++++++++++ 32 files changed, 976 insertions(+), 645 deletions(-) delete mode 100644 src/unlayer/resources/ai/__init__.py delete mode 100644 src/unlayer/resources/ai/ai.py delete mode 100644 src/unlayer/resources/convert/__init__.py delete mode 100644 src/unlayer/resources/convert/convert.py create mode 100644 src/unlayer/resources/templates/__init__.py rename src/unlayer/resources/{convert/full_to_simple.py => templates/convert_full_to_simple.py} (66%) rename src/unlayer/resources/{convert/simple_to_full.py => templates/convert_simple_to_full.py} (63%) rename src/unlayer/resources/{ai => templates}/generate.py (95%) create mode 100644 src/unlayer/resources/templates/import_.py rename src/unlayer/resources/{ => templates}/templates.py (55%) delete mode 100644 src/unlayer/types/ai/__init__.py delete mode 100644 src/unlayer/types/convert/__init__.py create mode 100644 src/unlayer/types/templates/__init__.py rename src/unlayer/types/{convert/full_to_simple_create_params.py => templates/convert_full_to_simple_create_params.py} (89%) rename src/unlayer/types/{convert/full_to_simple_create_response.py => templates/convert_full_to_simple_create_response.py} (76%) rename src/unlayer/types/{convert/simple_to_full_create_params.py => templates/convert_simple_to_full_create_params.py} (85%) rename src/unlayer/types/{convert/simple_to_full_create_response.py => templates/convert_simple_to_full_create_response.py} (76%) rename src/unlayer/types/{ai => templates}/generate_create_params.py (100%) rename src/unlayer/types/{ai => templates}/generate_create_response.py (100%) create mode 100644 src/unlayer/types/templates/import_create_params.py create mode 100644 src/unlayer/types/templates/import_create_response.py delete mode 100644 tests/api_resources/convert/__init__.py rename tests/api_resources/{ai => templates}/__init__.py (100%) rename tests/api_resources/{convert/test_full_to_simple.py => templates/test_convert_full_to_simple.py} (60%) rename tests/api_resources/{convert/test_simple_to_full.py => templates/test_convert_simple_to_full.py} (61%) rename tests/api_resources/{ai => templates}/test_generate.py (90%) create mode 100644 tests/api_resources/templates/test_import_.py diff --git a/.stats.yml b/.stats.yml index 0f2f691..f94ad81 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 8 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-b4c4ec2aa5631a32336e52d2c64dc8dc5bfe262f8630e21900ccbab702071d50.yml -openapi_spec_hash: 12a39212e6991daf3731f164dad85455 -config_hash: 6f1858ca62cea01f7c1c4427b9263c25 +configured_endpoints: 9 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-e87049219505c250c95423461c7fb7aa280a3238f98577973c687c1030da26bf.yml +openapi_spec_hash: 613060b45d55c1ab27b70973e4402dfd +config_hash: 2029dabcdae1b263de41e1a890ee90d8 diff --git a/README.md b/README.md index 77b79ae..757d268 100644 --- a/README.md +++ b/README.md @@ -199,15 +199,10 @@ from unlayer import Unlayer client = Unlayer() -generate = client.ai.generate.create( - display_mode="email", - input=[{"type": "text"}], - output={ - "block_type": "template", - "type": "json", - }, +convert_full_to_simple = client.templates.convert_full_to_simple.create( + design={"body": {"foo": "bar"}}, ) -print(generate.output) +print(convert_full_to_simple.design) ``` ## Handling errors diff --git a/api.md b/api.md index 3c78314..5160d97 100644 --- a/api.md +++ b/api.md @@ -1,67 +1,75 @@ -# AI - -## Generate +# Projects Types: ```python -from unlayer.types.ai import GenerateCreateResponse +from unlayer.types import ProjectRetrieveResponse ``` Methods: -- client.ai.generate.create(\*\*params) -> GenerateCreateResponse +- client.projects.retrieve(id) -> ProjectRetrieveResponse -# Convert +# Templates -## FullToSimple +Types: + +```python +from unlayer.types import TemplateRetrieveResponse, TemplateListResponse +``` + +Methods: + +- client.templates.retrieve(id, \*\*params) -> TemplateRetrieveResponse +- client.templates.list(\*\*params) -> SyncCursorPage[TemplateListResponse] + +## ConvertFullToSimple Types: ```python -from unlayer.types.convert import FullToSimpleCreateResponse +from unlayer.types.templates import ConvertFullToSimpleCreateResponse ``` Methods: -- client.convert.full_to_simple.create(\*\*params) -> FullToSimpleCreateResponse +- client.templates.convert_full_to_simple.create(\*\*params) -> ConvertFullToSimpleCreateResponse -## SimpleToFull +## ConvertSimpleToFull Types: ```python -from unlayer.types.convert import SimpleToFullCreateResponse +from unlayer.types.templates import ConvertSimpleToFullCreateResponse ``` Methods: -- client.convert.simple_to_full.create(\*\*params) -> SimpleToFullCreateResponse +- client.templates.convert_simple_to_full.create(\*\*params) -> ConvertSimpleToFullCreateResponse -# Projects +## Generate Types: ```python -from unlayer.types import ProjectRetrieveResponse +from unlayer.types.templates import GenerateCreateResponse ``` Methods: -- client.projects.retrieve(id) -> ProjectRetrieveResponse +- client.templates.generate.create(\*\*params) -> GenerateCreateResponse -# Templates +## Import Types: ```python -from unlayer.types import TemplateRetrieveResponse, TemplateListResponse +from unlayer.types.templates import ImportCreateResponse ``` Methods: -- client.templates.retrieve(id, \*\*params) -> TemplateRetrieveResponse -- client.templates.list(\*\*params) -> SyncCursorPage[TemplateListResponse] +- client.templates.import*.create(\*\*params) -> ImportCreateResponse # Workspaces diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 57ea61e..6ab1a5f 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -36,12 +36,10 @@ ) if TYPE_CHECKING: - from .resources import ai, convert, projects, templates, workspaces - from .resources.ai.ai import AIResource, AsyncAIResource + from .resources import projects, templates, workspaces from .resources.projects import ProjectsResource, AsyncProjectsResource - from .resources.templates import TemplatesResource, AsyncTemplatesResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource - from .resources.convert.convert import ConvertResource, AsyncConvertResource + from .resources.templates.templates import TemplatesResource, AsyncTemplatesResource __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Unlayer", "AsyncUnlayer", "Client", "AsyncClient"] @@ -121,18 +119,6 @@ def __init__( _strict_response_validation=_strict_response_validation, ) - @cached_property - def ai(self) -> AIResource: - from .resources.ai import AIResource - - return AIResource(self) - - @cached_property - def convert(self) -> ConvertResource: - from .resources.convert import ConvertResource - - return ConvertResource(self) - @cached_property def projects(self) -> ProjectsResource: """Project details and configuration.""" @@ -142,7 +128,9 @@ def projects(self) -> ProjectsResource: @cached_property def templates(self) -> TemplatesResource: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import TemplatesResource return TemplatesResource(self) @@ -369,18 +357,6 @@ def __init__( _strict_response_validation=_strict_response_validation, ) - @cached_property - def ai(self) -> AsyncAIResource: - from .resources.ai import AsyncAIResource - - return AsyncAIResource(self) - - @cached_property - def convert(self) -> AsyncConvertResource: - from .resources.convert import AsyncConvertResource - - return AsyncConvertResource(self) - @cached_property def projects(self) -> AsyncProjectsResource: """Project details and configuration.""" @@ -390,7 +366,9 @@ def projects(self) -> AsyncProjectsResource: @cached_property def templates(self) -> AsyncTemplatesResource: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import AsyncTemplatesResource return AsyncTemplatesResource(self) @@ -548,18 +526,6 @@ class UnlayerWithRawResponse: def __init__(self, client: Unlayer) -> None: self._client = client - @cached_property - def ai(self) -> ai.AIResourceWithRawResponse: - from .resources.ai import AIResourceWithRawResponse - - return AIResourceWithRawResponse(self._client.ai) - - @cached_property - def convert(self) -> convert.ConvertResourceWithRawResponse: - from .resources.convert import ConvertResourceWithRawResponse - - return ConvertResourceWithRawResponse(self._client.convert) - @cached_property def projects(self) -> projects.ProjectsResourceWithRawResponse: """Project details and configuration.""" @@ -569,7 +535,9 @@ def projects(self) -> projects.ProjectsResourceWithRawResponse: @cached_property def templates(self) -> templates.TemplatesResourceWithRawResponse: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import TemplatesResourceWithRawResponse return TemplatesResourceWithRawResponse(self._client.templates) @@ -588,18 +556,6 @@ class AsyncUnlayerWithRawResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client - @cached_property - def ai(self) -> ai.AsyncAIResourceWithRawResponse: - from .resources.ai import AsyncAIResourceWithRawResponse - - return AsyncAIResourceWithRawResponse(self._client.ai) - - @cached_property - def convert(self) -> convert.AsyncConvertResourceWithRawResponse: - from .resources.convert import AsyncConvertResourceWithRawResponse - - return AsyncConvertResourceWithRawResponse(self._client.convert) - @cached_property def projects(self) -> projects.AsyncProjectsResourceWithRawResponse: """Project details and configuration.""" @@ -609,7 +565,9 @@ def projects(self) -> projects.AsyncProjectsResourceWithRawResponse: @cached_property def templates(self) -> templates.AsyncTemplatesResourceWithRawResponse: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import AsyncTemplatesResourceWithRawResponse return AsyncTemplatesResourceWithRawResponse(self._client.templates) @@ -628,18 +586,6 @@ class UnlayerWithStreamedResponse: def __init__(self, client: Unlayer) -> None: self._client = client - @cached_property - def ai(self) -> ai.AIResourceWithStreamingResponse: - from .resources.ai import AIResourceWithStreamingResponse - - return AIResourceWithStreamingResponse(self._client.ai) - - @cached_property - def convert(self) -> convert.ConvertResourceWithStreamingResponse: - from .resources.convert import ConvertResourceWithStreamingResponse - - return ConvertResourceWithStreamingResponse(self._client.convert) - @cached_property def projects(self) -> projects.ProjectsResourceWithStreamingResponse: """Project details and configuration.""" @@ -649,7 +595,9 @@ def projects(self) -> projects.ProjectsResourceWithStreamingResponse: @cached_property def templates(self) -> templates.TemplatesResourceWithStreamingResponse: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import TemplatesResourceWithStreamingResponse return TemplatesResourceWithStreamingResponse(self._client.templates) @@ -668,18 +616,6 @@ class AsyncUnlayerWithStreamedResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client - @cached_property - def ai(self) -> ai.AsyncAIResourceWithStreamingResponse: - from .resources.ai import AsyncAIResourceWithStreamingResponse - - return AsyncAIResourceWithStreamingResponse(self._client.ai) - - @cached_property - def convert(self) -> convert.AsyncConvertResourceWithStreamingResponse: - from .resources.convert import AsyncConvertResourceWithStreamingResponse - - return AsyncConvertResourceWithStreamingResponse(self._client.convert) - @cached_property def projects(self) -> projects.AsyncProjectsResourceWithStreamingResponse: """Project details and configuration.""" @@ -689,7 +625,9 @@ def projects(self) -> projects.AsyncProjectsResourceWithStreamingResponse: @cached_property def templates(self) -> templates.AsyncTemplatesResourceWithStreamingResponse: - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ from .resources.templates import AsyncTemplatesResourceWithStreamingResponse return AsyncTemplatesResourceWithStreamingResponse(self._client.templates) diff --git a/src/unlayer/resources/__init__.py b/src/unlayer/resources/__init__.py index 9d521b2..7f3c4bd 100644 --- a/src/unlayer/resources/__init__.py +++ b/src/unlayer/resources/__init__.py @@ -1,21 +1,5 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from .ai import ( - AIResource, - AsyncAIResource, - AIResourceWithRawResponse, - AsyncAIResourceWithRawResponse, - AIResourceWithStreamingResponse, - AsyncAIResourceWithStreamingResponse, -) -from .convert import ( - ConvertResource, - AsyncConvertResource, - ConvertResourceWithRawResponse, - AsyncConvertResourceWithRawResponse, - ConvertResourceWithStreamingResponse, - AsyncConvertResourceWithStreamingResponse, -) from .projects import ( ProjectsResource, AsyncProjectsResource, @@ -42,18 +26,6 @@ ) __all__ = [ - "AIResource", - "AsyncAIResource", - "AIResourceWithRawResponse", - "AsyncAIResourceWithRawResponse", - "AIResourceWithStreamingResponse", - "AsyncAIResourceWithStreamingResponse", - "ConvertResource", - "AsyncConvertResource", - "ConvertResourceWithRawResponse", - "AsyncConvertResourceWithRawResponse", - "ConvertResourceWithStreamingResponse", - "AsyncConvertResourceWithStreamingResponse", "ProjectsResource", "AsyncProjectsResource", "ProjectsResourceWithRawResponse", diff --git a/src/unlayer/resources/ai/__init__.py b/src/unlayer/resources/ai/__init__.py deleted file mode 100644 index 2f677f9..0000000 --- a/src/unlayer/resources/ai/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from .ai import ( - AIResource, - AsyncAIResource, - AIResourceWithRawResponse, - AsyncAIResourceWithRawResponse, - AIResourceWithStreamingResponse, - AsyncAIResourceWithStreamingResponse, -) -from .generate import ( - GenerateResource, - AsyncGenerateResource, - GenerateResourceWithRawResponse, - AsyncGenerateResourceWithRawResponse, - GenerateResourceWithStreamingResponse, - AsyncGenerateResourceWithStreamingResponse, -) - -__all__ = [ - "GenerateResource", - "AsyncGenerateResource", - "GenerateResourceWithRawResponse", - "AsyncGenerateResourceWithRawResponse", - "GenerateResourceWithStreamingResponse", - "AsyncGenerateResourceWithStreamingResponse", - "AIResource", - "AsyncAIResource", - "AIResourceWithRawResponse", - "AsyncAIResourceWithRawResponse", - "AIResourceWithStreamingResponse", - "AsyncAIResourceWithStreamingResponse", -] diff --git a/src/unlayer/resources/ai/ai.py b/src/unlayer/resources/ai/ai.py deleted file mode 100644 index 503a4f1..0000000 --- a/src/unlayer/resources/ai/ai.py +++ /dev/null @@ -1,102 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from __future__ import annotations - -from .generate import ( - GenerateResource, - AsyncGenerateResource, - GenerateResourceWithRawResponse, - AsyncGenerateResourceWithRawResponse, - GenerateResourceWithStreamingResponse, - AsyncGenerateResourceWithStreamingResponse, -) -from ..._compat import cached_property -from ..._resource import SyncAPIResource, AsyncAPIResource - -__all__ = ["AIResource", "AsyncAIResource"] - - -class AIResource(SyncAPIResource): - @cached_property - def generate(self) -> GenerateResource: - return GenerateResource(self._client) - - @cached_property - def with_raw_response(self) -> AIResourceWithRawResponse: - """ - This property can be used as a prefix for any HTTP method call to return - the raw response object instead of the parsed content. - - For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers - """ - return AIResourceWithRawResponse(self) - - @cached_property - def with_streaming_response(self) -> AIResourceWithStreamingResponse: - """ - An alternative to `.with_raw_response` that doesn't eagerly read the response body. - - For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response - """ - return AIResourceWithStreamingResponse(self) - - -class AsyncAIResource(AsyncAPIResource): - @cached_property - def generate(self) -> AsyncGenerateResource: - return AsyncGenerateResource(self._client) - - @cached_property - def with_raw_response(self) -> AsyncAIResourceWithRawResponse: - """ - This property can be used as a prefix for any HTTP method call to return - the raw response object instead of the parsed content. - - For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers - """ - return AsyncAIResourceWithRawResponse(self) - - @cached_property - def with_streaming_response(self) -> AsyncAIResourceWithStreamingResponse: - """ - An alternative to `.with_raw_response` that doesn't eagerly read the response body. - - For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response - """ - return AsyncAIResourceWithStreamingResponse(self) - - -class AIResourceWithRawResponse: - def __init__(self, ai: AIResource) -> None: - self._ai = ai - - @cached_property - def generate(self) -> GenerateResourceWithRawResponse: - return GenerateResourceWithRawResponse(self._ai.generate) - - -class AsyncAIResourceWithRawResponse: - def __init__(self, ai: AsyncAIResource) -> None: - self._ai = ai - - @cached_property - def generate(self) -> AsyncGenerateResourceWithRawResponse: - return AsyncGenerateResourceWithRawResponse(self._ai.generate) - - -class AIResourceWithStreamingResponse: - def __init__(self, ai: AIResource) -> None: - self._ai = ai - - @cached_property - def generate(self) -> GenerateResourceWithStreamingResponse: - return GenerateResourceWithStreamingResponse(self._ai.generate) - - -class AsyncAIResourceWithStreamingResponse: - def __init__(self, ai: AsyncAIResource) -> None: - self._ai = ai - - @cached_property - def generate(self) -> AsyncGenerateResourceWithStreamingResponse: - return AsyncGenerateResourceWithStreamingResponse(self._ai.generate) diff --git a/src/unlayer/resources/convert/__init__.py b/src/unlayer/resources/convert/__init__.py deleted file mode 100644 index a2626b5..0000000 --- a/src/unlayer/resources/convert/__init__.py +++ /dev/null @@ -1,47 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from .convert import ( - ConvertResource, - AsyncConvertResource, - ConvertResourceWithRawResponse, - AsyncConvertResourceWithRawResponse, - ConvertResourceWithStreamingResponse, - AsyncConvertResourceWithStreamingResponse, -) -from .full_to_simple import ( - FullToSimpleResource, - AsyncFullToSimpleResource, - FullToSimpleResourceWithRawResponse, - AsyncFullToSimpleResourceWithRawResponse, - FullToSimpleResourceWithStreamingResponse, - AsyncFullToSimpleResourceWithStreamingResponse, -) -from .simple_to_full import ( - SimpleToFullResource, - AsyncSimpleToFullResource, - SimpleToFullResourceWithRawResponse, - AsyncSimpleToFullResourceWithRawResponse, - SimpleToFullResourceWithStreamingResponse, - AsyncSimpleToFullResourceWithStreamingResponse, -) - -__all__ = [ - "FullToSimpleResource", - "AsyncFullToSimpleResource", - "FullToSimpleResourceWithRawResponse", - "AsyncFullToSimpleResourceWithRawResponse", - "FullToSimpleResourceWithStreamingResponse", - "AsyncFullToSimpleResourceWithStreamingResponse", - "SimpleToFullResource", - "AsyncSimpleToFullResource", - "SimpleToFullResourceWithRawResponse", - "AsyncSimpleToFullResourceWithRawResponse", - "SimpleToFullResourceWithStreamingResponse", - "AsyncSimpleToFullResourceWithStreamingResponse", - "ConvertResource", - "AsyncConvertResource", - "ConvertResourceWithRawResponse", - "AsyncConvertResourceWithRawResponse", - "ConvertResourceWithStreamingResponse", - "AsyncConvertResourceWithStreamingResponse", -] diff --git a/src/unlayer/resources/convert/convert.py b/src/unlayer/resources/convert/convert.py deleted file mode 100644 index e4fdfc7..0000000 --- a/src/unlayer/resources/convert/convert.py +++ /dev/null @@ -1,146 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from __future__ import annotations - -from ..._compat import cached_property -from ..._resource import SyncAPIResource, AsyncAPIResource -from .full_to_simple import ( - FullToSimpleResource, - AsyncFullToSimpleResource, - FullToSimpleResourceWithRawResponse, - AsyncFullToSimpleResourceWithRawResponse, - FullToSimpleResourceWithStreamingResponse, - AsyncFullToSimpleResourceWithStreamingResponse, -) -from .simple_to_full import ( - SimpleToFullResource, - AsyncSimpleToFullResource, - SimpleToFullResourceWithRawResponse, - AsyncSimpleToFullResourceWithRawResponse, - SimpleToFullResourceWithStreamingResponse, - AsyncSimpleToFullResourceWithStreamingResponse, -) - -__all__ = ["ConvertResource", "AsyncConvertResource"] - - -class ConvertResource(SyncAPIResource): - @cached_property - def full_to_simple(self) -> FullToSimpleResource: - """Design schema conversion between Full and Simple formats.""" - return FullToSimpleResource(self._client) - - @cached_property - def simple_to_full(self) -> SimpleToFullResource: - """Design schema conversion between Full and Simple formats.""" - return SimpleToFullResource(self._client) - - @cached_property - def with_raw_response(self) -> ConvertResourceWithRawResponse: - """ - This property can be used as a prefix for any HTTP method call to return - the raw response object instead of the parsed content. - - For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers - """ - return ConvertResourceWithRawResponse(self) - - @cached_property - def with_streaming_response(self) -> ConvertResourceWithStreamingResponse: - """ - An alternative to `.with_raw_response` that doesn't eagerly read the response body. - - For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response - """ - return ConvertResourceWithStreamingResponse(self) - - -class AsyncConvertResource(AsyncAPIResource): - @cached_property - def full_to_simple(self) -> AsyncFullToSimpleResource: - """Design schema conversion between Full and Simple formats.""" - return AsyncFullToSimpleResource(self._client) - - @cached_property - def simple_to_full(self) -> AsyncSimpleToFullResource: - """Design schema conversion between Full and Simple formats.""" - return AsyncSimpleToFullResource(self._client) - - @cached_property - def with_raw_response(self) -> AsyncConvertResourceWithRawResponse: - """ - This property can be used as a prefix for any HTTP method call to return - the raw response object instead of the parsed content. - - For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers - """ - return AsyncConvertResourceWithRawResponse(self) - - @cached_property - def with_streaming_response(self) -> AsyncConvertResourceWithStreamingResponse: - """ - An alternative to `.with_raw_response` that doesn't eagerly read the response body. - - For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response - """ - return AsyncConvertResourceWithStreamingResponse(self) - - -class ConvertResourceWithRawResponse: - def __init__(self, convert: ConvertResource) -> None: - self._convert = convert - - @cached_property - def full_to_simple(self) -> FullToSimpleResourceWithRawResponse: - """Design schema conversion between Full and Simple formats.""" - return FullToSimpleResourceWithRawResponse(self._convert.full_to_simple) - - @cached_property - def simple_to_full(self) -> SimpleToFullResourceWithRawResponse: - """Design schema conversion between Full and Simple formats.""" - return SimpleToFullResourceWithRawResponse(self._convert.simple_to_full) - - -class AsyncConvertResourceWithRawResponse: - def __init__(self, convert: AsyncConvertResource) -> None: - self._convert = convert - - @cached_property - def full_to_simple(self) -> AsyncFullToSimpleResourceWithRawResponse: - """Design schema conversion between Full and Simple formats.""" - return AsyncFullToSimpleResourceWithRawResponse(self._convert.full_to_simple) - - @cached_property - def simple_to_full(self) -> AsyncSimpleToFullResourceWithRawResponse: - """Design schema conversion between Full and Simple formats.""" - return AsyncSimpleToFullResourceWithRawResponse(self._convert.simple_to_full) - - -class ConvertResourceWithStreamingResponse: - def __init__(self, convert: ConvertResource) -> None: - self._convert = convert - - @cached_property - def full_to_simple(self) -> FullToSimpleResourceWithStreamingResponse: - """Design schema conversion between Full and Simple formats.""" - return FullToSimpleResourceWithStreamingResponse(self._convert.full_to_simple) - - @cached_property - def simple_to_full(self) -> SimpleToFullResourceWithStreamingResponse: - """Design schema conversion between Full and Simple formats.""" - return SimpleToFullResourceWithStreamingResponse(self._convert.simple_to_full) - - -class AsyncConvertResourceWithStreamingResponse: - def __init__(self, convert: AsyncConvertResource) -> None: - self._convert = convert - - @cached_property - def full_to_simple(self) -> AsyncFullToSimpleResourceWithStreamingResponse: - """Design schema conversion between Full and Simple formats.""" - return AsyncFullToSimpleResourceWithStreamingResponse(self._convert.full_to_simple) - - @cached_property - def simple_to_full(self) -> AsyncSimpleToFullResourceWithStreamingResponse: - """Design schema conversion between Full and Simple formats.""" - return AsyncSimpleToFullResourceWithStreamingResponse(self._convert.simple_to_full) diff --git a/src/unlayer/resources/templates/__init__.py b/src/unlayer/resources/templates/__init__.py new file mode 100644 index 0000000..036e3f4 --- /dev/null +++ b/src/unlayer/resources/templates/__init__.py @@ -0,0 +1,75 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .import_ import ( + ImportResource, + AsyncImportResource, + ImportResourceWithRawResponse, + AsyncImportResourceWithRawResponse, + ImportResourceWithStreamingResponse, + AsyncImportResourceWithStreamingResponse, +) +from .generate import ( + GenerateResource, + AsyncGenerateResource, + GenerateResourceWithRawResponse, + AsyncGenerateResourceWithRawResponse, + GenerateResourceWithStreamingResponse, + AsyncGenerateResourceWithStreamingResponse, +) +from .templates import ( + TemplatesResource, + AsyncTemplatesResource, + TemplatesResourceWithRawResponse, + AsyncTemplatesResourceWithRawResponse, + TemplatesResourceWithStreamingResponse, + AsyncTemplatesResourceWithStreamingResponse, +) +from .convert_full_to_simple import ( + ConvertFullToSimpleResource, + AsyncConvertFullToSimpleResource, + ConvertFullToSimpleResourceWithRawResponse, + AsyncConvertFullToSimpleResourceWithRawResponse, + ConvertFullToSimpleResourceWithStreamingResponse, + AsyncConvertFullToSimpleResourceWithStreamingResponse, +) +from .convert_simple_to_full import ( + ConvertSimpleToFullResource, + AsyncConvertSimpleToFullResource, + ConvertSimpleToFullResourceWithRawResponse, + AsyncConvertSimpleToFullResourceWithRawResponse, + ConvertSimpleToFullResourceWithStreamingResponse, + AsyncConvertSimpleToFullResourceWithStreamingResponse, +) + +__all__ = [ + "ConvertFullToSimpleResource", + "AsyncConvertFullToSimpleResource", + "ConvertFullToSimpleResourceWithRawResponse", + "AsyncConvertFullToSimpleResourceWithRawResponse", + "ConvertFullToSimpleResourceWithStreamingResponse", + "AsyncConvertFullToSimpleResourceWithStreamingResponse", + "ConvertSimpleToFullResource", + "AsyncConvertSimpleToFullResource", + "ConvertSimpleToFullResourceWithRawResponse", + "AsyncConvertSimpleToFullResourceWithRawResponse", + "ConvertSimpleToFullResourceWithStreamingResponse", + "AsyncConvertSimpleToFullResourceWithStreamingResponse", + "GenerateResource", + "AsyncGenerateResource", + "GenerateResourceWithRawResponse", + "AsyncGenerateResourceWithRawResponse", + "GenerateResourceWithStreamingResponse", + "AsyncGenerateResourceWithStreamingResponse", + "ImportResource", + "AsyncImportResource", + "ImportResourceWithRawResponse", + "AsyncImportResourceWithRawResponse", + "ImportResourceWithStreamingResponse", + "AsyncImportResourceWithStreamingResponse", + "TemplatesResource", + "AsyncTemplatesResource", + "TemplatesResourceWithRawResponse", + "AsyncTemplatesResourceWithRawResponse", + "TemplatesResourceWithStreamingResponse", + "AsyncTemplatesResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/convert/full_to_simple.py b/src/unlayer/resources/templates/convert_full_to_simple.py similarity index 66% rename from src/unlayer/resources/convert/full_to_simple.py rename to src/unlayer/resources/templates/convert_full_to_simple.py index 35ea241..d1a2b3b 100644 --- a/src/unlayer/resources/convert/full_to_simple.py +++ b/src/unlayer/resources/templates/convert_full_to_simple.py @@ -17,38 +17,40 @@ async_to_streamed_response_wrapper, ) from ..._base_client import make_request_options -from ...types.convert import full_to_simple_create_params -from ...types.convert.full_to_simple_create_response import FullToSimpleCreateResponse +from ...types.templates import convert_full_to_simple_create_params +from ...types.templates.convert_full_to_simple_create_response import ConvertFullToSimpleCreateResponse -__all__ = ["FullToSimpleResource", "AsyncFullToSimpleResource"] +__all__ = ["ConvertFullToSimpleResource", "AsyncConvertFullToSimpleResource"] -class FullToSimpleResource(SyncAPIResource): - """Design schema conversion between Full and Simple formats.""" +class ConvertFullToSimpleResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ @cached_property - def with_raw_response(self) -> FullToSimpleResourceWithRawResponse: + def with_raw_response(self) -> ConvertFullToSimpleResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return FullToSimpleResourceWithRawResponse(self) + return ConvertFullToSimpleResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> FullToSimpleResourceWithStreamingResponse: + def with_streaming_response(self) -> ConvertFullToSimpleResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return FullToSimpleResourceWithStreamingResponse(self) + return ConvertFullToSimpleResourceWithStreamingResponse(self) def create( self, *, - design: full_to_simple_create_params.Design, + design: convert_full_to_simple_create_params.Design, display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, include_conversion: bool | Omit = omit, include_default_values: bool | Omit = omit, @@ -58,7 +60,7 @@ def create( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> FullToSimpleCreateResponse: + ) -> ConvertFullToSimpleCreateResponse: """ Convert design json from Full to Simple schema. @@ -75,7 +77,7 @@ def create( timeout: Override the client-level default timeout for this request, in seconds """ return self._post( - "/v3/convert/full-to-simple", + "/v3/templates/convert/full-to-simple", body=maybe_transform( { "design": design, @@ -83,41 +85,43 @@ def create( "include_conversion": include_conversion, "include_default_values": include_default_values, }, - full_to_simple_create_params.FullToSimpleCreateParams, + convert_full_to_simple_create_params.ConvertFullToSimpleCreateParams, ), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=FullToSimpleCreateResponse, + cast_to=ConvertFullToSimpleCreateResponse, ) -class AsyncFullToSimpleResource(AsyncAPIResource): - """Design schema conversion between Full and Simple formats.""" +class AsyncConvertFullToSimpleResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ @cached_property - def with_raw_response(self) -> AsyncFullToSimpleResourceWithRawResponse: + def with_raw_response(self) -> AsyncConvertFullToSimpleResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return AsyncFullToSimpleResourceWithRawResponse(self) + return AsyncConvertFullToSimpleResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> AsyncFullToSimpleResourceWithStreamingResponse: + def with_streaming_response(self) -> AsyncConvertFullToSimpleResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return AsyncFullToSimpleResourceWithStreamingResponse(self) + return AsyncConvertFullToSimpleResourceWithStreamingResponse(self) async def create( self, *, - design: full_to_simple_create_params.Design, + design: convert_full_to_simple_create_params.Design, display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, include_conversion: bool | Omit = omit, include_default_values: bool | Omit = omit, @@ -127,7 +131,7 @@ async def create( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> FullToSimpleCreateResponse: + ) -> ConvertFullToSimpleCreateResponse: """ Convert design json from Full to Simple schema. @@ -144,7 +148,7 @@ async def create( timeout: Override the client-level default timeout for this request, in seconds """ return await self._post( - "/v3/convert/full-to-simple", + "/v3/templates/convert/full-to-simple", body=await async_maybe_transform( { "design": design, @@ -152,46 +156,46 @@ async def create( "include_conversion": include_conversion, "include_default_values": include_default_values, }, - full_to_simple_create_params.FullToSimpleCreateParams, + convert_full_to_simple_create_params.ConvertFullToSimpleCreateParams, ), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=FullToSimpleCreateResponse, + cast_to=ConvertFullToSimpleCreateResponse, ) -class FullToSimpleResourceWithRawResponse: - def __init__(self, full_to_simple: FullToSimpleResource) -> None: - self._full_to_simple = full_to_simple +class ConvertFullToSimpleResourceWithRawResponse: + def __init__(self, convert_full_to_simple: ConvertFullToSimpleResource) -> None: + self._convert_full_to_simple = convert_full_to_simple self.create = to_raw_response_wrapper( - full_to_simple.create, + convert_full_to_simple.create, ) -class AsyncFullToSimpleResourceWithRawResponse: - def __init__(self, full_to_simple: AsyncFullToSimpleResource) -> None: - self._full_to_simple = full_to_simple +class AsyncConvertFullToSimpleResourceWithRawResponse: + def __init__(self, convert_full_to_simple: AsyncConvertFullToSimpleResource) -> None: + self._convert_full_to_simple = convert_full_to_simple self.create = async_to_raw_response_wrapper( - full_to_simple.create, + convert_full_to_simple.create, ) -class FullToSimpleResourceWithStreamingResponse: - def __init__(self, full_to_simple: FullToSimpleResource) -> None: - self._full_to_simple = full_to_simple +class ConvertFullToSimpleResourceWithStreamingResponse: + def __init__(self, convert_full_to_simple: ConvertFullToSimpleResource) -> None: + self._convert_full_to_simple = convert_full_to_simple self.create = to_streamed_response_wrapper( - full_to_simple.create, + convert_full_to_simple.create, ) -class AsyncFullToSimpleResourceWithStreamingResponse: - def __init__(self, full_to_simple: AsyncFullToSimpleResource) -> None: - self._full_to_simple = full_to_simple +class AsyncConvertFullToSimpleResourceWithStreamingResponse: + def __init__(self, convert_full_to_simple: AsyncConvertFullToSimpleResource) -> None: + self._convert_full_to_simple = convert_full_to_simple self.create = async_to_streamed_response_wrapper( - full_to_simple.create, + convert_full_to_simple.create, ) diff --git a/src/unlayer/resources/convert/simple_to_full.py b/src/unlayer/resources/templates/convert_simple_to_full.py similarity index 63% rename from src/unlayer/resources/convert/simple_to_full.py rename to src/unlayer/resources/templates/convert_simple_to_full.py index 5f22bb0..3023dbd 100644 --- a/src/unlayer/resources/convert/simple_to_full.py +++ b/src/unlayer/resources/templates/convert_simple_to_full.py @@ -17,38 +17,40 @@ async_to_streamed_response_wrapper, ) from ..._base_client import make_request_options -from ...types.convert import simple_to_full_create_params -from ...types.convert.simple_to_full_create_response import SimpleToFullCreateResponse +from ...types.templates import convert_simple_to_full_create_params +from ...types.templates.convert_simple_to_full_create_response import ConvertSimpleToFullCreateResponse -__all__ = ["SimpleToFullResource", "AsyncSimpleToFullResource"] +__all__ = ["ConvertSimpleToFullResource", "AsyncConvertSimpleToFullResource"] -class SimpleToFullResource(SyncAPIResource): - """Design schema conversion between Full and Simple formats.""" +class ConvertSimpleToFullResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ @cached_property - def with_raw_response(self) -> SimpleToFullResourceWithRawResponse: + def with_raw_response(self) -> ConvertSimpleToFullResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return SimpleToFullResourceWithRawResponse(self) + return ConvertSimpleToFullResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> SimpleToFullResourceWithStreamingResponse: + def with_streaming_response(self) -> ConvertSimpleToFullResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return SimpleToFullResourceWithStreamingResponse(self) + return ConvertSimpleToFullResourceWithStreamingResponse(self) def create( self, *, - design: simple_to_full_create_params.Design, + design: convert_simple_to_full_create_params.Design, display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, include_default_values: bool | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -57,7 +59,7 @@ def create( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> SimpleToFullCreateResponse: + ) -> ConvertSimpleToFullCreateResponse: """ Convert design json from Simple to Full schema. @@ -71,48 +73,50 @@ def create( timeout: Override the client-level default timeout for this request, in seconds """ return self._post( - "/v3/convert/simple-to-full", + "/v3/templates/convert/simple-to-full", body=maybe_transform( { "design": design, "display_mode": display_mode, "include_default_values": include_default_values, }, - simple_to_full_create_params.SimpleToFullCreateParams, + convert_simple_to_full_create_params.ConvertSimpleToFullCreateParams, ), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=SimpleToFullCreateResponse, + cast_to=ConvertSimpleToFullCreateResponse, ) -class AsyncSimpleToFullResource(AsyncAPIResource): - """Design schema conversion between Full and Simple formats.""" +class AsyncConvertSimpleToFullResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ @cached_property - def with_raw_response(self) -> AsyncSimpleToFullResourceWithRawResponse: + def with_raw_response(self) -> AsyncConvertSimpleToFullResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return AsyncSimpleToFullResourceWithRawResponse(self) + return AsyncConvertSimpleToFullResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> AsyncSimpleToFullResourceWithStreamingResponse: + def with_streaming_response(self) -> AsyncConvertSimpleToFullResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return AsyncSimpleToFullResourceWithStreamingResponse(self) + return AsyncConvertSimpleToFullResourceWithStreamingResponse(self) async def create( self, *, - design: simple_to_full_create_params.Design, + design: convert_simple_to_full_create_params.Design, display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, include_default_values: bool | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -121,7 +125,7 @@ async def create( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> SimpleToFullCreateResponse: + ) -> ConvertSimpleToFullCreateResponse: """ Convert design json from Simple to Full schema. @@ -135,53 +139,53 @@ async def create( timeout: Override the client-level default timeout for this request, in seconds """ return await self._post( - "/v3/convert/simple-to-full", + "/v3/templates/convert/simple-to-full", body=await async_maybe_transform( { "design": design, "display_mode": display_mode, "include_default_values": include_default_values, }, - simple_to_full_create_params.SimpleToFullCreateParams, + convert_simple_to_full_create_params.ConvertSimpleToFullCreateParams, ), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=SimpleToFullCreateResponse, + cast_to=ConvertSimpleToFullCreateResponse, ) -class SimpleToFullResourceWithRawResponse: - def __init__(self, simple_to_full: SimpleToFullResource) -> None: - self._simple_to_full = simple_to_full +class ConvertSimpleToFullResourceWithRawResponse: + def __init__(self, convert_simple_to_full: ConvertSimpleToFullResource) -> None: + self._convert_simple_to_full = convert_simple_to_full self.create = to_raw_response_wrapper( - simple_to_full.create, + convert_simple_to_full.create, ) -class AsyncSimpleToFullResourceWithRawResponse: - def __init__(self, simple_to_full: AsyncSimpleToFullResource) -> None: - self._simple_to_full = simple_to_full +class AsyncConvertSimpleToFullResourceWithRawResponse: + def __init__(self, convert_simple_to_full: AsyncConvertSimpleToFullResource) -> None: + self._convert_simple_to_full = convert_simple_to_full self.create = async_to_raw_response_wrapper( - simple_to_full.create, + convert_simple_to_full.create, ) -class SimpleToFullResourceWithStreamingResponse: - def __init__(self, simple_to_full: SimpleToFullResource) -> None: - self._simple_to_full = simple_to_full +class ConvertSimpleToFullResourceWithStreamingResponse: + def __init__(self, convert_simple_to_full: ConvertSimpleToFullResource) -> None: + self._convert_simple_to_full = convert_simple_to_full self.create = to_streamed_response_wrapper( - simple_to_full.create, + convert_simple_to_full.create, ) -class AsyncSimpleToFullResourceWithStreamingResponse: - def __init__(self, simple_to_full: AsyncSimpleToFullResource) -> None: - self._simple_to_full = simple_to_full +class AsyncConvertSimpleToFullResourceWithStreamingResponse: + def __init__(self, convert_simple_to_full: AsyncConvertSimpleToFullResource) -> None: + self._convert_simple_to_full = convert_simple_to_full self.create = async_to_streamed_response_wrapper( - simple_to_full.create, + convert_simple_to_full.create, ) diff --git a/src/unlayer/resources/ai/generate.py b/src/unlayer/resources/templates/generate.py similarity index 95% rename from src/unlayer/resources/ai/generate.py rename to src/unlayer/resources/templates/generate.py index df4acad..9ea24fa 100644 --- a/src/unlayer/resources/ai/generate.py +++ b/src/unlayer/resources/templates/generate.py @@ -10,7 +10,6 @@ from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given from ..._utils import maybe_transform, async_maybe_transform from ..._compat import cached_property -from ...types.ai import generate_create_params from ..._resource import SyncAPIResource, AsyncAPIResource from ..._response import ( to_raw_response_wrapper, @@ -19,12 +18,17 @@ async_to_streamed_response_wrapper, ) from ..._base_client import make_request_options -from ...types.ai.generate_create_response import GenerateCreateResponse +from ...types.templates import generate_create_params +from ...types.templates.generate_create_response import GenerateCreateResponse __all__ = ["GenerateResource", "AsyncGenerateResource"] class GenerateResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + @cached_property def with_raw_response(self) -> GenerateResourceWithRawResponse: """ @@ -88,7 +92,7 @@ def create( timeout: Override the client-level default timeout for this request, in seconds """ return self._post( - "/v3/ai/generate", + "/v3/templates/generate", body=maybe_transform( { "display_mode": display_mode, @@ -111,6 +115,10 @@ def create( class AsyncGenerateResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + @cached_property def with_raw_response(self) -> AsyncGenerateResourceWithRawResponse: """ @@ -174,7 +182,7 @@ async def create( timeout: Override the client-level default timeout for this request, in seconds """ return await self._post( - "/v3/ai/generate", + "/v3/templates/generate", body=await async_maybe_transform( { "display_mode": display_mode, diff --git a/src/unlayer/resources/templates/import_.py b/src/unlayer/resources/templates/import_.py new file mode 100644 index 0000000..02d788e --- /dev/null +++ b/src/unlayer/resources/templates/import_.py @@ -0,0 +1,224 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Iterable +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import import_create_params +from ...types.templates.import_create_response import ImportCreateResponse + +__all__ = ["ImportResource", "AsyncImportResource"] + + +class ImportResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> ImportResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ImportResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ImportResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ImportResourceWithStreamingResponse(self) + + def create( + self, + *, + display_mode: Literal["email", "web", "popup", "document"], + input: Iterable[import_create_params.Input], + project_id: str | Omit = omit, + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ImportCreateResponse: + """ + Import an existing template from HTML or an image (URL or base64) and return the + resulting Unlayer design JSON. No template DB entry is created. + + Args: + display_mode: Display mode for the imported design + + input: Array of input parts. Must contain exactly one "html" or "image" part; may also + contain one or more "text" parts with optional instructions. + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + model: AI model to use, in provider/model format. Optional — defaults to + anthropic/claude-opus-4-6. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/import", + body=maybe_transform( + { + "display_mode": display_mode, + "input": input, + "model": model, + }, + import_create_params.ImportCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, import_create_params.ImportCreateParams), + ), + cast_to=ImportCreateResponse, + ) + + +class AsyncImportResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> AsyncImportResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncImportResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncImportResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncImportResourceWithStreamingResponse(self) + + async def create( + self, + *, + display_mode: Literal["email", "web", "popup", "document"], + input: Iterable[import_create_params.Input], + project_id: str | Omit = omit, + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ImportCreateResponse: + """ + Import an existing template from HTML or an image (URL or base64) and return the + resulting Unlayer design JSON. No template DB entry is created. + + Args: + display_mode: Display mode for the imported design + + input: Array of input parts. Must contain exactly one "html" or "image" part; may also + contain one or more "text" parts with optional instructions. + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + model: AI model to use, in provider/model format. Optional — defaults to + anthropic/claude-opus-4-6. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/import", + body=await async_maybe_transform( + { + "display_mode": display_mode, + "input": input, + "model": model, + }, + import_create_params.ImportCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform({"project_id": project_id}, import_create_params.ImportCreateParams), + ), + cast_to=ImportCreateResponse, + ) + + +class ImportResourceWithRawResponse: + def __init__(self, import_: ImportResource) -> None: + self._import_ = import_ + + self.create = to_raw_response_wrapper( + import_.create, + ) + + +class AsyncImportResourceWithRawResponse: + def __init__(self, import_: AsyncImportResource) -> None: + self._import_ = import_ + + self.create = async_to_raw_response_wrapper( + import_.create, + ) + + +class ImportResourceWithStreamingResponse: + def __init__(self, import_: ImportResource) -> None: + self._import_ = import_ + + self.create = to_streamed_response_wrapper( + import_.create, + ) + + +class AsyncImportResourceWithStreamingResponse: + def __init__(self, import_: AsyncImportResource) -> None: + self._import_ = import_ + + self.create = async_to_streamed_response_wrapper( + import_.create, + ) diff --git a/src/unlayer/resources/templates.py b/src/unlayer/resources/templates/templates.py similarity index 55% rename from src/unlayer/resources/templates.py rename to src/unlayer/resources/templates/templates.py index 75fcee7..a8c5c81 100644 --- a/src/unlayer/resources/templates.py +++ b/src/unlayer/resources/templates/templates.py @@ -6,27 +6,89 @@ import httpx -from ..types import template_list_params, template_retrieve_params -from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given -from .._utils import path_template, maybe_transform, async_maybe_transform -from .._compat import cached_property -from .._resource import SyncAPIResource, AsyncAPIResource -from .._response import ( +from ...types import template_list_params, template_retrieve_params +from .import_ import ( + ImportResource, + AsyncImportResource, + ImportResourceWithRawResponse, + AsyncImportResourceWithRawResponse, + ImportResourceWithStreamingResponse, + AsyncImportResourceWithStreamingResponse, +) +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from .generate import ( + GenerateResource, + AsyncGenerateResource, + GenerateResourceWithRawResponse, + AsyncGenerateResourceWithRawResponse, + GenerateResourceWithStreamingResponse, + AsyncGenerateResourceWithStreamingResponse, +) +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( to_raw_response_wrapper, to_streamed_response_wrapper, async_to_raw_response_wrapper, async_to_streamed_response_wrapper, ) -from ..pagination import SyncCursorPage, AsyncCursorPage -from .._base_client import AsyncPaginator, make_request_options -from ..types.template_list_response import TemplateListResponse -from ..types.template_retrieve_response import TemplateRetrieveResponse +from ...pagination import SyncCursorPage, AsyncCursorPage +from ..._base_client import AsyncPaginator, make_request_options +from .convert_full_to_simple import ( + ConvertFullToSimpleResource, + AsyncConvertFullToSimpleResource, + ConvertFullToSimpleResourceWithRawResponse, + AsyncConvertFullToSimpleResourceWithRawResponse, + ConvertFullToSimpleResourceWithStreamingResponse, + AsyncConvertFullToSimpleResourceWithStreamingResponse, +) +from .convert_simple_to_full import ( + ConvertSimpleToFullResource, + AsyncConvertSimpleToFullResource, + ConvertSimpleToFullResourceWithRawResponse, + AsyncConvertSimpleToFullResourceWithRawResponse, + ConvertSimpleToFullResourceWithStreamingResponse, + AsyncConvertSimpleToFullResourceWithStreamingResponse, +) +from ...types.template_list_response import TemplateListResponse +from ...types.template_retrieve_response import TemplateRetrieveResponse __all__ = ["TemplatesResource", "AsyncTemplatesResource"] class TemplatesResource(SyncAPIResource): - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def convert_full_to_simple(self) -> ConvertFullToSimpleResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertFullToSimpleResource(self._client) + + @cached_property + def convert_simple_to_full(self) -> ConvertSimpleToFullResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertSimpleToFullResource(self._client) + + @cached_property + def generate(self) -> GenerateResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return GenerateResource(self._client) + + @cached_property + def import_(self) -> ImportResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ImportResource(self._client) @cached_property def with_raw_response(self) -> TemplatesResourceWithRawResponse: @@ -150,7 +212,37 @@ def list( class AsyncTemplatesResource(AsyncAPIResource): - """Template management and retrieval.""" + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def convert_full_to_simple(self) -> AsyncConvertFullToSimpleResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertFullToSimpleResource(self._client) + + @cached_property + def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertSimpleToFullResource(self._client) + + @cached_property + def generate(self) -> AsyncGenerateResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncGenerateResource(self._client) + + @cached_property + def import_(self) -> AsyncImportResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncImportResource(self._client) @cached_property def with_raw_response(self) -> AsyncTemplatesResourceWithRawResponse: @@ -286,6 +378,34 @@ def __init__(self, templates: TemplatesResource) -> None: templates.list, ) + @cached_property + def convert_full_to_simple(self) -> ConvertFullToSimpleResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertFullToSimpleResourceWithRawResponse(self._templates.convert_full_to_simple) + + @cached_property + def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertSimpleToFullResourceWithRawResponse(self._templates.convert_simple_to_full) + + @cached_property + def generate(self) -> GenerateResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return GenerateResourceWithRawResponse(self._templates.generate) + + @cached_property + def import_(self) -> ImportResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ImportResourceWithRawResponse(self._templates.import_) + class AsyncTemplatesResourceWithRawResponse: def __init__(self, templates: AsyncTemplatesResource) -> None: @@ -298,6 +418,34 @@ def __init__(self, templates: AsyncTemplatesResource) -> None: templates.list, ) + @cached_property + def convert_full_to_simple(self) -> AsyncConvertFullToSimpleResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertFullToSimpleResourceWithRawResponse(self._templates.convert_full_to_simple) + + @cached_property + def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertSimpleToFullResourceWithRawResponse(self._templates.convert_simple_to_full) + + @cached_property + def generate(self) -> AsyncGenerateResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncGenerateResourceWithRawResponse(self._templates.generate) + + @cached_property + def import_(self) -> AsyncImportResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncImportResourceWithRawResponse(self._templates.import_) + class TemplatesResourceWithStreamingResponse: def __init__(self, templates: TemplatesResource) -> None: @@ -310,6 +458,34 @@ def __init__(self, templates: TemplatesResource) -> None: templates.list, ) + @cached_property + def convert_full_to_simple(self) -> ConvertFullToSimpleResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertFullToSimpleResourceWithStreamingResponse(self._templates.convert_full_to_simple) + + @cached_property + def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ConvertSimpleToFullResourceWithStreamingResponse(self._templates.convert_simple_to_full) + + @cached_property + def generate(self) -> GenerateResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return GenerateResourceWithStreamingResponse(self._templates.generate) + + @cached_property + def import_(self) -> ImportResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ImportResourceWithStreamingResponse(self._templates.import_) + class AsyncTemplatesResourceWithStreamingResponse: def __init__(self, templates: AsyncTemplatesResource) -> None: @@ -321,3 +497,31 @@ def __init__(self, templates: AsyncTemplatesResource) -> None: self.list = async_to_streamed_response_wrapper( templates.list, ) + + @cached_property + def convert_full_to_simple(self) -> AsyncConvertFullToSimpleResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertFullToSimpleResourceWithStreamingResponse(self._templates.convert_full_to_simple) + + @cached_property + def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncConvertSimpleToFullResourceWithStreamingResponse(self._templates.convert_simple_to_full) + + @cached_property + def generate(self) -> AsyncGenerateResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncGenerateResourceWithStreamingResponse(self._templates.generate) + + @cached_property + def import_(self) -> AsyncImportResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncImportResourceWithStreamingResponse(self._templates.import_) diff --git a/src/unlayer/types/ai/__init__.py b/src/unlayer/types/ai/__init__.py deleted file mode 100644 index 199ad74..0000000 --- a/src/unlayer/types/ai/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from __future__ import annotations - -from .generate_create_params import GenerateCreateParams as GenerateCreateParams -from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse diff --git a/src/unlayer/types/convert/__init__.py b/src/unlayer/types/convert/__init__.py deleted file mode 100644 index df3d8f6..0000000 --- a/src/unlayer/types/convert/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -from __future__ import annotations - -from .full_to_simple_create_params import FullToSimpleCreateParams as FullToSimpleCreateParams -from .simple_to_full_create_params import SimpleToFullCreateParams as SimpleToFullCreateParams -from .full_to_simple_create_response import FullToSimpleCreateResponse as FullToSimpleCreateResponse -from .simple_to_full_create_response import SimpleToFullCreateResponse as SimpleToFullCreateResponse diff --git a/src/unlayer/types/templates/__init__.py b/src/unlayer/types/templates/__init__.py new file mode 100644 index 0000000..3b6ccd9 --- /dev/null +++ b/src/unlayer/types/templates/__init__.py @@ -0,0 +1,16 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .import_create_params import ImportCreateParams as ImportCreateParams +from .generate_create_params import GenerateCreateParams as GenerateCreateParams +from .import_create_response import ImportCreateResponse as ImportCreateResponse +from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse +from .convert_full_to_simple_create_params import ConvertFullToSimpleCreateParams as ConvertFullToSimpleCreateParams +from .convert_simple_to_full_create_params import ConvertSimpleToFullCreateParams as ConvertSimpleToFullCreateParams +from .convert_full_to_simple_create_response import ( + ConvertFullToSimpleCreateResponse as ConvertFullToSimpleCreateResponse, +) +from .convert_simple_to_full_create_response import ( + ConvertSimpleToFullCreateResponse as ConvertSimpleToFullCreateResponse, +) diff --git a/src/unlayer/types/convert/full_to_simple_create_params.py b/src/unlayer/types/templates/convert_full_to_simple_create_params.py similarity index 89% rename from src/unlayer/types/convert/full_to_simple_create_params.py rename to src/unlayer/types/templates/convert_full_to_simple_create_params.py index 5d70ae7..2e981d5 100644 --- a/src/unlayer/types/convert/full_to_simple_create_params.py +++ b/src/unlayer/types/templates/convert_full_to_simple_create_params.py @@ -7,10 +7,10 @@ from ..._utils import PropertyInfo -__all__ = ["FullToSimpleCreateParams", "Design"] +__all__ = ["ConvertFullToSimpleCreateParams", "Design"] -class FullToSimpleCreateParams(TypedDict, total=False): +class ConvertFullToSimpleCreateParams(TypedDict, total=False): design: Required[Design] display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] diff --git a/src/unlayer/types/convert/full_to_simple_create_response.py b/src/unlayer/types/templates/convert_full_to_simple_create_response.py similarity index 76% rename from src/unlayer/types/convert/full_to_simple_create_response.py rename to src/unlayer/types/templates/convert_full_to_simple_create_response.py index 7ded325..b4ec577 100644 --- a/src/unlayer/types/convert/full_to_simple_create_response.py +++ b/src/unlayer/types/templates/convert_full_to_simple_create_response.py @@ -5,14 +5,14 @@ from ..._models import BaseModel -__all__ = ["FullToSimpleCreateResponse", "Data"] +__all__ = ["ConvertFullToSimpleCreateResponse", "Data"] class Data(BaseModel): design: Optional[Dict[str, object]] = None -class FullToSimpleCreateResponse(BaseModel): +class ConvertFullToSimpleCreateResponse(BaseModel): data: Optional[Data] = None success: Optional[Literal[True]] = None diff --git a/src/unlayer/types/convert/simple_to_full_create_params.py b/src/unlayer/types/templates/convert_simple_to_full_create_params.py similarity index 85% rename from src/unlayer/types/convert/simple_to_full_create_params.py rename to src/unlayer/types/templates/convert_simple_to_full_create_params.py index b973376..5d99391 100644 --- a/src/unlayer/types/convert/simple_to_full_create_params.py +++ b/src/unlayer/types/templates/convert_simple_to_full_create_params.py @@ -7,10 +7,10 @@ from ..._utils import PropertyInfo -__all__ = ["SimpleToFullCreateParams", "Design", "Design_Conversion"] +__all__ = ["ConvertSimpleToFullCreateParams", "Design", "Design_Conversion"] -class SimpleToFullCreateParams(TypedDict, total=False): +class ConvertSimpleToFullCreateParams(TypedDict, total=False): design: Required[Design] display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] diff --git a/src/unlayer/types/convert/simple_to_full_create_response.py b/src/unlayer/types/templates/convert_simple_to_full_create_response.py similarity index 76% rename from src/unlayer/types/convert/simple_to_full_create_response.py rename to src/unlayer/types/templates/convert_simple_to_full_create_response.py index d224f92..efcf618 100644 --- a/src/unlayer/types/convert/simple_to_full_create_response.py +++ b/src/unlayer/types/templates/convert_simple_to_full_create_response.py @@ -5,14 +5,14 @@ from ..._models import BaseModel -__all__ = ["SimpleToFullCreateResponse", "Data"] +__all__ = ["ConvertSimpleToFullCreateResponse", "Data"] class Data(BaseModel): design: Optional[Dict[str, object]] = None -class SimpleToFullCreateResponse(BaseModel): +class ConvertSimpleToFullCreateResponse(BaseModel): data: Optional[Data] = None success: Optional[Literal[True]] = None diff --git a/src/unlayer/types/ai/generate_create_params.py b/src/unlayer/types/templates/generate_create_params.py similarity index 100% rename from src/unlayer/types/ai/generate_create_params.py rename to src/unlayer/types/templates/generate_create_params.py diff --git a/src/unlayer/types/ai/generate_create_response.py b/src/unlayer/types/templates/generate_create_response.py similarity index 100% rename from src/unlayer/types/ai/generate_create_response.py rename to src/unlayer/types/templates/generate_create_response.py diff --git a/src/unlayer/types/templates/import_create_params.py b/src/unlayer/types/templates/import_create_params.py new file mode 100644 index 0000000..30744de --- /dev/null +++ b/src/unlayer/types/templates/import_create_params.py @@ -0,0 +1,54 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Iterable +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["ImportCreateParams", "Input"] + + +class ImportCreateParams(TypedDict, total=False): + display_mode: Required[Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")]] + """Display mode for the imported design""" + + input: Required[Iterable[Input]] + """Array of input parts. + + Must contain exactly one "html" or "image" part; may also contain one or more + "text" parts with optional instructions. + """ + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] + """AI model to use, in provider/model format. + + Optional — defaults to anthropic/claude-opus-4-6. + """ + + +class Input(TypedDict, total=False): + type: Required[Literal["html", "image", "text"]] + """The type of input part. + + "html" or "image" carries the source content; "text" carries optional + instructions to apply during import. + """ + + data: str + """Base64 image data URL, e.g. "data:image/png;base64,…" (for type: "image")""" + + html: str + """HTML string to import (for type: "html")""" + + text: str + """ + Optional natural-language instructions to apply during import (for type: "text") + """ + + url: str + """Image URL to import (for type: "image")""" diff --git a/src/unlayer/types/templates/import_create_response.py b/src/unlayer/types/templates/import_create_response.py new file mode 100644 index 0000000..6aeeff6 --- /dev/null +++ b/src/unlayer/types/templates/import_create_response.py @@ -0,0 +1,44 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, Optional + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["ImportCreateResponse", "Output", "Usage"] + + +class Output(BaseModel): + block_type: Optional[str] = FieldInfo(alias="blockType", default=None) + + data: Optional[Dict[str, object]] = None + """Imported design data""" + + type: Optional[str] = None + + +class Usage(BaseModel): + cached_input_tokens: Optional[int] = FieldInfo(alias="cachedInputTokens", default=None) + + input_tokens: Optional[int] = FieldInfo(alias="inputTokens", default=None) + + output_tokens: Optional[int] = FieldInfo(alias="outputTokens", default=None) + + reasoning_tokens: Optional[int] = FieldInfo(alias="reasoningTokens", default=None) + + total_tokens: Optional[int] = FieldInfo(alias="totalTokens", default=None) + + +class ImportCreateResponse(BaseModel): + """Successfully imported template""" + + id: Optional[str] = None + + model: Optional[str] = None + + output: Optional[Output] = None + + provider: Optional[str] = None + + usage: Optional[Usage] = None diff --git a/tests/api_resources/convert/__init__.py b/tests/api_resources/convert/__init__.py deleted file mode 100644 index fd8019a..0000000 --- a/tests/api_resources/convert/__init__.py +++ /dev/null @@ -1 +0,0 @@ -# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/ai/__init__.py b/tests/api_resources/templates/__init__.py similarity index 100% rename from tests/api_resources/ai/__init__.py rename to tests/api_resources/templates/__init__.py diff --git a/tests/api_resources/convert/test_full_to_simple.py b/tests/api_resources/templates/test_convert_full_to_simple.py similarity index 60% rename from tests/api_resources/convert/test_full_to_simple.py rename to tests/api_resources/templates/test_convert_full_to_simple.py index aa7577f..d2a2267 100644 --- a/tests/api_resources/convert/test_full_to_simple.py +++ b/tests/api_resources/templates/test_convert_full_to_simple.py @@ -9,24 +9,24 @@ from unlayer import Unlayer, AsyncUnlayer from tests.utils import assert_matches_type -from unlayer.types.convert import FullToSimpleCreateResponse +from unlayer.types.templates import ConvertFullToSimpleCreateResponse base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") -class TestFullToSimple: +class TestConvertFullToSimple: parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) @parametrize def test_method_create(self, client: Unlayer) -> None: - full_to_simple = client.convert.full_to_simple.create( + convert_full_to_simple = client.templates.convert_full_to_simple.create( design={"body": {"foo": "bar"}}, ) - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize def test_method_create_with_all_params(self, client: Unlayer) -> None: - full_to_simple = client.convert.full_to_simple.create( + convert_full_to_simple = client.templates.convert_full_to_simple.create( design={ "body": {"foo": "bar"}, "counters": {"foo": "bar"}, @@ -36,48 +36,48 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: include_conversion=True, include_default_values=True, ) - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize def test_raw_response_create(self, client: Unlayer) -> None: - response = client.convert.full_to_simple.with_raw_response.create( + response = client.templates.convert_full_to_simple.with_raw_response.create( design={"body": {"foo": "bar"}}, ) assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - full_to_simple = response.parse() - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + convert_full_to_simple = response.parse() + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize def test_streaming_response_create(self, client: Unlayer) -> None: - with client.convert.full_to_simple.with_streaming_response.create( + with client.templates.convert_full_to_simple.with_streaming_response.create( design={"body": {"foo": "bar"}}, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - full_to_simple = response.parse() - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + convert_full_to_simple = response.parse() + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) assert cast(Any, response.is_closed) is True -class TestAsyncFullToSimple: +class TestAsyncConvertFullToSimple: parametrize = pytest.mark.parametrize( "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] ) @parametrize async def test_method_create(self, async_client: AsyncUnlayer) -> None: - full_to_simple = await async_client.convert.full_to_simple.create( + convert_full_to_simple = await async_client.templates.convert_full_to_simple.create( design={"body": {"foo": "bar"}}, ) - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: - full_to_simple = await async_client.convert.full_to_simple.create( + convert_full_to_simple = await async_client.templates.convert_full_to_simple.create( design={ "body": {"foo": "bar"}, "counters": {"foo": "bar"}, @@ -87,28 +87,28 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - include_conversion=True, include_default_values=True, ) - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: - response = await async_client.convert.full_to_simple.with_raw_response.create( + response = await async_client.templates.convert_full_to_simple.with_raw_response.create( design={"body": {"foo": "bar"}}, ) assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - full_to_simple = await response.parse() - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + convert_full_to_simple = await response.parse() + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) @parametrize async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: - async with async_client.convert.full_to_simple.with_streaming_response.create( + async with async_client.templates.convert_full_to_simple.with_streaming_response.create( design={"body": {"foo": "bar"}}, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - full_to_simple = await response.parse() - assert_matches_type(FullToSimpleCreateResponse, full_to_simple, path=["response"]) + convert_full_to_simple = await response.parse() + assert_matches_type(ConvertFullToSimpleCreateResponse, convert_full_to_simple, path=["response"]) assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/convert/test_simple_to_full.py b/tests/api_resources/templates/test_convert_simple_to_full.py similarity index 61% rename from tests/api_resources/convert/test_simple_to_full.py rename to tests/api_resources/templates/test_convert_simple_to_full.py index ca15814..3e7c174 100644 --- a/tests/api_resources/convert/test_simple_to_full.py +++ b/tests/api_resources/templates/test_convert_simple_to_full.py @@ -9,24 +9,24 @@ from unlayer import Unlayer, AsyncUnlayer from tests.utils import assert_matches_type -from unlayer.types.convert import SimpleToFullCreateResponse +from unlayer.types.templates import ConvertSimpleToFullCreateResponse base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") -class TestSimpleToFull: +class TestConvertSimpleToFull: parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) @parametrize def test_method_create(self, client: Unlayer) -> None: - simple_to_full = client.convert.simple_to_full.create( + convert_simple_to_full = client.templates.convert_simple_to_full.create( design={"body": {"foo": "bar"}}, ) - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize def test_method_create_with_all_params(self, client: Unlayer) -> None: - simple_to_full = client.convert.simple_to_full.create( + convert_simple_to_full = client.templates.convert_simple_to_full.create( design={ "body": {"foo": "bar"}, "_conversion": { @@ -39,48 +39,48 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: display_mode="email", include_default_values=True, ) - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize def test_raw_response_create(self, client: Unlayer) -> None: - response = client.convert.simple_to_full.with_raw_response.create( + response = client.templates.convert_simple_to_full.with_raw_response.create( design={"body": {"foo": "bar"}}, ) assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - simple_to_full = response.parse() - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + convert_simple_to_full = response.parse() + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize def test_streaming_response_create(self, client: Unlayer) -> None: - with client.convert.simple_to_full.with_streaming_response.create( + with client.templates.convert_simple_to_full.with_streaming_response.create( design={"body": {"foo": "bar"}}, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - simple_to_full = response.parse() - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + convert_simple_to_full = response.parse() + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) assert cast(Any, response.is_closed) is True -class TestAsyncSimpleToFull: +class TestAsyncConvertSimpleToFull: parametrize = pytest.mark.parametrize( "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] ) @parametrize async def test_method_create(self, async_client: AsyncUnlayer) -> None: - simple_to_full = await async_client.convert.simple_to_full.create( + convert_simple_to_full = await async_client.templates.convert_simple_to_full.create( design={"body": {"foo": "bar"}}, ) - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: - simple_to_full = await async_client.convert.simple_to_full.create( + convert_simple_to_full = await async_client.templates.convert_simple_to_full.create( design={ "body": {"foo": "bar"}, "_conversion": { @@ -93,28 +93,28 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - display_mode="email", include_default_values=True, ) - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: - response = await async_client.convert.simple_to_full.with_raw_response.create( + response = await async_client.templates.convert_simple_to_full.with_raw_response.create( design={"body": {"foo": "bar"}}, ) assert response.is_closed is True assert response.http_request.headers.get("X-Stainless-Lang") == "python" - simple_to_full = await response.parse() - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + convert_simple_to_full = await response.parse() + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) @parametrize async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: - async with async_client.convert.simple_to_full.with_streaming_response.create( + async with async_client.templates.convert_simple_to_full.with_streaming_response.create( design={"body": {"foo": "bar"}}, ) as response: assert not response.is_closed assert response.http_request.headers.get("X-Stainless-Lang") == "python" - simple_to_full = await response.parse() - assert_matches_type(SimpleToFullCreateResponse, simple_to_full, path=["response"]) + convert_simple_to_full = await response.parse() + assert_matches_type(ConvertSimpleToFullCreateResponse, convert_simple_to_full, path=["response"]) assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/ai/test_generate.py b/tests/api_resources/templates/test_generate.py similarity index 90% rename from tests/api_resources/ai/test_generate.py rename to tests/api_resources/templates/test_generate.py index c504af0..327a762 100644 --- a/tests/api_resources/ai/test_generate.py +++ b/tests/api_resources/templates/test_generate.py @@ -9,7 +9,7 @@ from unlayer import Unlayer, AsyncUnlayer from tests.utils import assert_matches_type -from unlayer.types.ai import GenerateCreateResponse +from unlayer.types.templates import GenerateCreateResponse base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") @@ -19,7 +19,7 @@ class TestGenerate: @parametrize def test_method_create(self, client: Unlayer) -> None: - generate = client.ai.generate.create( + generate = client.templates.generate.create( display_mode="email", input=[{"type": "text"}], output={ @@ -31,7 +31,7 @@ def test_method_create(self, client: Unlayer) -> None: @parametrize def test_method_create_with_all_params(self, client: Unlayer) -> None: - generate = client.ai.generate.create( + generate = client.templates.generate.create( display_mode="email", input=[ { @@ -65,7 +65,7 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: @parametrize def test_raw_response_create(self, client: Unlayer) -> None: - response = client.ai.generate.with_raw_response.create( + response = client.templates.generate.with_raw_response.create( display_mode="email", input=[{"type": "text"}], output={ @@ -81,7 +81,7 @@ def test_raw_response_create(self, client: Unlayer) -> None: @parametrize def test_streaming_response_create(self, client: Unlayer) -> None: - with client.ai.generate.with_streaming_response.create( + with client.templates.generate.with_streaming_response.create( display_mode="email", input=[{"type": "text"}], output={ @@ -105,7 +105,7 @@ class TestAsyncGenerate: @parametrize async def test_method_create(self, async_client: AsyncUnlayer) -> None: - generate = await async_client.ai.generate.create( + generate = await async_client.templates.generate.create( display_mode="email", input=[{"type": "text"}], output={ @@ -117,7 +117,7 @@ async def test_method_create(self, async_client: AsyncUnlayer) -> None: @parametrize async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: - generate = await async_client.ai.generate.create( + generate = await async_client.templates.generate.create( display_mode="email", input=[ { @@ -151,7 +151,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - @parametrize async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: - response = await async_client.ai.generate.with_raw_response.create( + response = await async_client.templates.generate.with_raw_response.create( display_mode="email", input=[{"type": "text"}], output={ @@ -167,7 +167,7 @@ async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: @parametrize async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: - async with async_client.ai.generate.with_streaming_response.create( + async with async_client.templates.generate.with_streaming_response.create( display_mode="email", input=[{"type": "text"}], output={ diff --git a/tests/api_resources/templates/test_import_.py b/tests/api_resources/templates/test_import_.py new file mode 100644 index 0000000..c039168 --- /dev/null +++ b/tests/api_resources/templates/test_import_.py @@ -0,0 +1,128 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ImportCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestImport: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + import_ = client.templates.import_.create( + display_mode="email", + input=[{"type": "html"}], + ) + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + import_ = client.templates.import_.create( + display_mode="email", + input=[ + { + "type": "html", + "data": "data", + "html": "html", + "text": "text", + "url": "url", + } + ], + project_id="projectId", + model="anthropic/claude-opus-4-6", + ) + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.import_.with_raw_response.create( + display_mode="email", + input=[{"type": "html"}], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + import_ = response.parse() + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.import_.with_streaming_response.create( + display_mode="email", + input=[{"type": "html"}], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + import_ = response.parse() + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncImport: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + import_ = await async_client.templates.import_.create( + display_mode="email", + input=[{"type": "html"}], + ) + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + import_ = await async_client.templates.import_.create( + display_mode="email", + input=[ + { + "type": "html", + "data": "data", + "html": "html", + "text": "text", + "url": "url", + } + ], + project_id="projectId", + model="anthropic/claude-opus-4-6", + ) + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.import_.with_raw_response.create( + display_mode="email", + input=[{"type": "html"}], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + import_ = await response.parse() + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.import_.with_streaming_response.create( + display_mode="email", + input=[{"type": "html"}], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + import_ = await response.parse() + assert_matches_type(ImportCreateResponse, import_, path=["response"]) + + assert cast(Any, response.is_closed) is True From 7b6ee5197eff6de84b71685f2ceded7cac99d6a5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 26 May 2026 02:22:47 +0000 Subject: [PATCH 35/46] feat(api): api update --- .stats.yml | 8 +- api.md | 1 + src/unlayer/resources/templates/generate.py | 143 +++++++++---- src/unlayer/resources/templates/import_.py | 18 +- src/unlayer/resources/templates/templates.py | 18 -- .../types/templates/generate_create_params.py | 112 ++++++---- .../templates/generate_create_response.py | 61 ++++-- .../types/templates/import_create_params.py | 12 +- .../api_resources/templates/test_generate.py | 200 +++++++++++++----- tests/api_resources/templates/test_import_.py | 4 +- 10 files changed, 393 insertions(+), 184 deletions(-) diff --git a/.stats.yml b/.stats.yml index f94ad81..eb0d57f 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 9 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-e87049219505c250c95423461c7fb7aa280a3238f98577973c687c1030da26bf.yml -openapi_spec_hash: 613060b45d55c1ab27b70973e4402dfd -config_hash: 2029dabcdae1b263de41e1a890ee90d8 +configured_endpoints: 10 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-35699cec89167aa9ce539f8008695911611f8bdf923234ed701ee3dbc0c5bcd2.yml +openapi_spec_hash: 2ec4eef9500ac0007e1740f431835931 +config_hash: 20e7fbba9d423291aaf676f6a629dcaf diff --git a/api.md b/api.md index 5160d97..9df7cff 100644 --- a/api.md +++ b/api.md @@ -58,6 +58,7 @@ from unlayer.types.templates import GenerateCreateResponse Methods: - client.templates.generate.create(\*\*params) -> GenerateCreateResponse +- client.templates.generate.retrieve() -> None ## Import diff --git a/src/unlayer/resources/templates/generate.py b/src/unlayer/resources/templates/generate.py index 9ea24fa..294c375 100644 --- a/src/unlayer/resources/templates/generate.py +++ b/src/unlayer/resources/templates/generate.py @@ -3,11 +3,10 @@ from __future__ import annotations from typing import Iterable -from typing_extensions import Literal import httpx -from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given from ..._utils import maybe_transform, async_maybe_transform from ..._compat import cached_property from ..._resource import SyncAPIResource, AsyncAPIResource @@ -25,10 +24,6 @@ class GenerateResource(SyncAPIResource): - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ - @cached_property def with_raw_response(self) -> GenerateResourceWithRawResponse: """ @@ -51,12 +46,13 @@ def with_streaming_response(self) -> GenerateResourceWithStreamingResponse: def create( self, *, - display_mode: Literal["email", "web", "popup", "document"], - input: Iterable[generate_create_params.Input], + messages: Iterable[generate_create_params.Message], output: generate_create_params.Output, project_id: str | Omit = omit, context: generate_create_params.Context | Omit = omit, - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + conversation_id: str | Omit = omit, + locale: str | Omit = omit, + model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -64,24 +60,31 @@ def create( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> GenerateCreateResponse: - """Generate, modify, or import an Unlayer design using AI. + """Generate or modify an Unlayer design using AI. - Provide typed input - parts to describe what to generate. + Send the conversation as + `messages` (today only the last user message is consumed; earlier turns are + accepted as chat history) and describe the target with `output.kind` + + `output.displayMode`. Pass the current canvas state in `context` (full design + JSON + selection pointer) to modify an existing design. Only `anthropic` and + `openai` models are supported. To import existing HTML or an image instead, use + POST /v3/templates/import. Args: - display_mode: Display mode for the design - - input: Array of typed input parts (max 50) - - output: What to generate + messages: Conversation messages in chronological order, capped at 10 messages. The last + `user` message is the prompt for this turn; any earlier `user`/`assistant` text + turns are forwarded to the model as prior chat context. A `user` message may + carry a predefined prompt action via `metadata.action.id` (e.g. SPELLING, + REPHRASE). project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - context: Editor environment context + conversation_id: Reserved for future server-side conversation memory. - model: AI model to use, in provider/model format. Optional — defaults to - anthropic/claude-opus-4-6. + locale: BCP-47 fallback locale for AI status messages. + + model: AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". Optional — + server resolves a default per output kind. extra_headers: Send extra headers @@ -95,10 +98,11 @@ def create( "/v3/templates/generate", body=maybe_transform( { - "display_mode": display_mode, - "input": input, + "messages": messages, "output": output, "context": context, + "conversation_id": conversation_id, + "locale": locale, "model": model, }, generate_create_params.GenerateCreateParams, @@ -113,12 +117,27 @@ def create( cast_to=GenerateCreateResponse, ) + def retrieve( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._get( + "/v3/templates/generate", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) -class AsyncGenerateResource(AsyncAPIResource): - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ +class AsyncGenerateResource(AsyncAPIResource): @cached_property def with_raw_response(self) -> AsyncGenerateResourceWithRawResponse: """ @@ -141,12 +160,13 @@ def with_streaming_response(self) -> AsyncGenerateResourceWithStreamingResponse: async def create( self, *, - display_mode: Literal["email", "web", "popup", "document"], - input: Iterable[generate_create_params.Input], + messages: Iterable[generate_create_params.Message], output: generate_create_params.Output, project_id: str | Omit = omit, context: generate_create_params.Context | Omit = omit, - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + conversation_id: str | Omit = omit, + locale: str | Omit = omit, + model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -154,24 +174,31 @@ async def create( extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, ) -> GenerateCreateResponse: - """Generate, modify, or import an Unlayer design using AI. + """Generate or modify an Unlayer design using AI. - Provide typed input - parts to describe what to generate. + Send the conversation as + `messages` (today only the last user message is consumed; earlier turns are + accepted as chat history) and describe the target with `output.kind` + + `output.displayMode`. Pass the current canvas state in `context` (full design + JSON + selection pointer) to modify an existing design. Only `anthropic` and + `openai` models are supported. To import existing HTML or an image instead, use + POST /v3/templates/import. Args: - display_mode: Display mode for the design - - input: Array of typed input parts (max 50) - - output: What to generate + messages: Conversation messages in chronological order, capped at 10 messages. The last + `user` message is the prompt for this turn; any earlier `user`/`assistant` text + turns are forwarded to the model as prior chat context. A `user` message may + carry a predefined prompt action via `metadata.action.id` (e.g. SPELLING, + REPHRASE). project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - context: Editor environment context + conversation_id: Reserved for future server-side conversation memory. + + locale: BCP-47 fallback locale for AI status messages. - model: AI model to use, in provider/model format. Optional — defaults to - anthropic/claude-opus-4-6. + model: AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". Optional — + server resolves a default per output kind. extra_headers: Send extra headers @@ -185,10 +212,11 @@ async def create( "/v3/templates/generate", body=await async_maybe_transform( { - "display_mode": display_mode, - "input": input, + "messages": messages, "output": output, "context": context, + "conversation_id": conversation_id, + "locale": locale, "model": model, }, generate_create_params.GenerateCreateParams, @@ -205,6 +233,25 @@ async def create( cast_to=GenerateCreateResponse, ) + async def retrieve( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._get( + "/v3/templates/generate", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=NoneType, + ) + class GenerateResourceWithRawResponse: def __init__(self, generate: GenerateResource) -> None: @@ -213,6 +260,9 @@ def __init__(self, generate: GenerateResource) -> None: self.create = to_raw_response_wrapper( generate.create, ) + self.retrieve = to_raw_response_wrapper( + generate.retrieve, + ) class AsyncGenerateResourceWithRawResponse: @@ -222,6 +272,9 @@ def __init__(self, generate: AsyncGenerateResource) -> None: self.create = async_to_raw_response_wrapper( generate.create, ) + self.retrieve = async_to_raw_response_wrapper( + generate.retrieve, + ) class GenerateResourceWithStreamingResponse: @@ -231,6 +284,9 @@ def __init__(self, generate: GenerateResource) -> None: self.create = to_streamed_response_wrapper( generate.create, ) + self.retrieve = to_streamed_response_wrapper( + generate.retrieve, + ) class AsyncGenerateResourceWithStreamingResponse: @@ -240,3 +296,6 @@ def __init__(self, generate: AsyncGenerateResource) -> None: self.create = async_to_streamed_response_wrapper( generate.create, ) + self.retrieve = async_to_streamed_response_wrapper( + generate.retrieve, + ) diff --git a/src/unlayer/resources/templates/import_.py b/src/unlayer/resources/templates/import_.py index 02d788e..3a603af 100644 --- a/src/unlayer/resources/templates/import_.py +++ b/src/unlayer/resources/templates/import_.py @@ -54,7 +54,7 @@ def create( display_mode: Literal["email", "web", "popup", "document"], input: Iterable[import_create_params.Input], project_id: str | Omit = omit, - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -74,8 +74,11 @@ def create( project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - model: AI model to use, in provider/model format. Optional — defaults to - anthropic/claude-opus-4-6. + model: AI model to use. Accepts a provider/model string (e.g. + "anthropic/claude-opus-4-7", "openai/gpt-5.5"), a bare provider ("anthropic", + "openai") which uses that provider's default model, or a bare model id + ("claude-opus-4-7", "gpt-5.5") with the provider inferred from the name. + Optional — defaults to anthropic/claude-opus-4-7. extra_headers: Send extra headers @@ -136,7 +139,7 @@ async def create( display_mode: Literal["email", "web", "popup", "document"], input: Iterable[import_create_params.Input], project_id: str | Omit = omit, - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] | Omit = omit, + model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -156,8 +159,11 @@ async def create( project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - model: AI model to use, in provider/model format. Optional — defaults to - anthropic/claude-opus-4-6. + model: AI model to use. Accepts a provider/model string (e.g. + "anthropic/claude-opus-4-7", "openai/gpt-5.5"), a bare provider ("anthropic", + "openai") which uses that provider's default model, or a bare model id + ("claude-opus-4-7", "gpt-5.5") with the provider inferred from the name. + Optional — defaults to anthropic/claude-opus-4-7. extra_headers: Send extra headers diff --git a/src/unlayer/resources/templates/templates.py b/src/unlayer/resources/templates/templates.py index a8c5c81..31f17fe 100644 --- a/src/unlayer/resources/templates/templates.py +++ b/src/unlayer/resources/templates/templates.py @@ -78,9 +78,6 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResource: @cached_property def generate(self) -> GenerateResource: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return GenerateResource(self._client) @cached_property @@ -232,9 +229,6 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResource: @cached_property def generate(self) -> AsyncGenerateResource: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return AsyncGenerateResource(self._client) @cached_property @@ -394,9 +388,6 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithRawResponse: @cached_property def generate(self) -> GenerateResourceWithRawResponse: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return GenerateResourceWithRawResponse(self._templates.generate) @cached_property @@ -434,9 +425,6 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithRawRespo @cached_property def generate(self) -> AsyncGenerateResourceWithRawResponse: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return AsyncGenerateResourceWithRawResponse(self._templates.generate) @cached_property @@ -474,9 +462,6 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithStreamingResp @cached_property def generate(self) -> GenerateResourceWithStreamingResponse: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return GenerateResourceWithStreamingResponse(self._templates.generate) @cached_property @@ -514,9 +499,6 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithStreamin @cached_property def generate(self) -> AsyncGenerateResourceWithStreamingResponse: - """ - Template management — list, retrieve, generate, import, export, and convert designs. - """ return AsyncGenerateResourceWithStreamingResponse(self._templates.generate) @cached_property diff --git a/src/unlayer/types/templates/generate_create_params.py b/src/unlayer/types/templates/generate_create_params.py index e779f52..f2c60f0 100644 --- a/src/unlayer/types/templates/generate_create_params.py +++ b/src/unlayer/types/templates/generate_create_params.py @@ -2,80 +2,96 @@ from __future__ import annotations -from typing import Dict, Union, Iterable +from typing import Dict, Union, Iterable, Optional from typing_extensions import Literal, Required, Annotated, TypedDict from ..._types import SequenceNotStr from ..._utils import PropertyInfo -__all__ = ["GenerateCreateParams", "Input", "Output", "Context", "ContextCustomTool"] +__all__ = [ + "GenerateCreateParams", + "Message", + "MessageContent", + "MessageContentFile", + "MessageMetadata", + "MessageMetadataAction", + "Output", + "Context", + "ContextCustomTool", + "ContextSelection", +] class GenerateCreateParams(TypedDict, total=False): - display_mode: Required[Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")]] - """Display mode for the design""" + messages: Required[Iterable[Message]] + """Conversation messages in chronological order, capped at 10 messages. - input: Required[Iterable[Input]] - """Array of typed input parts (max 50)""" + The last `user` message is the prompt for this turn; any earlier + `user`/`assistant` text turns are forwarded to the model as prior chat context. + A `user` message may carry a predefined prompt action via `metadata.action.id` + (e.g. SPELLING, REPHRASE). + """ output: Required[Output] - """What to generate""" project_id: Annotated[str, PropertyInfo(alias="projectId")] """The project ID (required for PAT auth, auto-resolved for API key auth)""" context: Context - """Editor environment context""" - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] - """AI model to use, in provider/model format. + conversation_id: Annotated[str, PropertyInfo(alias="conversationId")] + """Reserved for future server-side conversation memory.""" + + locale: str + """BCP-47 fallback locale for AI status messages.""" + + model: str + """AI model in "provider/id" form, e.g. - Optional — defaults to anthropic/claude-opus-4-6. + "anthropic/claude-opus-4-7". Optional — server resolves a default per output + kind. """ -class Input(TypedDict, total=False): - type: Required[Literal["text", "prompt", "json", "html", "image"]] - """The type of input part""" +class MessageContentFile(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + url: Required[str] - id: str - """ - Predefined prompt ID: SPELLING, EXPAND, SUMMARIZE, REPHRASE, FRIENDLY, FORMAL - (for type: "prompt") - """ + media_type: Annotated[str, PropertyInfo(alias="mediaType")] - block_type: Annotated[str, PropertyInfo(alias="blockType")] - """Block type of the design data (for type: "json")""" - data: Union[Dict[str, object], str] - """ - Existing design data (object, for type: "json") or base64 image data (string, - for type: "image") - """ +class MessageContent(TypedDict, total=False): + type: Required[Literal["text", "image", "file"]] - html: str - """HTML string to import (for type: "html")""" + file: MessageContentFile - schema_version: Annotated[int, PropertyInfo(alias="schemaVersion")] - """Design schema version (for type: "json")""" + image: str + """URL or data URL of the image""" text: str - """Natural language prompt (for type: "text")""" - url: str - """Image URL to import (for type: "image")""" + +class MessageMetadataAction(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + id: Required[str] + + +class MessageMetadata(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + action: MessageMetadataAction + + +class Message(TypedDict, total=False): + content: Required[Iterable[MessageContent]] + + role: Required[Literal["user", "assistant", "system"]] + + metadata: MessageMetadata class Output(TypedDict, total=False): - """What to generate""" + display_mode: Required[Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")]] - block_type: Required[ - Annotated[Literal["template", "page", "body", "content", "row", "column"], PropertyInfo(alias="blockType")] - ] - """The type of design block to generate""" + kind: Required[Literal["template", "page", "body", "header", "footer", "row", "column", "content", "text"]] - type: Required[Literal["json"]] - """Output format — currently only "json" is supported""" + schema_version: Annotated[int, PropertyInfo(alias="schemaVersion")] class ContextCustomTool(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] @@ -84,11 +100,19 @@ class ContextCustomTool(TypedDict, total=False, extra_items=object): # type: ig slug: Required[str] -class Context(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] - """Editor environment context""" +class ContextSelection(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] + id: Required[Union[str, float]] + collection: Required[Literal["pages", "bodies", "rows", "columns", "contents", "headers", "footers"]] + + value: str + + +class Context(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] available_tools: Annotated[SequenceNotStr[str], PropertyInfo(alias="availableTools")] - """Filter content types available in the generated design""" custom_tools: Annotated[Iterable[ContextCustomTool], PropertyInfo(alias="customTools")] - """Custom tool declarations with their options""" + + full_design: Annotated[Optional[Dict[str, object]], PropertyInfo(alias="fullDesign")] + + selection: Optional[ContextSelection] diff --git a/src/unlayer/types/templates/generate_create_response.py b/src/unlayer/types/templates/generate_create_response.py index 669e741..1ddf243 100644 --- a/src/unlayer/types/templates/generate_create_response.py +++ b/src/unlayer/types/templates/generate_create_response.py @@ -6,40 +6,73 @@ from ..._models import BaseModel -__all__ = ["GenerateCreateResponse", "Output", "Usage"] +__all__ = ["GenerateCreateResponse", "Model", "Output", "Usage"] + + +class Model(BaseModel): + """ + The provider + model that actually produced the output (may differ from the requested model after failover). + """ + + id: Optional[str] = None + """Resolved model id, e.g. "claude-opus-4-7".""" + + provider: Optional[str] = None + """e.g. "anthropic", "openai".""" class Output(BaseModel): - block_type: Optional[str] = FieldInfo(alias="blockType", default=None) + """The generated output for the requested block.""" data: Optional[Dict[str, object]] = None - """Generated design data""" + """ + The generated design JSON, scoped to the requested kind (the full design for + template/page/body; the row/column/content/element for narrower kinds). + """ - type: Optional[str] = None + kind: Optional[str] = None + """Echoes the requested `output.kind`.""" class Usage(BaseModel): - cached_input_tokens: Optional[int] = FieldInfo(alias="cachedInputTokens", default=None) + """Aggregate token usage for the turn when exposed by the caller. - input_tokens: Optional[int] = FieldInfo(alias="inputTokens", default=None) + Builder copilot endpoints expose it only in local/dev/QA and omit it in staging/production. + """ - output_tokens: Optional[int] = FieldInfo(alias="outputTokens", default=None) + cached_input_tokens: Optional[float] = FieldInfo(alias="cachedInputTokens", default=None) - reasoning_tokens: Optional[int] = FieldInfo(alias="reasoningTokens", default=None) + estimated_cost_micro_usd: Optional[float] = FieldInfo(alias="estimatedCostMicroUsd", default=None) - total_tokens: Optional[int] = FieldInfo(alias="totalTokens", default=None) + input_tokens: Optional[float] = FieldInfo(alias="inputTokens", default=None) + + output_tokens: Optional[float] = FieldInfo(alias="outputTokens", default=None) + + reasoning_tokens: Optional[float] = FieldInfo(alias="reasoningTokens", default=None) + + total_tokens: Optional[float] = FieldInfo(alias="totalTokens", default=None) class GenerateCreateResponse(BaseModel): - """Successfully generated design""" + """ + The generated (or modified) design plus model metadata and optional usage metadata. + """ id: Optional[str] = None - """AI response ID""" + """Provider response id for the generation turn.""" - model: Optional[str] = None + model: Optional[Model] = None + """ + The provider + model that actually produced the output (may differ from the + requested model after failover). + """ output: Optional[Output] = None - - provider: Optional[str] = None + """The generated output for the requested block.""" usage: Optional[Usage] = None + """Aggregate token usage for the turn when exposed by the caller. + + Builder copilot endpoints expose it only in local/dev/QA and omit it in + staging/production. + """ diff --git a/src/unlayer/types/templates/import_create_params.py b/src/unlayer/types/templates/import_create_params.py index 30744de..7b5a8d7 100644 --- a/src/unlayer/types/templates/import_create_params.py +++ b/src/unlayer/types/templates/import_create_params.py @@ -24,10 +24,14 @@ class ImportCreateParams(TypedDict, total=False): project_id: Annotated[str, PropertyInfo(alias="projectId")] """The project ID (required for PAT auth, auto-resolved for API key auth)""" - model: Literal["anthropic/claude-opus-4-6", "openai/gpt-5.2"] - """AI model to use, in provider/model format. - - Optional — defaults to anthropic/claude-opus-4-6. + model: str + """AI model to use. + + Accepts a provider/model string (e.g. "anthropic/claude-opus-4-7", + "openai/gpt-5.5"), a bare provider ("anthropic", "openai") which uses that + provider's default model, or a bare model id ("claude-opus-4-7", "gpt-5.5") with + the provider inferred from the name. Optional — defaults to + anthropic/claude-opus-4-7. """ diff --git a/tests/api_resources/templates/test_generate.py b/tests/api_resources/templates/test_generate.py index 327a762..33e941b 100644 --- a/tests/api_resources/templates/test_generate.py +++ b/tests/api_resources/templates/test_generate.py @@ -20,11 +20,15 @@ class TestGenerate: @parametrize def test_method_create(self, client: Unlayer) -> None: generate = client.templates.generate.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) assert_matches_type(GenerateCreateResponse, generate, path=["response"]) @@ -32,22 +36,27 @@ def test_method_create(self, client: Unlayer) -> None: @parametrize def test_method_create_with_all_params(self, client: Unlayer) -> None: generate = client.templates.generate.create( - display_mode="email", - input=[ + messages=[ { - "type": "text", - "id": "id", - "block_type": "blockType", - "data": {"foo": "bar"}, - "html": "html", - "schema_version": 0, - "text": "text", - "url": "url", + "content": [ + { + "type": "text", + "file": { + "url": "url", + "media_type": "mediaType", + }, + "image": "image", + "text": "text", + } + ], + "role": "user", + "metadata": {"action": {"id": "id"}}, } ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", + "schema_version": 0, }, project_id="projectId", context={ @@ -58,19 +67,31 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: "slug": "slug", } ], + "full_design": {"foo": "bar"}, + "selection": { + "id": "string", + "collection": "pages", + "value": "value", + }, }, - model="anthropic/claude-opus-4-6", + conversation_id="conversationId", + locale="locale", + model="model", ) assert_matches_type(GenerateCreateResponse, generate, path=["response"]) @parametrize def test_raw_response_create(self, client: Unlayer) -> None: response = client.templates.generate.with_raw_response.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) @@ -82,11 +103,15 @@ def test_raw_response_create(self, client: Unlayer) -> None: @parametrize def test_streaming_response_create(self, client: Unlayer) -> None: with client.templates.generate.with_streaming_response.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) as response: assert not response.is_closed @@ -97,6 +122,31 @@ def test_streaming_response_create(self, client: Unlayer) -> None: assert cast(Any, response.is_closed) is True + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + generate = client.templates.generate.retrieve() + assert generate is None + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.templates.generate.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + generate = response.parse() + assert generate is None + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.templates.generate.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + generate = response.parse() + assert generate is None + + assert cast(Any, response.is_closed) is True + class TestAsyncGenerate: parametrize = pytest.mark.parametrize( @@ -106,11 +156,15 @@ class TestAsyncGenerate: @parametrize async def test_method_create(self, async_client: AsyncUnlayer) -> None: generate = await async_client.templates.generate.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) assert_matches_type(GenerateCreateResponse, generate, path=["response"]) @@ -118,22 +172,27 @@ async def test_method_create(self, async_client: AsyncUnlayer) -> None: @parametrize async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: generate = await async_client.templates.generate.create( - display_mode="email", - input=[ + messages=[ { - "type": "text", - "id": "id", - "block_type": "blockType", - "data": {"foo": "bar"}, - "html": "html", - "schema_version": 0, - "text": "text", - "url": "url", + "content": [ + { + "type": "text", + "file": { + "url": "url", + "media_type": "mediaType", + }, + "image": "image", + "text": "text", + } + ], + "role": "user", + "metadata": {"action": {"id": "id"}}, } ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", + "schema_version": 0, }, project_id="projectId", context={ @@ -144,19 +203,31 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - "slug": "slug", } ], + "full_design": {"foo": "bar"}, + "selection": { + "id": "string", + "collection": "pages", + "value": "value", + }, }, - model="anthropic/claude-opus-4-6", + conversation_id="conversationId", + locale="locale", + model="model", ) assert_matches_type(GenerateCreateResponse, generate, path=["response"]) @parametrize async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: response = await async_client.templates.generate.with_raw_response.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) @@ -168,11 +239,15 @@ async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: @parametrize async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: async with async_client.templates.generate.with_streaming_response.create( - display_mode="email", - input=[{"type": "text"}], + messages=[ + { + "content": [{"type": "text"}], + "role": "user", + } + ], output={ - "block_type": "template", - "type": "json", + "display_mode": "email", + "kind": "template", }, ) as response: assert not response.is_closed @@ -182,3 +257,28 @@ async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> No assert_matches_type(GenerateCreateResponse, generate, path=["response"]) assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + generate = await async_client.templates.generate.retrieve() + assert generate is None + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.generate.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + generate = await response.parse() + assert generate is None + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.generate.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + generate = await response.parse() + assert generate is None + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_import_.py b/tests/api_resources/templates/test_import_.py index c039168..5e859cf 100644 --- a/tests/api_resources/templates/test_import_.py +++ b/tests/api_resources/templates/test_import_.py @@ -39,7 +39,7 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: } ], project_id="projectId", - model="anthropic/claude-opus-4-6", + model="model", ) assert_matches_type(ImportCreateResponse, import_, path=["response"]) @@ -97,7 +97,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - } ], project_id="projectId", - model="anthropic/claude-opus-4-6", + model="model", ) assert_matches_type(ImportCreateResponse, import_, path=["response"]) From 808556a0dad1364117d5b63c2285f47fa2bb641f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 05:37:21 +0000 Subject: [PATCH 36/46] feat(api): api update --- .stats.yml | 4 ++-- src/unlayer/resources/templates/generate.py | 24 ++++++++++++++----- src/unlayer/resources/templates/import_.py | 20 ++++++++++++---- .../types/templates/generate_create_params.py | 10 +++++++- .../types/templates/import_create_params.py | 13 ++++++++-- .../api_resources/templates/test_generate.py | 2 ++ tests/api_resources/templates/test_import_.py | 2 ++ 7 files changed, 60 insertions(+), 15 deletions(-) diff --git a/.stats.yml b/.stats.yml index eb0d57f..13a7855 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 10 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-35699cec89167aa9ce539f8008695911611f8bdf923234ed701ee3dbc0c5bcd2.yml -openapi_spec_hash: 2ec4eef9500ac0007e1740f431835931 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-091234302d1c0907a6e2c646ad31f2757e832985758314af9171390851ffc12f.yml +openapi_spec_hash: bbac170e82fb6bb60e0db638457623d1 config_hash: 20e7fbba9d423291aaf676f6a629dcaf diff --git a/src/unlayer/resources/templates/generate.py b/src/unlayer/resources/templates/generate.py index 294c375..a0d894e 100644 --- a/src/unlayer/resources/templates/generate.py +++ b/src/unlayer/resources/templates/generate.py @@ -2,11 +2,11 @@ from __future__ import annotations -from typing import Iterable +from typing import Union, Iterable import httpx -from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given +from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given from ..._utils import maybe_transform, async_maybe_transform from ..._compat import cached_property from ..._resource import SyncAPIResource, AsyncAPIResource @@ -51,6 +51,7 @@ def create( project_id: str | Omit = omit, context: generate_create_params.Context | Omit = omit, conversation_id: str | Omit = omit, + fallback_models: Union[bool, SequenceNotStr[str]] | Omit = omit, locale: str | Omit = omit, model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -81,10 +82,14 @@ def create( conversation_id: Reserved for future server-side conversation memory. + fallback_models: Transient-outage fallback controls. Omit to use Unlayer defaults only when no + model is pinned; true always uses Unlayer defaults; false disables the outage + tail; an ordered array replaces the default provider/model strings. + locale: BCP-47 fallback locale for AI status messages. - model: AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". Optional — - server resolves a default per output kind. + model: Preferred AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". + Optional — server resolves a default per output kind. extra_headers: Send extra headers @@ -102,6 +107,7 @@ def create( "output": output, "context": context, "conversation_id": conversation_id, + "fallback_models": fallback_models, "locale": locale, "model": model, }, @@ -165,6 +171,7 @@ async def create( project_id: str | Omit = omit, context: generate_create_params.Context | Omit = omit, conversation_id: str | Omit = omit, + fallback_models: Union[bool, SequenceNotStr[str]] | Omit = omit, locale: str | Omit = omit, model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. @@ -195,10 +202,14 @@ async def create( conversation_id: Reserved for future server-side conversation memory. + fallback_models: Transient-outage fallback controls. Omit to use Unlayer defaults only when no + model is pinned; true always uses Unlayer defaults; false disables the outage + tail; an ordered array replaces the default provider/model strings. + locale: BCP-47 fallback locale for AI status messages. - model: AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". Optional — - server resolves a default per output kind. + model: Preferred AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". + Optional — server resolves a default per output kind. extra_headers: Send extra headers @@ -216,6 +227,7 @@ async def create( "output": output, "context": context, "conversation_id": conversation_id, + "fallback_models": fallback_models, "locale": locale, "model": model, }, diff --git a/src/unlayer/resources/templates/import_.py b/src/unlayer/resources/templates/import_.py index 3a603af..7c83fd9 100644 --- a/src/unlayer/resources/templates/import_.py +++ b/src/unlayer/resources/templates/import_.py @@ -2,12 +2,12 @@ from __future__ import annotations -from typing import Iterable +from typing import Union, Iterable from typing_extensions import Literal import httpx -from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given from ..._utils import maybe_transform, async_maybe_transform from ..._compat import cached_property from ..._resource import SyncAPIResource, AsyncAPIResource @@ -54,6 +54,7 @@ def create( display_mode: Literal["email", "web", "popup", "document"], input: Iterable[import_create_params.Input], project_id: str | Omit = omit, + fallback_models: Union[bool, SequenceNotStr[str]] | Omit = omit, model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. @@ -74,7 +75,11 @@ def create( project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - model: AI model to use. Accepts a provider/model string (e.g. + fallback_models: Transient-outage fallback controls. Omit to use Unlayer defaults only when no + model is pinned; true always uses Unlayer defaults; false disables the outage + tail; an ordered array replaces the default provider/model strings. + + model: Preferred AI model. Accepts a provider/model string (e.g. "anthropic/claude-opus-4-7", "openai/gpt-5.5"), a bare provider ("anthropic", "openai") which uses that provider's default model, or a bare model id ("claude-opus-4-7", "gpt-5.5") with the provider inferred from the name. @@ -94,6 +99,7 @@ def create( { "display_mode": display_mode, "input": input, + "fallback_models": fallback_models, "model": model, }, import_create_params.ImportCreateParams, @@ -139,6 +145,7 @@ async def create( display_mode: Literal["email", "web", "popup", "document"], input: Iterable[import_create_params.Input], project_id: str | Omit = omit, + fallback_models: Union[bool, SequenceNotStr[str]] | Omit = omit, model: str | Omit = omit, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. @@ -159,7 +166,11 @@ async def create( project_id: The project ID (required for PAT auth, auto-resolved for API key auth) - model: AI model to use. Accepts a provider/model string (e.g. + fallback_models: Transient-outage fallback controls. Omit to use Unlayer defaults only when no + model is pinned; true always uses Unlayer defaults; false disables the outage + tail; an ordered array replaces the default provider/model strings. + + model: Preferred AI model. Accepts a provider/model string (e.g. "anthropic/claude-opus-4-7", "openai/gpt-5.5"), a bare provider ("anthropic", "openai") which uses that provider's default model, or a bare model id ("claude-opus-4-7", "gpt-5.5") with the provider inferred from the name. @@ -179,6 +190,7 @@ async def create( { "display_mode": display_mode, "input": input, + "fallback_models": fallback_models, "model": model, }, import_create_params.ImportCreateParams, diff --git a/src/unlayer/types/templates/generate_create_params.py b/src/unlayer/types/templates/generate_create_params.py index f2c60f0..7214d5e 100644 --- a/src/unlayer/types/templates/generate_create_params.py +++ b/src/unlayer/types/templates/generate_create_params.py @@ -42,11 +42,19 @@ class GenerateCreateParams(TypedDict, total=False): conversation_id: Annotated[str, PropertyInfo(alias="conversationId")] """Reserved for future server-side conversation memory.""" + fallback_models: Annotated[Union[bool, SequenceNotStr[str]], PropertyInfo(alias="fallbackModels")] + """Transient-outage fallback controls. + + Omit to use Unlayer defaults only when no model is pinned; true always uses + Unlayer defaults; false disables the outage tail; an ordered array replaces the + default provider/model strings. + """ + locale: str """BCP-47 fallback locale for AI status messages.""" model: str - """AI model in "provider/id" form, e.g. + """Preferred AI model in "provider/id" form, e.g. "anthropic/claude-opus-4-7". Optional — server resolves a default per output kind. diff --git a/src/unlayer/types/templates/import_create_params.py b/src/unlayer/types/templates/import_create_params.py index 7b5a8d7..6f2caed 100644 --- a/src/unlayer/types/templates/import_create_params.py +++ b/src/unlayer/types/templates/import_create_params.py @@ -2,9 +2,10 @@ from __future__ import annotations -from typing import Iterable +from typing import Union, Iterable from typing_extensions import Literal, Required, Annotated, TypedDict +from ..._types import SequenceNotStr from ..._utils import PropertyInfo __all__ = ["ImportCreateParams", "Input"] @@ -24,8 +25,16 @@ class ImportCreateParams(TypedDict, total=False): project_id: Annotated[str, PropertyInfo(alias="projectId")] """The project ID (required for PAT auth, auto-resolved for API key auth)""" + fallback_models: Annotated[Union[bool, SequenceNotStr[str]], PropertyInfo(alias="fallbackModels")] + """Transient-outage fallback controls. + + Omit to use Unlayer defaults only when no model is pinned; true always uses + Unlayer defaults; false disables the outage tail; an ordered array replaces the + default provider/model strings. + """ + model: str - """AI model to use. + """Preferred AI model. Accepts a provider/model string (e.g. "anthropic/claude-opus-4-7", "openai/gpt-5.5"), a bare provider ("anthropic", "openai") which uses that diff --git a/tests/api_resources/templates/test_generate.py b/tests/api_resources/templates/test_generate.py index 33e941b..4937690 100644 --- a/tests/api_resources/templates/test_generate.py +++ b/tests/api_resources/templates/test_generate.py @@ -75,6 +75,7 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: }, }, conversation_id="conversationId", + fallback_models=True, locale="locale", model="model", ) @@ -211,6 +212,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - }, }, conversation_id="conversationId", + fallback_models=True, locale="locale", model="model", ) diff --git a/tests/api_resources/templates/test_import_.py b/tests/api_resources/templates/test_import_.py index 5e859cf..fc10c32 100644 --- a/tests/api_resources/templates/test_import_.py +++ b/tests/api_resources/templates/test_import_.py @@ -39,6 +39,7 @@ def test_method_create_with_all_params(self, client: Unlayer) -> None: } ], project_id="projectId", + fallback_models=True, model="model", ) assert_matches_type(ImportCreateResponse, import_, path=["response"]) @@ -97,6 +98,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) - } ], project_id="projectId", + fallback_models=True, model="model", ) assert_matches_type(ImportCreateResponse, import_, path=["response"]) From ad5130bb1a5fe2c2a49914df3ea8bc6fb444add6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 07:02:52 +0000 Subject: [PATCH 37/46] codegen metadata --- .stats.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index 13a7855..6f038da 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 10 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-091234302d1c0907a6e2c646ad31f2757e832985758314af9171390851ffc12f.yml -openapi_spec_hash: bbac170e82fb6bb60e0db638457623d1 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-3d1f50d8fdb57c0bbafaa16aeffc061ee7532ed5a9823bacbce1cc0916c008b9.yml +openapi_spec_hash: 97d36fb19154cc936e9ef2558965e290 config_hash: 20e7fbba9d423291aaf676f6a629dcaf From d03691f5182f0919ab3cdbfe66692fd287471f1b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 30 Jun 2026 02:23:48 +0000 Subject: [PATCH 38/46] fix(types): avoid type-checker errors on params with additional properties --- .../convert_full_to_simple_create_params.py | 6 +++- .../convert_simple_to_full_create_params.py | 6 +++- .../types/templates/generate_create_params.py | 36 +++++++++++++++---- 3 files changed, 40 insertions(+), 8 deletions(-) diff --git a/src/unlayer/types/templates/convert_full_to_simple_create_params.py b/src/unlayer/types/templates/convert_full_to_simple_create_params.py index 2e981d5..739b363 100644 --- a/src/unlayer/types/templates/convert_full_to_simple_create_params.py +++ b/src/unlayer/types/templates/convert_full_to_simple_create_params.py @@ -25,7 +25,11 @@ class ConvertFullToSimpleCreateParams(TypedDict, total=False): include_default_values: Annotated[bool, PropertyInfo(alias="includeDefaultValues")] -class Design(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class Design( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): body: Required[Dict[str, object]] counters: Dict[str, object] diff --git a/src/unlayer/types/templates/convert_simple_to_full_create_params.py b/src/unlayer/types/templates/convert_simple_to_full_create_params.py index 5d99391..4ee6a26 100644 --- a/src/unlayer/types/templates/convert_simple_to_full_create_params.py +++ b/src/unlayer/types/templates/convert_simple_to_full_create_params.py @@ -24,7 +24,11 @@ class Design_Conversion(TypedDict, total=False): version: float -class Design(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class Design( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): body: Required[Dict[str, object]] _conversion: Design_Conversion diff --git a/src/unlayer/types/templates/generate_create_params.py b/src/unlayer/types/templates/generate_create_params.py index 7214d5e..a84e61b 100644 --- a/src/unlayer/types/templates/generate_create_params.py +++ b/src/unlayer/types/templates/generate_create_params.py @@ -61,7 +61,11 @@ class GenerateCreateParams(TypedDict, total=False): """ -class MessageContentFile(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class MessageContentFile( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): url: Required[str] media_type: Annotated[str, PropertyInfo(alias="mediaType")] @@ -78,11 +82,19 @@ class MessageContent(TypedDict, total=False): text: str -class MessageMetadataAction(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class MessageMetadataAction( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): id: Required[str] -class MessageMetadata(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class MessageMetadata( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): action: MessageMetadataAction @@ -102,13 +114,21 @@ class Output(TypedDict, total=False): schema_version: Annotated[int, PropertyInfo(alias="schemaVersion")] -class ContextCustomTool(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class ContextCustomTool( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): options: Required[Dict[str, object]] slug: Required[str] -class ContextSelection(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class ContextSelection( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): id: Required[Union[str, float]] collection: Required[Literal["pages", "bodies", "rows", "columns", "contents", "headers", "footers"]] @@ -116,7 +136,11 @@ class ContextSelection(TypedDict, total=False, extra_items=object): # type: ign value: str -class Context(TypedDict, total=False, extra_items=object): # type: ignore[call-arg] +class Context( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): available_tools: Annotated[SequenceNotStr[str], PropertyInfo(alias="availableTools")] custom_tools: Annotated[Iterable[ContextCustomTool], PropertyInfo(alias="customTools")] From c85f0878584b737bc83016c20c0bba9fc81d498b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 10 Jul 2026 18:42:42 +0000 Subject: [PATCH 39/46] feat(api): api update --- .stats.yml | 8 +- api.md | 48 ++++ src/unlayer/resources/templates/__init__.py | 56 ++++ .../resources/templates/export_html.py | 236 ++++++++++++++++ .../resources/templates/export_image.py | 252 ++++++++++++++++++ src/unlayer/resources/templates/export_pdf.py | 246 +++++++++++++++++ src/unlayer/resources/templates/export_zip.py | 236 ++++++++++++++++ src/unlayer/resources/templates/templates.py | 128 +++++++++ src/unlayer/types/templates/__init__.py | 8 + .../templates/export_html_create_params.py | 39 +++ .../templates/export_html_create_response.py | 29 ++ .../templates/export_image_create_params.py | 47 ++++ .../templates/export_image_create_response.py | 17 ++ .../templates/export_pdf_create_params.py | 46 ++++ .../templates/export_pdf_create_response.py | 17 ++ .../templates/export_zip_create_params.py | 39 +++ .../templates/export_zip_create_response.py | 17 ++ .../templates/test_export_html.py | 122 +++++++++ .../templates/test_export_image.py | 130 +++++++++ .../templates/test_export_pdf.py | 126 +++++++++ .../templates/test_export_zip.py | 122 +++++++++ 21 files changed, 1965 insertions(+), 4 deletions(-) create mode 100644 src/unlayer/resources/templates/export_html.py create mode 100644 src/unlayer/resources/templates/export_image.py create mode 100644 src/unlayer/resources/templates/export_pdf.py create mode 100644 src/unlayer/resources/templates/export_zip.py create mode 100644 src/unlayer/types/templates/export_html_create_params.py create mode 100644 src/unlayer/types/templates/export_html_create_response.py create mode 100644 src/unlayer/types/templates/export_image_create_params.py create mode 100644 src/unlayer/types/templates/export_image_create_response.py create mode 100644 src/unlayer/types/templates/export_pdf_create_params.py create mode 100644 src/unlayer/types/templates/export_pdf_create_response.py create mode 100644 src/unlayer/types/templates/export_zip_create_params.py create mode 100644 src/unlayer/types/templates/export_zip_create_response.py create mode 100644 tests/api_resources/templates/test_export_html.py create mode 100644 tests/api_resources/templates/test_export_image.py create mode 100644 tests/api_resources/templates/test_export_pdf.py create mode 100644 tests/api_resources/templates/test_export_zip.py diff --git a/.stats.yml b/.stats.yml index 6f038da..2e4bbbe 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 10 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-3d1f50d8fdb57c0bbafaa16aeffc061ee7532ed5a9823bacbce1cc0916c008b9.yml -openapi_spec_hash: 97d36fb19154cc936e9ef2558965e290 -config_hash: 20e7fbba9d423291aaf676f6a629dcaf +configured_endpoints: 14 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-8f62b635191810fa318afdeaabbbb0276b0e1f85f18b5ff2ddaad9a18241f047.yml +openapi_spec_hash: e80a61e80827f2a822db46f4ba82c15d +config_hash: 2949daec69cb6f5d34ae232544245952 diff --git a/api.md b/api.md index 9df7cff..71e781f 100644 --- a/api.md +++ b/api.md @@ -47,6 +47,54 @@ Methods: - client.templates.convert_simple_to_full.create(\*\*params) -> ConvertSimpleToFullCreateResponse +## ExportHTML + +Types: + +```python +from unlayer.types.templates import ExportHTMLCreateResponse +``` + +Methods: + +- client.templates.export_html.create(\*\*params) -> ExportHTMLCreateResponse + +## ExportImage + +Types: + +```python +from unlayer.types.templates import ExportImageCreateResponse +``` + +Methods: + +- client.templates.export_image.create(\*\*params) -> ExportImageCreateResponse + +## ExportPdf + +Types: + +```python +from unlayer.types.templates import ExportPdfCreateResponse +``` + +Methods: + +- client.templates.export_pdf.create(\*\*params) -> ExportPdfCreateResponse + +## ExportZip + +Types: + +```python +from unlayer.types.templates import ExportZipCreateResponse +``` + +Methods: + +- client.templates.export_zip.create(\*\*params) -> ExportZipCreateResponse + ## Generate Types: diff --git a/src/unlayer/resources/templates/__init__.py b/src/unlayer/resources/templates/__init__.py index 036e3f4..9f97937 100644 --- a/src/unlayer/resources/templates/__init__.py +++ b/src/unlayer/resources/templates/__init__.py @@ -24,6 +24,38 @@ TemplatesResourceWithStreamingResponse, AsyncTemplatesResourceWithStreamingResponse, ) +from .export_pdf import ( + ExportPdfResource, + AsyncExportPdfResource, + ExportPdfResourceWithRawResponse, + AsyncExportPdfResourceWithRawResponse, + ExportPdfResourceWithStreamingResponse, + AsyncExportPdfResourceWithStreamingResponse, +) +from .export_zip import ( + ExportZipResource, + AsyncExportZipResource, + ExportZipResourceWithRawResponse, + AsyncExportZipResourceWithRawResponse, + ExportZipResourceWithStreamingResponse, + AsyncExportZipResourceWithStreamingResponse, +) +from .export_html import ( + ExportHTMLResource, + AsyncExportHTMLResource, + ExportHTMLResourceWithRawResponse, + AsyncExportHTMLResourceWithRawResponse, + ExportHTMLResourceWithStreamingResponse, + AsyncExportHTMLResourceWithStreamingResponse, +) +from .export_image import ( + ExportImageResource, + AsyncExportImageResource, + ExportImageResourceWithRawResponse, + AsyncExportImageResourceWithRawResponse, + ExportImageResourceWithStreamingResponse, + AsyncExportImageResourceWithStreamingResponse, +) from .convert_full_to_simple import ( ConvertFullToSimpleResource, AsyncConvertFullToSimpleResource, @@ -54,6 +86,30 @@ "AsyncConvertSimpleToFullResourceWithRawResponse", "ConvertSimpleToFullResourceWithStreamingResponse", "AsyncConvertSimpleToFullResourceWithStreamingResponse", + "ExportHTMLResource", + "AsyncExportHTMLResource", + "ExportHTMLResourceWithRawResponse", + "AsyncExportHTMLResourceWithRawResponse", + "ExportHTMLResourceWithStreamingResponse", + "AsyncExportHTMLResourceWithStreamingResponse", + "ExportImageResource", + "AsyncExportImageResource", + "ExportImageResourceWithRawResponse", + "AsyncExportImageResourceWithRawResponse", + "ExportImageResourceWithStreamingResponse", + "AsyncExportImageResourceWithStreamingResponse", + "ExportPdfResource", + "AsyncExportPdfResource", + "ExportPdfResourceWithRawResponse", + "AsyncExportPdfResourceWithRawResponse", + "ExportPdfResourceWithStreamingResponse", + "AsyncExportPdfResourceWithStreamingResponse", + "ExportZipResource", + "AsyncExportZipResource", + "ExportZipResourceWithRawResponse", + "AsyncExportZipResourceWithRawResponse", + "ExportZipResourceWithStreamingResponse", + "AsyncExportZipResourceWithStreamingResponse", "GenerateResource", "AsyncGenerateResource", "GenerateResourceWithRawResponse", diff --git a/src/unlayer/resources/templates/export_html.py b/src/unlayer/resources/templates/export_html.py new file mode 100644 index 0000000..50bd642 --- /dev/null +++ b/src/unlayer/resources/templates/export_html.py @@ -0,0 +1,236 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import export_html_create_params +from ...types.templates.export_html_create_response import ExportHTMLCreateResponse + +__all__ = ["ExportHTMLResource", "AsyncExportHTMLResource"] + + +class ExportHTMLResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> ExportHTMLResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ExportHTMLResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ExportHTMLResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ExportHTMLResourceWithStreamingResponse(self) + + def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportHTMLCreateResponse: + """ + Export a design as rendered HTML. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/export/html", + body=maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + }, + export_html_create_params.ExportHTMLCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, export_html_create_params.ExportHTMLCreateParams), + ), + cast_to=ExportHTMLCreateResponse, + ) + + +class AsyncExportHTMLResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncExportHTMLResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncExportHTMLResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncExportHTMLResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncExportHTMLResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportHTMLCreateResponse: + """ + Export a design as rendered HTML. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/export/html", + body=await async_maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + }, + export_html_create_params.ExportHTMLCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, export_html_create_params.ExportHTMLCreateParams + ), + ), + cast_to=ExportHTMLCreateResponse, + ) + + +class ExportHTMLResourceWithRawResponse: + def __init__(self, export_html: ExportHTMLResource) -> None: + self._export_html = export_html + + self.create = to_raw_response_wrapper( + export_html.create, + ) + + +class AsyncExportHTMLResourceWithRawResponse: + def __init__(self, export_html: AsyncExportHTMLResource) -> None: + self._export_html = export_html + + self.create = async_to_raw_response_wrapper( + export_html.create, + ) + + +class ExportHTMLResourceWithStreamingResponse: + def __init__(self, export_html: ExportHTMLResource) -> None: + self._export_html = export_html + + self.create = to_streamed_response_wrapper( + export_html.create, + ) + + +class AsyncExportHTMLResourceWithStreamingResponse: + def __init__(self, export_html: AsyncExportHTMLResource) -> None: + self._export_html = export_html + + self.create = async_to_streamed_response_wrapper( + export_html.create, + ) diff --git a/src/unlayer/resources/templates/export_image.py b/src/unlayer/resources/templates/export_image.py new file mode 100644 index 0000000..f296f33 --- /dev/null +++ b/src/unlayer/resources/templates/export_image.py @@ -0,0 +1,252 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import export_image_create_params +from ...types.templates.export_image_create_response import ExportImageCreateResponse + +__all__ = ["ExportImageResource", "AsyncExportImageResource"] + + +class ExportImageResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> ExportImageResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ExportImageResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ExportImageResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ExportImageResourceWithStreamingResponse(self) + + def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + device_scale_factor: float | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + full_page: bool | Omit = omit, + height: float | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + width: float | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportImageCreateResponse: + """ + Export a design as a PNG image. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/export/image", + body=maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "device_scale_factor": device_scale_factor, + "display_mode": display_mode, + "editor_version": editor_version, + "full_page": full_page, + "height": height, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + "width": width, + }, + export_image_create_params.ExportImageCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, export_image_create_params.ExportImageCreateParams), + ), + cast_to=ExportImageCreateResponse, + ) + + +class AsyncExportImageResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncExportImageResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncExportImageResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncExportImageResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncExportImageResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + device_scale_factor: float | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + full_page: bool | Omit = omit, + height: float | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + width: float | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportImageCreateResponse: + """ + Export a design as a PNG image. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/export/image", + body=await async_maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "device_scale_factor": device_scale_factor, + "display_mode": display_mode, + "editor_version": editor_version, + "full_page": full_page, + "height": height, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + "width": width, + }, + export_image_create_params.ExportImageCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, export_image_create_params.ExportImageCreateParams + ), + ), + cast_to=ExportImageCreateResponse, + ) + + +class ExportImageResourceWithRawResponse: + def __init__(self, export_image: ExportImageResource) -> None: + self._export_image = export_image + + self.create = to_raw_response_wrapper( + export_image.create, + ) + + +class AsyncExportImageResourceWithRawResponse: + def __init__(self, export_image: AsyncExportImageResource) -> None: + self._export_image = export_image + + self.create = async_to_raw_response_wrapper( + export_image.create, + ) + + +class ExportImageResourceWithStreamingResponse: + def __init__(self, export_image: ExportImageResource) -> None: + self._export_image = export_image + + self.create = to_streamed_response_wrapper( + export_image.create, + ) + + +class AsyncExportImageResourceWithStreamingResponse: + def __init__(self, export_image: AsyncExportImageResource) -> None: + self._export_image = export_image + + self.create = async_to_streamed_response_wrapper( + export_image.create, + ) diff --git a/src/unlayer/resources/templates/export_pdf.py b/src/unlayer/resources/templates/export_pdf.py new file mode 100644 index 0000000..f342762 --- /dev/null +++ b/src/unlayer/resources/templates/export_pdf.py @@ -0,0 +1,246 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import export_pdf_create_params +from ...types.templates.export_pdf_create_response import ExportPdfCreateResponse + +__all__ = ["ExportPdfResource", "AsyncExportPdfResource"] + + +class ExportPdfResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> ExportPdfResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ExportPdfResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ExportPdfResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ExportPdfResourceWithStreamingResponse(self) + + def create( + self, + *, + design: object, + project_id: str | Omit = omit, + content_width: Union[float, Literal["full"]] | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + page_size: Literal["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"] + | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportPdfCreateResponse: + """ + Export a design as a PDF document. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/export/pdf", + body=maybe_transform( + { + "design": design, + "content_width": content_width, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "page_size": page_size, + "safe_html": safe_html, + }, + export_pdf_create_params.ExportPdfCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, export_pdf_create_params.ExportPdfCreateParams), + ), + cast_to=ExportPdfCreateResponse, + ) + + +class AsyncExportPdfResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncExportPdfResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncExportPdfResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncExportPdfResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncExportPdfResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: object, + project_id: str | Omit = omit, + content_width: Union[float, Literal["full"]] | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + page_size: Literal["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"] + | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportPdfCreateResponse: + """ + Export a design as a PDF document. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/export/pdf", + body=await async_maybe_transform( + { + "design": design, + "content_width": content_width, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "page_size": page_size, + "safe_html": safe_html, + }, + export_pdf_create_params.ExportPdfCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, export_pdf_create_params.ExportPdfCreateParams + ), + ), + cast_to=ExportPdfCreateResponse, + ) + + +class ExportPdfResourceWithRawResponse: + def __init__(self, export_pdf: ExportPdfResource) -> None: + self._export_pdf = export_pdf + + self.create = to_raw_response_wrapper( + export_pdf.create, + ) + + +class AsyncExportPdfResourceWithRawResponse: + def __init__(self, export_pdf: AsyncExportPdfResource) -> None: + self._export_pdf = export_pdf + + self.create = async_to_raw_response_wrapper( + export_pdf.create, + ) + + +class ExportPdfResourceWithStreamingResponse: + def __init__(self, export_pdf: ExportPdfResource) -> None: + self._export_pdf = export_pdf + + self.create = to_streamed_response_wrapper( + export_pdf.create, + ) + + +class AsyncExportPdfResourceWithStreamingResponse: + def __init__(self, export_pdf: AsyncExportPdfResource) -> None: + self._export_pdf = export_pdf + + self.create = async_to_streamed_response_wrapper( + export_pdf.create, + ) diff --git a/src/unlayer/resources/templates/export_zip.py b/src/unlayer/resources/templates/export_zip.py new file mode 100644 index 0000000..20fd4b7 --- /dev/null +++ b/src/unlayer/resources/templates/export_zip.py @@ -0,0 +1,236 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import export_zip_create_params +from ...types.templates.export_zip_create_response import ExportZipCreateResponse + +__all__ = ["ExportZipResource", "AsyncExportZipResource"] + + +class ExportZipResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> ExportZipResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ExportZipResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ExportZipResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ExportZipResourceWithStreamingResponse(self) + + def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportZipCreateResponse: + """ + Export a design as a ZIP archive containing HTML and assets. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/export/zip", + body=maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + }, + export_zip_create_params.ExportZipCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform({"project_id": project_id}, export_zip_create_params.ExportZipCreateParams), + ), + cast_to=ExportZipCreateResponse, + ) + + +class AsyncExportZipResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncExportZipResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncExportZipResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncExportZipResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncExportZipResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: object, + project_id: str | Omit = omit, + custom_js: Union[str, SequenceNotStr[str]] | Omit = omit, + design_tags: object | Omit = omit, + design_tags_config: object | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + editor_version: str | Omit = omit, + language: str | Omit = omit, + languages: SequenceNotStr[str] | Omit = omit, + merge_tags: object | Omit = omit, + merge_tags_schema: object | Omit = omit, + safe_html: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ExportZipCreateResponse: + """ + Export a design as a ZIP archive containing HTML and assets. + + Args: + design: Unlayer design JSON + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/export/zip", + body=await async_maybe_transform( + { + "design": design, + "custom_js": custom_js, + "design_tags": design_tags, + "design_tags_config": design_tags_config, + "display_mode": display_mode, + "editor_version": editor_version, + "language": language, + "languages": languages, + "merge_tags": merge_tags, + "merge_tags_schema": merge_tags_schema, + "safe_html": safe_html, + }, + export_zip_create_params.ExportZipCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, export_zip_create_params.ExportZipCreateParams + ), + ), + cast_to=ExportZipCreateResponse, + ) + + +class ExportZipResourceWithRawResponse: + def __init__(self, export_zip: ExportZipResource) -> None: + self._export_zip = export_zip + + self.create = to_raw_response_wrapper( + export_zip.create, + ) + + +class AsyncExportZipResourceWithRawResponse: + def __init__(self, export_zip: AsyncExportZipResource) -> None: + self._export_zip = export_zip + + self.create = async_to_raw_response_wrapper( + export_zip.create, + ) + + +class ExportZipResourceWithStreamingResponse: + def __init__(self, export_zip: ExportZipResource) -> None: + self._export_zip = export_zip + + self.create = to_streamed_response_wrapper( + export_zip.create, + ) + + +class AsyncExportZipResourceWithStreamingResponse: + def __init__(self, export_zip: AsyncExportZipResource) -> None: + self._export_zip = export_zip + + self.create = async_to_streamed_response_wrapper( + export_zip.create, + ) diff --git a/src/unlayer/resources/templates/templates.py b/src/unlayer/resources/templates/templates.py index 31f17fe..8d3e9b8 100644 --- a/src/unlayer/resources/templates/templates.py +++ b/src/unlayer/resources/templates/templates.py @@ -26,6 +26,22 @@ AsyncGenerateResourceWithStreamingResponse, ) from ..._compat import cached_property +from .export_pdf import ( + ExportPdfResource, + AsyncExportPdfResource, + ExportPdfResourceWithRawResponse, + AsyncExportPdfResourceWithRawResponse, + ExportPdfResourceWithStreamingResponse, + AsyncExportPdfResourceWithStreamingResponse, +) +from .export_zip import ( + ExportZipResource, + AsyncExportZipResource, + ExportZipResourceWithRawResponse, + AsyncExportZipResourceWithRawResponse, + ExportZipResourceWithStreamingResponse, + AsyncExportZipResourceWithStreamingResponse, +) from ..._resource import SyncAPIResource, AsyncAPIResource from ..._response import ( to_raw_response_wrapper, @@ -33,7 +49,23 @@ async_to_raw_response_wrapper, async_to_streamed_response_wrapper, ) +from .export_html import ( + ExportHTMLResource, + AsyncExportHTMLResource, + ExportHTMLResourceWithRawResponse, + AsyncExportHTMLResourceWithRawResponse, + ExportHTMLResourceWithStreamingResponse, + AsyncExportHTMLResourceWithStreamingResponse, +) from ...pagination import SyncCursorPage, AsyncCursorPage +from .export_image import ( + ExportImageResource, + AsyncExportImageResource, + ExportImageResourceWithRawResponse, + AsyncExportImageResourceWithRawResponse, + ExportImageResourceWithStreamingResponse, + AsyncExportImageResourceWithStreamingResponse, +) from ..._base_client import AsyncPaginator, make_request_options from .convert_full_to_simple import ( ConvertFullToSimpleResource, @@ -76,6 +108,22 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResource: """ return ConvertSimpleToFullResource(self._client) + @cached_property + def export_html(self) -> ExportHTMLResource: + return ExportHTMLResource(self._client) + + @cached_property + def export_image(self) -> ExportImageResource: + return ExportImageResource(self._client) + + @cached_property + def export_pdf(self) -> ExportPdfResource: + return ExportPdfResource(self._client) + + @cached_property + def export_zip(self) -> ExportZipResource: + return ExportZipResource(self._client) + @cached_property def generate(self) -> GenerateResource: return GenerateResource(self._client) @@ -227,6 +275,22 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResource: """ return AsyncConvertSimpleToFullResource(self._client) + @cached_property + def export_html(self) -> AsyncExportHTMLResource: + return AsyncExportHTMLResource(self._client) + + @cached_property + def export_image(self) -> AsyncExportImageResource: + return AsyncExportImageResource(self._client) + + @cached_property + def export_pdf(self) -> AsyncExportPdfResource: + return AsyncExportPdfResource(self._client) + + @cached_property + def export_zip(self) -> AsyncExportZipResource: + return AsyncExportZipResource(self._client) + @cached_property def generate(self) -> AsyncGenerateResource: return AsyncGenerateResource(self._client) @@ -386,6 +450,22 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithRawResponse: """ return ConvertSimpleToFullResourceWithRawResponse(self._templates.convert_simple_to_full) + @cached_property + def export_html(self) -> ExportHTMLResourceWithRawResponse: + return ExportHTMLResourceWithRawResponse(self._templates.export_html) + + @cached_property + def export_image(self) -> ExportImageResourceWithRawResponse: + return ExportImageResourceWithRawResponse(self._templates.export_image) + + @cached_property + def export_pdf(self) -> ExportPdfResourceWithRawResponse: + return ExportPdfResourceWithRawResponse(self._templates.export_pdf) + + @cached_property + def export_zip(self) -> ExportZipResourceWithRawResponse: + return ExportZipResourceWithRawResponse(self._templates.export_zip) + @cached_property def generate(self) -> GenerateResourceWithRawResponse: return GenerateResourceWithRawResponse(self._templates.generate) @@ -423,6 +503,22 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithRawRespo """ return AsyncConvertSimpleToFullResourceWithRawResponse(self._templates.convert_simple_to_full) + @cached_property + def export_html(self) -> AsyncExportHTMLResourceWithRawResponse: + return AsyncExportHTMLResourceWithRawResponse(self._templates.export_html) + + @cached_property + def export_image(self) -> AsyncExportImageResourceWithRawResponse: + return AsyncExportImageResourceWithRawResponse(self._templates.export_image) + + @cached_property + def export_pdf(self) -> AsyncExportPdfResourceWithRawResponse: + return AsyncExportPdfResourceWithRawResponse(self._templates.export_pdf) + + @cached_property + def export_zip(self) -> AsyncExportZipResourceWithRawResponse: + return AsyncExportZipResourceWithRawResponse(self._templates.export_zip) + @cached_property def generate(self) -> AsyncGenerateResourceWithRawResponse: return AsyncGenerateResourceWithRawResponse(self._templates.generate) @@ -460,6 +556,22 @@ def convert_simple_to_full(self) -> ConvertSimpleToFullResourceWithStreamingResp """ return ConvertSimpleToFullResourceWithStreamingResponse(self._templates.convert_simple_to_full) + @cached_property + def export_html(self) -> ExportHTMLResourceWithStreamingResponse: + return ExportHTMLResourceWithStreamingResponse(self._templates.export_html) + + @cached_property + def export_image(self) -> ExportImageResourceWithStreamingResponse: + return ExportImageResourceWithStreamingResponse(self._templates.export_image) + + @cached_property + def export_pdf(self) -> ExportPdfResourceWithStreamingResponse: + return ExportPdfResourceWithStreamingResponse(self._templates.export_pdf) + + @cached_property + def export_zip(self) -> ExportZipResourceWithStreamingResponse: + return ExportZipResourceWithStreamingResponse(self._templates.export_zip) + @cached_property def generate(self) -> GenerateResourceWithStreamingResponse: return GenerateResourceWithStreamingResponse(self._templates.generate) @@ -497,6 +609,22 @@ def convert_simple_to_full(self) -> AsyncConvertSimpleToFullResourceWithStreamin """ return AsyncConvertSimpleToFullResourceWithStreamingResponse(self._templates.convert_simple_to_full) + @cached_property + def export_html(self) -> AsyncExportHTMLResourceWithStreamingResponse: + return AsyncExportHTMLResourceWithStreamingResponse(self._templates.export_html) + + @cached_property + def export_image(self) -> AsyncExportImageResourceWithStreamingResponse: + return AsyncExportImageResourceWithStreamingResponse(self._templates.export_image) + + @cached_property + def export_pdf(self) -> AsyncExportPdfResourceWithStreamingResponse: + return AsyncExportPdfResourceWithStreamingResponse(self._templates.export_pdf) + + @cached_property + def export_zip(self) -> AsyncExportZipResourceWithStreamingResponse: + return AsyncExportZipResourceWithStreamingResponse(self._templates.export_zip) + @cached_property def generate(self) -> AsyncGenerateResourceWithStreamingResponse: return AsyncGenerateResourceWithStreamingResponse(self._templates.generate) diff --git a/src/unlayer/types/templates/__init__.py b/src/unlayer/types/templates/__init__.py index 3b6ccd9..bfc0663 100644 --- a/src/unlayer/types/templates/__init__.py +++ b/src/unlayer/types/templates/__init__.py @@ -5,7 +5,15 @@ from .import_create_params import ImportCreateParams as ImportCreateParams from .generate_create_params import GenerateCreateParams as GenerateCreateParams from .import_create_response import ImportCreateResponse as ImportCreateResponse +from .export_pdf_create_params import ExportPdfCreateParams as ExportPdfCreateParams +from .export_zip_create_params import ExportZipCreateParams as ExportZipCreateParams from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse +from .export_html_create_params import ExportHTMLCreateParams as ExportHTMLCreateParams +from .export_image_create_params import ExportImageCreateParams as ExportImageCreateParams +from .export_pdf_create_response import ExportPdfCreateResponse as ExportPdfCreateResponse +from .export_zip_create_response import ExportZipCreateResponse as ExportZipCreateResponse +from .export_html_create_response import ExportHTMLCreateResponse as ExportHTMLCreateResponse +from .export_image_create_response import ExportImageCreateResponse as ExportImageCreateResponse from .convert_full_to_simple_create_params import ConvertFullToSimpleCreateParams as ConvertFullToSimpleCreateParams from .convert_simple_to_full_create_params import ConvertSimpleToFullCreateParams as ConvertSimpleToFullCreateParams from .convert_full_to_simple_create_response import ( diff --git a/src/unlayer/types/templates/export_html_create_params.py b/src/unlayer/types/templates/export_html_create_params.py new file mode 100644 index 0000000..f7945ea --- /dev/null +++ b/src/unlayer/types/templates/export_html_create_params.py @@ -0,0 +1,39 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["ExportHTMLCreateParams"] + + +class ExportHTMLCreateParams(TypedDict, total=False): + design: Required[object] + """Unlayer design JSON""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + custom_js: Annotated[Union[str, SequenceNotStr[str]], PropertyInfo(alias="customJS")] + + design_tags: Annotated[object, PropertyInfo(alias="designTags")] + + design_tags_config: Annotated[object, PropertyInfo(alias="designTagsConfig")] + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + + editor_version: Annotated[str, PropertyInfo(alias="editorVersion")] + + language: str + + languages: SequenceNotStr[str] + + merge_tags: Annotated[object, PropertyInfo(alias="mergeTags")] + + merge_tags_schema: Annotated[object, PropertyInfo(alias="mergeTagsSchema")] + + safe_html: Annotated[bool, PropertyInfo(alias="safeHtml")] diff --git a/src/unlayer/types/templates/export_html_create_response.py b/src/unlayer/types/templates/export_html_create_response.py new file mode 100644 index 0000000..5bb3038 --- /dev/null +++ b/src/unlayer/types/templates/export_html_create_response.py @@ -0,0 +1,29 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from ..._models import BaseModel + +__all__ = ["ExportHTMLCreateResponse", "Data", "DataChunks"] + + +class DataChunks(BaseModel): + body: Optional[str] = None + + css: Optional[str] = None + + fonts: Optional[List[object]] = None + + js: Optional[str] = None + + +class Data(BaseModel): + chunks: Optional[DataChunks] = None + + html: Optional[str] = None + + +class ExportHTMLCreateResponse(BaseModel): + data: Optional[Data] = None + + success: Optional[bool] = None diff --git a/src/unlayer/types/templates/export_image_create_params.py b/src/unlayer/types/templates/export_image_create_params.py new file mode 100644 index 0000000..7429f9b --- /dev/null +++ b/src/unlayer/types/templates/export_image_create_params.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["ExportImageCreateParams"] + + +class ExportImageCreateParams(TypedDict, total=False): + design: Required[object] + """Unlayer design JSON""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + custom_js: Annotated[Union[str, SequenceNotStr[str]], PropertyInfo(alias="customJS")] + + design_tags: Annotated[object, PropertyInfo(alias="designTags")] + + design_tags_config: Annotated[object, PropertyInfo(alias="designTagsConfig")] + + device_scale_factor: Annotated[float, PropertyInfo(alias="deviceScaleFactor")] + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + + editor_version: Annotated[str, PropertyInfo(alias="editorVersion")] + + full_page: Annotated[bool, PropertyInfo(alias="fullPage")] + + height: float + + language: str + + languages: SequenceNotStr[str] + + merge_tags: Annotated[object, PropertyInfo(alias="mergeTags")] + + merge_tags_schema: Annotated[object, PropertyInfo(alias="mergeTagsSchema")] + + safe_html: Annotated[bool, PropertyInfo(alias="safeHtml")] + + width: float diff --git a/src/unlayer/types/templates/export_image_create_response.py b/src/unlayer/types/templates/export_image_create_response.py new file mode 100644 index 0000000..d5123e4 --- /dev/null +++ b/src/unlayer/types/templates/export_image_create_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["ExportImageCreateResponse", "Data"] + + +class Data(BaseModel): + url: Optional[str] = None + + +class ExportImageCreateResponse(BaseModel): + data: Optional[Data] = None + + success: Optional[bool] = None diff --git a/src/unlayer/types/templates/export_pdf_create_params.py b/src/unlayer/types/templates/export_pdf_create_params.py new file mode 100644 index 0000000..e357620 --- /dev/null +++ b/src/unlayer/types/templates/export_pdf_create_params.py @@ -0,0 +1,46 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["ExportPdfCreateParams"] + + +class ExportPdfCreateParams(TypedDict, total=False): + design: Required[object] + """Unlayer design JSON""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + content_width: Annotated[Union[float, Literal["full"]], PropertyInfo(alias="contentWidth")] + + custom_js: Annotated[Union[str, SequenceNotStr[str]], PropertyInfo(alias="customJS")] + + design_tags: Annotated[object, PropertyInfo(alias="designTags")] + + design_tags_config: Annotated[object, PropertyInfo(alias="designTagsConfig")] + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + + editor_version: Annotated[str, PropertyInfo(alias="editorVersion")] + + language: str + + languages: SequenceNotStr[str] + + merge_tags: Annotated[object, PropertyInfo(alias="mergeTags")] + + merge_tags_schema: Annotated[object, PropertyInfo(alias="mergeTagsSchema")] + + page_size: Annotated[ + Literal["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"], + PropertyInfo(alias="pageSize"), + ] + + safe_html: Annotated[bool, PropertyInfo(alias="safeHtml")] diff --git a/src/unlayer/types/templates/export_pdf_create_response.py b/src/unlayer/types/templates/export_pdf_create_response.py new file mode 100644 index 0000000..6a0da7e --- /dev/null +++ b/src/unlayer/types/templates/export_pdf_create_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["ExportPdfCreateResponse", "Data"] + + +class Data(BaseModel): + url: Optional[str] = None + + +class ExportPdfCreateResponse(BaseModel): + data: Optional[Data] = None + + success: Optional[bool] = None diff --git a/src/unlayer/types/templates/export_zip_create_params.py b/src/unlayer/types/templates/export_zip_create_params.py new file mode 100644 index 0000000..21e0591 --- /dev/null +++ b/src/unlayer/types/templates/export_zip_create_params.py @@ -0,0 +1,39 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["ExportZipCreateParams"] + + +class ExportZipCreateParams(TypedDict, total=False): + design: Required[object] + """Unlayer design JSON""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + custom_js: Annotated[Union[str, SequenceNotStr[str]], PropertyInfo(alias="customJS")] + + design_tags: Annotated[object, PropertyInfo(alias="designTags")] + + design_tags_config: Annotated[object, PropertyInfo(alias="designTagsConfig")] + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + + editor_version: Annotated[str, PropertyInfo(alias="editorVersion")] + + language: str + + languages: SequenceNotStr[str] + + merge_tags: Annotated[object, PropertyInfo(alias="mergeTags")] + + merge_tags_schema: Annotated[object, PropertyInfo(alias="mergeTagsSchema")] + + safe_html: Annotated[bool, PropertyInfo(alias="safeHtml")] diff --git a/src/unlayer/types/templates/export_zip_create_response.py b/src/unlayer/types/templates/export_zip_create_response.py new file mode 100644 index 0000000..9cecde2 --- /dev/null +++ b/src/unlayer/types/templates/export_zip_create_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["ExportZipCreateResponse", "Data"] + + +class Data(BaseModel): + url: Optional[str] = None + + +class ExportZipCreateResponse(BaseModel): + data: Optional[Data] = None + + success: Optional[bool] = None diff --git a/tests/api_resources/templates/test_export_html.py b/tests/api_resources/templates/test_export_html.py new file mode 100644 index 0000000..ad0d2e5 --- /dev/null +++ b/tests/api_resources/templates/test_export_html.py @@ -0,0 +1,122 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ExportHTMLCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestExportHTML: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + export_html = client.templates.export_html.create( + design={}, + ) + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + export_html = client.templates.export_html.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + ) + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.export_html.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_html = response.parse() + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.export_html.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_html = response.parse() + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncExportHTML: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + export_html = await async_client.templates.export_html.create( + design={}, + ) + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + export_html = await async_client.templates.export_html.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + ) + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.export_html.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_html = await response.parse() + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.export_html.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_html = await response.parse() + assert_matches_type(ExportHTMLCreateResponse, export_html, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_export_image.py b/tests/api_resources/templates/test_export_image.py new file mode 100644 index 0000000..9fe609b --- /dev/null +++ b/tests/api_resources/templates/test_export_image.py @@ -0,0 +1,130 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ExportImageCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestExportImage: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + export_image = client.templates.export_image.create( + design={}, + ) + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + export_image = client.templates.export_image.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + device_scale_factor=0, + display_mode="email", + editor_version="editorVersion", + full_page=True, + height=0, + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + width=0, + ) + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.export_image.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_image = response.parse() + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.export_image.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_image = response.parse() + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncExportImage: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + export_image = await async_client.templates.export_image.create( + design={}, + ) + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + export_image = await async_client.templates.export_image.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + device_scale_factor=0, + display_mode="email", + editor_version="editorVersion", + full_page=True, + height=0, + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + width=0, + ) + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.export_image.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_image = await response.parse() + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.export_image.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_image = await response.parse() + assert_matches_type(ExportImageCreateResponse, export_image, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_export_pdf.py b/tests/api_resources/templates/test_export_pdf.py new file mode 100644 index 0000000..9807bf8 --- /dev/null +++ b/tests/api_resources/templates/test_export_pdf.py @@ -0,0 +1,126 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ExportPdfCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestExportPdf: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + export_pdf = client.templates.export_pdf.create( + design={}, + ) + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + export_pdf = client.templates.export_pdf.create( + design={}, + project_id="projectId", + content_width="full", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + page_size="Letter", + safe_html=True, + ) + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.export_pdf.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_pdf = response.parse() + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.export_pdf.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_pdf = response.parse() + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncExportPdf: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + export_pdf = await async_client.templates.export_pdf.create( + design={}, + ) + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + export_pdf = await async_client.templates.export_pdf.create( + design={}, + project_id="projectId", + content_width="full", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + page_size="Letter", + safe_html=True, + ) + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.export_pdf.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_pdf = await response.parse() + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.export_pdf.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_pdf = await response.parse() + assert_matches_type(ExportPdfCreateResponse, export_pdf, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_export_zip.py b/tests/api_resources/templates/test_export_zip.py new file mode 100644 index 0000000..e9914cb --- /dev/null +++ b/tests/api_resources/templates/test_export_zip.py @@ -0,0 +1,122 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ExportZipCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestExportZip: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + export_zip = client.templates.export_zip.create( + design={}, + ) + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + export_zip = client.templates.export_zip.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + ) + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.export_zip.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_zip = response.parse() + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.export_zip.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_zip = response.parse() + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncExportZip: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + export_zip = await async_client.templates.export_zip.create( + design={}, + ) + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + export_zip = await async_client.templates.export_zip.create( + design={}, + project_id="projectId", + custom_js="string", + design_tags={}, + design_tags_config={}, + display_mode="email", + editor_version="editorVersion", + language="language", + languages=["string"], + merge_tags={}, + merge_tags_schema={}, + safe_html=True, + ) + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.export_zip.with_raw_response.create( + design={}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + export_zip = await response.parse() + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.export_zip.with_streaming_response.create( + design={}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + export_zip = await response.parse() + assert_matches_type(ExportZipCreateResponse, export_zip, path=["response"]) + + assert cast(Any, response.is_closed) is True From 1105634587e7908392c26243a3a22c44d5fa63e7 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 18 Jul 2026 02:14:28 +0000 Subject: [PATCH 40/46] feat(stlc): configurable CI runner and private-production-repo support in workflow templates --- .github/workflows/ci.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 342d2cd..c0f24af 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,7 +18,7 @@ jobs: lint: timeout-minutes: 10 name: lint - runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: (github.event_name == 'push' || github.event.pull_request.head.repo.fork) && (github.event_name != 'push' || github.event.head_commit.message != 'codegen metadata') steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 @@ -44,7 +44,7 @@ jobs: permissions: contents: read id-token: write - runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 @@ -84,7 +84,7 @@ jobs: test: timeout-minutes: 10 name: test - runs-on: ${{ github.repository == 'stainless-sdks/unlayer-python' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + runs-on: ${{ startsWith(github.repository, 'stainless-sdks/') && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} if: github.event_name == 'push' || github.event.pull_request.head.repo.fork steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 From a19b633a992b7f3c7fea7d3e0086d6df4d417b7f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 21 Jul 2026 12:12:49 +0000 Subject: [PATCH 41/46] feat(api): api update --- .stats.yml | 8 +- api.md | 26 +++ src/unlayer/_client.py | 76 ++++++- src/unlayer/resources/__init__.py | 28 +++ src/unlayer/resources/editor_sessions.py | 208 ++++++++++++++++++ src/unlayer/resources/me/__init__.py | 33 +++ src/unlayer/resources/me/me.py | 102 +++++++++ src/unlayer/resources/me/subscription.py | 183 +++++++++++++++ src/unlayer/types/__init__.py | 2 + .../types/editor_session_create_params.py | 21 ++ .../types/editor_session_create_response.py | 21 ++ src/unlayer/types/me/__init__.py | 6 + .../types/me/subscription_retrieve_params.py | 14 ++ .../me/subscription_retrieve_response.py | 39 ++++ tests/api_resources/me/__init__.py | 1 + tests/api_resources/me/test_subscription.py | 88 ++++++++ tests/api_resources/test_editor_sessions.py | 104 +++++++++ 17 files changed, 955 insertions(+), 5 deletions(-) create mode 100644 src/unlayer/resources/editor_sessions.py create mode 100644 src/unlayer/resources/me/__init__.py create mode 100644 src/unlayer/resources/me/me.py create mode 100644 src/unlayer/resources/me/subscription.py create mode 100644 src/unlayer/types/editor_session_create_params.py create mode 100644 src/unlayer/types/editor_session_create_response.py create mode 100644 src/unlayer/types/me/__init__.py create mode 100644 src/unlayer/types/me/subscription_retrieve_params.py create mode 100644 src/unlayer/types/me/subscription_retrieve_response.py create mode 100644 tests/api_resources/me/__init__.py create mode 100644 tests/api_resources/me/test_subscription.py create mode 100644 tests/api_resources/test_editor_sessions.py diff --git a/.stats.yml b/.stats.yml index 2e4bbbe..61fd7e3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 14 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-8f62b635191810fa318afdeaabbbb0276b0e1f85f18b5ff2ddaad9a18241f047.yml -openapi_spec_hash: e80a61e80827f2a822db46f4ba82c15d -config_hash: 2949daec69cb6f5d34ae232544245952 +configured_endpoints: 16 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-bccf7c265777474ad23af36d8613e0c738575733ba2335e42129def19d09c021.yml +openapi_spec_hash: 28687f1755511828bc8323d621eba251 +config_hash: de0fdd9f4e2afbb6886dfabb1e7306fa diff --git a/api.md b/api.md index 71e781f..7bf9161 100644 --- a/api.md +++ b/api.md @@ -1,3 +1,29 @@ +# EditorSessions + +Types: + +```python +from unlayer.types import EditorSessionCreateResponse +``` + +Methods: + +- client.editor_sessions.create(\*\*params) -> EditorSessionCreateResponse + +# Me + +## Subscription + +Types: + +```python +from unlayer.types.me import SubscriptionRetrieveResponse +``` + +Methods: + +- client.me.subscription.retrieve(\*\*params) -> SubscriptionRetrieveResponse + # Projects Types: diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 6ab1a5f..7e6e095 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -36,9 +36,11 @@ ) if TYPE_CHECKING: - from .resources import projects, templates, workspaces + from .resources import me, projects, templates, workspaces, editor_sessions + from .resources.me.me import MeResource, AsyncMeResource from .resources.projects import ProjectsResource, AsyncProjectsResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource + from .resources.editor_sessions import EditorSessionsResource, AsyncEditorSessionsResource from .resources.templates.templates import TemplatesResource, AsyncTemplatesResource __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Unlayer", "AsyncUnlayer", "Client", "AsyncClient"] @@ -119,6 +121,18 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def editor_sessions(self) -> EditorSessionsResource: + from .resources.editor_sessions import EditorSessionsResource + + return EditorSessionsResource(self) + + @cached_property + def me(self) -> MeResource: + from .resources.me import MeResource + + return MeResource(self) + @cached_property def projects(self) -> ProjectsResource: """Project details and configuration.""" @@ -357,6 +371,18 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def editor_sessions(self) -> AsyncEditorSessionsResource: + from .resources.editor_sessions import AsyncEditorSessionsResource + + return AsyncEditorSessionsResource(self) + + @cached_property + def me(self) -> AsyncMeResource: + from .resources.me import AsyncMeResource + + return AsyncMeResource(self) + @cached_property def projects(self) -> AsyncProjectsResource: """Project details and configuration.""" @@ -526,6 +552,18 @@ class UnlayerWithRawResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def editor_sessions(self) -> editor_sessions.EditorSessionsResourceWithRawResponse: + from .resources.editor_sessions import EditorSessionsResourceWithRawResponse + + return EditorSessionsResourceWithRawResponse(self._client.editor_sessions) + + @cached_property + def me(self) -> me.MeResourceWithRawResponse: + from .resources.me import MeResourceWithRawResponse + + return MeResourceWithRawResponse(self._client.me) + @cached_property def projects(self) -> projects.ProjectsResourceWithRawResponse: """Project details and configuration.""" @@ -556,6 +594,18 @@ class AsyncUnlayerWithRawResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def editor_sessions(self) -> editor_sessions.AsyncEditorSessionsResourceWithRawResponse: + from .resources.editor_sessions import AsyncEditorSessionsResourceWithRawResponse + + return AsyncEditorSessionsResourceWithRawResponse(self._client.editor_sessions) + + @cached_property + def me(self) -> me.AsyncMeResourceWithRawResponse: + from .resources.me import AsyncMeResourceWithRawResponse + + return AsyncMeResourceWithRawResponse(self._client.me) + @cached_property def projects(self) -> projects.AsyncProjectsResourceWithRawResponse: """Project details and configuration.""" @@ -586,6 +636,18 @@ class UnlayerWithStreamedResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def editor_sessions(self) -> editor_sessions.EditorSessionsResourceWithStreamingResponse: + from .resources.editor_sessions import EditorSessionsResourceWithStreamingResponse + + return EditorSessionsResourceWithStreamingResponse(self._client.editor_sessions) + + @cached_property + def me(self) -> me.MeResourceWithStreamingResponse: + from .resources.me import MeResourceWithStreamingResponse + + return MeResourceWithStreamingResponse(self._client.me) + @cached_property def projects(self) -> projects.ProjectsResourceWithStreamingResponse: """Project details and configuration.""" @@ -616,6 +678,18 @@ class AsyncUnlayerWithStreamedResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def editor_sessions(self) -> editor_sessions.AsyncEditorSessionsResourceWithStreamingResponse: + from .resources.editor_sessions import AsyncEditorSessionsResourceWithStreamingResponse + + return AsyncEditorSessionsResourceWithStreamingResponse(self._client.editor_sessions) + + @cached_property + def me(self) -> me.AsyncMeResourceWithStreamingResponse: + from .resources.me import AsyncMeResourceWithStreamingResponse + + return AsyncMeResourceWithStreamingResponse(self._client.me) + @cached_property def projects(self) -> projects.AsyncProjectsResourceWithStreamingResponse: """Project details and configuration.""" diff --git a/src/unlayer/resources/__init__.py b/src/unlayer/resources/__init__.py index 7f3c4bd..4694e01 100644 --- a/src/unlayer/resources/__init__.py +++ b/src/unlayer/resources/__init__.py @@ -1,5 +1,13 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +from .me import ( + MeResource, + AsyncMeResource, + MeResourceWithRawResponse, + AsyncMeResourceWithRawResponse, + MeResourceWithStreamingResponse, + AsyncMeResourceWithStreamingResponse, +) from .projects import ( ProjectsResource, AsyncProjectsResource, @@ -24,8 +32,28 @@ WorkspacesResourceWithStreamingResponse, AsyncWorkspacesResourceWithStreamingResponse, ) +from .editor_sessions import ( + EditorSessionsResource, + AsyncEditorSessionsResource, + EditorSessionsResourceWithRawResponse, + AsyncEditorSessionsResourceWithRawResponse, + EditorSessionsResourceWithStreamingResponse, + AsyncEditorSessionsResourceWithStreamingResponse, +) __all__ = [ + "EditorSessionsResource", + "AsyncEditorSessionsResource", + "EditorSessionsResourceWithRawResponse", + "AsyncEditorSessionsResourceWithRawResponse", + "EditorSessionsResourceWithStreamingResponse", + "AsyncEditorSessionsResourceWithStreamingResponse", + "MeResource", + "AsyncMeResource", + "MeResourceWithRawResponse", + "AsyncMeResourceWithRawResponse", + "MeResourceWithStreamingResponse", + "AsyncMeResourceWithStreamingResponse", "ProjectsResource", "AsyncProjectsResource", "ProjectsResourceWithRawResponse", diff --git a/src/unlayer/resources/editor_sessions.py b/src/unlayer/resources/editor_sessions.py new file mode 100644 index 0000000..74ed20d --- /dev/null +++ b/src/unlayer/resources/editor_sessions.py @@ -0,0 +1,208 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict +from typing_extensions import Literal + +import httpx + +from ..types import editor_session_create_params +from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from .._utils import maybe_transform, async_maybe_transform +from .._compat import cached_property +from .._resource import SyncAPIResource, AsyncAPIResource +from .._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .._base_client import make_request_options +from ..types.editor_session_create_response import EditorSessionCreateResponse + +__all__ = ["EditorSessionsResource", "AsyncEditorSessionsResource"] + + +class EditorSessionsResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> EditorSessionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return EditorSessionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> EditorSessionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return EditorSessionsResourceWithStreamingResponse(self) + + def create( + self, + *, + design: Dict[str, object], + project_id: str | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EditorSessionCreateResponse: + """ + Create an ephemeral, no-DB editor session for a design and return a hosted + editor URL the user can open to edit it in the real Unlayer editor. + + Args: + design: Design JSON to load into the editor. + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + display_mode: Editor display mode. Defaults to email. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/editor-sessions", + body=maybe_transform( + { + "design": design, + "display_mode": display_mode, + }, + editor_session_create_params.EditorSessionCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + {"project_id": project_id}, editor_session_create_params.EditorSessionCreateParams + ), + ), + cast_to=EditorSessionCreateResponse, + ) + + +class AsyncEditorSessionsResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncEditorSessionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncEditorSessionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncEditorSessionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncEditorSessionsResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: Dict[str, object], + project_id: str | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EditorSessionCreateResponse: + """ + Create an ephemeral, no-DB editor session for a design and return a hosted + editor URL the user can open to edit it in the real Unlayer editor. + + Args: + design: Design JSON to load into the editor. + + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + display_mode: Editor display mode. Defaults to email. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/editor-sessions", + body=await async_maybe_transform( + { + "design": design, + "display_mode": display_mode, + }, + editor_session_create_params.EditorSessionCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, editor_session_create_params.EditorSessionCreateParams + ), + ), + cast_to=EditorSessionCreateResponse, + ) + + +class EditorSessionsResourceWithRawResponse: + def __init__(self, editor_sessions: EditorSessionsResource) -> None: + self._editor_sessions = editor_sessions + + self.create = to_raw_response_wrapper( + editor_sessions.create, + ) + + +class AsyncEditorSessionsResourceWithRawResponse: + def __init__(self, editor_sessions: AsyncEditorSessionsResource) -> None: + self._editor_sessions = editor_sessions + + self.create = async_to_raw_response_wrapper( + editor_sessions.create, + ) + + +class EditorSessionsResourceWithStreamingResponse: + def __init__(self, editor_sessions: EditorSessionsResource) -> None: + self._editor_sessions = editor_sessions + + self.create = to_streamed_response_wrapper( + editor_sessions.create, + ) + + +class AsyncEditorSessionsResourceWithStreamingResponse: + def __init__(self, editor_sessions: AsyncEditorSessionsResource) -> None: + self._editor_sessions = editor_sessions + + self.create = async_to_streamed_response_wrapper( + editor_sessions.create, + ) diff --git a/src/unlayer/resources/me/__init__.py b/src/unlayer/resources/me/__init__.py new file mode 100644 index 0000000..5638802 --- /dev/null +++ b/src/unlayer/resources/me/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .me import ( + MeResource, + AsyncMeResource, + MeResourceWithRawResponse, + AsyncMeResourceWithRawResponse, + MeResourceWithStreamingResponse, + AsyncMeResourceWithStreamingResponse, +) +from .subscription import ( + SubscriptionResource, + AsyncSubscriptionResource, + SubscriptionResourceWithRawResponse, + AsyncSubscriptionResourceWithRawResponse, + SubscriptionResourceWithStreamingResponse, + AsyncSubscriptionResourceWithStreamingResponse, +) + +__all__ = [ + "SubscriptionResource", + "AsyncSubscriptionResource", + "SubscriptionResourceWithRawResponse", + "AsyncSubscriptionResourceWithRawResponse", + "SubscriptionResourceWithStreamingResponse", + "AsyncSubscriptionResourceWithStreamingResponse", + "MeResource", + "AsyncMeResource", + "MeResourceWithRawResponse", + "AsyncMeResourceWithRawResponse", + "MeResourceWithStreamingResponse", + "AsyncMeResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/me/me.py b/src/unlayer/resources/me/me.py new file mode 100644 index 0000000..5d39fd1 --- /dev/null +++ b/src/unlayer/resources/me/me.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from .subscription import ( + SubscriptionResource, + AsyncSubscriptionResource, + SubscriptionResourceWithRawResponse, + AsyncSubscriptionResourceWithRawResponse, + SubscriptionResourceWithStreamingResponse, + AsyncSubscriptionResourceWithStreamingResponse, +) + +__all__ = ["MeResource", "AsyncMeResource"] + + +class MeResource(SyncAPIResource): + @cached_property + def subscription(self) -> SubscriptionResource: + return SubscriptionResource(self._client) + + @cached_property + def with_raw_response(self) -> MeResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return MeResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> MeResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return MeResourceWithStreamingResponse(self) + + +class AsyncMeResource(AsyncAPIResource): + @cached_property + def subscription(self) -> AsyncSubscriptionResource: + return AsyncSubscriptionResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncMeResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncMeResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncMeResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncMeResourceWithStreamingResponse(self) + + +class MeResourceWithRawResponse: + def __init__(self, me: MeResource) -> None: + self._me = me + + @cached_property + def subscription(self) -> SubscriptionResourceWithRawResponse: + return SubscriptionResourceWithRawResponse(self._me.subscription) + + +class AsyncMeResourceWithRawResponse: + def __init__(self, me: AsyncMeResource) -> None: + self._me = me + + @cached_property + def subscription(self) -> AsyncSubscriptionResourceWithRawResponse: + return AsyncSubscriptionResourceWithRawResponse(self._me.subscription) + + +class MeResourceWithStreamingResponse: + def __init__(self, me: MeResource) -> None: + self._me = me + + @cached_property + def subscription(self) -> SubscriptionResourceWithStreamingResponse: + return SubscriptionResourceWithStreamingResponse(self._me.subscription) + + +class AsyncMeResourceWithStreamingResponse: + def __init__(self, me: AsyncMeResource) -> None: + self._me = me + + @cached_property + def subscription(self) -> AsyncSubscriptionResourceWithStreamingResponse: + return AsyncSubscriptionResourceWithStreamingResponse(self._me.subscription) diff --git a/src/unlayer/resources/me/subscription.py b/src/unlayer/resources/me/subscription.py new file mode 100644 index 0000000..8af1d4a --- /dev/null +++ b/src/unlayer/resources/me/subscription.py @@ -0,0 +1,183 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ...types.me import subscription_retrieve_params +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.me.subscription_retrieve_response import SubscriptionRetrieveResponse + +__all__ = ["SubscriptionResource", "AsyncSubscriptionResource"] + + +class SubscriptionResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> SubscriptionResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return SubscriptionResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SubscriptionResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return SubscriptionResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SubscriptionRetrieveResponse: + """Get the current plan, feature availability, and limits for a project. + + Used to + answer "can I do X" / "what plan do I need" questions with ground-truth data + instead of guessing. + + Args: + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/me/subscription", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + {"project_id": project_id}, subscription_retrieve_params.SubscriptionRetrieveParams + ), + ), + cast_to=SubscriptionRetrieveResponse, + ) + + +class AsyncSubscriptionResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncSubscriptionResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncSubscriptionResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSubscriptionResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncSubscriptionResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SubscriptionRetrieveResponse: + """Get the current plan, feature availability, and limits for a project. + + Used to + answer "can I do X" / "what plan do I need" questions with ground-truth data + instead of guessing. + + Args: + project_id: The project ID (required for PAT auth, auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/me/subscription", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + {"project_id": project_id}, subscription_retrieve_params.SubscriptionRetrieveParams + ), + ), + cast_to=SubscriptionRetrieveResponse, + ) + + +class SubscriptionResourceWithRawResponse: + def __init__(self, subscription: SubscriptionResource) -> None: + self._subscription = subscription + + self.retrieve = to_raw_response_wrapper( + subscription.retrieve, + ) + + +class AsyncSubscriptionResourceWithRawResponse: + def __init__(self, subscription: AsyncSubscriptionResource) -> None: + self._subscription = subscription + + self.retrieve = async_to_raw_response_wrapper( + subscription.retrieve, + ) + + +class SubscriptionResourceWithStreamingResponse: + def __init__(self, subscription: SubscriptionResource) -> None: + self._subscription = subscription + + self.retrieve = to_streamed_response_wrapper( + subscription.retrieve, + ) + + +class AsyncSubscriptionResourceWithStreamingResponse: + def __init__(self, subscription: AsyncSubscriptionResource) -> None: + self._subscription = subscription + + self.retrieve = async_to_streamed_response_wrapper( + subscription.retrieve, + ) diff --git a/src/unlayer/types/__init__.py b/src/unlayer/types/__init__.py index 3aa8608..c11e0fa 100644 --- a/src/unlayer/types/__init__.py +++ b/src/unlayer/types/__init__.py @@ -9,3 +9,5 @@ from .project_retrieve_response import ProjectRetrieveResponse as ProjectRetrieveResponse from .template_retrieve_response import TemplateRetrieveResponse as TemplateRetrieveResponse from .workspace_retrieve_response import WorkspaceRetrieveResponse as WorkspaceRetrieveResponse +from .editor_session_create_params import EditorSessionCreateParams as EditorSessionCreateParams +from .editor_session_create_response import EditorSessionCreateResponse as EditorSessionCreateResponse diff --git a/src/unlayer/types/editor_session_create_params.py b/src/unlayer/types/editor_session_create_params.py new file mode 100644 index 0000000..26d7cdd --- /dev/null +++ b/src/unlayer/types/editor_session_create_params.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict +from typing_extensions import Literal, Required, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["EditorSessionCreateParams"] + + +class EditorSessionCreateParams(TypedDict, total=False): + design: Required[Dict[str, object]] + """Design JSON to load into the editor.""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Editor display mode. Defaults to email.""" diff --git a/src/unlayer/types/editor_session_create_response.py b/src/unlayer/types/editor_session_create_response.py new file mode 100644 index 0000000..2a3efbd --- /dev/null +++ b/src/unlayer/types/editor_session_create_response.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["EditorSessionCreateResponse", "Data"] + + +class Data(BaseModel): + token: Optional[str] = None + + editor_url: Optional[str] = FieldInfo(alias="editorUrl", default=None) + + expires_at: Optional[str] = FieldInfo(alias="expiresAt", default=None) + + +class EditorSessionCreateResponse(BaseModel): + data: Optional[Data] = None diff --git a/src/unlayer/types/me/__init__.py b/src/unlayer/types/me/__init__.py new file mode 100644 index 0000000..860855d --- /dev/null +++ b/src/unlayer/types/me/__init__.py @@ -0,0 +1,6 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .subscription_retrieve_params import SubscriptionRetrieveParams as SubscriptionRetrieveParams +from .subscription_retrieve_response import SubscriptionRetrieveResponse as SubscriptionRetrieveResponse diff --git a/src/unlayer/types/me/subscription_retrieve_params.py b/src/unlayer/types/me/subscription_retrieve_params.py new file mode 100644 index 0000000..87e8c47 --- /dev/null +++ b/src/unlayer/types/me/subscription_retrieve_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SubscriptionRetrieveParams"] + + +class SubscriptionRetrieveParams(TypedDict, total=False): + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID (required for PAT auth, auto-resolved for API key auth)""" diff --git a/src/unlayer/types/me/subscription_retrieve_response.py b/src/unlayer/types/me/subscription_retrieve_response.py new file mode 100644 index 0000000..c7ba9d3 --- /dev/null +++ b/src/unlayer/types/me/subscription_retrieve_response.py @@ -0,0 +1,39 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["SubscriptionRetrieveResponse", "Data", "DataFeature", "DataLimit"] + + +class DataFeature(BaseModel): + available: Optional[bool] = None + + name: Optional[str] = None + + +class DataLimit(BaseModel): + name: Optional[str] = None + + unit: Optional[str] = None + + value: Optional[float] = None + + +class Data(BaseModel): + expires_at: Optional[str] = FieldInfo(alias="expiresAt", default=None) + + features: Optional[List[DataFeature]] = None + + limits: Optional[List[DataLimit]] = None + + plan_name: Optional[str] = FieldInfo(alias="planName", default=None) + + status: Optional[str] = None + + +class SubscriptionRetrieveResponse(BaseModel): + data: Optional[Data] = None diff --git a/tests/api_resources/me/__init__.py b/tests/api_resources/me/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/me/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/me/test_subscription.py b/tests/api_resources/me/test_subscription.py new file mode 100644 index 0000000..08ec36c --- /dev/null +++ b/tests/api_resources/me/test_subscription.py @@ -0,0 +1,88 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.me import SubscriptionRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSubscription: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + subscription = client.me.subscription.retrieve() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + subscription = client.me.subscription.retrieve( + project_id="projectId", + ) + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.me.subscription.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + subscription = response.parse() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.me.subscription.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + subscription = response.parse() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncSubscription: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + subscription = await async_client.me.subscription.retrieve() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + subscription = await async_client.me.subscription.retrieve( + project_id="projectId", + ) + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.me.subscription.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + subscription = await response.parse() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.me.subscription.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + subscription = await response.parse() + assert_matches_type(SubscriptionRetrieveResponse, subscription, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_editor_sessions.py b/tests/api_resources/test_editor_sessions.py new file mode 100644 index 0000000..66c0a2b --- /dev/null +++ b/tests/api_resources/test_editor_sessions.py @@ -0,0 +1,104 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types import EditorSessionCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestEditorSessions: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + editor_session = client.editor_sessions.create( + design={"foo": "bar"}, + ) + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + editor_session = client.editor_sessions.create( + design={"foo": "bar"}, + project_id="projectId", + display_mode="email", + ) + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.editor_sessions.with_raw_response.create( + design={"foo": "bar"}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + editor_session = response.parse() + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.editor_sessions.with_streaming_response.create( + design={"foo": "bar"}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + editor_session = response.parse() + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncEditorSessions: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + editor_session = await async_client.editor_sessions.create( + design={"foo": "bar"}, + ) + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + editor_session = await async_client.editor_sessions.create( + design={"foo": "bar"}, + project_id="projectId", + display_mode="email", + ) + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.editor_sessions.with_raw_response.create( + design={"foo": "bar"}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + editor_session = await response.parse() + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.editor_sessions.with_streaming_response.create( + design={"foo": "bar"}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + editor_session = await response.parse() + assert_matches_type(EditorSessionCreateResponse, editor_session, path=["response"]) + + assert cast(Any, response.is_closed) is True From afa74d05a94c6614ff92ee5f714288bca8d13d7d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 07:55:52 +0000 Subject: [PATCH 42/46] feat(api): api update --- .stats.yml | 4 ++-- .../types/templates/export_html_create_response.py | 8 +++++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index 61fd7e3..b7f1d1a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-bccf7c265777474ad23af36d8613e0c738575733ba2335e42129def19d09c021.yml -openapi_spec_hash: 28687f1755511828bc8323d621eba251 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-aa551455ecbd91da3298aa03a688686374e19650fb3fce54f437fb4086eef3ba.yml +openapi_spec_hash: c44982974f0272a5fa34de8b2d8d759d config_hash: de0fdd9f4e2afbb6886dfabb1e7306fa diff --git a/src/unlayer/types/templates/export_html_create_response.py b/src/unlayer/types/templates/export_html_create_response.py index 5bb3038..4e80cf1 100644 --- a/src/unlayer/types/templates/export_html_create_response.py +++ b/src/unlayer/types/templates/export_html_create_response.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import List, Optional +from typing import Dict, List, Optional from ..._models import BaseModel @@ -16,10 +16,16 @@ class DataChunks(BaseModel): js: Optional[str] = None + tags: Optional[List[str]] = None + class Data(BaseModel): + amp: Optional[Dict[str, object]] = None + chunks: Optional[DataChunks] = None + design: Optional[Dict[str, object]] = None + html: Optional[str] = None From c6b629ba3d6183805e939a2c7dca278bbbb7fed1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 17:25:14 +0000 Subject: [PATCH 43/46] feat(api): api update --- .stats.yml | 8 +- api.md | 87 ++- src/unlayer/_client.py | 2 +- src/unlayer/resources/projects/__init__.py | 117 ++++ .../{projects.py => projects/ai_credits.py} | 104 ++-- .../resources/projects/ai_credits_settings.py | 303 +++++++++ .../ai_credits_settings_rotate_secret.py | 180 ++++++ .../resources/projects/ai_credits_usage.py | 267 ++++++++ .../ai_credits_webhooks_deliveries.py | 231 +++++++ .../ai_credits_webhooks_deliveriesattempts.py | 231 +++++++ .../ai_credits_webhooks_deliveriesretry.py | 190 ++++++ src/unlayer/resources/projects/projects.py | 588 ++++++++++++++++++ src/unlayer/types/projects/__init__.py | 28 + .../projects/ai_credit_retrieve_response.py | 25 + .../ai_credits_setting_retrieve_response.py | 17 + .../ai_credits_setting_update_params.py | 22 + .../ai_credits_setting_update_response.py | 20 + ..._settings_rotate_secret_create_response.py | 12 + .../ai_credits_usage_retrieve_params.py | 33 + .../ai_credits_usage_retrieve_response.py | 34 + ...hooks_deliveriesattempt_retrieve_params.py | 17 + ...oks_deliveriesattempt_retrieve_response.py | 25 + ...ebhooks_deliveriesretry_create_response.py | 12 + ...edits_webhooks_delivery_retrieve_params.py | 21 + ...its_webhooks_delivery_retrieve_response.py | 36 ++ tests/api_resources/projects/__init__.py | 1 + .../api_resources/projects/test_ai_credits.py | 100 +++ .../projects/test_ai_credits_settings.py | 199 ++++++ .../test_ai_credits_settings_rotate_secret.py | 112 ++++ .../projects/test_ai_credits_usage.py | 130 ++++ .../test_ai_credits_webhooks_deliveries.py | 128 ++++ ..._ai_credits_webhooks_deliveriesattempts.py | 166 +++++ ...est_ai_credits_webhooks_deliveriesretry.py | 132 ++++ 33 files changed, 3526 insertions(+), 52 deletions(-) create mode 100644 src/unlayer/resources/projects/__init__.py rename src/unlayer/resources/{projects.py => projects/ai_credits.py} (57%) create mode 100644 src/unlayer/resources/projects/ai_credits_settings.py create mode 100644 src/unlayer/resources/projects/ai_credits_settings_rotate_secret.py create mode 100644 src/unlayer/resources/projects/ai_credits_usage.py create mode 100644 src/unlayer/resources/projects/ai_credits_webhooks_deliveries.py create mode 100644 src/unlayer/resources/projects/ai_credits_webhooks_deliveriesattempts.py create mode 100644 src/unlayer/resources/projects/ai_credits_webhooks_deliveriesretry.py create mode 100644 src/unlayer/resources/projects/projects.py create mode 100644 src/unlayer/types/projects/__init__.py create mode 100644 src/unlayer/types/projects/ai_credit_retrieve_response.py create mode 100644 src/unlayer/types/projects/ai_credits_setting_retrieve_response.py create mode 100644 src/unlayer/types/projects/ai_credits_setting_update_params.py create mode 100644 src/unlayer/types/projects/ai_credits_setting_update_response.py create mode 100644 src/unlayer/types/projects/ai_credits_settings_rotate_secret_create_response.py create mode 100644 src/unlayer/types/projects/ai_credits_usage_retrieve_params.py create mode 100644 src/unlayer/types/projects/ai_credits_usage_retrieve_response.py create mode 100644 src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_params.py create mode 100644 src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_response.py create mode 100644 src/unlayer/types/projects/ai_credits_webhooks_deliveriesretry_create_response.py create mode 100644 src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_params.py create mode 100644 src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_response.py create mode 100644 tests/api_resources/projects/__init__.py create mode 100644 tests/api_resources/projects/test_ai_credits.py create mode 100644 tests/api_resources/projects/test_ai_credits_settings.py create mode 100644 tests/api_resources/projects/test_ai_credits_settings_rotate_secret.py create mode 100644 tests/api_resources/projects/test_ai_credits_usage.py create mode 100644 tests/api_resources/projects/test_ai_credits_webhooks_deliveries.py create mode 100644 tests/api_resources/projects/test_ai_credits_webhooks_deliveriesattempts.py create mode 100644 tests/api_resources/projects/test_ai_credits_webhooks_deliveriesretry.py diff --git a/.stats.yml b/.stats.yml index b7f1d1a..568730e 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 16 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-aa551455ecbd91da3298aa03a688686374e19650fb3fce54f437fb4086eef3ba.yml -openapi_spec_hash: c44982974f0272a5fa34de8b2d8d759d -config_hash: de0fdd9f4e2afbb6886dfabb1e7306fa +configured_endpoints: 24 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-b42187e1b2fff52630a33946829067dcc76dd842a7fb85d826ee9ccc4f44175d.yml +openapi_spec_hash: 7f0c95f3bb404716e0a77878c0c21b91 +config_hash: ee438ad5d5e9b8446d21fc7cb50eff95 diff --git a/api.md b/api.md index 7bf9161..182b670 100644 --- a/api.md +++ b/api.md @@ -34,7 +34,92 @@ from unlayer.types import ProjectRetrieveResponse Methods: -- client.projects.retrieve(id) -> ProjectRetrieveResponse +- client.projects.retrieve(id) -> ProjectRetrieveResponse + +## AICredits + +Types: + +```python +from unlayer.types.projects import AICreditRetrieveResponse +``` + +Methods: + +- client.projects.ai_credits.retrieve(id) -> AICreditRetrieveResponse + +## AICreditsSettings + +Types: + +```python +from unlayer.types.projects import AICreditsSettingRetrieveResponse, AICreditsSettingUpdateResponse +``` + +Methods: + +- client.projects.ai_credits_settings.retrieve(id) -> AICreditsSettingRetrieveResponse +- client.projects.ai_credits_settings.update(id, \*\*params) -> AICreditsSettingUpdateResponse + +## AICreditsSettingsRotateSecret + +Types: + +```python +from unlayer.types.projects import AICreditsSettingsRotateSecretCreateResponse +``` + +Methods: + +- client.projects.ai_credits_settings_rotate_secret.create(id) -> AICreditsSettingsRotateSecretCreateResponse + +## AICreditsUsage + +Types: + +```python +from unlayer.types.projects import AICreditsUsageRetrieveResponse +``` + +Methods: + +- client.projects.ai_credits_usage.retrieve(id, \*\*params) -> AICreditsUsageRetrieveResponse + +## AICreditsWebhooksDeliveries + +Types: + +```python +from unlayer.types.projects import AICreditsWebhooksDeliveryRetrieveResponse +``` + +Methods: + +- client.projects.ai_credits_webhooks_deliveries.retrieve(id, \*\*params) -> AICreditsWebhooksDeliveryRetrieveResponse + +## AICreditsWebhooksDeliveriesattempts + +Types: + +```python +from unlayer.types.projects import AICreditsWebhooksDeliveriesattemptRetrieveResponse +``` + +Methods: + +- client.projects.ai_credits_webhooks_deliveriesattempts.retrieve(delivery_id, \*, id, \*\*params) -> AICreditsWebhooksDeliveriesattemptRetrieveResponse + +## AICreditsWebhooksDeliveriesretry + +Types: + +```python +from unlayer.types.projects import AICreditsWebhooksDeliveriesretryCreateResponse +``` + +Methods: + +- client.projects.ai_credits_webhooks_deliveriesretry.create(delivery_id, \*, id) -> AICreditsWebhooksDeliveriesretryCreateResponse # Templates diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 7e6e095..30d36b6 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -38,9 +38,9 @@ if TYPE_CHECKING: from .resources import me, projects, templates, workspaces, editor_sessions from .resources.me.me import MeResource, AsyncMeResource - from .resources.projects import ProjectsResource, AsyncProjectsResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource from .resources.editor_sessions import EditorSessionsResource, AsyncEditorSessionsResource + from .resources.projects.projects import ProjectsResource, AsyncProjectsResource from .resources.templates.templates import TemplatesResource, AsyncTemplatesResource __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Unlayer", "AsyncUnlayer", "Client", "AsyncClient"] diff --git a/src/unlayer/resources/projects/__init__.py b/src/unlayer/resources/projects/__init__.py new file mode 100644 index 0000000..cc0c135 --- /dev/null +++ b/src/unlayer/resources/projects/__init__.py @@ -0,0 +1,117 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .projects import ( + ProjectsResource, + AsyncProjectsResource, + ProjectsResourceWithRawResponse, + AsyncProjectsResourceWithRawResponse, + ProjectsResourceWithStreamingResponse, + AsyncProjectsResourceWithStreamingResponse, +) +from .ai_credits import ( + AICreditsResource, + AsyncAICreditsResource, + AICreditsResourceWithRawResponse, + AsyncAICreditsResourceWithRawResponse, + AICreditsResourceWithStreamingResponse, + AsyncAICreditsResourceWithStreamingResponse, +) +from .ai_credits_usage import ( + AICreditsUsageResource, + AsyncAICreditsUsageResource, + AICreditsUsageResourceWithRawResponse, + AsyncAICreditsUsageResourceWithRawResponse, + AICreditsUsageResourceWithStreamingResponse, + AsyncAICreditsUsageResourceWithStreamingResponse, +) +from .ai_credits_settings import ( + AICreditsSettingsResource, + AsyncAICreditsSettingsResource, + AICreditsSettingsResourceWithRawResponse, + AsyncAICreditsSettingsResourceWithRawResponse, + AICreditsSettingsResourceWithStreamingResponse, + AsyncAICreditsSettingsResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveries import ( + AICreditsWebhooksDeliveriesResource, + AsyncAICreditsWebhooksDeliveriesResource, + AICreditsWebhooksDeliveriesResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse, + AICreditsWebhooksDeliveriesResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse, +) +from .ai_credits_settings_rotate_secret import ( + AICreditsSettingsRotateSecretResource, + AsyncAICreditsSettingsRotateSecretResource, + AICreditsSettingsRotateSecretResourceWithRawResponse, + AsyncAICreditsSettingsRotateSecretResourceWithRawResponse, + AICreditsSettingsRotateSecretResourceWithStreamingResponse, + AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveriesretry import ( + AICreditsWebhooksDeliveriesretryResource, + AsyncAICreditsWebhooksDeliveriesretryResource, + AICreditsWebhooksDeliveriesretryResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse, + AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveriesattempts import ( + AICreditsWebhooksDeliveriesattemptsResource, + AsyncAICreditsWebhooksDeliveriesattemptsResource, + AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse, + AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse, +) + +__all__ = [ + "AICreditsResource", + "AsyncAICreditsResource", + "AICreditsResourceWithRawResponse", + "AsyncAICreditsResourceWithRawResponse", + "AICreditsResourceWithStreamingResponse", + "AsyncAICreditsResourceWithStreamingResponse", + "AICreditsSettingsResource", + "AsyncAICreditsSettingsResource", + "AICreditsSettingsResourceWithRawResponse", + "AsyncAICreditsSettingsResourceWithRawResponse", + "AICreditsSettingsResourceWithStreamingResponse", + "AsyncAICreditsSettingsResourceWithStreamingResponse", + "AICreditsSettingsRotateSecretResource", + "AsyncAICreditsSettingsRotateSecretResource", + "AICreditsSettingsRotateSecretResourceWithRawResponse", + "AsyncAICreditsSettingsRotateSecretResourceWithRawResponse", + "AICreditsSettingsRotateSecretResourceWithStreamingResponse", + "AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse", + "AICreditsUsageResource", + "AsyncAICreditsUsageResource", + "AICreditsUsageResourceWithRawResponse", + "AsyncAICreditsUsageResourceWithRawResponse", + "AICreditsUsageResourceWithStreamingResponse", + "AsyncAICreditsUsageResourceWithStreamingResponse", + "AICreditsWebhooksDeliveriesResource", + "AsyncAICreditsWebhooksDeliveriesResource", + "AICreditsWebhooksDeliveriesResourceWithRawResponse", + "AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse", + "AICreditsWebhooksDeliveriesResourceWithStreamingResponse", + "AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse", + "AICreditsWebhooksDeliveriesattemptsResource", + "AsyncAICreditsWebhooksDeliveriesattemptsResource", + "AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse", + "AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse", + "AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse", + "AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse", + "AICreditsWebhooksDeliveriesretryResource", + "AsyncAICreditsWebhooksDeliveriesretryResource", + "AICreditsWebhooksDeliveriesretryResourceWithRawResponse", + "AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse", + "AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse", + "AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse", + "ProjectsResource", + "AsyncProjectsResource", + "ProjectsResourceWithRawResponse", + "AsyncProjectsResourceWithRawResponse", + "ProjectsResourceWithStreamingResponse", + "AsyncProjectsResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/projects.py b/src/unlayer/resources/projects/ai_credits.py similarity index 57% rename from src/unlayer/resources/projects.py rename to src/unlayer/resources/projects/ai_credits.py index f842cfe..0258351 100644 --- a/src/unlayer/resources/projects.py +++ b/src/unlayer/resources/projects/ai_credits.py @@ -4,43 +4,46 @@ import httpx -from .._types import Body, Query, Headers, NotGiven, not_given -from .._utils import path_template -from .._compat import cached_property -from .._resource import SyncAPIResource, AsyncAPIResource -from .._response import ( +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( to_raw_response_wrapper, to_streamed_response_wrapper, async_to_raw_response_wrapper, async_to_streamed_response_wrapper, ) -from .._base_client import make_request_options -from ..types.project_retrieve_response import ProjectRetrieveResponse +from ..._base_client import make_request_options +from ...types.projects.ai_credit_retrieve_response import AICreditRetrieveResponse -__all__ = ["ProjectsResource", "AsyncProjectsResource"] +__all__ = ["AICreditsResource", "AsyncAICreditsResource"] -class ProjectsResource(SyncAPIResource): - """Project details and configuration.""" +class AICreditsResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ @cached_property - def with_raw_response(self) -> ProjectsResourceWithRawResponse: + def with_raw_response(self) -> AICreditsResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return ProjectsResourceWithRawResponse(self) + return AICreditsResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> ProjectsResourceWithStreamingResponse: + def with_streaming_response(self) -> AICreditsResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return ProjectsResourceWithStreamingResponse(self) + return AICreditsResourceWithStreamingResponse(self) def retrieve( self, @@ -52,9 +55,12 @@ def retrieve( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> ProjectRetrieveResponse: - """ - Get project details by ID. + ) -> AICreditRetrieveResponse: + """Returns the current AI credit balance for the project. + + Credits are pooled per + workspace — every project in a workspace shares one balance. Only credit counts + are returned; token counts, model names, and costs are never exposed. Args: extra_headers: Send extra headers @@ -68,35 +74,38 @@ def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return self._get( - path_template("/v3/projects/{id}", id=id), + path_template("/v3/projects/{id}/ai-credits", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=ProjectRetrieveResponse, + cast_to=AICreditRetrieveResponse, ) -class AsyncProjectsResource(AsyncAPIResource): - """Project details and configuration.""" +class AsyncAICreditsResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ @cached_property - def with_raw_response(self) -> AsyncProjectsResourceWithRawResponse: + def with_raw_response(self) -> AsyncAICreditsResourceWithRawResponse: """ This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content. For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers """ - return AsyncProjectsResourceWithRawResponse(self) + return AsyncAICreditsResourceWithRawResponse(self) @cached_property - def with_streaming_response(self) -> AsyncProjectsResourceWithStreamingResponse: + def with_streaming_response(self) -> AsyncAICreditsResourceWithStreamingResponse: """ An alternative to `.with_raw_response` that doesn't eagerly read the response body. For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response """ - return AsyncProjectsResourceWithStreamingResponse(self) + return AsyncAICreditsResourceWithStreamingResponse(self) async def retrieve( self, @@ -108,9 +117,12 @@ async def retrieve( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> ProjectRetrieveResponse: - """ - Get project details by ID. + ) -> AICreditRetrieveResponse: + """Returns the current AI credit balance for the project. + + Credits are pooled per + workspace — every project in a workspace shares one balance. Only credit counts + are returned; token counts, model names, and costs are never exposed. Args: extra_headers: Send extra headers @@ -124,45 +136,45 @@ async def retrieve( if not id: raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") return await self._get( - path_template("/v3/projects/{id}", id=id), + path_template("/v3/projects/{id}/ai-credits", id=id), options=make_request_options( extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout ), - cast_to=ProjectRetrieveResponse, + cast_to=AICreditRetrieveResponse, ) -class ProjectsResourceWithRawResponse: - def __init__(self, projects: ProjectsResource) -> None: - self._projects = projects +class AICreditsResourceWithRawResponse: + def __init__(self, ai_credits: AICreditsResource) -> None: + self._ai_credits = ai_credits self.retrieve = to_raw_response_wrapper( - projects.retrieve, + ai_credits.retrieve, ) -class AsyncProjectsResourceWithRawResponse: - def __init__(self, projects: AsyncProjectsResource) -> None: - self._projects = projects +class AsyncAICreditsResourceWithRawResponse: + def __init__(self, ai_credits: AsyncAICreditsResource) -> None: + self._ai_credits = ai_credits self.retrieve = async_to_raw_response_wrapper( - projects.retrieve, + ai_credits.retrieve, ) -class ProjectsResourceWithStreamingResponse: - def __init__(self, projects: ProjectsResource) -> None: - self._projects = projects +class AICreditsResourceWithStreamingResponse: + def __init__(self, ai_credits: AICreditsResource) -> None: + self._ai_credits = ai_credits self.retrieve = to_streamed_response_wrapper( - projects.retrieve, + ai_credits.retrieve, ) -class AsyncProjectsResourceWithStreamingResponse: - def __init__(self, projects: AsyncProjectsResource) -> None: - self._projects = projects +class AsyncAICreditsResourceWithStreamingResponse: + def __init__(self, ai_credits: AsyncAICreditsResource) -> None: + self._ai_credits = ai_credits self.retrieve = async_to_streamed_response_wrapper( - projects.retrieve, + ai_credits.retrieve, ) diff --git a/src/unlayer/resources/projects/ai_credits_settings.py b/src/unlayer/resources/projects/ai_credits_settings.py new file mode 100644 index 0000000..cf6b08c --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_settings.py @@ -0,0 +1,303 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Iterable, Optional +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects import ai_credits_setting_update_params +from ...types.projects.ai_credits_setting_update_response import AICreditsSettingUpdateResponse +from ...types.projects.ai_credits_setting_retrieve_response import AICreditsSettingRetrieveResponse + +__all__ = ["AICreditsSettingsResource", "AsyncAICreditsSettingsResource"] + + +class AICreditsSettingsResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsSettingsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsSettingsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsSettingsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsSettingsResourceWithStreamingResponse(self) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingRetrieveResponse: + """ + Returns a project's AI credit exhaustion behavior, alert thresholds, and webhook + endpoint. The signing secret is never returned — only whether one exists + (`has_signing_secret`). + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/projects/{id}/ai-credits/settings", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingRetrieveResponse, + ) + + def update( + self, + id: str, + *, + exhaustion_behavior: Literal["disable", "show_error"] | Omit = omit, + threshold_alerts: Iterable[int] | Omit = omit, + webhook_url: Optional[str] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingUpdateResponse: + """ + Configures AI credit exhaustion behavior, usage alert thresholds, and the + webhook endpoint for a project. The HMAC signing secret is generated the first + time a webhook URL is set and returned exactly once in the response — store it + securely; it is never shown again. + + Args: + exhaustion_behavior: What the editor does when the credit balance is exhausted. + + threshold_alerts: Usage percentages (1-100) at which a threshold_reached webhook fires, once per + crossing per period. + + webhook_url: HTTPS endpoint that receives AI credit webhooks. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._put( + path_template("/v3/projects/{id}/ai-credits/settings", id=id), + body=maybe_transform( + { + "exhaustion_behavior": exhaustion_behavior, + "threshold_alerts": threshold_alerts, + "webhook_url": webhook_url, + }, + ai_credits_setting_update_params.AICreditsSettingUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingUpdateResponse, + ) + + +class AsyncAICreditsSettingsResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsSettingsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsSettingsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsSettingsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsSettingsResourceWithStreamingResponse(self) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingRetrieveResponse: + """ + Returns a project's AI credit exhaustion behavior, alert thresholds, and webhook + endpoint. The signing secret is never returned — only whether one exists + (`has_signing_secret`). + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/projects/{id}/ai-credits/settings", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingRetrieveResponse, + ) + + async def update( + self, + id: str, + *, + exhaustion_behavior: Literal["disable", "show_error"] | Omit = omit, + threshold_alerts: Iterable[int] | Omit = omit, + webhook_url: Optional[str] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingUpdateResponse: + """ + Configures AI credit exhaustion behavior, usage alert thresholds, and the + webhook endpoint for a project. The HMAC signing secret is generated the first + time a webhook URL is set and returned exactly once in the response — store it + securely; it is never shown again. + + Args: + exhaustion_behavior: What the editor does when the credit balance is exhausted. + + threshold_alerts: Usage percentages (1-100) at which a threshold_reached webhook fires, once per + crossing per period. + + webhook_url: HTTPS endpoint that receives AI credit webhooks. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._put( + path_template("/v3/projects/{id}/ai-credits/settings", id=id), + body=await async_maybe_transform( + { + "exhaustion_behavior": exhaustion_behavior, + "threshold_alerts": threshold_alerts, + "webhook_url": webhook_url, + }, + ai_credits_setting_update_params.AICreditsSettingUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingUpdateResponse, + ) + + +class AICreditsSettingsResourceWithRawResponse: + def __init__(self, ai_credits_settings: AICreditsSettingsResource) -> None: + self._ai_credits_settings = ai_credits_settings + + self.retrieve = to_raw_response_wrapper( + ai_credits_settings.retrieve, + ) + self.update = to_raw_response_wrapper( + ai_credits_settings.update, + ) + + +class AsyncAICreditsSettingsResourceWithRawResponse: + def __init__(self, ai_credits_settings: AsyncAICreditsSettingsResource) -> None: + self._ai_credits_settings = ai_credits_settings + + self.retrieve = async_to_raw_response_wrapper( + ai_credits_settings.retrieve, + ) + self.update = async_to_raw_response_wrapper( + ai_credits_settings.update, + ) + + +class AICreditsSettingsResourceWithStreamingResponse: + def __init__(self, ai_credits_settings: AICreditsSettingsResource) -> None: + self._ai_credits_settings = ai_credits_settings + + self.retrieve = to_streamed_response_wrapper( + ai_credits_settings.retrieve, + ) + self.update = to_streamed_response_wrapper( + ai_credits_settings.update, + ) + + +class AsyncAICreditsSettingsResourceWithStreamingResponse: + def __init__(self, ai_credits_settings: AsyncAICreditsSettingsResource) -> None: + self._ai_credits_settings = ai_credits_settings + + self.retrieve = async_to_streamed_response_wrapper( + ai_credits_settings.retrieve, + ) + self.update = async_to_streamed_response_wrapper( + ai_credits_settings.update, + ) diff --git a/src/unlayer/resources/projects/ai_credits_settings_rotate_secret.py b/src/unlayer/resources/projects/ai_credits_settings_rotate_secret.py new file mode 100644 index 0000000..b2daebb --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_settings_rotate_secret.py @@ -0,0 +1,180 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects.ai_credits_settings_rotate_secret_create_response import ( + AICreditsSettingsRotateSecretCreateResponse, +) + +__all__ = ["AICreditsSettingsRotateSecretResource", "AsyncAICreditsSettingsRotateSecretResource"] + + +class AICreditsSettingsRotateSecretResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsSettingsRotateSecretResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsSettingsRotateSecretResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsSettingsRotateSecretResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsSettingsRotateSecretResourceWithStreamingResponse(self) + + def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingsRotateSecretCreateResponse: + """ + Generates a new HMAC signing secret for the project and returns it exactly once. + The previous secret stops working immediately, so update your webhook + verification before rotating. Requires a webhook URL to be configured first. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._post( + path_template("/v3/projects/{id}/ai-credits/settings/rotate-secret", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingsRotateSecretCreateResponse, + ) + + +class AsyncAICreditsSettingsRotateSecretResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsSettingsRotateSecretResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsSettingsRotateSecretResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse(self) + + async def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsSettingsRotateSecretCreateResponse: + """ + Generates a new HMAC signing secret for the project and returns it exactly once. + The previous secret stops working immediately, so update your webhook + verification before rotating. Requires a webhook URL to be configured first. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._post( + path_template("/v3/projects/{id}/ai-credits/settings/rotate-secret", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsSettingsRotateSecretCreateResponse, + ) + + +class AICreditsSettingsRotateSecretResourceWithRawResponse: + def __init__(self, ai_credits_settings_rotate_secret: AICreditsSettingsRotateSecretResource) -> None: + self._ai_credits_settings_rotate_secret = ai_credits_settings_rotate_secret + + self.create = to_raw_response_wrapper( + ai_credits_settings_rotate_secret.create, + ) + + +class AsyncAICreditsSettingsRotateSecretResourceWithRawResponse: + def __init__(self, ai_credits_settings_rotate_secret: AsyncAICreditsSettingsRotateSecretResource) -> None: + self._ai_credits_settings_rotate_secret = ai_credits_settings_rotate_secret + + self.create = async_to_raw_response_wrapper( + ai_credits_settings_rotate_secret.create, + ) + + +class AICreditsSettingsRotateSecretResourceWithStreamingResponse: + def __init__(self, ai_credits_settings_rotate_secret: AICreditsSettingsRotateSecretResource) -> None: + self._ai_credits_settings_rotate_secret = ai_credits_settings_rotate_secret + + self.create = to_streamed_response_wrapper( + ai_credits_settings_rotate_secret.create, + ) + + +class AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse: + def __init__(self, ai_credits_settings_rotate_secret: AsyncAICreditsSettingsRotateSecretResource) -> None: + self._ai_credits_settings_rotate_secret = ai_credits_settings_rotate_secret + + self.create = async_to_streamed_response_wrapper( + ai_credits_settings_rotate_secret.create, + ) diff --git a/src/unlayer/resources/projects/ai_credits_usage.py b/src/unlayer/resources/projects/ai_credits_usage.py new file mode 100644 index 0000000..9f4fa26 --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_usage.py @@ -0,0 +1,267 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects import ai_credits_usage_retrieve_params +from ...types.projects.ai_credits_usage_retrieve_response import AICreditsUsageRetrieveResponse + +__all__ = ["AICreditsUsageResource", "AsyncAICreditsUsageResource"] + + +class AICreditsUsageResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsUsageResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsUsageResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsUsageResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsUsageResourceWithStreamingResponse(self) + + def retrieve( + self, + id: str, + *, + end: str | Omit = omit, + end_user_id: str | Omit = omit, + feature_type: Literal["full_template_gen", "block_edit", "html_import", "image_import", "image_generation"] + | Omit = omit, + limit: int | Omit = omit, + offset: int | Omit = omit, + order: Literal["asc", "desc"] | Omit = omit, + sort: Literal["credits", "end_user_id", "feature_type"] | Omit = omit, + start: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsUsageRetrieveResponse: + """ + Returns AI credit consumption for the project, broken down by end user and + feature type. Filterable by date range, end user, and feature type. Defaults to + the current billing period. Only credit counts are returned; token counts, model + names, and costs are never exposed. Per-end-user attribution requires the + partner to pass `endUserId` on editor initialization. + + Args: + end: End date (inclusive), YYYY-MM-DD. + + end_user_id: Filter to a single end user id. + + feature_type: Filter to a single feature type. + + limit: Max breakdown rows to return (1-1000). + + offset: Number of breakdown rows to skip (pagination). + + order: Sort direction. Defaults to desc (highest credits first). + + sort: Field the breakdown is ordered by. Defaults to credits. + + start: Start date (inclusive), YYYY-MM-DD. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/projects/{id}/ai-credits/usage", id=id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "end": end, + "end_user_id": end_user_id, + "feature_type": feature_type, + "limit": limit, + "offset": offset, + "order": order, + "sort": sort, + "start": start, + }, + ai_credits_usage_retrieve_params.AICreditsUsageRetrieveParams, + ), + ), + cast_to=AICreditsUsageRetrieveResponse, + ) + + +class AsyncAICreditsUsageResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsUsageResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsUsageResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsUsageResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsUsageResourceWithStreamingResponse(self) + + async def retrieve( + self, + id: str, + *, + end: str | Omit = omit, + end_user_id: str | Omit = omit, + feature_type: Literal["full_template_gen", "block_edit", "html_import", "image_import", "image_generation"] + | Omit = omit, + limit: int | Omit = omit, + offset: int | Omit = omit, + order: Literal["asc", "desc"] | Omit = omit, + sort: Literal["credits", "end_user_id", "feature_type"] | Omit = omit, + start: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsUsageRetrieveResponse: + """ + Returns AI credit consumption for the project, broken down by end user and + feature type. Filterable by date range, end user, and feature type. Defaults to + the current billing period. Only credit counts are returned; token counts, model + names, and costs are never exposed. Per-end-user attribution requires the + partner to pass `endUserId` on editor initialization. + + Args: + end: End date (inclusive), YYYY-MM-DD. + + end_user_id: Filter to a single end user id. + + feature_type: Filter to a single feature type. + + limit: Max breakdown rows to return (1-1000). + + offset: Number of breakdown rows to skip (pagination). + + order: Sort direction. Defaults to desc (highest credits first). + + sort: Field the breakdown is ordered by. Defaults to credits. + + start: Start date (inclusive), YYYY-MM-DD. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/projects/{id}/ai-credits/usage", id=id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "end": end, + "end_user_id": end_user_id, + "feature_type": feature_type, + "limit": limit, + "offset": offset, + "order": order, + "sort": sort, + "start": start, + }, + ai_credits_usage_retrieve_params.AICreditsUsageRetrieveParams, + ), + ), + cast_to=AICreditsUsageRetrieveResponse, + ) + + +class AICreditsUsageResourceWithRawResponse: + def __init__(self, ai_credits_usage: AICreditsUsageResource) -> None: + self._ai_credits_usage = ai_credits_usage + + self.retrieve = to_raw_response_wrapper( + ai_credits_usage.retrieve, + ) + + +class AsyncAICreditsUsageResourceWithRawResponse: + def __init__(self, ai_credits_usage: AsyncAICreditsUsageResource) -> None: + self._ai_credits_usage = ai_credits_usage + + self.retrieve = async_to_raw_response_wrapper( + ai_credits_usage.retrieve, + ) + + +class AICreditsUsageResourceWithStreamingResponse: + def __init__(self, ai_credits_usage: AICreditsUsageResource) -> None: + self._ai_credits_usage = ai_credits_usage + + self.retrieve = to_streamed_response_wrapper( + ai_credits_usage.retrieve, + ) + + +class AsyncAICreditsUsageResourceWithStreamingResponse: + def __init__(self, ai_credits_usage: AsyncAICreditsUsageResource) -> None: + self._ai_credits_usage = ai_credits_usage + + self.retrieve = async_to_streamed_response_wrapper( + ai_credits_usage.retrieve, + ) diff --git a/src/unlayer/resources/projects/ai_credits_webhooks_deliveries.py b/src/unlayer/resources/projects/ai_credits_webhooks_deliveries.py new file mode 100644 index 0000000..9d17381 --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_webhooks_deliveries.py @@ -0,0 +1,231 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects import ai_credits_webhooks_delivery_retrieve_params +from ...types.projects.ai_credits_webhooks_delivery_retrieve_response import AICreditsWebhooksDeliveryRetrieveResponse + +__all__ = ["AICreditsWebhooksDeliveriesResource", "AsyncAICreditsWebhooksDeliveriesResource"] + + +class AICreditsWebhooksDeliveriesResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsWebhooksDeliveriesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsWebhooksDeliveriesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsWebhooksDeliveriesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsWebhooksDeliveriesResourceWithStreamingResponse(self) + + def retrieve( + self, + id: str, + *, + event: Literal["ai.credits.usage_recorded", "ai.credits.threshold_reached", "ai.credits.exhausted"] + | Omit = omit, + limit: int | Omit = omit, + offset: int | Omit = omit, + status: Literal["pending", "delivered", "failed"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveryRetrieveResponse: + """ + Returns the webhook delivery history for the project, newest first — the event, + delivery status, attempt count, and last response code for each. Use it to spot + failed deliveries and drive the retry endpoint. Payloads expose credits only. + + Args: + event: Filter to a single event type. + + limit: Max deliveries to return (1-100). + + offset: Number of deliveries to skip (pagination). + + status: Filter to a single delivery status. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/projects/{id}/ai-credits/webhooks/deliveries", id=id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "event": event, + "limit": limit, + "offset": offset, + "status": status, + }, + ai_credits_webhooks_delivery_retrieve_params.AICreditsWebhooksDeliveryRetrieveParams, + ), + ), + cast_to=AICreditsWebhooksDeliveryRetrieveResponse, + ) + + +class AsyncAICreditsWebhooksDeliveriesResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse(self) + + async def retrieve( + self, + id: str, + *, + event: Literal["ai.credits.usage_recorded", "ai.credits.threshold_reached", "ai.credits.exhausted"] + | Omit = omit, + limit: int | Omit = omit, + offset: int | Omit = omit, + status: Literal["pending", "delivered", "failed"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveryRetrieveResponse: + """ + Returns the webhook delivery history for the project, newest first — the event, + delivery status, attempt count, and last response code for each. Use it to spot + failed deliveries and drive the retry endpoint. Payloads expose credits only. + + Args: + event: Filter to a single event type. + + limit: Max deliveries to return (1-100). + + offset: Number of deliveries to skip (pagination). + + status: Filter to a single delivery status. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/projects/{id}/ai-credits/webhooks/deliveries", id=id), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "event": event, + "limit": limit, + "offset": offset, + "status": status, + }, + ai_credits_webhooks_delivery_retrieve_params.AICreditsWebhooksDeliveryRetrieveParams, + ), + ), + cast_to=AICreditsWebhooksDeliveryRetrieveResponse, + ) + + +class AICreditsWebhooksDeliveriesResourceWithRawResponse: + def __init__(self, ai_credits_webhooks_deliveries: AICreditsWebhooksDeliveriesResource) -> None: + self._ai_credits_webhooks_deliveries = ai_credits_webhooks_deliveries + + self.retrieve = to_raw_response_wrapper( + ai_credits_webhooks_deliveries.retrieve, + ) + + +class AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse: + def __init__(self, ai_credits_webhooks_deliveries: AsyncAICreditsWebhooksDeliveriesResource) -> None: + self._ai_credits_webhooks_deliveries = ai_credits_webhooks_deliveries + + self.retrieve = async_to_raw_response_wrapper( + ai_credits_webhooks_deliveries.retrieve, + ) + + +class AICreditsWebhooksDeliveriesResourceWithStreamingResponse: + def __init__(self, ai_credits_webhooks_deliveries: AICreditsWebhooksDeliveriesResource) -> None: + self._ai_credits_webhooks_deliveries = ai_credits_webhooks_deliveries + + self.retrieve = to_streamed_response_wrapper( + ai_credits_webhooks_deliveries.retrieve, + ) + + +class AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse: + def __init__(self, ai_credits_webhooks_deliveries: AsyncAICreditsWebhooksDeliveriesResource) -> None: + self._ai_credits_webhooks_deliveries = ai_credits_webhooks_deliveries + + self.retrieve = async_to_streamed_response_wrapper( + ai_credits_webhooks_deliveries.retrieve, + ) diff --git a/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesattempts.py b/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesattempts.py new file mode 100644 index 0000000..e93aba4 --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesattempts.py @@ -0,0 +1,231 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects import ai_credits_webhooks_deliveriesattempt_retrieve_params +from ...types.projects.ai_credits_webhooks_deliveriesattempt_retrieve_response import ( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, +) + +__all__ = ["AICreditsWebhooksDeliveriesattemptsResource", "AsyncAICreditsWebhooksDeliveriesattemptsResource"] + + +class AICreditsWebhooksDeliveriesattemptsResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse(self) + + def retrieve( + self, + delivery_id: str, + *, + id: str, + limit: int | Omit = omit, + offset: int | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveriesattemptRetrieveResponse: + """ + Returns the per-attempt history for a single delivery, newest attempt first — + the response code, error, and time of each POST (including automatic retries). + Returns 404 if the delivery is not found for this project. + + Args: + limit: Max attempts to return (1-100). + + offset: Number of attempts to skip (pagination). + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + if not delivery_id: + raise ValueError(f"Expected a non-empty value for `delivery_id` but received {delivery_id!r}") + return self._get( + path_template( + "/v3/projects/{id}/ai-credits/webhooks/deliveries/{delivery_id}/attempts", + id=id, + delivery_id=delivery_id, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "limit": limit, + "offset": offset, + }, + ai_credits_webhooks_deliveriesattempt_retrieve_params.AICreditsWebhooksDeliveriesattemptRetrieveParams, + ), + ), + cast_to=AICreditsWebhooksDeliveriesattemptRetrieveResponse, + ) + + +class AsyncAICreditsWebhooksDeliveriesattemptsResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse(self) + + async def retrieve( + self, + delivery_id: str, + *, + id: str, + limit: int | Omit = omit, + offset: int | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveriesattemptRetrieveResponse: + """ + Returns the per-attempt history for a single delivery, newest attempt first — + the response code, error, and time of each POST (including automatic retries). + Returns 404 if the delivery is not found for this project. + + Args: + limit: Max attempts to return (1-100). + + offset: Number of attempts to skip (pagination). + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + if not delivery_id: + raise ValueError(f"Expected a non-empty value for `delivery_id` but received {delivery_id!r}") + return await self._get( + path_template( + "/v3/projects/{id}/ai-credits/webhooks/deliveries/{delivery_id}/attempts", + id=id, + delivery_id=delivery_id, + ), + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "limit": limit, + "offset": offset, + }, + ai_credits_webhooks_deliveriesattempt_retrieve_params.AICreditsWebhooksDeliveriesattemptRetrieveParams, + ), + ), + cast_to=AICreditsWebhooksDeliveriesattemptRetrieveResponse, + ) + + +class AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + def __init__(self, ai_credits_webhooks_deliveriesattempts: AICreditsWebhooksDeliveriesattemptsResource) -> None: + self._ai_credits_webhooks_deliveriesattempts = ai_credits_webhooks_deliveriesattempts + + self.retrieve = to_raw_response_wrapper( + ai_credits_webhooks_deliveriesattempts.retrieve, + ) + + +class AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + def __init__( + self, ai_credits_webhooks_deliveriesattempts: AsyncAICreditsWebhooksDeliveriesattemptsResource + ) -> None: + self._ai_credits_webhooks_deliveriesattempts = ai_credits_webhooks_deliveriesattempts + + self.retrieve = async_to_raw_response_wrapper( + ai_credits_webhooks_deliveriesattempts.retrieve, + ) + + +class AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + def __init__(self, ai_credits_webhooks_deliveriesattempts: AICreditsWebhooksDeliveriesattemptsResource) -> None: + self._ai_credits_webhooks_deliveriesattempts = ai_credits_webhooks_deliveriesattempts + + self.retrieve = to_streamed_response_wrapper( + ai_credits_webhooks_deliveriesattempts.retrieve, + ) + + +class AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + def __init__( + self, ai_credits_webhooks_deliveriesattempts: AsyncAICreditsWebhooksDeliveriesattemptsResource + ) -> None: + self._ai_credits_webhooks_deliveriesattempts = ai_credits_webhooks_deliveriesattempts + + self.retrieve = async_to_streamed_response_wrapper( + ai_credits_webhooks_deliveriesattempts.retrieve, + ) diff --git a/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesretry.py b/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesretry.py new file mode 100644 index 0000000..e4133fe --- /dev/null +++ b/src/unlayer/resources/projects/ai_credits_webhooks_deliveriesretry.py @@ -0,0 +1,190 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.projects.ai_credits_webhooks_deliveriesretry_create_response import ( + AICreditsWebhooksDeliveriesretryCreateResponse, +) + +__all__ = ["AICreditsWebhooksDeliveriesretryResource", "AsyncAICreditsWebhooksDeliveriesretryResource"] + + +class AICreditsWebhooksDeliveriesretryResource(SyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AICreditsWebhooksDeliveriesretryResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AICreditsWebhooksDeliveriesretryResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse(self) + + def create( + self, + delivery_id: str, + *, + id: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveriesretryCreateResponse: + """ + Re-queues a single previously-failed (or pending) webhook delivery for another + attempt. Returns 404 if the delivery is not found for this project, and 409 if + it was already delivered. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + if not delivery_id: + raise ValueError(f"Expected a non-empty value for `delivery_id` but received {delivery_id!r}") + return self._post( + path_template( + "/v3/projects/{id}/ai-credits/webhooks/deliveries/{delivery_id}/retry", id=id, delivery_id=delivery_id + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsWebhooksDeliveriesretryCreateResponse, + ) + + +class AsyncAICreditsWebhooksDeliveriesretryResource(AsyncAPIResource): + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + + @cached_property + def with_raw_response(self) -> AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse(self) + + async def create( + self, + delivery_id: str, + *, + id: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> AICreditsWebhooksDeliveriesretryCreateResponse: + """ + Re-queues a single previously-failed (or pending) webhook delivery for another + attempt. Returns 404 if the delivery is not found for this project, and 409 if + it was already delivered. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + if not delivery_id: + raise ValueError(f"Expected a non-empty value for `delivery_id` but received {delivery_id!r}") + return await self._post( + path_template( + "/v3/projects/{id}/ai-credits/webhooks/deliveries/{delivery_id}/retry", id=id, delivery_id=delivery_id + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=AICreditsWebhooksDeliveriesretryCreateResponse, + ) + + +class AICreditsWebhooksDeliveriesretryResourceWithRawResponse: + def __init__(self, ai_credits_webhooks_deliveriesretry: AICreditsWebhooksDeliveriesretryResource) -> None: + self._ai_credits_webhooks_deliveriesretry = ai_credits_webhooks_deliveriesretry + + self.create = to_raw_response_wrapper( + ai_credits_webhooks_deliveriesretry.create, + ) + + +class AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse: + def __init__(self, ai_credits_webhooks_deliveriesretry: AsyncAICreditsWebhooksDeliveriesretryResource) -> None: + self._ai_credits_webhooks_deliveriesretry = ai_credits_webhooks_deliveriesretry + + self.create = async_to_raw_response_wrapper( + ai_credits_webhooks_deliveriesretry.create, + ) + + +class AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + def __init__(self, ai_credits_webhooks_deliveriesretry: AICreditsWebhooksDeliveriesretryResource) -> None: + self._ai_credits_webhooks_deliveriesretry = ai_credits_webhooks_deliveriesretry + + self.create = to_streamed_response_wrapper( + ai_credits_webhooks_deliveriesretry.create, + ) + + +class AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + def __init__(self, ai_credits_webhooks_deliveriesretry: AsyncAICreditsWebhooksDeliveriesretryResource) -> None: + self._ai_credits_webhooks_deliveriesretry = ai_credits_webhooks_deliveriesretry + + self.create = async_to_streamed_response_wrapper( + ai_credits_webhooks_deliveriesretry.create, + ) diff --git a/src/unlayer/resources/projects/projects.py b/src/unlayer/resources/projects/projects.py new file mode 100644 index 0000000..607257a --- /dev/null +++ b/src/unlayer/resources/projects/projects.py @@ -0,0 +1,588 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from .ai_credits import ( + AICreditsResource, + AsyncAICreditsResource, + AICreditsResourceWithRawResponse, + AsyncAICreditsResourceWithRawResponse, + AICreditsResourceWithStreamingResponse, + AsyncAICreditsResourceWithStreamingResponse, +) +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from .ai_credits_usage import ( + AICreditsUsageResource, + AsyncAICreditsUsageResource, + AICreditsUsageResourceWithRawResponse, + AsyncAICreditsUsageResourceWithRawResponse, + AICreditsUsageResourceWithStreamingResponse, + AsyncAICreditsUsageResourceWithStreamingResponse, +) +from .ai_credits_settings import ( + AICreditsSettingsResource, + AsyncAICreditsSettingsResource, + AICreditsSettingsResourceWithRawResponse, + AsyncAICreditsSettingsResourceWithRawResponse, + AICreditsSettingsResourceWithStreamingResponse, + AsyncAICreditsSettingsResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveries import ( + AICreditsWebhooksDeliveriesResource, + AsyncAICreditsWebhooksDeliveriesResource, + AICreditsWebhooksDeliveriesResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse, + AICreditsWebhooksDeliveriesResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse, +) +from ...types.project_retrieve_response import ProjectRetrieveResponse +from .ai_credits_settings_rotate_secret import ( + AICreditsSettingsRotateSecretResource, + AsyncAICreditsSettingsRotateSecretResource, + AICreditsSettingsRotateSecretResourceWithRawResponse, + AsyncAICreditsSettingsRotateSecretResourceWithRawResponse, + AICreditsSettingsRotateSecretResourceWithStreamingResponse, + AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveriesretry import ( + AICreditsWebhooksDeliveriesretryResource, + AsyncAICreditsWebhooksDeliveriesretryResource, + AICreditsWebhooksDeliveriesretryResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse, + AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse, +) +from .ai_credits_webhooks_deliveriesattempts import ( + AICreditsWebhooksDeliveriesattemptsResource, + AsyncAICreditsWebhooksDeliveriesattemptsResource, + AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse, + AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse, + AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse, + AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse, +) + +__all__ = ["ProjectsResource", "AsyncProjectsResource"] + + +class ProjectsResource(SyncAPIResource): + """Project details and configuration.""" + + @cached_property + def ai_credits(self) -> AICreditsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsResource(self._client) + + @cached_property + def ai_credits_settings(self) -> AICreditsSettingsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsResource(self._client) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AICreditsSettingsRotateSecretResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsRotateSecretResource(self._client) + + @cached_property + def ai_credits_usage(self) -> AICreditsUsageResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsUsageResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AICreditsWebhooksDeliveriesResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveriesattempts(self) -> AICreditsWebhooksDeliveriesattemptsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesattemptsResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AICreditsWebhooksDeliveriesretryResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesretryResource(self._client) + + @cached_property + def with_raw_response(self) -> ProjectsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ProjectsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ProjectsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ProjectsResourceWithStreamingResponse(self) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ProjectRetrieveResponse: + """ + Get project details by ID. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/projects/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ProjectRetrieveResponse, + ) + + +class AsyncProjectsResource(AsyncAPIResource): + """Project details and configuration.""" + + @cached_property + def ai_credits(self) -> AsyncAICreditsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsResource(self._client) + + @cached_property + def ai_credits_settings(self) -> AsyncAICreditsSettingsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsResource(self._client) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AsyncAICreditsSettingsRotateSecretResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsRotateSecretResource(self._client) + + @cached_property + def ai_credits_usage(self) -> AsyncAICreditsUsageResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsUsageResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AsyncAICreditsWebhooksDeliveriesResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveriesattempts(self) -> AsyncAICreditsWebhooksDeliveriesattemptsResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesattemptsResource(self._client) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AsyncAICreditsWebhooksDeliveriesretryResource: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesretryResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncProjectsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncProjectsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncProjectsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncProjectsResourceWithStreamingResponse(self) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ProjectRetrieveResponse: + """ + Get project details by ID. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/projects/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ProjectRetrieveResponse, + ) + + +class ProjectsResourceWithRawResponse: + def __init__(self, projects: ProjectsResource) -> None: + self._projects = projects + + self.retrieve = to_raw_response_wrapper( + projects.retrieve, + ) + + @cached_property + def ai_credits(self) -> AICreditsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsResourceWithRawResponse(self._projects.ai_credits) + + @cached_property + def ai_credits_settings(self) -> AICreditsSettingsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsResourceWithRawResponse(self._projects.ai_credits_settings) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AICreditsSettingsRotateSecretResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsRotateSecretResourceWithRawResponse(self._projects.ai_credits_settings_rotate_secret) + + @cached_property + def ai_credits_usage(self) -> AICreditsUsageResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsUsageResourceWithRawResponse(self._projects.ai_credits_usage) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AICreditsWebhooksDeliveriesResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesResourceWithRawResponse(self._projects.ai_credits_webhooks_deliveries) + + @cached_property + def ai_credits_webhooks_deliveriesattempts(self) -> AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesattemptsResourceWithRawResponse( + self._projects.ai_credits_webhooks_deliveriesattempts + ) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AICreditsWebhooksDeliveriesretryResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesretryResourceWithRawResponse( + self._projects.ai_credits_webhooks_deliveriesretry + ) + + +class AsyncProjectsResourceWithRawResponse: + def __init__(self, projects: AsyncProjectsResource) -> None: + self._projects = projects + + self.retrieve = async_to_raw_response_wrapper( + projects.retrieve, + ) + + @cached_property + def ai_credits(self) -> AsyncAICreditsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsResourceWithRawResponse(self._projects.ai_credits) + + @cached_property + def ai_credits_settings(self) -> AsyncAICreditsSettingsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsResourceWithRawResponse(self._projects.ai_credits_settings) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AsyncAICreditsSettingsRotateSecretResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsRotateSecretResourceWithRawResponse( + self._projects.ai_credits_settings_rotate_secret + ) + + @cached_property + def ai_credits_usage(self) -> AsyncAICreditsUsageResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsUsageResourceWithRawResponse(self._projects.ai_credits_usage) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesResourceWithRawResponse(self._projects.ai_credits_webhooks_deliveries) + + @cached_property + def ai_credits_webhooks_deliveriesattempts(self) -> AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesattemptsResourceWithRawResponse( + self._projects.ai_credits_webhooks_deliveriesattempts + ) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesretryResourceWithRawResponse( + self._projects.ai_credits_webhooks_deliveriesretry + ) + + +class ProjectsResourceWithStreamingResponse: + def __init__(self, projects: ProjectsResource) -> None: + self._projects = projects + + self.retrieve = to_streamed_response_wrapper( + projects.retrieve, + ) + + @cached_property + def ai_credits(self) -> AICreditsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsResourceWithStreamingResponse(self._projects.ai_credits) + + @cached_property + def ai_credits_settings(self) -> AICreditsSettingsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsResourceWithStreamingResponse(self._projects.ai_credits_settings) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AICreditsSettingsRotateSecretResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsSettingsRotateSecretResourceWithStreamingResponse( + self._projects.ai_credits_settings_rotate_secret + ) + + @cached_property + def ai_credits_usage(self) -> AICreditsUsageResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsUsageResourceWithStreamingResponse(self._projects.ai_credits_usage) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AICreditsWebhooksDeliveriesResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesResourceWithStreamingResponse(self._projects.ai_credits_webhooks_deliveries) + + @cached_property + def ai_credits_webhooks_deliveriesattempts( + self, + ) -> AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse( + self._projects.ai_credits_webhooks_deliveriesattempts + ) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AICreditsWebhooksDeliveriesretryResourceWithStreamingResponse( + self._projects.ai_credits_webhooks_deliveriesretry + ) + + +class AsyncProjectsResourceWithStreamingResponse: + def __init__(self, projects: AsyncProjectsResource) -> None: + self._projects = projects + + self.retrieve = async_to_streamed_response_wrapper( + projects.retrieve, + ) + + @cached_property + def ai_credits(self) -> AsyncAICreditsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsResourceWithStreamingResponse(self._projects.ai_credits) + + @cached_property + def ai_credits_settings(self) -> AsyncAICreditsSettingsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsResourceWithStreamingResponse(self._projects.ai_credits_settings) + + @cached_property + def ai_credits_settings_rotate_secret(self) -> AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsSettingsRotateSecretResourceWithStreamingResponse( + self._projects.ai_credits_settings_rotate_secret + ) + + @cached_property + def ai_credits_usage(self) -> AsyncAICreditsUsageResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsUsageResourceWithStreamingResponse(self._projects.ai_credits_usage) + + @cached_property + def ai_credits_webhooks_deliveries(self) -> AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesResourceWithStreamingResponse( + self._projects.ai_credits_webhooks_deliveries + ) + + @cached_property + def ai_credits_webhooks_deliveriesattempts( + self, + ) -> AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesattemptsResourceWithStreamingResponse( + self._projects.ai_credits_webhooks_deliveriesattempts + ) + + @cached_property + def ai_credits_webhooks_deliveriesretry(self) -> AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse: + """AI credit balance, usage breakdown, and webhook/alert settings. + + Credits are pooled per workspace; settings are per project. + """ + return AsyncAICreditsWebhooksDeliveriesretryResourceWithStreamingResponse( + self._projects.ai_credits_webhooks_deliveriesretry + ) diff --git a/src/unlayer/types/projects/__init__.py b/src/unlayer/types/projects/__init__.py new file mode 100644 index 0000000..9531b53 --- /dev/null +++ b/src/unlayer/types/projects/__init__.py @@ -0,0 +1,28 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .ai_credit_retrieve_response import AICreditRetrieveResponse as AICreditRetrieveResponse +from .ai_credits_setting_update_params import AICreditsSettingUpdateParams as AICreditsSettingUpdateParams +from .ai_credits_usage_retrieve_params import AICreditsUsageRetrieveParams as AICreditsUsageRetrieveParams +from .ai_credits_setting_update_response import AICreditsSettingUpdateResponse as AICreditsSettingUpdateResponse +from .ai_credits_usage_retrieve_response import AICreditsUsageRetrieveResponse as AICreditsUsageRetrieveResponse +from .ai_credits_setting_retrieve_response import AICreditsSettingRetrieveResponse as AICreditsSettingRetrieveResponse +from .ai_credits_webhooks_delivery_retrieve_params import ( + AICreditsWebhooksDeliveryRetrieveParams as AICreditsWebhooksDeliveryRetrieveParams, +) +from .ai_credits_webhooks_delivery_retrieve_response import ( + AICreditsWebhooksDeliveryRetrieveResponse as AICreditsWebhooksDeliveryRetrieveResponse, +) +from .ai_credits_settings_rotate_secret_create_response import ( + AICreditsSettingsRotateSecretCreateResponse as AICreditsSettingsRotateSecretCreateResponse, +) +from .ai_credits_webhooks_deliveriesretry_create_response import ( + AICreditsWebhooksDeliveriesretryCreateResponse as AICreditsWebhooksDeliveriesretryCreateResponse, +) +from .ai_credits_webhooks_deliveriesattempt_retrieve_params import ( + AICreditsWebhooksDeliveriesattemptRetrieveParams as AICreditsWebhooksDeliveriesattemptRetrieveParams, +) +from .ai_credits_webhooks_deliveriesattempt_retrieve_response import ( + AICreditsWebhooksDeliveriesattemptRetrieveResponse as AICreditsWebhooksDeliveriesattemptRetrieveResponse, +) diff --git a/src/unlayer/types/projects/ai_credit_retrieve_response.py b/src/unlayer/types/projects/ai_credit_retrieve_response.py new file mode 100644 index 0000000..a078c28 --- /dev/null +++ b/src/unlayer/types/projects/ai_credit_retrieve_response.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from datetime import datetime + +from ..._models import BaseModel + +__all__ = ["AICreditRetrieveResponse"] + + +class AICreditRetrieveResponse(BaseModel): + credits_remaining: Optional[float] = None + """AI credits remaining in the current period.""" + + credits_total: Optional[float] = None + """Total AI credits available for the current period.""" + + credits_used: Optional[float] = None + """AI credits consumed so far in the current period.""" + + reset_date: Optional[datetime] = None + """ + When the current credit period resets, or null if there is no active billing + period — including once a subscription is cancelled or its term has ended. + """ diff --git a/src/unlayer/types/projects/ai_credits_setting_retrieve_response.py b/src/unlayer/types/projects/ai_credits_setting_retrieve_response.py new file mode 100644 index 0000000..910c2e9 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_setting_retrieve_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from ..._models import BaseModel + +__all__ = ["AICreditsSettingRetrieveResponse"] + + +class AICreditsSettingRetrieveResponse(BaseModel): + exhaustion_behavior: Optional[str] = None + + has_signing_secret: Optional[bool] = None + + threshold_alerts: Optional[List[float]] = None + + webhook_url: Optional[str] = None diff --git a/src/unlayer/types/projects/ai_credits_setting_update_params.py b/src/unlayer/types/projects/ai_credits_setting_update_params.py new file mode 100644 index 0000000..569366d --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_setting_update_params.py @@ -0,0 +1,22 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Iterable, Optional +from typing_extensions import Literal, TypedDict + +__all__ = ["AICreditsSettingUpdateParams"] + + +class AICreditsSettingUpdateParams(TypedDict, total=False): + exhaustion_behavior: Literal["disable", "show_error"] + """What the editor does when the credit balance is exhausted.""" + + threshold_alerts: Iterable[int] + """ + Usage percentages (1-100) at which a threshold_reached webhook fires, once per + crossing per period. + """ + + webhook_url: Optional[str] + """HTTPS endpoint that receives AI credit webhooks.""" diff --git a/src/unlayer/types/projects/ai_credits_setting_update_response.py b/src/unlayer/types/projects/ai_credits_setting_update_response.py new file mode 100644 index 0000000..b83ef75 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_setting_update_response.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from ..._models import BaseModel + +__all__ = ["AICreditsSettingUpdateResponse"] + + +class AICreditsSettingUpdateResponse(BaseModel): + exhaustion_behavior: Optional[str] = None + + has_signing_secret: Optional[bool] = None + + signing_secret: Optional[str] = None + """The HMAC signing secret. Returned ONLY on the response that first generates it.""" + + threshold_alerts: Optional[List[float]] = None + + webhook_url: Optional[str] = None diff --git a/src/unlayer/types/projects/ai_credits_settings_rotate_secret_create_response.py b/src/unlayer/types/projects/ai_credits_settings_rotate_secret_create_response.py new file mode 100644 index 0000000..b8f92eb --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_settings_rotate_secret_create_response.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["AICreditsSettingsRotateSecretCreateResponse"] + + +class AICreditsSettingsRotateSecretCreateResponse(BaseModel): + signing_secret: Optional[str] = None + """The new HMAC signing secret. Shown only once.""" diff --git a/src/unlayer/types/projects/ai_credits_usage_retrieve_params.py b/src/unlayer/types/projects/ai_credits_usage_retrieve_params.py new file mode 100644 index 0000000..3072648 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_usage_retrieve_params.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, TypedDict + +__all__ = ["AICreditsUsageRetrieveParams"] + + +class AICreditsUsageRetrieveParams(TypedDict, total=False): + end: str + """End date (inclusive), YYYY-MM-DD.""" + + end_user_id: str + """Filter to a single end user id.""" + + feature_type: Literal["full_template_gen", "block_edit", "html_import", "image_import", "image_generation"] + """Filter to a single feature type.""" + + limit: int + """Max breakdown rows to return (1-1000).""" + + offset: int + """Number of breakdown rows to skip (pagination).""" + + order: Literal["asc", "desc"] + """Sort direction. Defaults to desc (highest credits first).""" + + sort: Literal["credits", "end_user_id", "feature_type"] + """Field the breakdown is ordered by. Defaults to credits.""" + + start: str + """Start date (inclusive), YYYY-MM-DD.""" diff --git a/src/unlayer/types/projects/ai_credits_usage_retrieve_response.py b/src/unlayer/types/projects/ai_credits_usage_retrieve_response.py new file mode 100644 index 0000000..8289984 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_usage_retrieve_response.py @@ -0,0 +1,34 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from ..._models import BaseModel + +__all__ = ["AICreditsUsageRetrieveResponse", "Breakdown"] + + +class Breakdown(BaseModel): + credits: Optional[float] = None + """AI credits used by this end user and feature type.""" + + end_user_id: Optional[str] = None + """The end user id, or null for unattributed usage.""" + + feature_type: Optional[ + Literal["full_template_gen", "block_edit", "html_import", "image_import", "image_generation"] + ] = None + """The partner-facing feature type.""" + + +class AICreditsUsageRetrieveResponse(BaseModel): + breakdown: Optional[List[Breakdown]] = None + + total: Optional[float] = None + """Number of breakdown rows matching the filter (ignores paging).""" + + total_credits_used: Optional[float] = None + """ + Total AI credits used across the full filtered range (not just the returned + page). + """ diff --git a/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_params.py b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_params.py new file mode 100644 index 0000000..89f12c4 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["AICreditsWebhooksDeliveriesattemptRetrieveParams"] + + +class AICreditsWebhooksDeliveriesattemptRetrieveParams(TypedDict, total=False): + id: Required[str] + + limit: int + """Max attempts to return (1-100).""" + + offset: int + """Number of attempts to skip (pagination).""" diff --git a/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_response.py b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_response.py new file mode 100644 index 0000000..c6f5c45 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesattempt_retrieve_response.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime + +from ..._models import BaseModel + +__all__ = ["AICreditsWebhooksDeliveriesattemptRetrieveResponse", "Attempt"] + + +class Attempt(BaseModel): + attempt: Optional[float] = None + + attempted_at: Optional[datetime] = None + + error: Optional[str] = None + + status_code: Optional[float] = None + + +class AICreditsWebhooksDeliveriesattemptRetrieveResponse(BaseModel): + attempts: Optional[List[Attempt]] = None + + total: Optional[float] = None + """Total attempts for the delivery (ignores limit/offset).""" diff --git a/src/unlayer/types/projects/ai_credits_webhooks_deliveriesretry_create_response.py b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesretry_create_response.py new file mode 100644 index 0000000..7de6a88 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_webhooks_deliveriesretry_create_response.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from typing_extensions import Literal + +from ..._models import BaseModel + +__all__ = ["AICreditsWebhooksDeliveriesretryCreateResponse"] + + +class AICreditsWebhooksDeliveriesretryCreateResponse(BaseModel): + status: Optional[Literal["requeued"]] = None diff --git a/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_params.py b/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_params.py new file mode 100644 index 0000000..a869ec0 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_params.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, TypedDict + +__all__ = ["AICreditsWebhooksDeliveryRetrieveParams"] + + +class AICreditsWebhooksDeliveryRetrieveParams(TypedDict, total=False): + event: Literal["ai.credits.usage_recorded", "ai.credits.threshold_reached", "ai.credits.exhausted"] + """Filter to a single event type.""" + + limit: int + """Max deliveries to return (1-100).""" + + offset: int + """Number of deliveries to skip (pagination).""" + + status: Literal["pending", "delivered", "failed"] + """Filter to a single delivery status.""" diff --git a/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_response.py b/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_response.py new file mode 100644 index 0000000..5b0c233 --- /dev/null +++ b/src/unlayer/types/projects/ai_credits_webhooks_delivery_retrieve_response.py @@ -0,0 +1,36 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional +from datetime import datetime +from typing_extensions import Literal + +from ..._models import BaseModel + +__all__ = ["AICreditsWebhooksDeliveryRetrieveResponse", "Delivery"] + + +class Delivery(BaseModel): + id: Optional[str] = None + + attempts: Optional[float] = None + + created_at: Optional[datetime] = None + + delivered_at: Optional[str] = None + + end_user_id: Optional[str] = None + + event: Optional[str] = None + + last_status_code: Optional[float] = None + + payload: Optional[Dict[str, object]] = None + + status: Optional[Literal["pending", "delivered", "failed"]] = None + + +class AICreditsWebhooksDeliveryRetrieveResponse(BaseModel): + deliveries: Optional[List[Delivery]] = None + + total: Optional[float] = None + """Total deliveries matching the filter (ignores limit/offset).""" diff --git a/tests/api_resources/projects/__init__.py b/tests/api_resources/projects/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/projects/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/projects/test_ai_credits.py b/tests/api_resources/projects/test_ai_credits.py new file mode 100644 index 0000000..5c290a7 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits.py @@ -0,0 +1,100 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import AICreditRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICredits: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + ai_credit = client.projects.ai_credits.retrieve( + "id", + ) + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.projects.ai_credits.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credit = response.parse() + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.projects.ai_credits.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credit = response.parse() + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits.with_raw_response.retrieve( + "", + ) + + +class TestAsyncAICredits: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + ai_credit = await async_client.projects.ai_credits.retrieve( + "id", + ) + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credit = await response.parse() + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credit = await response.parse() + assert_matches_type(AICreditRetrieveResponse, ai_credit, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits.with_raw_response.retrieve( + "", + ) diff --git a/tests/api_resources/projects/test_ai_credits_settings.py b/tests/api_resources/projects/test_ai_credits_settings.py new file mode 100644 index 0000000..d06f752 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_settings.py @@ -0,0 +1,199 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import ( + AICreditsSettingUpdateResponse, + AICreditsSettingRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsSettings: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + ai_credits_setting = client.projects.ai_credits_settings.retrieve( + "id", + ) + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.projects.ai_credits_settings.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_setting = response.parse() + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.projects.ai_credits_settings.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_setting = response.parse() + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_settings.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_update(self, client: Unlayer) -> None: + ai_credits_setting = client.projects.ai_credits_settings.update( + id="id", + ) + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + def test_method_update_with_all_params(self, client: Unlayer) -> None: + ai_credits_setting = client.projects.ai_credits_settings.update( + id="id", + exhaustion_behavior="disable", + threshold_alerts=[1], + webhook_url="https://example.com", + ) + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + def test_raw_response_update(self, client: Unlayer) -> None: + response = client.projects.ai_credits_settings.with_raw_response.update( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_setting = response.parse() + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + def test_streaming_response_update(self, client: Unlayer) -> None: + with client.projects.ai_credits_settings.with_streaming_response.update( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_setting = response.parse() + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_update(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_settings.with_raw_response.update( + id="", + ) + + +class TestAsyncAICreditsSettings: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + ai_credits_setting = await async_client.projects.ai_credits_settings.retrieve( + "id", + ) + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_settings.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_setting = await response.parse() + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_settings.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_setting = await response.parse() + assert_matches_type(AICreditsSettingRetrieveResponse, ai_credits_setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_settings.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_update(self, async_client: AsyncUnlayer) -> None: + ai_credits_setting = await async_client.projects.ai_credits_settings.update( + id="id", + ) + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + async def test_method_update_with_all_params(self, async_client: AsyncUnlayer) -> None: + ai_credits_setting = await async_client.projects.ai_credits_settings.update( + id="id", + exhaustion_behavior="disable", + threshold_alerts=[1], + webhook_url="https://example.com", + ) + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + async def test_raw_response_update(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_settings.with_raw_response.update( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_setting = await response.parse() + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + @parametrize + async def test_streaming_response_update(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_settings.with_streaming_response.update( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_setting = await response.parse() + assert_matches_type(AICreditsSettingUpdateResponse, ai_credits_setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_update(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_settings.with_raw_response.update( + id="", + ) diff --git a/tests/api_resources/projects/test_ai_credits_settings_rotate_secret.py b/tests/api_resources/projects/test_ai_credits_settings_rotate_secret.py new file mode 100644 index 0000000..07d9f84 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_settings_rotate_secret.py @@ -0,0 +1,112 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import AICreditsSettingsRotateSecretCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsSettingsRotateSecret: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + ai_credits_settings_rotate_secret = client.projects.ai_credits_settings_rotate_secret.create( + "id", + ) + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.projects.ai_credits_settings_rotate_secret.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_settings_rotate_secret = response.parse() + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.projects.ai_credits_settings_rotate_secret.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_settings_rotate_secret = response.parse() + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_settings_rotate_secret.with_raw_response.create( + "", + ) + + +class TestAsyncAICreditsSettingsRotateSecret: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + ai_credits_settings_rotate_secret = await async_client.projects.ai_credits_settings_rotate_secret.create( + "id", + ) + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_settings_rotate_secret.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_settings_rotate_secret = await response.parse() + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_settings_rotate_secret.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_settings_rotate_secret = await response.parse() + assert_matches_type( + AICreditsSettingsRotateSecretCreateResponse, ai_credits_settings_rotate_secret, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_settings_rotate_secret.with_raw_response.create( + "", + ) diff --git a/tests/api_resources/projects/test_ai_credits_usage.py b/tests/api_resources/projects/test_ai_credits_usage.py new file mode 100644 index 0000000..c079bc5 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_usage.py @@ -0,0 +1,130 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import AICreditsUsageRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsUsage: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + ai_credits_usage = client.projects.ai_credits_usage.retrieve( + id="id", + ) + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + ai_credits_usage = client.projects.ai_credits_usage.retrieve( + id="id", + end="7321-69-10", + end_user_id="end_user_id", + feature_type="full_template_gen", + limit=1, + offset=0, + order="asc", + sort="credits", + start="7321-69-10", + ) + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.projects.ai_credits_usage.with_raw_response.retrieve( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_usage = response.parse() + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.projects.ai_credits_usage.with_streaming_response.retrieve( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_usage = response.parse() + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_usage.with_raw_response.retrieve( + id="", + ) + + +class TestAsyncAICreditsUsage: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + ai_credits_usage = await async_client.projects.ai_credits_usage.retrieve( + id="id", + ) + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + ai_credits_usage = await async_client.projects.ai_credits_usage.retrieve( + id="id", + end="7321-69-10", + end_user_id="end_user_id", + feature_type="full_template_gen", + limit=1, + offset=0, + order="asc", + sort="credits", + start="7321-69-10", + ) + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_usage.with_raw_response.retrieve( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_usage = await response.parse() + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_usage.with_streaming_response.retrieve( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_usage = await response.parse() + assert_matches_type(AICreditsUsageRetrieveResponse, ai_credits_usage, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_usage.with_raw_response.retrieve( + id="", + ) diff --git a/tests/api_resources/projects/test_ai_credits_webhooks_deliveries.py b/tests/api_resources/projects/test_ai_credits_webhooks_deliveries.py new file mode 100644 index 0000000..0668ec2 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_webhooks_deliveries.py @@ -0,0 +1,128 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import ( + AICreditsWebhooksDeliveryRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsWebhooksDeliveries: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + ai_credits_webhooks_delivery = client.projects.ai_credits_webhooks_deliveries.retrieve( + id="id", + ) + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + ai_credits_webhooks_delivery = client.projects.ai_credits_webhooks_deliveries.retrieve( + id="id", + event="ai.credits.usage_recorded", + limit=1, + offset=0, + status="pending", + ) + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.projects.ai_credits_webhooks_deliveries.with_raw_response.retrieve( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_delivery = response.parse() + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.projects.ai_credits_webhooks_deliveries.with_streaming_response.retrieve( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_delivery = response.parse() + assert_matches_type( + AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_webhooks_deliveries.with_raw_response.retrieve( + id="", + ) + + +class TestAsyncAICreditsWebhooksDeliveries: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + ai_credits_webhooks_delivery = await async_client.projects.ai_credits_webhooks_deliveries.retrieve( + id="id", + ) + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + ai_credits_webhooks_delivery = await async_client.projects.ai_credits_webhooks_deliveries.retrieve( + id="id", + event="ai.credits.usage_recorded", + limit=1, + offset=0, + status="pending", + ) + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_webhooks_deliveries.with_raw_response.retrieve( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_delivery = await response.parse() + assert_matches_type(AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_webhooks_deliveries.with_streaming_response.retrieve( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_delivery = await response.parse() + assert_matches_type( + AICreditsWebhooksDeliveryRetrieveResponse, ai_credits_webhooks_delivery, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_webhooks_deliveries.with_raw_response.retrieve( + id="", + ) diff --git a/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesattempts.py b/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesattempts.py new file mode 100644 index 0000000..a322a25 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesattempts.py @@ -0,0 +1,166 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import ( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsWebhooksDeliveriesattempts: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + ai_credits_webhooks_deliveriesattempt = client.projects.ai_credits_webhooks_deliveriesattempts.retrieve( + delivery_id="deliveryId", + id="id", + ) + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + ai_credits_webhooks_deliveriesattempt = client.projects.ai_credits_webhooks_deliveriesattempts.retrieve( + delivery_id="deliveryId", + id="id", + limit=1, + offset=0, + ) + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="deliveryId", + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_deliveriesattempt = response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.projects.ai_credits_webhooks_deliveriesattempts.with_streaming_response.retrieve( + delivery_id="deliveryId", + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_deliveriesattempt = response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, + ai_credits_webhooks_deliveriesattempt, + path=["response"], + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="deliveryId", + id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `delivery_id` but received ''"): + client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="", + id="id", + ) + + +class TestAsyncAICreditsWebhooksDeliveriesattempts: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + ai_credits_webhooks_deliveriesattempt = ( + await async_client.projects.ai_credits_webhooks_deliveriesattempts.retrieve( + delivery_id="deliveryId", + id="id", + ) + ) + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + ai_credits_webhooks_deliveriesattempt = ( + await async_client.projects.ai_credits_webhooks_deliveriesattempts.retrieve( + delivery_id="deliveryId", + id="id", + limit=1, + offset=0, + ) + ) + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="deliveryId", + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_deliveriesattempt = await response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, ai_credits_webhooks_deliveriesattempt, path=["response"] + ) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_webhooks_deliveriesattempts.with_streaming_response.retrieve( + delivery_id="deliveryId", + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_deliveriesattempt = await response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesattemptRetrieveResponse, + ai_credits_webhooks_deliveriesattempt, + path=["response"], + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="deliveryId", + id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `delivery_id` but received ''"): + await async_client.projects.ai_credits_webhooks_deliveriesattempts.with_raw_response.retrieve( + delivery_id="", + id="id", + ) diff --git a/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesretry.py b/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesretry.py new file mode 100644 index 0000000..f863af3 --- /dev/null +++ b/tests/api_resources/projects/test_ai_credits_webhooks_deliveriesretry.py @@ -0,0 +1,132 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.projects import AICreditsWebhooksDeliveriesretryCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestAICreditsWebhooksDeliveriesretry: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + ai_credits_webhooks_deliveriesretry = client.projects.ai_credits_webhooks_deliveriesretry.create( + delivery_id="deliveryId", + id="id", + ) + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="deliveryId", + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_deliveriesretry = response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.projects.ai_credits_webhooks_deliveriesretry.with_streaming_response.create( + delivery_id="deliveryId", + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_deliveriesretry = response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="deliveryId", + id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `delivery_id` but received ''"): + client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="", + id="id", + ) + + +class TestAsyncAICreditsWebhooksDeliveriesretry: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + ai_credits_webhooks_deliveriesretry = await async_client.projects.ai_credits_webhooks_deliveriesretry.create( + delivery_id="deliveryId", + id="id", + ) + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="deliveryId", + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + ai_credits_webhooks_deliveriesretry = await response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.projects.ai_credits_webhooks_deliveriesretry.with_streaming_response.create( + delivery_id="deliveryId", + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + ai_credits_webhooks_deliveriesretry = await response.parse() + assert_matches_type( + AICreditsWebhooksDeliveriesretryCreateResponse, ai_credits_webhooks_deliveriesretry, path=["response"] + ) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="deliveryId", + id="", + ) + + with pytest.raises(ValueError, match=r"Expected a non-empty value for `delivery_id` but received ''"): + await async_client.projects.ai_credits_webhooks_deliveriesretry.with_raw_response.create( + delivery_id="", + id="id", + ) From 8e7ad05d2c31ac5e30d8336c0a2c612c37225298 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 2 Aug 2026 08:03:09 +0000 Subject: [PATCH 44/46] feat(api): api update --- .stats.yml | 8 +- api.md | 189 +++++ src/unlayer/_client.py | 113 ++- src/unlayer/resources/__init__.py | 42 + src/unlayer/resources/domains/__init__.py | 33 + src/unlayer/resources/domains/domains.py | 432 ++++++++++ src/unlayer/resources/domains/verify.py | 168 ++++ src/unlayer/resources/emails/__init__.py | 117 +++ src/unlayer/resources/emails/emails.py | 751 ++++++++++++++++++ src/unlayer/resources/emails/events.py | 168 ++++ src/unlayer/resources/emails/render.py | 191 +++++ src/unlayer/resources/emails/settings.py | 224 ++++++ src/unlayer/resources/emails/stats.py | 207 +++++ src/unlayer/resources/emails/suppressions.py | 393 +++++++++ .../resources/emails/suppressions_check.py | 193 +++++ src/unlayer/resources/emails/template.py | 291 +++++++ src/unlayer/resources/templates/__init__.py | 28 + .../templates/convert_full_to_simple.py | 10 + .../templates/convert_simple_to_full.py | 10 + src/unlayer/resources/templates/schema.py | 214 +++++ src/unlayer/resources/templates/templates.py | 100 +++ src/unlayer/resources/templates/validate.py | 254 ++++++ src/unlayer/resources/webhooks/__init__.py | 33 + .../resources/webhooks/rotate_secret.py | 168 ++++ src/unlayer/resources/webhooks/webhooks.py | 556 +++++++++++++ src/unlayer/types/__init__.py | 17 + src/unlayer/types/domain_create_params.py | 12 + src/unlayer/types/domain_create_response.py | 39 + src/unlayer/types/domain_delete_response.py | 15 + src/unlayer/types/domain_list_response.py | 25 + src/unlayer/types/domain_retrieve_response.py | 38 + src/unlayer/types/domains/__init__.py | 5 + .../types/domains/verify_create_response.py | 33 + src/unlayer/types/email_create_params.py | 114 +++ src/unlayer/types/email_create_response.py | 48 ++ src/unlayer/types/email_list_params.py | 45 ++ src/unlayer/types/email_list_response.py | 40 + src/unlayer/types/email_retrieve_response.py | 36 + src/unlayer/types/emails/__init__.py | 22 + .../types/emails/event_retrieve_response.py | 21 + .../types/emails/render_create_params.py | 18 + .../types/emails/render_create_response.py | 19 + .../types/emails/setting_retrieve_response.py | 25 + .../types/emails/setting_update_params.py | 14 + .../types/emails/setting_update_response.py | 25 + .../types/emails/stat_retrieve_params.py | 20 + .../types/emails/stat_retrieve_response.py | 66 ++ .../types/emails/suppression_create_params.py | 12 + .../emails/suppression_create_response.py | 22 + .../types/emails/suppression_delete_params.py | 17 + .../emails/suppression_delete_response.py | 17 + .../emails/suppression_retrieve_params.py | 20 + .../emails/suppression_retrieve_response.py | 27 + .../suppressions_check_retrieve_params.py | 17 + .../suppressions_check_retrieve_response.py | 17 + .../types/emails/template_create_params.py | 115 +++ .../types/emails/template_create_response.py | 45 ++ src/unlayer/types/templates/__init__.py | 3 + .../convert_full_to_simple_create_params.py | 7 + .../convert_simple_to_full_create_params.py | 7 + .../types/templates/schema_retrieve_params.py | 20 + .../types/templates/validate_create_params.py | 68 ++ .../templates/validate_create_response.py | 47 ++ src/unlayer/types/webhook_create_params.py | 19 + src/unlayer/types/webhook_create_response.py | 38 + src/unlayer/types/webhook_delete_response.py | 15 + src/unlayer/types/webhook_list_response.py | 32 + .../types/webhook_retrieve_response.py | 35 + src/unlayer/types/webhook_update_params.py | 19 + src/unlayer/types/webhook_update_response.py | 32 + src/unlayer/types/webhooks/__init__.py | 5 + .../webhooks/rotate_secret_create_response.py | 23 + tests/api_resources/domains/__init__.py | 1 + tests/api_resources/domains/test_verify.py | 100 +++ tests/api_resources/emails/__init__.py | 1 + tests/api_resources/emails/test_events.py | 100 +++ tests/api_resources/emails/test_render.py | 102 +++ tests/api_resources/emails/test_settings.py | 138 ++++ tests/api_resources/emails/test_stats.py | 92 +++ .../api_resources/emails/test_suppressions.py | 236 ++++++ .../emails/test_suppressions_check.py | 102 +++ tests/api_resources/emails/test_template.py | 148 ++++ tests/api_resources/templates/test_schema.py | 88 ++ .../api_resources/templates/test_validate.py | 126 +++ tests/api_resources/test_domains.py | 293 +++++++ tests/api_resources/test_emails.py | 311 ++++++++ tests/api_resources/test_webhooks.py | 408 ++++++++++ tests/api_resources/webhooks/__init__.py | 1 + .../webhooks/test_rotate_secret.py | 100 +++ 89 files changed, 8611 insertions(+), 5 deletions(-) create mode 100644 src/unlayer/resources/domains/__init__.py create mode 100644 src/unlayer/resources/domains/domains.py create mode 100644 src/unlayer/resources/domains/verify.py create mode 100644 src/unlayer/resources/emails/__init__.py create mode 100644 src/unlayer/resources/emails/emails.py create mode 100644 src/unlayer/resources/emails/events.py create mode 100644 src/unlayer/resources/emails/render.py create mode 100644 src/unlayer/resources/emails/settings.py create mode 100644 src/unlayer/resources/emails/stats.py create mode 100644 src/unlayer/resources/emails/suppressions.py create mode 100644 src/unlayer/resources/emails/suppressions_check.py create mode 100644 src/unlayer/resources/emails/template.py create mode 100644 src/unlayer/resources/templates/schema.py create mode 100644 src/unlayer/resources/templates/validate.py create mode 100644 src/unlayer/resources/webhooks/__init__.py create mode 100644 src/unlayer/resources/webhooks/rotate_secret.py create mode 100644 src/unlayer/resources/webhooks/webhooks.py create mode 100644 src/unlayer/types/domain_create_params.py create mode 100644 src/unlayer/types/domain_create_response.py create mode 100644 src/unlayer/types/domain_delete_response.py create mode 100644 src/unlayer/types/domain_list_response.py create mode 100644 src/unlayer/types/domain_retrieve_response.py create mode 100644 src/unlayer/types/domains/__init__.py create mode 100644 src/unlayer/types/domains/verify_create_response.py create mode 100644 src/unlayer/types/email_create_params.py create mode 100644 src/unlayer/types/email_create_response.py create mode 100644 src/unlayer/types/email_list_params.py create mode 100644 src/unlayer/types/email_list_response.py create mode 100644 src/unlayer/types/email_retrieve_response.py create mode 100644 src/unlayer/types/emails/__init__.py create mode 100644 src/unlayer/types/emails/event_retrieve_response.py create mode 100644 src/unlayer/types/emails/render_create_params.py create mode 100644 src/unlayer/types/emails/render_create_response.py create mode 100644 src/unlayer/types/emails/setting_retrieve_response.py create mode 100644 src/unlayer/types/emails/setting_update_params.py create mode 100644 src/unlayer/types/emails/setting_update_response.py create mode 100644 src/unlayer/types/emails/stat_retrieve_params.py create mode 100644 src/unlayer/types/emails/stat_retrieve_response.py create mode 100644 src/unlayer/types/emails/suppression_create_params.py create mode 100644 src/unlayer/types/emails/suppression_create_response.py create mode 100644 src/unlayer/types/emails/suppression_delete_params.py create mode 100644 src/unlayer/types/emails/suppression_delete_response.py create mode 100644 src/unlayer/types/emails/suppression_retrieve_params.py create mode 100644 src/unlayer/types/emails/suppression_retrieve_response.py create mode 100644 src/unlayer/types/emails/suppressions_check_retrieve_params.py create mode 100644 src/unlayer/types/emails/suppressions_check_retrieve_response.py create mode 100644 src/unlayer/types/emails/template_create_params.py create mode 100644 src/unlayer/types/emails/template_create_response.py create mode 100644 src/unlayer/types/templates/schema_retrieve_params.py create mode 100644 src/unlayer/types/templates/validate_create_params.py create mode 100644 src/unlayer/types/templates/validate_create_response.py create mode 100644 src/unlayer/types/webhook_create_params.py create mode 100644 src/unlayer/types/webhook_create_response.py create mode 100644 src/unlayer/types/webhook_delete_response.py create mode 100644 src/unlayer/types/webhook_list_response.py create mode 100644 src/unlayer/types/webhook_retrieve_response.py create mode 100644 src/unlayer/types/webhook_update_params.py create mode 100644 src/unlayer/types/webhook_update_response.py create mode 100644 src/unlayer/types/webhooks/__init__.py create mode 100644 src/unlayer/types/webhooks/rotate_secret_create_response.py create mode 100644 tests/api_resources/domains/__init__.py create mode 100644 tests/api_resources/domains/test_verify.py create mode 100644 tests/api_resources/emails/__init__.py create mode 100644 tests/api_resources/emails/test_events.py create mode 100644 tests/api_resources/emails/test_render.py create mode 100644 tests/api_resources/emails/test_settings.py create mode 100644 tests/api_resources/emails/test_stats.py create mode 100644 tests/api_resources/emails/test_suppressions.py create mode 100644 tests/api_resources/emails/test_suppressions_check.py create mode 100644 tests/api_resources/emails/test_template.py create mode 100644 tests/api_resources/templates/test_schema.py create mode 100644 tests/api_resources/templates/test_validate.py create mode 100644 tests/api_resources/test_domains.py create mode 100644 tests/api_resources/test_emails.py create mode 100644 tests/api_resources/test_webhooks.py create mode 100644 tests/api_resources/webhooks/__init__.py create mode 100644 tests/api_resources/webhooks/test_rotate_secret.py diff --git a/.stats.yml b/.stats.yml index 568730e..b5c4710 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 24 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-b42187e1b2fff52630a33946829067dcc76dd842a7fb85d826ee9ccc4f44175d.yml -openapi_spec_hash: 7f0c95f3bb404716e0a77878c0c21b91 -config_hash: ee438ad5d5e9b8446d21fc7cb50eff95 +configured_endpoints: 50 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-112356d364a4c9b7cf7f8d272937732568d750f9574ecc0c07516eca112cdddf.yml +openapi_spec_hash: 283e15c9bc02c4d7c69189873b1da9d4 +config_hash: c65b47a2f20400d392a50837c0a10945 diff --git a/api.md b/api.md index 182b670..42f2916 100644 --- a/api.md +++ b/api.md @@ -1,3 +1,35 @@ +# Domains + +Types: + +```python +from unlayer.types import ( + DomainCreateResponse, + DomainRetrieveResponse, + DomainListResponse, + DomainDeleteResponse, +) +``` + +Methods: + +- client.domains.create(\*\*params) -> DomainCreateResponse +- client.domains.retrieve(id) -> DomainRetrieveResponse +- client.domains.list() -> DomainListResponse +- client.domains.delete(id) -> DomainDeleteResponse + +## Verify + +Types: + +```python +from unlayer.types.domains import VerifyCreateResponse +``` + +Methods: + +- client.domains.verify.create(id) -> VerifyCreateResponse + # EditorSessions Types: @@ -10,6 +42,111 @@ Methods: - client.editor_sessions.create(\*\*params) -> EditorSessionCreateResponse +# Emails + +Types: + +```python +from unlayer.types import EmailCreateResponse, EmailRetrieveResponse, EmailListResponse +``` + +Methods: + +- client.emails.create(\*\*params) -> EmailCreateResponse +- client.emails.retrieve(id) -> EmailRetrieveResponse +- client.emails.list(\*\*params) -> EmailListResponse + +## Events + +Types: + +```python +from unlayer.types.emails import EventRetrieveResponse +``` + +Methods: + +- client.emails.events.retrieve(id) -> EventRetrieveResponse + +## Render + +Types: + +```python +from unlayer.types.emails import RenderCreateResponse +``` + +Methods: + +- client.emails.render.create(\*\*params) -> RenderCreateResponse + +## Settings + +Types: + +```python +from unlayer.types.emails import SettingRetrieveResponse, SettingUpdateResponse +``` + +Methods: + +- client.emails.settings.retrieve() -> SettingRetrieveResponse +- client.emails.settings.update(\*\*params) -> SettingUpdateResponse + +## Stats + +Types: + +```python +from unlayer.types.emails import StatRetrieveResponse +``` + +Methods: + +- client.emails.stats.retrieve(\*\*params) -> StatRetrieveResponse + +## Suppressions + +Types: + +```python +from unlayer.types.emails import ( + SuppressionCreateResponse, + SuppressionRetrieveResponse, + SuppressionDeleteResponse, +) +``` + +Methods: + +- client.emails.suppressions.create(\*\*params) -> SuppressionCreateResponse +- client.emails.suppressions.retrieve(\*\*params) -> SuppressionRetrieveResponse +- client.emails.suppressions.delete(\*\*params) -> SuppressionDeleteResponse + +## SuppressionsCheck + +Types: + +```python +from unlayer.types.emails import SuppressionsCheckRetrieveResponse +``` + +Methods: + +- client.emails.suppressions_check.retrieve(\*\*params) -> SuppressionsCheckRetrieveResponse + +## Template + +Types: + +```python +from unlayer.types.emails import TemplateCreateResponse +``` + +Methods: + +- client.emails.template.create(\*\*params) -> TemplateCreateResponse + # Me ## Subscription @@ -231,6 +368,58 @@ Methods: - client.templates.import*.create(\*\*params) -> ImportCreateResponse +## Schema + +Methods: + +- client.templates.schema.retrieve(\*\*params) -> None + +## Validate + +Types: + +```python +from unlayer.types.templates import ValidateCreateResponse +``` + +Methods: + +- client.templates.validate.create(\*\*params) -> ValidateCreateResponse + +# Webhooks + +Types: + +```python +from unlayer.types import ( + WebhookCreateResponse, + WebhookRetrieveResponse, + WebhookUpdateResponse, + WebhookListResponse, + WebhookDeleteResponse, +) +``` + +Methods: + +- client.webhooks.create(\*\*params) -> WebhookCreateResponse +- client.webhooks.retrieve(id) -> WebhookRetrieveResponse +- client.webhooks.update(id, \*\*params) -> WebhookUpdateResponse +- client.webhooks.list() -> WebhookListResponse +- client.webhooks.delete(id) -> WebhookDeleteResponse + +## RotateSecret + +Types: + +```python +from unlayer.types.webhooks import RotateSecretCreateResponse +``` + +Methods: + +- client.webhooks.rotate_secret.create(id) -> RotateSecretCreateResponse + # Workspaces Types: diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 30d36b6..9c811c9 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -36,11 +36,14 @@ ) if TYPE_CHECKING: - from .resources import me, projects, templates, workspaces, editor_sessions + from .resources import me, emails, domains, projects, webhooks, templates, workspaces, editor_sessions from .resources.me.me import MeResource, AsyncMeResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource + from .resources.emails.emails import EmailsResource, AsyncEmailsResource + from .resources.domains.domains import DomainsResource, AsyncDomainsResource from .resources.editor_sessions import EditorSessionsResource, AsyncEditorSessionsResource from .resources.projects.projects import ProjectsResource, AsyncProjectsResource + from .resources.webhooks.webhooks import WebhooksResource, AsyncWebhooksResource from .resources.templates.templates import TemplatesResource, AsyncTemplatesResource __all__ = ["Timeout", "Transport", "ProxiesTypes", "RequestOptions", "Unlayer", "AsyncUnlayer", "Client", "AsyncClient"] @@ -121,12 +124,24 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def domains(self) -> DomainsResource: + from .resources.domains import DomainsResource + + return DomainsResource(self) + @cached_property def editor_sessions(self) -> EditorSessionsResource: from .resources.editor_sessions import EditorSessionsResource return EditorSessionsResource(self) + @cached_property + def emails(self) -> EmailsResource: + from .resources.emails import EmailsResource + + return EmailsResource(self) + @cached_property def me(self) -> MeResource: from .resources.me import MeResource @@ -149,6 +164,12 @@ def templates(self) -> TemplatesResource: return TemplatesResource(self) + @cached_property + def webhooks(self) -> WebhooksResource: + from .resources.webhooks import WebhooksResource + + return WebhooksResource(self) + @cached_property def workspaces(self) -> WorkspacesResource: """Workspace access and management.""" @@ -371,12 +392,24 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def domains(self) -> AsyncDomainsResource: + from .resources.domains import AsyncDomainsResource + + return AsyncDomainsResource(self) + @cached_property def editor_sessions(self) -> AsyncEditorSessionsResource: from .resources.editor_sessions import AsyncEditorSessionsResource return AsyncEditorSessionsResource(self) + @cached_property + def emails(self) -> AsyncEmailsResource: + from .resources.emails import AsyncEmailsResource + + return AsyncEmailsResource(self) + @cached_property def me(self) -> AsyncMeResource: from .resources.me import AsyncMeResource @@ -399,6 +432,12 @@ def templates(self) -> AsyncTemplatesResource: return AsyncTemplatesResource(self) + @cached_property + def webhooks(self) -> AsyncWebhooksResource: + from .resources.webhooks import AsyncWebhooksResource + + return AsyncWebhooksResource(self) + @cached_property def workspaces(self) -> AsyncWorkspacesResource: """Workspace access and management.""" @@ -552,12 +591,24 @@ class UnlayerWithRawResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def domains(self) -> domains.DomainsResourceWithRawResponse: + from .resources.domains import DomainsResourceWithRawResponse + + return DomainsResourceWithRawResponse(self._client.domains) + @cached_property def editor_sessions(self) -> editor_sessions.EditorSessionsResourceWithRawResponse: from .resources.editor_sessions import EditorSessionsResourceWithRawResponse return EditorSessionsResourceWithRawResponse(self._client.editor_sessions) + @cached_property + def emails(self) -> emails.EmailsResourceWithRawResponse: + from .resources.emails import EmailsResourceWithRawResponse + + return EmailsResourceWithRawResponse(self._client.emails) + @cached_property def me(self) -> me.MeResourceWithRawResponse: from .resources.me import MeResourceWithRawResponse @@ -580,6 +631,12 @@ def templates(self) -> templates.TemplatesResourceWithRawResponse: return TemplatesResourceWithRawResponse(self._client.templates) + @cached_property + def webhooks(self) -> webhooks.WebhooksResourceWithRawResponse: + from .resources.webhooks import WebhooksResourceWithRawResponse + + return WebhooksResourceWithRawResponse(self._client.webhooks) + @cached_property def workspaces(self) -> workspaces.WorkspacesResourceWithRawResponse: """Workspace access and management.""" @@ -594,12 +651,24 @@ class AsyncUnlayerWithRawResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def domains(self) -> domains.AsyncDomainsResourceWithRawResponse: + from .resources.domains import AsyncDomainsResourceWithRawResponse + + return AsyncDomainsResourceWithRawResponse(self._client.domains) + @cached_property def editor_sessions(self) -> editor_sessions.AsyncEditorSessionsResourceWithRawResponse: from .resources.editor_sessions import AsyncEditorSessionsResourceWithRawResponse return AsyncEditorSessionsResourceWithRawResponse(self._client.editor_sessions) + @cached_property + def emails(self) -> emails.AsyncEmailsResourceWithRawResponse: + from .resources.emails import AsyncEmailsResourceWithRawResponse + + return AsyncEmailsResourceWithRawResponse(self._client.emails) + @cached_property def me(self) -> me.AsyncMeResourceWithRawResponse: from .resources.me import AsyncMeResourceWithRawResponse @@ -622,6 +691,12 @@ def templates(self) -> templates.AsyncTemplatesResourceWithRawResponse: return AsyncTemplatesResourceWithRawResponse(self._client.templates) + @cached_property + def webhooks(self) -> webhooks.AsyncWebhooksResourceWithRawResponse: + from .resources.webhooks import AsyncWebhooksResourceWithRawResponse + + return AsyncWebhooksResourceWithRawResponse(self._client.webhooks) + @cached_property def workspaces(self) -> workspaces.AsyncWorkspacesResourceWithRawResponse: """Workspace access and management.""" @@ -636,12 +711,24 @@ class UnlayerWithStreamedResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def domains(self) -> domains.DomainsResourceWithStreamingResponse: + from .resources.domains import DomainsResourceWithStreamingResponse + + return DomainsResourceWithStreamingResponse(self._client.domains) + @cached_property def editor_sessions(self) -> editor_sessions.EditorSessionsResourceWithStreamingResponse: from .resources.editor_sessions import EditorSessionsResourceWithStreamingResponse return EditorSessionsResourceWithStreamingResponse(self._client.editor_sessions) + @cached_property + def emails(self) -> emails.EmailsResourceWithStreamingResponse: + from .resources.emails import EmailsResourceWithStreamingResponse + + return EmailsResourceWithStreamingResponse(self._client.emails) + @cached_property def me(self) -> me.MeResourceWithStreamingResponse: from .resources.me import MeResourceWithStreamingResponse @@ -664,6 +751,12 @@ def templates(self) -> templates.TemplatesResourceWithStreamingResponse: return TemplatesResourceWithStreamingResponse(self._client.templates) + @cached_property + def webhooks(self) -> webhooks.WebhooksResourceWithStreamingResponse: + from .resources.webhooks import WebhooksResourceWithStreamingResponse + + return WebhooksResourceWithStreamingResponse(self._client.webhooks) + @cached_property def workspaces(self) -> workspaces.WorkspacesResourceWithStreamingResponse: """Workspace access and management.""" @@ -678,12 +771,24 @@ class AsyncUnlayerWithStreamedResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def domains(self) -> domains.AsyncDomainsResourceWithStreamingResponse: + from .resources.domains import AsyncDomainsResourceWithStreamingResponse + + return AsyncDomainsResourceWithStreamingResponse(self._client.domains) + @cached_property def editor_sessions(self) -> editor_sessions.AsyncEditorSessionsResourceWithStreamingResponse: from .resources.editor_sessions import AsyncEditorSessionsResourceWithStreamingResponse return AsyncEditorSessionsResourceWithStreamingResponse(self._client.editor_sessions) + @cached_property + def emails(self) -> emails.AsyncEmailsResourceWithStreamingResponse: + from .resources.emails import AsyncEmailsResourceWithStreamingResponse + + return AsyncEmailsResourceWithStreamingResponse(self._client.emails) + @cached_property def me(self) -> me.AsyncMeResourceWithStreamingResponse: from .resources.me import AsyncMeResourceWithStreamingResponse @@ -706,6 +811,12 @@ def templates(self) -> templates.AsyncTemplatesResourceWithStreamingResponse: return AsyncTemplatesResourceWithStreamingResponse(self._client.templates) + @cached_property + def webhooks(self) -> webhooks.AsyncWebhooksResourceWithStreamingResponse: + from .resources.webhooks import AsyncWebhooksResourceWithStreamingResponse + + return AsyncWebhooksResourceWithStreamingResponse(self._client.webhooks) + @cached_property def workspaces(self) -> workspaces.AsyncWorkspacesResourceWithStreamingResponse: """Workspace access and management.""" diff --git a/src/unlayer/resources/__init__.py b/src/unlayer/resources/__init__.py index 4694e01..dbeb66f 100644 --- a/src/unlayer/resources/__init__.py +++ b/src/unlayer/resources/__init__.py @@ -8,6 +8,22 @@ MeResourceWithStreamingResponse, AsyncMeResourceWithStreamingResponse, ) +from .emails import ( + EmailsResource, + AsyncEmailsResource, + EmailsResourceWithRawResponse, + AsyncEmailsResourceWithRawResponse, + EmailsResourceWithStreamingResponse, + AsyncEmailsResourceWithStreamingResponse, +) +from .domains import ( + DomainsResource, + AsyncDomainsResource, + DomainsResourceWithRawResponse, + AsyncDomainsResourceWithRawResponse, + DomainsResourceWithStreamingResponse, + AsyncDomainsResourceWithStreamingResponse, +) from .projects import ( ProjectsResource, AsyncProjectsResource, @@ -16,6 +32,14 @@ ProjectsResourceWithStreamingResponse, AsyncProjectsResourceWithStreamingResponse, ) +from .webhooks import ( + WebhooksResource, + AsyncWebhooksResource, + WebhooksResourceWithRawResponse, + AsyncWebhooksResourceWithRawResponse, + WebhooksResourceWithStreamingResponse, + AsyncWebhooksResourceWithStreamingResponse, +) from .templates import ( TemplatesResource, AsyncTemplatesResource, @@ -42,12 +66,24 @@ ) __all__ = [ + "DomainsResource", + "AsyncDomainsResource", + "DomainsResourceWithRawResponse", + "AsyncDomainsResourceWithRawResponse", + "DomainsResourceWithStreamingResponse", + "AsyncDomainsResourceWithStreamingResponse", "EditorSessionsResource", "AsyncEditorSessionsResource", "EditorSessionsResourceWithRawResponse", "AsyncEditorSessionsResourceWithRawResponse", "EditorSessionsResourceWithStreamingResponse", "AsyncEditorSessionsResourceWithStreamingResponse", + "EmailsResource", + "AsyncEmailsResource", + "EmailsResourceWithRawResponse", + "AsyncEmailsResourceWithRawResponse", + "EmailsResourceWithStreamingResponse", + "AsyncEmailsResourceWithStreamingResponse", "MeResource", "AsyncMeResource", "MeResourceWithRawResponse", @@ -66,6 +102,12 @@ "AsyncTemplatesResourceWithRawResponse", "TemplatesResourceWithStreamingResponse", "AsyncTemplatesResourceWithStreamingResponse", + "WebhooksResource", + "AsyncWebhooksResource", + "WebhooksResourceWithRawResponse", + "AsyncWebhooksResourceWithRawResponse", + "WebhooksResourceWithStreamingResponse", + "AsyncWebhooksResourceWithStreamingResponse", "WorkspacesResource", "AsyncWorkspacesResource", "WorkspacesResourceWithRawResponse", diff --git a/src/unlayer/resources/domains/__init__.py b/src/unlayer/resources/domains/__init__.py new file mode 100644 index 0000000..5c99cb0 --- /dev/null +++ b/src/unlayer/resources/domains/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .verify import ( + VerifyResource, + AsyncVerifyResource, + VerifyResourceWithRawResponse, + AsyncVerifyResourceWithRawResponse, + VerifyResourceWithStreamingResponse, + AsyncVerifyResourceWithStreamingResponse, +) +from .domains import ( + DomainsResource, + AsyncDomainsResource, + DomainsResourceWithRawResponse, + AsyncDomainsResourceWithRawResponse, + DomainsResourceWithStreamingResponse, + AsyncDomainsResourceWithStreamingResponse, +) + +__all__ = [ + "VerifyResource", + "AsyncVerifyResource", + "VerifyResourceWithRawResponse", + "AsyncVerifyResourceWithRawResponse", + "VerifyResourceWithStreamingResponse", + "AsyncVerifyResourceWithStreamingResponse", + "DomainsResource", + "AsyncDomainsResource", + "DomainsResourceWithRawResponse", + "AsyncDomainsResourceWithRawResponse", + "DomainsResourceWithStreamingResponse", + "AsyncDomainsResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/domains/domains.py b/src/unlayer/resources/domains/domains.py new file mode 100644 index 0000000..8336132 --- /dev/null +++ b/src/unlayer/resources/domains/domains.py @@ -0,0 +1,432 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from .verify import ( + VerifyResource, + AsyncVerifyResource, + VerifyResourceWithRawResponse, + AsyncVerifyResourceWithRawResponse, + VerifyResourceWithStreamingResponse, + AsyncVerifyResourceWithStreamingResponse, +) +from ...types import domain_create_params +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.domain_list_response import DomainListResponse +from ...types.domain_create_response import DomainCreateResponse +from ...types.domain_delete_response import DomainDeleteResponse +from ...types.domain_retrieve_response import DomainRetrieveResponse + +__all__ = ["DomainsResource", "AsyncDomainsResource"] + + +class DomainsResource(SyncAPIResource): + @cached_property + def verify(self) -> VerifyResource: + return VerifyResource(self._client) + + @cached_property + def with_raw_response(self) -> DomainsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return DomainsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> DomainsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return DomainsResourceWithStreamingResponse(self) + + def create( + self, + *, + domain: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainCreateResponse: + """ + Register a sender domain shared by every Developer Email API project in the + workspace. Requires a personal access token belonging to a workspace owner or + admin. Verification requires the workspace-specific TXT record and the returned + SES DKIM records. + + Args: + domain: Domain name to register, such as example.com. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/domains", + body=maybe_transform({"domain": domain}, domain_create_params.DomainCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainCreateResponse, + ) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainRetrieveResponse: + """ + Get the ownership TXT challenge and SES DKIM records for a sender domain shared + by every Developer Email API project in the workspace. Requires a personal + access token belonging to a workspace owner or admin. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/domains/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainRetrieveResponse, + ) + + def list( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainListResponse: + """List sender domains shared by every Developer Email API project in the + workspace. + + Requires a personal access token belonging to a workspace owner or + admin; project API keys cannot manage domains. + """ + return self._get( + "/v3/domains", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainListResponse, + ) + + def delete( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainDeleteResponse: + """ + Delete a sender domain shared by every Developer Email API project in the + workspace. Requires a personal access token belonging to a workspace owner or + admin. The SES identity remains so a later reconciler can clean it up safely. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._delete( + path_template("/v3/domains/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainDeleteResponse, + ) + + +class AsyncDomainsResource(AsyncAPIResource): + @cached_property + def verify(self) -> AsyncVerifyResource: + return AsyncVerifyResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncDomainsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncDomainsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncDomainsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncDomainsResourceWithStreamingResponse(self) + + async def create( + self, + *, + domain: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainCreateResponse: + """ + Register a sender domain shared by every Developer Email API project in the + workspace. Requires a personal access token belonging to a workspace owner or + admin. Verification requires the workspace-specific TXT record and the returned + SES DKIM records. + + Args: + domain: Domain name to register, such as example.com. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/domains", + body=await async_maybe_transform({"domain": domain}, domain_create_params.DomainCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainCreateResponse, + ) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainRetrieveResponse: + """ + Get the ownership TXT challenge and SES DKIM records for a sender domain shared + by every Developer Email API project in the workspace. Requires a personal + access token belonging to a workspace owner or admin. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/domains/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainRetrieveResponse, + ) + + async def list( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainListResponse: + """List sender domains shared by every Developer Email API project in the + workspace. + + Requires a personal access token belonging to a workspace owner or + admin; project API keys cannot manage domains. + """ + return await self._get( + "/v3/domains", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainListResponse, + ) + + async def delete( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> DomainDeleteResponse: + """ + Delete a sender domain shared by every Developer Email API project in the + workspace. Requires a personal access token belonging to a workspace owner or + admin. The SES identity remains so a later reconciler can clean it up safely. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._delete( + path_template("/v3/domains/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=DomainDeleteResponse, + ) + + +class DomainsResourceWithRawResponse: + def __init__(self, domains: DomainsResource) -> None: + self._domains = domains + + self.create = to_raw_response_wrapper( + domains.create, + ) + self.retrieve = to_raw_response_wrapper( + domains.retrieve, + ) + self.list = to_raw_response_wrapper( + domains.list, + ) + self.delete = to_raw_response_wrapper( + domains.delete, + ) + + @cached_property + def verify(self) -> VerifyResourceWithRawResponse: + return VerifyResourceWithRawResponse(self._domains.verify) + + +class AsyncDomainsResourceWithRawResponse: + def __init__(self, domains: AsyncDomainsResource) -> None: + self._domains = domains + + self.create = async_to_raw_response_wrapper( + domains.create, + ) + self.retrieve = async_to_raw_response_wrapper( + domains.retrieve, + ) + self.list = async_to_raw_response_wrapper( + domains.list, + ) + self.delete = async_to_raw_response_wrapper( + domains.delete, + ) + + @cached_property + def verify(self) -> AsyncVerifyResourceWithRawResponse: + return AsyncVerifyResourceWithRawResponse(self._domains.verify) + + +class DomainsResourceWithStreamingResponse: + def __init__(self, domains: DomainsResource) -> None: + self._domains = domains + + self.create = to_streamed_response_wrapper( + domains.create, + ) + self.retrieve = to_streamed_response_wrapper( + domains.retrieve, + ) + self.list = to_streamed_response_wrapper( + domains.list, + ) + self.delete = to_streamed_response_wrapper( + domains.delete, + ) + + @cached_property + def verify(self) -> VerifyResourceWithStreamingResponse: + return VerifyResourceWithStreamingResponse(self._domains.verify) + + +class AsyncDomainsResourceWithStreamingResponse: + def __init__(self, domains: AsyncDomainsResource) -> None: + self._domains = domains + + self.create = async_to_streamed_response_wrapper( + domains.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + domains.retrieve, + ) + self.list = async_to_streamed_response_wrapper( + domains.list, + ) + self.delete = async_to_streamed_response_wrapper( + domains.delete, + ) + + @cached_property + def verify(self) -> AsyncVerifyResourceWithStreamingResponse: + return AsyncVerifyResourceWithStreamingResponse(self._domains.verify) diff --git a/src/unlayer/resources/domains/verify.py b/src/unlayer/resources/domains/verify.py new file mode 100644 index 0000000..62acaf9 --- /dev/null +++ b/src/unlayer/resources/domains/verify.py @@ -0,0 +1,168 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.domains.verify_create_response import VerifyCreateResponse + +__all__ = ["VerifyResource", "AsyncVerifyResource"] + + +class VerifyResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> VerifyResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return VerifyResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> VerifyResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return VerifyResourceWithStreamingResponse(self) + + def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerifyCreateResponse: + """ + Verify the ownership TXT challenge and SES DKIM identity for a sender domain + shared by every Developer Email API project in the workspace. Requires a + personal access token belonging to a workspace owner or admin. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._post( + path_template("/v3/domains/{id}/verify", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerifyCreateResponse, + ) + + +class AsyncVerifyResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncVerifyResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncVerifyResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncVerifyResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncVerifyResourceWithStreamingResponse(self) + + async def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> VerifyCreateResponse: + """ + Verify the ownership TXT challenge and SES DKIM identity for a sender domain + shared by every Developer Email API project in the workspace. Requires a + personal access token belonging to a workspace owner or admin. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._post( + path_template("/v3/domains/{id}/verify", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=VerifyCreateResponse, + ) + + +class VerifyResourceWithRawResponse: + def __init__(self, verify: VerifyResource) -> None: + self._verify = verify + + self.create = to_raw_response_wrapper( + verify.create, + ) + + +class AsyncVerifyResourceWithRawResponse: + def __init__(self, verify: AsyncVerifyResource) -> None: + self._verify = verify + + self.create = async_to_raw_response_wrapper( + verify.create, + ) + + +class VerifyResourceWithStreamingResponse: + def __init__(self, verify: VerifyResource) -> None: + self._verify = verify + + self.create = to_streamed_response_wrapper( + verify.create, + ) + + +class AsyncVerifyResourceWithStreamingResponse: + def __init__(self, verify: AsyncVerifyResource) -> None: + self._verify = verify + + self.create = async_to_streamed_response_wrapper( + verify.create, + ) diff --git a/src/unlayer/resources/emails/__init__.py b/src/unlayer/resources/emails/__init__.py new file mode 100644 index 0000000..ddbf5b8 --- /dev/null +++ b/src/unlayer/resources/emails/__init__.py @@ -0,0 +1,117 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .stats import ( + StatsResource, + AsyncStatsResource, + StatsResourceWithRawResponse, + AsyncStatsResourceWithRawResponse, + StatsResourceWithStreamingResponse, + AsyncStatsResourceWithStreamingResponse, +) +from .emails import ( + EmailsResource, + AsyncEmailsResource, + EmailsResourceWithRawResponse, + AsyncEmailsResourceWithRawResponse, + EmailsResourceWithStreamingResponse, + AsyncEmailsResourceWithStreamingResponse, +) +from .events import ( + EventsResource, + AsyncEventsResource, + EventsResourceWithRawResponse, + AsyncEventsResourceWithRawResponse, + EventsResourceWithStreamingResponse, + AsyncEventsResourceWithStreamingResponse, +) +from .render import ( + RenderResource, + AsyncRenderResource, + RenderResourceWithRawResponse, + AsyncRenderResourceWithRawResponse, + RenderResourceWithStreamingResponse, + AsyncRenderResourceWithStreamingResponse, +) +from .settings import ( + SettingsResource, + AsyncSettingsResource, + SettingsResourceWithRawResponse, + AsyncSettingsResourceWithRawResponse, + SettingsResourceWithStreamingResponse, + AsyncSettingsResourceWithStreamingResponse, +) +from .template import ( + TemplateResource, + AsyncTemplateResource, + TemplateResourceWithRawResponse, + AsyncTemplateResourceWithRawResponse, + TemplateResourceWithStreamingResponse, + AsyncTemplateResourceWithStreamingResponse, +) +from .suppressions import ( + SuppressionsResource, + AsyncSuppressionsResource, + SuppressionsResourceWithRawResponse, + AsyncSuppressionsResourceWithRawResponse, + SuppressionsResourceWithStreamingResponse, + AsyncSuppressionsResourceWithStreamingResponse, +) +from .suppressions_check import ( + SuppressionsCheckResource, + AsyncSuppressionsCheckResource, + SuppressionsCheckResourceWithRawResponse, + AsyncSuppressionsCheckResourceWithRawResponse, + SuppressionsCheckResourceWithStreamingResponse, + AsyncSuppressionsCheckResourceWithStreamingResponse, +) + +__all__ = [ + "EventsResource", + "AsyncEventsResource", + "EventsResourceWithRawResponse", + "AsyncEventsResourceWithRawResponse", + "EventsResourceWithStreamingResponse", + "AsyncEventsResourceWithStreamingResponse", + "RenderResource", + "AsyncRenderResource", + "RenderResourceWithRawResponse", + "AsyncRenderResourceWithRawResponse", + "RenderResourceWithStreamingResponse", + "AsyncRenderResourceWithStreamingResponse", + "SettingsResource", + "AsyncSettingsResource", + "SettingsResourceWithRawResponse", + "AsyncSettingsResourceWithRawResponse", + "SettingsResourceWithStreamingResponse", + "AsyncSettingsResourceWithStreamingResponse", + "StatsResource", + "AsyncStatsResource", + "StatsResourceWithRawResponse", + "AsyncStatsResourceWithRawResponse", + "StatsResourceWithStreamingResponse", + "AsyncStatsResourceWithStreamingResponse", + "SuppressionsResource", + "AsyncSuppressionsResource", + "SuppressionsResourceWithRawResponse", + "AsyncSuppressionsResourceWithRawResponse", + "SuppressionsResourceWithStreamingResponse", + "AsyncSuppressionsResourceWithStreamingResponse", + "SuppressionsCheckResource", + "AsyncSuppressionsCheckResource", + "SuppressionsCheckResourceWithRawResponse", + "AsyncSuppressionsCheckResourceWithRawResponse", + "SuppressionsCheckResourceWithStreamingResponse", + "AsyncSuppressionsCheckResourceWithStreamingResponse", + "TemplateResource", + "AsyncTemplateResource", + "TemplateResourceWithRawResponse", + "AsyncTemplateResourceWithRawResponse", + "TemplateResourceWithStreamingResponse", + "AsyncTemplateResourceWithStreamingResponse", + "EmailsResource", + "AsyncEmailsResource", + "EmailsResourceWithRawResponse", + "AsyncEmailsResourceWithRawResponse", + "EmailsResourceWithStreamingResponse", + "AsyncEmailsResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/emails/emails.py b/src/unlayer/resources/emails/emails.py new file mode 100644 index 0000000..999612a --- /dev/null +++ b/src/unlayer/resources/emails/emails.py @@ -0,0 +1,751 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Union, Iterable +from datetime import date +from typing_extensions import Literal + +import httpx + +from .stats import ( + StatsResource, + AsyncStatsResource, + StatsResourceWithRawResponse, + AsyncStatsResourceWithRawResponse, + StatsResourceWithStreamingResponse, + AsyncStatsResourceWithStreamingResponse, +) +from .events import ( + EventsResource, + AsyncEventsResource, + EventsResourceWithRawResponse, + AsyncEventsResourceWithRawResponse, + EventsResourceWithStreamingResponse, + AsyncEventsResourceWithStreamingResponse, +) +from .render import ( + RenderResource, + AsyncRenderResource, + RenderResourceWithRawResponse, + AsyncRenderResourceWithRawResponse, + RenderResourceWithStreamingResponse, + AsyncRenderResourceWithStreamingResponse, +) +from ...types import email_list_params, email_create_params +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import path_template, maybe_transform, strip_not_given, async_maybe_transform +from .settings import ( + SettingsResource, + AsyncSettingsResource, + SettingsResourceWithRawResponse, + AsyncSettingsResourceWithRawResponse, + SettingsResourceWithStreamingResponse, + AsyncSettingsResourceWithStreamingResponse, +) +from .template import ( + TemplateResource, + AsyncTemplateResource, + TemplateResourceWithRawResponse, + AsyncTemplateResourceWithRawResponse, + TemplateResourceWithStreamingResponse, + AsyncTemplateResourceWithStreamingResponse, +) +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .suppressions import ( + SuppressionsResource, + AsyncSuppressionsResource, + SuppressionsResourceWithRawResponse, + AsyncSuppressionsResourceWithRawResponse, + SuppressionsResourceWithStreamingResponse, + AsyncSuppressionsResourceWithStreamingResponse, +) +from ..._base_client import make_request_options +from .suppressions_check import ( + SuppressionsCheckResource, + AsyncSuppressionsCheckResource, + SuppressionsCheckResourceWithRawResponse, + AsyncSuppressionsCheckResourceWithRawResponse, + SuppressionsCheckResourceWithStreamingResponse, + AsyncSuppressionsCheckResourceWithStreamingResponse, +) +from ...types.email_list_response import EmailListResponse +from ...types.email_create_response import EmailCreateResponse +from ...types.email_retrieve_response import EmailRetrieveResponse + +__all__ = ["EmailsResource", "AsyncEmailsResource"] + + +class EmailsResource(SyncAPIResource): + @cached_property + def events(self) -> EventsResource: + return EventsResource(self._client) + + @cached_property + def render(self) -> RenderResource: + return RenderResource(self._client) + + @cached_property + def settings(self) -> SettingsResource: + return SettingsResource(self._client) + + @cached_property + def stats(self) -> StatsResource: + return StatsResource(self._client) + + @cached_property + def suppressions(self) -> SuppressionsResource: + return SuppressionsResource(self._client) + + @cached_property + def suppressions_check(self) -> SuppressionsCheckResource: + return SuppressionsCheckResource(self._client) + + @cached_property + def template(self) -> TemplateResource: + return TemplateResource(self._client) + + @cached_property + def with_raw_response(self) -> EmailsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return EmailsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> EmailsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return EmailsResourceWithStreamingResponse(self) + + def create( + self, + *, + from_: str, + html: str, + subject: str, + to: SequenceNotStr[str], + attachments: Iterable[email_create_params.Attachment] | Omit = omit, + bcc: Iterable[object] | Omit = omit, + cc: Iterable[object] | Omit = omit, + headers: Dict[str, str] | Omit = omit, + reply_to: str | Omit = omit, + tags: Dict[str, str] | Omit = omit, + text: str | Omit = omit, + idempotency_key: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailCreateResponse: + """Send a transactional email with raw HTML content. + + The sender domain must be + verified in the project workspace; verified sender domains are shared by every + Developer Email API project in that workspace. + + Args: + from_: Sender email address or "Name " format. Domain must be verified. + + html: HTML content of the email + + subject: Email subject line + + to: Exactly one recipient. Each request creates one independently tracked delivery. + + attachments: File attachments. Max 10 files per email, max 5 MB total payload size (including + headers and base64 overhead). + + bcc: BCC is not supported by this endpoint. + + cc: CC is not supported by this endpoint. + + headers: Custom email headers. Up to 9 printable-ASCII X-\\** headers are allowed (e.g. + {"X-Entity-Ref-ID": "abc123"}). Header names may contain up to 126 characters + and each name plus value may contain up to 996 characters. + + reply_to: Reply-To email address + + tags: Key-value tags for categorizing the email (e.g. {"campaign": "welcome"}). Max 10 + tags. Keys (1-64 chars) and values (up to 256 chars) may only contain letters, + numbers, underscores, and hyphens (the Amazon SES message-tag character set). + + text: Plain text version of the email. If provided, a multipart/alternative message is + sent. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {**strip_not_given({"idempotency-key": idempotency_key}), **(extra_headers or {})} + return self._post( + "/v3/emails", + body=maybe_transform( + { + "from_": from_, + "html": html, + "subject": subject, + "to": to, + "attachments": attachments, + "bcc": bcc, + "cc": cc, + "headers": headers, + "reply_to": reply_to, + "tags": tags, + "text": text, + }, + email_create_params.EmailCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EmailCreateResponse, + ) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailRetrieveResponse: + """ + Retrieve details of a sent email, including its current delivery status, during + the rolling 90-day history window. Expired emails return 404. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/emails/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EmailRetrieveResponse, + ) + + def list( + self, + *, + cursor: str | Omit = omit, + from_: Union[str, date] | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + search: str | Omit = omit, + status: Literal["queued", "sending", "sent", "delivered", "bounced", "complained", "failed"] | Omit = omit, + tag: str | Omit = omit, + to: Union[str, date] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailListResponse: + """ + List emails sent from this project within the rolling 90-day history window. + Without a status filter, results and date bounds use acceptance time. With a + status filter, results and date bounds use the time each email entered that + status. + + Args: + cursor: Pagination cursor from previous response + + from_: Start date (ISO date). Bounds acceptance time normally, or status transition + time when status is supplied. + + limit: Number of emails to return (1-100) + + project_id: Project ID (auto-resolved for API key auth) + + search: Search recipient addresses and subjects by case-sensitive substring + + status: Filter by email delivery status + + tag: Filter by tag in "key=value" format (e.g. "campaign=welcome") + + to: End date (ISO date). Bounds acceptance time normally, or status transition time + when status is supplied. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/emails", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "from_": from_, + "limit": limit, + "project_id": project_id, + "search": search, + "status": status, + "tag": tag, + "to": to, + }, + email_list_params.EmailListParams, + ), + ), + cast_to=EmailListResponse, + ) + + +class AsyncEmailsResource(AsyncAPIResource): + @cached_property + def events(self) -> AsyncEventsResource: + return AsyncEventsResource(self._client) + + @cached_property + def render(self) -> AsyncRenderResource: + return AsyncRenderResource(self._client) + + @cached_property + def settings(self) -> AsyncSettingsResource: + return AsyncSettingsResource(self._client) + + @cached_property + def stats(self) -> AsyncStatsResource: + return AsyncStatsResource(self._client) + + @cached_property + def suppressions(self) -> AsyncSuppressionsResource: + return AsyncSuppressionsResource(self._client) + + @cached_property + def suppressions_check(self) -> AsyncSuppressionsCheckResource: + return AsyncSuppressionsCheckResource(self._client) + + @cached_property + def template(self) -> AsyncTemplateResource: + return AsyncTemplateResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncEmailsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncEmailsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncEmailsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncEmailsResourceWithStreamingResponse(self) + + async def create( + self, + *, + from_: str, + html: str, + subject: str, + to: SequenceNotStr[str], + attachments: Iterable[email_create_params.Attachment] | Omit = omit, + bcc: Iterable[object] | Omit = omit, + cc: Iterable[object] | Omit = omit, + headers: Dict[str, str] | Omit = omit, + reply_to: str | Omit = omit, + tags: Dict[str, str] | Omit = omit, + text: str | Omit = omit, + idempotency_key: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailCreateResponse: + """Send a transactional email with raw HTML content. + + The sender domain must be + verified in the project workspace; verified sender domains are shared by every + Developer Email API project in that workspace. + + Args: + from_: Sender email address or "Name " format. Domain must be verified. + + html: HTML content of the email + + subject: Email subject line + + to: Exactly one recipient. Each request creates one independently tracked delivery. + + attachments: File attachments. Max 10 files per email, max 5 MB total payload size (including + headers and base64 overhead). + + bcc: BCC is not supported by this endpoint. + + cc: CC is not supported by this endpoint. + + headers: Custom email headers. Up to 9 printable-ASCII X-\\** headers are allowed (e.g. + {"X-Entity-Ref-ID": "abc123"}). Header names may contain up to 126 characters + and each name plus value may contain up to 996 characters. + + reply_to: Reply-To email address + + tags: Key-value tags for categorizing the email (e.g. {"campaign": "welcome"}). Max 10 + tags. Keys (1-64 chars) and values (up to 256 chars) may only contain letters, + numbers, underscores, and hyphens (the Amazon SES message-tag character set). + + text: Plain text version of the email. If provided, a multipart/alternative message is + sent. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {**strip_not_given({"idempotency-key": idempotency_key}), **(extra_headers or {})} + return await self._post( + "/v3/emails", + body=await async_maybe_transform( + { + "from_": from_, + "html": html, + "subject": subject, + "to": to, + "attachments": attachments, + "bcc": bcc, + "cc": cc, + "headers": headers, + "reply_to": reply_to, + "tags": tags, + "text": text, + }, + email_create_params.EmailCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EmailCreateResponse, + ) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailRetrieveResponse: + """ + Retrieve details of a sent email, including its current delivery status, during + the rolling 90-day history window. Expired emails return 404. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/emails/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EmailRetrieveResponse, + ) + + async def list( + self, + *, + cursor: str | Omit = omit, + from_: Union[str, date] | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + search: str | Omit = omit, + status: Literal["queued", "sending", "sent", "delivered", "bounced", "complained", "failed"] | Omit = omit, + tag: str | Omit = omit, + to: Union[str, date] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EmailListResponse: + """ + List emails sent from this project within the rolling 90-day history window. + Without a status filter, results and date bounds use acceptance time. With a + status filter, results and date bounds use the time each email entered that + status. + + Args: + cursor: Pagination cursor from previous response + + from_: Start date (ISO date). Bounds acceptance time normally, or status transition + time when status is supplied. + + limit: Number of emails to return (1-100) + + project_id: Project ID (auto-resolved for API key auth) + + search: Search recipient addresses and subjects by case-sensitive substring + + status: Filter by email delivery status + + tag: Filter by tag in "key=value" format (e.g. "campaign=welcome") + + to: End date (ISO date). Bounds acceptance time normally, or status transition time + when status is supplied. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/emails", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "cursor": cursor, + "from_": from_, + "limit": limit, + "project_id": project_id, + "search": search, + "status": status, + "tag": tag, + "to": to, + }, + email_list_params.EmailListParams, + ), + ), + cast_to=EmailListResponse, + ) + + +class EmailsResourceWithRawResponse: + def __init__(self, emails: EmailsResource) -> None: + self._emails = emails + + self.create = to_raw_response_wrapper( + emails.create, + ) + self.retrieve = to_raw_response_wrapper( + emails.retrieve, + ) + self.list = to_raw_response_wrapper( + emails.list, + ) + + @cached_property + def events(self) -> EventsResourceWithRawResponse: + return EventsResourceWithRawResponse(self._emails.events) + + @cached_property + def render(self) -> RenderResourceWithRawResponse: + return RenderResourceWithRawResponse(self._emails.render) + + @cached_property + def settings(self) -> SettingsResourceWithRawResponse: + return SettingsResourceWithRawResponse(self._emails.settings) + + @cached_property + def stats(self) -> StatsResourceWithRawResponse: + return StatsResourceWithRawResponse(self._emails.stats) + + @cached_property + def suppressions(self) -> SuppressionsResourceWithRawResponse: + return SuppressionsResourceWithRawResponse(self._emails.suppressions) + + @cached_property + def suppressions_check(self) -> SuppressionsCheckResourceWithRawResponse: + return SuppressionsCheckResourceWithRawResponse(self._emails.suppressions_check) + + @cached_property + def template(self) -> TemplateResourceWithRawResponse: + return TemplateResourceWithRawResponse(self._emails.template) + + +class AsyncEmailsResourceWithRawResponse: + def __init__(self, emails: AsyncEmailsResource) -> None: + self._emails = emails + + self.create = async_to_raw_response_wrapper( + emails.create, + ) + self.retrieve = async_to_raw_response_wrapper( + emails.retrieve, + ) + self.list = async_to_raw_response_wrapper( + emails.list, + ) + + @cached_property + def events(self) -> AsyncEventsResourceWithRawResponse: + return AsyncEventsResourceWithRawResponse(self._emails.events) + + @cached_property + def render(self) -> AsyncRenderResourceWithRawResponse: + return AsyncRenderResourceWithRawResponse(self._emails.render) + + @cached_property + def settings(self) -> AsyncSettingsResourceWithRawResponse: + return AsyncSettingsResourceWithRawResponse(self._emails.settings) + + @cached_property + def stats(self) -> AsyncStatsResourceWithRawResponse: + return AsyncStatsResourceWithRawResponse(self._emails.stats) + + @cached_property + def suppressions(self) -> AsyncSuppressionsResourceWithRawResponse: + return AsyncSuppressionsResourceWithRawResponse(self._emails.suppressions) + + @cached_property + def suppressions_check(self) -> AsyncSuppressionsCheckResourceWithRawResponse: + return AsyncSuppressionsCheckResourceWithRawResponse(self._emails.suppressions_check) + + @cached_property + def template(self) -> AsyncTemplateResourceWithRawResponse: + return AsyncTemplateResourceWithRawResponse(self._emails.template) + + +class EmailsResourceWithStreamingResponse: + def __init__(self, emails: EmailsResource) -> None: + self._emails = emails + + self.create = to_streamed_response_wrapper( + emails.create, + ) + self.retrieve = to_streamed_response_wrapper( + emails.retrieve, + ) + self.list = to_streamed_response_wrapper( + emails.list, + ) + + @cached_property + def events(self) -> EventsResourceWithStreamingResponse: + return EventsResourceWithStreamingResponse(self._emails.events) + + @cached_property + def render(self) -> RenderResourceWithStreamingResponse: + return RenderResourceWithStreamingResponse(self._emails.render) + + @cached_property + def settings(self) -> SettingsResourceWithStreamingResponse: + return SettingsResourceWithStreamingResponse(self._emails.settings) + + @cached_property + def stats(self) -> StatsResourceWithStreamingResponse: + return StatsResourceWithStreamingResponse(self._emails.stats) + + @cached_property + def suppressions(self) -> SuppressionsResourceWithStreamingResponse: + return SuppressionsResourceWithStreamingResponse(self._emails.suppressions) + + @cached_property + def suppressions_check(self) -> SuppressionsCheckResourceWithStreamingResponse: + return SuppressionsCheckResourceWithStreamingResponse(self._emails.suppressions_check) + + @cached_property + def template(self) -> TemplateResourceWithStreamingResponse: + return TemplateResourceWithStreamingResponse(self._emails.template) + + +class AsyncEmailsResourceWithStreamingResponse: + def __init__(self, emails: AsyncEmailsResource) -> None: + self._emails = emails + + self.create = async_to_streamed_response_wrapper( + emails.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + emails.retrieve, + ) + self.list = async_to_streamed_response_wrapper( + emails.list, + ) + + @cached_property + def events(self) -> AsyncEventsResourceWithStreamingResponse: + return AsyncEventsResourceWithStreamingResponse(self._emails.events) + + @cached_property + def render(self) -> AsyncRenderResourceWithStreamingResponse: + return AsyncRenderResourceWithStreamingResponse(self._emails.render) + + @cached_property + def settings(self) -> AsyncSettingsResourceWithStreamingResponse: + return AsyncSettingsResourceWithStreamingResponse(self._emails.settings) + + @cached_property + def stats(self) -> AsyncStatsResourceWithStreamingResponse: + return AsyncStatsResourceWithStreamingResponse(self._emails.stats) + + @cached_property + def suppressions(self) -> AsyncSuppressionsResourceWithStreamingResponse: + return AsyncSuppressionsResourceWithStreamingResponse(self._emails.suppressions) + + @cached_property + def suppressions_check(self) -> AsyncSuppressionsCheckResourceWithStreamingResponse: + return AsyncSuppressionsCheckResourceWithStreamingResponse(self._emails.suppressions_check) + + @cached_property + def template(self) -> AsyncTemplateResourceWithStreamingResponse: + return AsyncTemplateResourceWithStreamingResponse(self._emails.template) diff --git a/src/unlayer/resources/emails/events.py b/src/unlayer/resources/emails/events.py new file mode 100644 index 0000000..9a27458 --- /dev/null +++ b/src/unlayer/resources/emails/events.py @@ -0,0 +1,168 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails.event_retrieve_response import EventRetrieveResponse + +__all__ = ["EventsResource", "AsyncEventsResource"] + + +class EventsResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> EventsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return EventsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> EventsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return EventsResourceWithStreamingResponse(self) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EventRetrieveResponse: + """ + Retrieve the operational event timeline for a sent email, showing send, + delivery, bounce, and complaint events in chronological order during the rolling + 90-day history window. Expired emails return 404. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/emails/{id}/events", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EventRetrieveResponse, + ) + + +class AsyncEventsResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncEventsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncEventsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncEventsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncEventsResourceWithStreamingResponse(self) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> EventRetrieveResponse: + """ + Retrieve the operational event timeline for a sent email, showing send, + delivery, bounce, and complaint events in chronological order during the rolling + 90-day history window. Expired emails return 404. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/emails/{id}/events", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=EventRetrieveResponse, + ) + + +class EventsResourceWithRawResponse: + def __init__(self, events: EventsResource) -> None: + self._events = events + + self.retrieve = to_raw_response_wrapper( + events.retrieve, + ) + + +class AsyncEventsResourceWithRawResponse: + def __init__(self, events: AsyncEventsResource) -> None: + self._events = events + + self.retrieve = async_to_raw_response_wrapper( + events.retrieve, + ) + + +class EventsResourceWithStreamingResponse: + def __init__(self, events: EventsResource) -> None: + self._events = events + + self.retrieve = to_streamed_response_wrapper( + events.retrieve, + ) + + +class AsyncEventsResourceWithStreamingResponse: + def __init__(self, events: AsyncEventsResource) -> None: + self._events = events + + self.retrieve = async_to_streamed_response_wrapper( + events.retrieve, + ) diff --git a/src/unlayer/resources/emails/render.py b/src/unlayer/resources/emails/render.py new file mode 100644 index 0000000..92a8c90 --- /dev/null +++ b/src/unlayer/resources/emails/render.py @@ -0,0 +1,191 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import render_create_params +from ...types.emails.render_create_response import RenderCreateResponse + +__all__ = ["RenderResource", "AsyncRenderResource"] + + +class RenderResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> RenderResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return RenderResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> RenderResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return RenderResourceWithStreamingResponse(self) + + def create( + self, + *, + template_id: str, + variables: Dict[str, str] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RenderCreateResponse: + """Render a saved email template with optional merge variables. + + Returns the final + HTML without sending. Useful for previewing emails before sending. + + Args: + template_id: Template ID to render + + variables: Merge variables to substitute. Use {{key}} syntax in your template. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/emails/render", + body=maybe_transform( + { + "template_id": template_id, + "variables": variables, + }, + render_create_params.RenderCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RenderCreateResponse, + ) + + +class AsyncRenderResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncRenderResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncRenderResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncRenderResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncRenderResourceWithStreamingResponse(self) + + async def create( + self, + *, + template_id: str, + variables: Dict[str, str] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RenderCreateResponse: + """Render a saved email template with optional merge variables. + + Returns the final + HTML without sending. Useful for previewing emails before sending. + + Args: + template_id: Template ID to render + + variables: Merge variables to substitute. Use {{key}} syntax in your template. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/emails/render", + body=await async_maybe_transform( + { + "template_id": template_id, + "variables": variables, + }, + render_create_params.RenderCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RenderCreateResponse, + ) + + +class RenderResourceWithRawResponse: + def __init__(self, render: RenderResource) -> None: + self._render = render + + self.create = to_raw_response_wrapper( + render.create, + ) + + +class AsyncRenderResourceWithRawResponse: + def __init__(self, render: AsyncRenderResource) -> None: + self._render = render + + self.create = async_to_raw_response_wrapper( + render.create, + ) + + +class RenderResourceWithStreamingResponse: + def __init__(self, render: RenderResource) -> None: + self._render = render + + self.create = to_streamed_response_wrapper( + render.create, + ) + + +class AsyncRenderResourceWithStreamingResponse: + def __init__(self, render: AsyncRenderResource) -> None: + self._render = render + + self.create = async_to_streamed_response_wrapper( + render.create, + ) diff --git a/src/unlayer/resources/emails/settings.py b/src/unlayer/resources/emails/settings.py new file mode 100644 index 0000000..ee14645 --- /dev/null +++ b/src/unlayer/resources/emails/settings.py @@ -0,0 +1,224 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import setting_update_params +from ...types.emails.setting_update_response import SettingUpdateResponse +from ...types.emails.setting_retrieve_response import SettingRetrieveResponse + +__all__ = ["SettingsResource", "AsyncSettingsResource"] + + +class SettingsResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> SettingsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return SettingsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SettingsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return SettingsResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SettingRetrieveResponse: + """Get the email sender settings for this project.""" + return self._get( + "/v3/emails/settings", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SettingRetrieveResponse, + ) + + def update( + self, + *, + default_from_name: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SettingUpdateResponse: + """Update the email sending configuration for this project. + + Only include the fields + you want to change. + + Args: + default_from_name: Default sender display name + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._patch( + "/v3/emails/settings", + body=maybe_transform({"default_from_name": default_from_name}, setting_update_params.SettingUpdateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SettingUpdateResponse, + ) + + +class AsyncSettingsResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncSettingsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncSettingsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSettingsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncSettingsResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SettingRetrieveResponse: + """Get the email sender settings for this project.""" + return await self._get( + "/v3/emails/settings", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SettingRetrieveResponse, + ) + + async def update( + self, + *, + default_from_name: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SettingUpdateResponse: + """Update the email sending configuration for this project. + + Only include the fields + you want to change. + + Args: + default_from_name: Default sender display name + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._patch( + "/v3/emails/settings", + body=await async_maybe_transform( + {"default_from_name": default_from_name}, setting_update_params.SettingUpdateParams + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SettingUpdateResponse, + ) + + +class SettingsResourceWithRawResponse: + def __init__(self, settings: SettingsResource) -> None: + self._settings = settings + + self.retrieve = to_raw_response_wrapper( + settings.retrieve, + ) + self.update = to_raw_response_wrapper( + settings.update, + ) + + +class AsyncSettingsResourceWithRawResponse: + def __init__(self, settings: AsyncSettingsResource) -> None: + self._settings = settings + + self.retrieve = async_to_raw_response_wrapper( + settings.retrieve, + ) + self.update = async_to_raw_response_wrapper( + settings.update, + ) + + +class SettingsResourceWithStreamingResponse: + def __init__(self, settings: SettingsResource) -> None: + self._settings = settings + + self.retrieve = to_streamed_response_wrapper( + settings.retrieve, + ) + self.update = to_streamed_response_wrapper( + settings.update, + ) + + +class AsyncSettingsResourceWithStreamingResponse: + def __init__(self, settings: AsyncSettingsResource) -> None: + self._settings = settings + + self.retrieve = async_to_streamed_response_wrapper( + settings.retrieve, + ) + self.update = async_to_streamed_response_wrapper( + settings.update, + ) diff --git a/src/unlayer/resources/emails/stats.py b/src/unlayer/resources/emails/stats.py new file mode 100644 index 0000000..c130c46 --- /dev/null +++ b/src/unlayer/resources/emails/stats.py @@ -0,0 +1,207 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import stat_retrieve_params +from ...types.emails.stat_retrieve_response import StatRetrieveResponse + +__all__ = ["StatsResource", "AsyncStatsResource"] + + +class StatsResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> StatsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return StatsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> StatsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return StatsResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + group_by: Literal["day"] | Omit = omit, + period: Literal["7d", "30d", "90d"] | Omit = omit, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> StatRetrieveResponse: + """Get aggregated email delivery statistics for a project. + + Returns totals or daily + breakdown for the specified period. Statistics are asynchronous and may lag by + about one hour. + + Args: + group_by: Group results by day for chart data + + period: Time period for stats + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/emails/stats", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "group_by": group_by, + "period": period, + "project_id": project_id, + }, + stat_retrieve_params.StatRetrieveParams, + ), + ), + cast_to=StatRetrieveResponse, + ) + + +class AsyncStatsResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncStatsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncStatsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncStatsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncStatsResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + group_by: Literal["day"] | Omit = omit, + period: Literal["7d", "30d", "90d"] | Omit = omit, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> StatRetrieveResponse: + """Get aggregated email delivery statistics for a project. + + Returns totals or daily + breakdown for the specified period. Statistics are asynchronous and may lag by + about one hour. + + Args: + group_by: Group results by day for chart data + + period: Time period for stats + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/emails/stats", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "group_by": group_by, + "period": period, + "project_id": project_id, + }, + stat_retrieve_params.StatRetrieveParams, + ), + ), + cast_to=StatRetrieveResponse, + ) + + +class StatsResourceWithRawResponse: + def __init__(self, stats: StatsResource) -> None: + self._stats = stats + + self.retrieve = to_raw_response_wrapper( + stats.retrieve, + ) + + +class AsyncStatsResourceWithRawResponse: + def __init__(self, stats: AsyncStatsResource) -> None: + self._stats = stats + + self.retrieve = async_to_raw_response_wrapper( + stats.retrieve, + ) + + +class StatsResourceWithStreamingResponse: + def __init__(self, stats: StatsResource) -> None: + self._stats = stats + + self.retrieve = to_streamed_response_wrapper( + stats.retrieve, + ) + + +class AsyncStatsResourceWithStreamingResponse: + def __init__(self, stats: AsyncStatsResource) -> None: + self._stats = stats + + self.retrieve = async_to_streamed_response_wrapper( + stats.retrieve, + ) diff --git a/src/unlayer/resources/emails/suppressions.py b/src/unlayer/resources/emails/suppressions.py new file mode 100644 index 0000000..c350fe8 --- /dev/null +++ b/src/unlayer/resources/emails/suppressions.py @@ -0,0 +1,393 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import suppression_create_params, suppression_delete_params, suppression_retrieve_params +from ...types.emails.suppression_create_response import SuppressionCreateResponse +from ...types.emails.suppression_delete_response import SuppressionDeleteResponse +from ...types.emails.suppression_retrieve_response import SuppressionRetrieveResponse + +__all__ = ["SuppressionsResource", "AsyncSuppressionsResource"] + + +class SuppressionsResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> SuppressionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return SuppressionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SuppressionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return SuppressionsResourceWithStreamingResponse(self) + + def create( + self, + *, + email: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionCreateResponse: + """Manually add an email address to the suppression list. + + Future sends to this + address will be blocked. + + Args: + email: Email address to suppress + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/emails/suppressions", + body=maybe_transform({"email": email}, suppression_create_params.SuppressionCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SuppressionCreateResponse, + ) + + def retrieve( + self, + *, + cursor: str | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionRetrieveResponse: + """ + List all email addresses suppressed for this project due to bounces, complaints, + or manual suppression. Cursor-paginated. + + Args: + cursor: Pagination cursor from a previous response. Omit to start from the beginning. + + limit: Max number of results (1-200) + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/emails/suppressions", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "cursor": cursor, + "limit": limit, + "project_id": project_id, + }, + suppression_retrieve_params.SuppressionRetrieveParams, + ), + ), + cast_to=SuppressionRetrieveResponse, + ) + + def delete( + self, + *, + email: str, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionDeleteResponse: + """ + Remove an email address from the suppression list so it can receive emails + again. + + Args: + email: Email address to unsuppress + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._delete( + "/v3/emails/suppressions", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "email": email, + "project_id": project_id, + }, + suppression_delete_params.SuppressionDeleteParams, + ), + ), + cast_to=SuppressionDeleteResponse, + ) + + +class AsyncSuppressionsResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncSuppressionsResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncSuppressionsResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSuppressionsResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncSuppressionsResourceWithStreamingResponse(self) + + async def create( + self, + *, + email: str, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionCreateResponse: + """Manually add an email address to the suppression list. + + Future sends to this + address will be blocked. + + Args: + email: Email address to suppress + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/emails/suppressions", + body=await async_maybe_transform({"email": email}, suppression_create_params.SuppressionCreateParams), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=SuppressionCreateResponse, + ) + + async def retrieve( + self, + *, + cursor: str | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionRetrieveResponse: + """ + List all email addresses suppressed for this project due to bounces, complaints, + or manual suppression. Cursor-paginated. + + Args: + cursor: Pagination cursor from a previous response. Omit to start from the beginning. + + limit: Max number of results (1-200) + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/emails/suppressions", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "cursor": cursor, + "limit": limit, + "project_id": project_id, + }, + suppression_retrieve_params.SuppressionRetrieveParams, + ), + ), + cast_to=SuppressionRetrieveResponse, + ) + + async def delete( + self, + *, + email: str, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionDeleteResponse: + """ + Remove an email address from the suppression list so it can receive emails + again. + + Args: + email: Email address to unsuppress + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._delete( + "/v3/emails/suppressions", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "email": email, + "project_id": project_id, + }, + suppression_delete_params.SuppressionDeleteParams, + ), + ), + cast_to=SuppressionDeleteResponse, + ) + + +class SuppressionsResourceWithRawResponse: + def __init__(self, suppressions: SuppressionsResource) -> None: + self._suppressions = suppressions + + self.create = to_raw_response_wrapper( + suppressions.create, + ) + self.retrieve = to_raw_response_wrapper( + suppressions.retrieve, + ) + self.delete = to_raw_response_wrapper( + suppressions.delete, + ) + + +class AsyncSuppressionsResourceWithRawResponse: + def __init__(self, suppressions: AsyncSuppressionsResource) -> None: + self._suppressions = suppressions + + self.create = async_to_raw_response_wrapper( + suppressions.create, + ) + self.retrieve = async_to_raw_response_wrapper( + suppressions.retrieve, + ) + self.delete = async_to_raw_response_wrapper( + suppressions.delete, + ) + + +class SuppressionsResourceWithStreamingResponse: + def __init__(self, suppressions: SuppressionsResource) -> None: + self._suppressions = suppressions + + self.create = to_streamed_response_wrapper( + suppressions.create, + ) + self.retrieve = to_streamed_response_wrapper( + suppressions.retrieve, + ) + self.delete = to_streamed_response_wrapper( + suppressions.delete, + ) + + +class AsyncSuppressionsResourceWithStreamingResponse: + def __init__(self, suppressions: AsyncSuppressionsResource) -> None: + self._suppressions = suppressions + + self.create = async_to_streamed_response_wrapper( + suppressions.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + suppressions.retrieve, + ) + self.delete = async_to_streamed_response_wrapper( + suppressions.delete, + ) diff --git a/src/unlayer/resources/emails/suppressions_check.py b/src/unlayer/resources/emails/suppressions_check.py new file mode 100644 index 0000000..226996f --- /dev/null +++ b/src/unlayer/resources/emails/suppressions_check.py @@ -0,0 +1,193 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import suppressions_check_retrieve_params +from ...types.emails.suppressions_check_retrieve_response import SuppressionsCheckRetrieveResponse + +__all__ = ["SuppressionsCheckResource", "AsyncSuppressionsCheckResource"] + + +class SuppressionsCheckResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> SuppressionsCheckResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return SuppressionsCheckResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SuppressionsCheckResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return SuppressionsCheckResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + email: str, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionsCheckRetrieveResponse: + """ + Look up a specific email address to see if it is currently on the suppression + list. + + Args: + email: Email address to check + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/emails/suppressions/check", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "email": email, + "project_id": project_id, + }, + suppressions_check_retrieve_params.SuppressionsCheckRetrieveParams, + ), + ), + cast_to=SuppressionsCheckRetrieveResponse, + ) + + +class AsyncSuppressionsCheckResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncSuppressionsCheckResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncSuppressionsCheckResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSuppressionsCheckResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncSuppressionsCheckResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + email: str, + project_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> SuppressionsCheckRetrieveResponse: + """ + Look up a specific email address to see if it is currently on the suppression + list. + + Args: + email: Email address to check + + project_id: Project ID (auto-resolved for API key auth) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/emails/suppressions/check", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "email": email, + "project_id": project_id, + }, + suppressions_check_retrieve_params.SuppressionsCheckRetrieveParams, + ), + ), + cast_to=SuppressionsCheckRetrieveResponse, + ) + + +class SuppressionsCheckResourceWithRawResponse: + def __init__(self, suppressions_check: SuppressionsCheckResource) -> None: + self._suppressions_check = suppressions_check + + self.retrieve = to_raw_response_wrapper( + suppressions_check.retrieve, + ) + + +class AsyncSuppressionsCheckResourceWithRawResponse: + def __init__(self, suppressions_check: AsyncSuppressionsCheckResource) -> None: + self._suppressions_check = suppressions_check + + self.retrieve = async_to_raw_response_wrapper( + suppressions_check.retrieve, + ) + + +class SuppressionsCheckResourceWithStreamingResponse: + def __init__(self, suppressions_check: SuppressionsCheckResource) -> None: + self._suppressions_check = suppressions_check + + self.retrieve = to_streamed_response_wrapper( + suppressions_check.retrieve, + ) + + +class AsyncSuppressionsCheckResourceWithStreamingResponse: + def __init__(self, suppressions_check: AsyncSuppressionsCheckResource) -> None: + self._suppressions_check = suppressions_check + + self.retrieve = async_to_streamed_response_wrapper( + suppressions_check.retrieve, + ) diff --git a/src/unlayer/resources/emails/template.py b/src/unlayer/resources/emails/template.py new file mode 100644 index 0000000..f9fa1db --- /dev/null +++ b/src/unlayer/resources/emails/template.py @@ -0,0 +1,291 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Iterable + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given +from ..._utils import maybe_transform, strip_not_given, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.emails import template_create_params +from ...types.emails.template_create_response import TemplateCreateResponse + +__all__ = ["TemplateResource", "AsyncTemplateResource"] + + +class TemplateResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> TemplateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return TemplateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> TemplateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return TemplateResourceWithStreamingResponse(self) + + def create( + self, + *, + from_: str, + template_id: str, + to: SequenceNotStr[str], + attachments: Iterable[template_create_params.Attachment] | Omit = omit, + bcc: Iterable[object] | Omit = omit, + cc: Iterable[object] | Omit = omit, + headers: Dict[str, str] | Omit = omit, + reply_to: str | Omit = omit, + subject: str | Omit = omit, + tags: Dict[str, str] | Omit = omit, + text: str | Omit = omit, + variables: Dict[str, str] | Omit = omit, + idempotency_key: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> TemplateCreateResponse: + """ + Send a transactional email by rendering a saved template with optional merge + variables. The template must have rendered HTML (saved at least once in the + editor). The sender domain must be verified in the project workspace; verified + sender domains are shared by every Developer Email API project in that + workspace. + + Args: + from_: Sender email address or "Name " format. Domain must be verified. + + template_id: Template ID to use for the email body + + to: Exactly one recipient. Each request creates one independently tracked delivery. + + attachments: File attachments. Max 10 files per email, max 5 MB total payload size. + + bcc: BCC is not supported by this endpoint. + + cc: CC is not supported by this endpoint. + + headers: Custom email headers. Up to 9 printable-ASCII X-\\** headers are allowed. Header + names may contain up to 126 characters and each name plus value may contain up + to 996 characters. + + reply_to: Reply-To email address + + subject: Email subject line. Supports {{variable}} merge syntax. Defaults to template + name if omitted. + + tags: Key-value tags for categorizing the email (e.g. {"campaign": "welcome"}). Max 10 + tags. Keys (1-64 chars) and values (up to 256 chars) may only contain letters, + numbers, underscores, and hyphens (the Amazon SES message-tag character set). + + text: Plain text version of the email. Supports {{variable}} merge syntax. + + variables: Merge variables to substitute in the template and subject. Use {{key}} syntax in + your template. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {**strip_not_given({"idempotency-key": idempotency_key}), **(extra_headers or {})} + return self._post( + "/v3/emails/template", + body=maybe_transform( + { + "from_": from_, + "template_id": template_id, + "to": to, + "attachments": attachments, + "bcc": bcc, + "cc": cc, + "headers": headers, + "reply_to": reply_to, + "subject": subject, + "tags": tags, + "text": text, + "variables": variables, + }, + template_create_params.TemplateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=TemplateCreateResponse, + ) + + +class AsyncTemplateResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncTemplateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncTemplateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncTemplateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncTemplateResourceWithStreamingResponse(self) + + async def create( + self, + *, + from_: str, + template_id: str, + to: SequenceNotStr[str], + attachments: Iterable[template_create_params.Attachment] | Omit = omit, + bcc: Iterable[object] | Omit = omit, + cc: Iterable[object] | Omit = omit, + headers: Dict[str, str] | Omit = omit, + reply_to: str | Omit = omit, + subject: str | Omit = omit, + tags: Dict[str, str] | Omit = omit, + text: str | Omit = omit, + variables: Dict[str, str] | Omit = omit, + idempotency_key: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> TemplateCreateResponse: + """ + Send a transactional email by rendering a saved template with optional merge + variables. The template must have rendered HTML (saved at least once in the + editor). The sender domain must be verified in the project workspace; verified + sender domains are shared by every Developer Email API project in that + workspace. + + Args: + from_: Sender email address or "Name " format. Domain must be verified. + + template_id: Template ID to use for the email body + + to: Exactly one recipient. Each request creates one independently tracked delivery. + + attachments: File attachments. Max 10 files per email, max 5 MB total payload size. + + bcc: BCC is not supported by this endpoint. + + cc: CC is not supported by this endpoint. + + headers: Custom email headers. Up to 9 printable-ASCII X-\\** headers are allowed. Header + names may contain up to 126 characters and each name plus value may contain up + to 996 characters. + + reply_to: Reply-To email address + + subject: Email subject line. Supports {{variable}} merge syntax. Defaults to template + name if omitted. + + tags: Key-value tags for categorizing the email (e.g. {"campaign": "welcome"}). Max 10 + tags. Keys (1-64 chars) and values (up to 256 chars) may only contain letters, + numbers, underscores, and hyphens (the Amazon SES message-tag character set). + + text: Plain text version of the email. Supports {{variable}} merge syntax. + + variables: Merge variables to substitute in the template and subject. Use {{key}} syntax in + your template. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {**strip_not_given({"idempotency-key": idempotency_key}), **(extra_headers or {})} + return await self._post( + "/v3/emails/template", + body=await async_maybe_transform( + { + "from_": from_, + "template_id": template_id, + "to": to, + "attachments": attachments, + "bcc": bcc, + "cc": cc, + "headers": headers, + "reply_to": reply_to, + "subject": subject, + "tags": tags, + "text": text, + "variables": variables, + }, + template_create_params.TemplateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=TemplateCreateResponse, + ) + + +class TemplateResourceWithRawResponse: + def __init__(self, template: TemplateResource) -> None: + self._template = template + + self.create = to_raw_response_wrapper( + template.create, + ) + + +class AsyncTemplateResourceWithRawResponse: + def __init__(self, template: AsyncTemplateResource) -> None: + self._template = template + + self.create = async_to_raw_response_wrapper( + template.create, + ) + + +class TemplateResourceWithStreamingResponse: + def __init__(self, template: TemplateResource) -> None: + self._template = template + + self.create = to_streamed_response_wrapper( + template.create, + ) + + +class AsyncTemplateResourceWithStreamingResponse: + def __init__(self, template: AsyncTemplateResource) -> None: + self._template = template + + self.create = async_to_streamed_response_wrapper( + template.create, + ) diff --git a/src/unlayer/resources/templates/__init__.py b/src/unlayer/resources/templates/__init__.py index 9f97937..a27e7e1 100644 --- a/src/unlayer/resources/templates/__init__.py +++ b/src/unlayer/resources/templates/__init__.py @@ -1,5 +1,13 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. +from .schema import ( + SchemaResource, + AsyncSchemaResource, + SchemaResourceWithRawResponse, + AsyncSchemaResourceWithRawResponse, + SchemaResourceWithStreamingResponse, + AsyncSchemaResourceWithStreamingResponse, +) from .import_ import ( ImportResource, AsyncImportResource, @@ -16,6 +24,14 @@ GenerateResourceWithStreamingResponse, AsyncGenerateResourceWithStreamingResponse, ) +from .validate import ( + ValidateResource, + AsyncValidateResource, + ValidateResourceWithRawResponse, + AsyncValidateResourceWithRawResponse, + ValidateResourceWithStreamingResponse, + AsyncValidateResourceWithStreamingResponse, +) from .templates import ( TemplatesResource, AsyncTemplatesResource, @@ -122,6 +138,18 @@ "AsyncImportResourceWithRawResponse", "ImportResourceWithStreamingResponse", "AsyncImportResourceWithStreamingResponse", + "SchemaResource", + "AsyncSchemaResource", + "SchemaResourceWithRawResponse", + "AsyncSchemaResourceWithRawResponse", + "SchemaResourceWithStreamingResponse", + "AsyncSchemaResourceWithStreamingResponse", + "ValidateResource", + "AsyncValidateResource", + "ValidateResourceWithRawResponse", + "AsyncValidateResourceWithRawResponse", + "ValidateResourceWithStreamingResponse", + "AsyncValidateResourceWithStreamingResponse", "TemplatesResource", "AsyncTemplatesResource", "TemplatesResourceWithRawResponse", diff --git a/src/unlayer/resources/templates/convert_full_to_simple.py b/src/unlayer/resources/templates/convert_full_to_simple.py index d1a2b3b..c66c74e 100644 --- a/src/unlayer/resources/templates/convert_full_to_simple.py +++ b/src/unlayer/resources/templates/convert_full_to_simple.py @@ -65,6 +65,11 @@ def create( Convert design json from Full to Simple schema. Args: + display_mode: Display mode of the design (email, web, document, popup). Defaults to "email", + matching /v3/templates/validate. Mode-specific repairs apply during conversion + (email caps contentWidth at 900px, for example), so pass the design's actual + mode — a web design converted under the email default can be altered. + include_conversion: When true, includes \\__conversion metadata in the response. This metadata can be passed to simple-to-full to restore original values without data loss. @@ -136,6 +141,11 @@ async def create( Convert design json from Full to Simple schema. Args: + display_mode: Display mode of the design (email, web, document, popup). Defaults to "email", + matching /v3/templates/validate. Mode-specific repairs apply during conversion + (email caps contentWidth at 900px, for example), so pass the design's actual + mode — a web design converted under the email default can be altered. + include_conversion: When true, includes \\__conversion metadata in the response. This metadata can be passed to simple-to-full to restore original values without data loss. diff --git a/src/unlayer/resources/templates/convert_simple_to_full.py b/src/unlayer/resources/templates/convert_simple_to_full.py index 3023dbd..7e2d717 100644 --- a/src/unlayer/resources/templates/convert_simple_to_full.py +++ b/src/unlayer/resources/templates/convert_simple_to_full.py @@ -64,6 +64,11 @@ def create( Convert design json from Simple to Full schema. Args: + display_mode: Display mode of the design (email, web, document, popup). Defaults to "email", + matching /v3/templates/validate. Mode-specific repairs apply during conversion + (email caps contentWidth at 900px, for example), so pass the design's actual + mode — a web design converted under the email default can be altered. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request @@ -130,6 +135,11 @@ async def create( Convert design json from Simple to Full schema. Args: + display_mode: Display mode of the design (email, web, document, popup). Defaults to "email", + matching /v3/templates/validate. Mode-specific repairs apply during conversion + (email caps contentWidth at 900px, for example), so pass the design's actual + mode — a web design converted under the email default can be altered. + extra_headers: Send extra headers extra_query: Add additional query parameters to the request diff --git a/src/unlayer/resources/templates/schema.py b/src/unlayer/resources/templates/schema.py new file mode 100644 index 0000000..fdb764f --- /dev/null +++ b/src/unlayer/resources/templates/schema.py @@ -0,0 +1,214 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import schema_retrieve_params + +__all__ = ["SchemaResource", "AsyncSchemaResource"] + + +class SchemaResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> SchemaResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return SchemaResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> SchemaResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return SchemaResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + simple: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """ + Returns the canonical design schema as a standard JSON Schema document — the + exact schema POST /v3/templates/validate checks against, ready to plug into any + JSON Schema validator or editor tooling. Serves the Full schema by default; pass + simple=true for the compact Simple schema. No authentication required. Responses + carry a strong ETag and long-lived cache headers; send If-None-Match to + revalidate for free. + + Args: + display_mode: Display mode whose rules the schema describes (email, web, document, popup). + Defaults to "email". + + simple: When true, returns the Simple schema instead of the Full schema. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return self._get( + "/v3/templates/schema", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "display_mode": display_mode, + "simple": simple, + }, + schema_retrieve_params.SchemaRetrieveParams, + ), + ), + cast_to=NoneType, + ) + + +class AsyncSchemaResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> AsyncSchemaResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncSchemaResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncSchemaResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncSchemaResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + simple: bool | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> None: + """ + Returns the canonical design schema as a standard JSON Schema document — the + exact schema POST /v3/templates/validate checks against, ready to plug into any + JSON Schema validator or editor tooling. Serves the Full schema by default; pass + simple=true for the compact Simple schema. No authentication required. Responses + carry a strong ETag and long-lived cache headers; send If-None-Match to + revalidate for free. + + Args: + display_mode: Display mode whose rules the schema describes (email, web, document, popup). + Defaults to "email". + + simple: When true, returns the Simple schema instead of the Full schema. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + extra_headers = {"Accept": "*/*", **(extra_headers or {})} + return await self._get( + "/v3/templates/schema", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "display_mode": display_mode, + "simple": simple, + }, + schema_retrieve_params.SchemaRetrieveParams, + ), + ), + cast_to=NoneType, + ) + + +class SchemaResourceWithRawResponse: + def __init__(self, schema: SchemaResource) -> None: + self._schema = schema + + self.retrieve = to_raw_response_wrapper( + schema.retrieve, + ) + + +class AsyncSchemaResourceWithRawResponse: + def __init__(self, schema: AsyncSchemaResource) -> None: + self._schema = schema + + self.retrieve = async_to_raw_response_wrapper( + schema.retrieve, + ) + + +class SchemaResourceWithStreamingResponse: + def __init__(self, schema: SchemaResource) -> None: + self._schema = schema + + self.retrieve = to_streamed_response_wrapper( + schema.retrieve, + ) + + +class AsyncSchemaResourceWithStreamingResponse: + def __init__(self, schema: AsyncSchemaResource) -> None: + self._schema = schema + + self.retrieve = async_to_streamed_response_wrapper( + schema.retrieve, + ) diff --git a/src/unlayer/resources/templates/templates.py b/src/unlayer/resources/templates/templates.py index 8d3e9b8..1532029 100644 --- a/src/unlayer/resources/templates/templates.py +++ b/src/unlayer/resources/templates/templates.py @@ -6,6 +6,14 @@ import httpx +from .schema import ( + SchemaResource, + AsyncSchemaResource, + SchemaResourceWithRawResponse, + AsyncSchemaResourceWithRawResponse, + SchemaResourceWithStreamingResponse, + AsyncSchemaResourceWithStreamingResponse, +) from ...types import template_list_params, template_retrieve_params from .import_ import ( ImportResource, @@ -25,6 +33,14 @@ GenerateResourceWithStreamingResponse, AsyncGenerateResourceWithStreamingResponse, ) +from .validate import ( + ValidateResource, + AsyncValidateResource, + ValidateResourceWithRawResponse, + AsyncValidateResourceWithRawResponse, + ValidateResourceWithStreamingResponse, + AsyncValidateResourceWithStreamingResponse, +) from ..._compat import cached_property from .export_pdf import ( ExportPdfResource, @@ -135,6 +151,20 @@ def import_(self) -> ImportResource: """ return ImportResource(self._client) + @cached_property + def schema(self) -> SchemaResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return SchemaResource(self._client) + + @cached_property + def validate(self) -> ValidateResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ValidateResource(self._client) + @cached_property def with_raw_response(self) -> TemplatesResourceWithRawResponse: """ @@ -302,6 +332,20 @@ def import_(self) -> AsyncImportResource: """ return AsyncImportResource(self._client) + @cached_property + def schema(self) -> AsyncSchemaResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncSchemaResource(self._client) + + @cached_property + def validate(self) -> AsyncValidateResource: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncValidateResource(self._client) + @cached_property def with_raw_response(self) -> AsyncTemplatesResourceWithRawResponse: """ @@ -477,6 +521,20 @@ def import_(self) -> ImportResourceWithRawResponse: """ return ImportResourceWithRawResponse(self._templates.import_) + @cached_property + def schema(self) -> SchemaResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return SchemaResourceWithRawResponse(self._templates.schema) + + @cached_property + def validate(self) -> ValidateResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ValidateResourceWithRawResponse(self._templates.validate) + class AsyncTemplatesResourceWithRawResponse: def __init__(self, templates: AsyncTemplatesResource) -> None: @@ -530,6 +588,20 @@ def import_(self) -> AsyncImportResourceWithRawResponse: """ return AsyncImportResourceWithRawResponse(self._templates.import_) + @cached_property + def schema(self) -> AsyncSchemaResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncSchemaResourceWithRawResponse(self._templates.schema) + + @cached_property + def validate(self) -> AsyncValidateResourceWithRawResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncValidateResourceWithRawResponse(self._templates.validate) + class TemplatesResourceWithStreamingResponse: def __init__(self, templates: TemplatesResource) -> None: @@ -583,6 +655,20 @@ def import_(self) -> ImportResourceWithStreamingResponse: """ return ImportResourceWithStreamingResponse(self._templates.import_) + @cached_property + def schema(self) -> SchemaResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return SchemaResourceWithStreamingResponse(self._templates.schema) + + @cached_property + def validate(self) -> ValidateResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return ValidateResourceWithStreamingResponse(self._templates.validate) + class AsyncTemplatesResourceWithStreamingResponse: def __init__(self, templates: AsyncTemplatesResource) -> None: @@ -635,3 +721,17 @@ def import_(self) -> AsyncImportResourceWithStreamingResponse: Template management — list, retrieve, generate, import, export, and convert designs. """ return AsyncImportResourceWithStreamingResponse(self._templates.import_) + + @cached_property + def schema(self) -> AsyncSchemaResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncSchemaResourceWithStreamingResponse(self._templates.schema) + + @cached_property + def validate(self) -> AsyncValidateResourceWithStreamingResponse: + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + return AsyncValidateResourceWithStreamingResponse(self._templates.validate) diff --git a/src/unlayer/resources/templates/validate.py b/src/unlayer/resources/templates/validate.py new file mode 100644 index 0000000..9174950 --- /dev/null +++ b/src/unlayer/resources/templates/validate.py @@ -0,0 +1,254 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Iterable +from typing_extensions import Literal + +import httpx + +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.templates import validate_create_params +from ...types.templates.validate_create_response import ValidateCreateResponse + +__all__ = ["ValidateResource", "AsyncValidateResource"] + + +class ValidateResource(SyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> ValidateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return ValidateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> ValidateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return ValidateResourceWithStreamingResponse(self) + + def create( + self, + *, + design: Dict[str, object], + custom_tools: Iterable[validate_create_params.CustomTool] | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + migrate: bool | Omit = omit, + schema: Literal["full", "simple"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ValidateCreateResponse: + """Validate a design JSON against the Unlayer design schema. + + Returns { success: + true, data: { valid: true } } when the payload conforms; otherwise data is { + valid: false, errors: [...] } with descriptive issues. Every checked design gets + HTTP 200 — `data.valid` is the source of truth, not the status code. Only + malformed requests (e.g. a missing design field or an unknown displayMode) fail + request validation with 400 VALIDATION_ERROR. + + Args: + design: The design JSON to validate. + + custom_tools: Custom tool declarations, in the same shape passed to unlayer.registerTool. When + provided, blocks matching a declared tool have their values checked against the + tool's declared options (wrong types are reported at their exact path). Blocks + of undeclared tools keep envelope-only validation. + + display_mode: Display mode for the design (email, web, document, popup). Some validation rules + differ per mode. Defaults to "email" — without a default, options from every + mode would apply at once, the strictest possible check, and real editor-saved + designs could be reported invalid. + + migrate: When true (default), a full-form design with an older schemaVersion is upgraded + to the current schema before validating — matching how the editor and the + convert endpoints treat stored designs. Designs without a schemaVersion predate + versioning and are fully migrated the same way. Set to false to check strict + conformance with the current schema version. Designs with a newer schemaVersion + than this API knows are validated as-if-current. + + schema: Which form of the schema to validate against. Defaults to "full". + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/templates/validate", + body=maybe_transform( + { + "design": design, + "custom_tools": custom_tools, + "display_mode": display_mode, + "migrate": migrate, + "schema": schema, + }, + validate_create_params.ValidateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ValidateCreateResponse, + ) + + +class AsyncValidateResource(AsyncAPIResource): + """ + Template management — list, retrieve, generate, import, export, and convert designs. + """ + + @cached_property + def with_raw_response(self) -> AsyncValidateResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncValidateResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncValidateResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncValidateResourceWithStreamingResponse(self) + + async def create( + self, + *, + design: Dict[str, object], + custom_tools: Iterable[validate_create_params.CustomTool] | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + migrate: bool | Omit = omit, + schema: Literal["full", "simple"] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> ValidateCreateResponse: + """Validate a design JSON against the Unlayer design schema. + + Returns { success: + true, data: { valid: true } } when the payload conforms; otherwise data is { + valid: false, errors: [...] } with descriptive issues. Every checked design gets + HTTP 200 — `data.valid` is the source of truth, not the status code. Only + malformed requests (e.g. a missing design field or an unknown displayMode) fail + request validation with 400 VALIDATION_ERROR. + + Args: + design: The design JSON to validate. + + custom_tools: Custom tool declarations, in the same shape passed to unlayer.registerTool. When + provided, blocks matching a declared tool have their values checked against the + tool's declared options (wrong types are reported at their exact path). Blocks + of undeclared tools keep envelope-only validation. + + display_mode: Display mode for the design (email, web, document, popup). Some validation rules + differ per mode. Defaults to "email" — without a default, options from every + mode would apply at once, the strictest possible check, and real editor-saved + designs could be reported invalid. + + migrate: When true (default), a full-form design with an older schemaVersion is upgraded + to the current schema before validating — matching how the editor and the + convert endpoints treat stored designs. Designs without a schemaVersion predate + versioning and are fully migrated the same way. Set to false to check strict + conformance with the current schema version. Designs with a newer schemaVersion + than this API knows are validated as-if-current. + + schema: Which form of the schema to validate against. Defaults to "full". + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/templates/validate", + body=await async_maybe_transform( + { + "design": design, + "custom_tools": custom_tools, + "display_mode": display_mode, + "migrate": migrate, + "schema": schema, + }, + validate_create_params.ValidateCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=ValidateCreateResponse, + ) + + +class ValidateResourceWithRawResponse: + def __init__(self, validate: ValidateResource) -> None: + self._validate = validate + + self.create = to_raw_response_wrapper( + validate.create, + ) + + +class AsyncValidateResourceWithRawResponse: + def __init__(self, validate: AsyncValidateResource) -> None: + self._validate = validate + + self.create = async_to_raw_response_wrapper( + validate.create, + ) + + +class ValidateResourceWithStreamingResponse: + def __init__(self, validate: ValidateResource) -> None: + self._validate = validate + + self.create = to_streamed_response_wrapper( + validate.create, + ) + + +class AsyncValidateResourceWithStreamingResponse: + def __init__(self, validate: AsyncValidateResource) -> None: + self._validate = validate + + self.create = async_to_streamed_response_wrapper( + validate.create, + ) diff --git a/src/unlayer/resources/webhooks/__init__.py b/src/unlayer/resources/webhooks/__init__.py new file mode 100644 index 0000000..469c5c1 --- /dev/null +++ b/src/unlayer/resources/webhooks/__init__.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from .webhooks import ( + WebhooksResource, + AsyncWebhooksResource, + WebhooksResourceWithRawResponse, + AsyncWebhooksResourceWithRawResponse, + WebhooksResourceWithStreamingResponse, + AsyncWebhooksResourceWithStreamingResponse, +) +from .rotate_secret import ( + RotateSecretResource, + AsyncRotateSecretResource, + RotateSecretResourceWithRawResponse, + AsyncRotateSecretResourceWithRawResponse, + RotateSecretResourceWithStreamingResponse, + AsyncRotateSecretResourceWithStreamingResponse, +) + +__all__ = [ + "RotateSecretResource", + "AsyncRotateSecretResource", + "RotateSecretResourceWithRawResponse", + "AsyncRotateSecretResourceWithRawResponse", + "RotateSecretResourceWithStreamingResponse", + "AsyncRotateSecretResourceWithStreamingResponse", + "WebhooksResource", + "AsyncWebhooksResource", + "WebhooksResourceWithRawResponse", + "AsyncWebhooksResourceWithRawResponse", + "WebhooksResourceWithStreamingResponse", + "AsyncWebhooksResourceWithStreamingResponse", +] diff --git a/src/unlayer/resources/webhooks/rotate_secret.py b/src/unlayer/resources/webhooks/rotate_secret.py new file mode 100644 index 0000000..27cbf6f --- /dev/null +++ b/src/unlayer/resources/webhooks/rotate_secret.py @@ -0,0 +1,168 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import httpx + +from ..._types import Body, Query, Headers, NotGiven, not_given +from ..._utils import path_template +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from ..._base_client import make_request_options +from ...types.webhooks.rotate_secret_create_response import RotateSecretCreateResponse + +__all__ = ["RotateSecretResource", "AsyncRotateSecretResource"] + + +class RotateSecretResource(SyncAPIResource): + @cached_property + def with_raw_response(self) -> RotateSecretResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return RotateSecretResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> RotateSecretResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return RotateSecretResourceWithStreamingResponse(self) + + def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RotateSecretCreateResponse: + """Generate a new signing secret for a webhook. + + The new secret is returned once — + store it securely. The old secret is invalidated immediately. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._post( + path_template("/v3/webhooks/{id}/rotate-secret", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RotateSecretCreateResponse, + ) + + +class AsyncRotateSecretResource(AsyncAPIResource): + @cached_property + def with_raw_response(self) -> AsyncRotateSecretResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncRotateSecretResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncRotateSecretResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncRotateSecretResourceWithStreamingResponse(self) + + async def create( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> RotateSecretCreateResponse: + """Generate a new signing secret for a webhook. + + The new secret is returned once — + store it securely. The old secret is invalidated immediately. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._post( + path_template("/v3/webhooks/{id}/rotate-secret", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=RotateSecretCreateResponse, + ) + + +class RotateSecretResourceWithRawResponse: + def __init__(self, rotate_secret: RotateSecretResource) -> None: + self._rotate_secret = rotate_secret + + self.create = to_raw_response_wrapper( + rotate_secret.create, + ) + + +class AsyncRotateSecretResourceWithRawResponse: + def __init__(self, rotate_secret: AsyncRotateSecretResource) -> None: + self._rotate_secret = rotate_secret + + self.create = async_to_raw_response_wrapper( + rotate_secret.create, + ) + + +class RotateSecretResourceWithStreamingResponse: + def __init__(self, rotate_secret: RotateSecretResource) -> None: + self._rotate_secret = rotate_secret + + self.create = to_streamed_response_wrapper( + rotate_secret.create, + ) + + +class AsyncRotateSecretResourceWithStreamingResponse: + def __init__(self, rotate_secret: AsyncRotateSecretResource) -> None: + self._rotate_secret = rotate_secret + + self.create = async_to_streamed_response_wrapper( + rotate_secret.create, + ) diff --git a/src/unlayer/resources/webhooks/webhooks.py b/src/unlayer/resources/webhooks/webhooks.py new file mode 100644 index 0000000..56cdfdc --- /dev/null +++ b/src/unlayer/resources/webhooks/webhooks.py @@ -0,0 +1,556 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import List +from typing_extensions import Literal + +import httpx + +from ...types import webhook_create_params, webhook_update_params +from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from ..._utils import path_template, maybe_transform, async_maybe_transform +from ..._compat import cached_property +from ..._resource import SyncAPIResource, AsyncAPIResource +from ..._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .rotate_secret import ( + RotateSecretResource, + AsyncRotateSecretResource, + RotateSecretResourceWithRawResponse, + AsyncRotateSecretResourceWithRawResponse, + RotateSecretResourceWithStreamingResponse, + AsyncRotateSecretResourceWithStreamingResponse, +) +from ..._base_client import make_request_options +from ...types.webhook_list_response import WebhookListResponse +from ...types.webhook_create_response import WebhookCreateResponse +from ...types.webhook_delete_response import WebhookDeleteResponse +from ...types.webhook_update_response import WebhookUpdateResponse +from ...types.webhook_retrieve_response import WebhookRetrieveResponse + +__all__ = ["WebhooksResource", "AsyncWebhooksResource"] + + +class WebhooksResource(SyncAPIResource): + @cached_property + def rotate_secret(self) -> RotateSecretResource: + return RotateSecretResource(self._client) + + @cached_property + def with_raw_response(self) -> WebhooksResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return WebhooksResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> WebhooksResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return WebhooksResourceWithStreamingResponse(self) + + def create( + self, + *, + url: str, + active: bool | Omit = omit, + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookCreateResponse: + """Create a new webhook endpoint. + + A signing secret is auto-generated and returned + once. Use it to verify webhook signatures. + + Args: + url: The HTTPS URL to receive webhook events + + active: Whether the webhook is active + + events: Event types to subscribe to. If omitted or empty, all events are sent. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._post( + "/v3/webhooks", + body=maybe_transform( + { + "url": url, + "active": active, + "events": events, + }, + webhook_create_params.WebhookCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookCreateResponse, + ) + + def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookRetrieveResponse: + """ + Get details of a specific webhook endpoint. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._get( + path_template("/v3/webhooks/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookRetrieveResponse, + ) + + def update( + self, + id: str, + *, + active: bool | Omit = omit, + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] | Omit = omit, + url: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookUpdateResponse: + """ + Update a webhook endpoint URL, events, or active status. + + Args: + active: Whether the webhook is actively receiving events + + events: Event types to subscribe to. If omitted or empty, all events are sent. + + url: The HTTPS URL to receive webhook events + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._patch( + path_template("/v3/webhooks/{id}", id=id), + body=maybe_transform( + { + "active": active, + "events": events, + "url": url, + }, + webhook_update_params.WebhookUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookUpdateResponse, + ) + + def list( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookListResponse: + """List all webhook endpoints configured for a project.""" + return self._get( + "/v3/webhooks", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookListResponse, + ) + + def delete( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookDeleteResponse: + """Delete a webhook endpoint. + + It will no longer receive events. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return self._delete( + path_template("/v3/webhooks/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookDeleteResponse, + ) + + +class AsyncWebhooksResource(AsyncAPIResource): + @cached_property + def rotate_secret(self) -> AsyncRotateSecretResource: + return AsyncRotateSecretResource(self._client) + + @cached_property + def with_raw_response(self) -> AsyncWebhooksResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncWebhooksResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncWebhooksResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncWebhooksResourceWithStreamingResponse(self) + + async def create( + self, + *, + url: str, + active: bool | Omit = omit, + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookCreateResponse: + """Create a new webhook endpoint. + + A signing secret is auto-generated and returned + once. Use it to verify webhook signatures. + + Args: + url: The HTTPS URL to receive webhook events + + active: Whether the webhook is active + + events: Event types to subscribe to. If omitted or empty, all events are sent. + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._post( + "/v3/webhooks", + body=await async_maybe_transform( + { + "url": url, + "active": active, + "events": events, + }, + webhook_create_params.WebhookCreateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookCreateResponse, + ) + + async def retrieve( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookRetrieveResponse: + """ + Get details of a specific webhook endpoint. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._get( + path_template("/v3/webhooks/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookRetrieveResponse, + ) + + async def update( + self, + id: str, + *, + active: bool | Omit = omit, + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] | Omit = omit, + url: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookUpdateResponse: + """ + Update a webhook endpoint URL, events, or active status. + + Args: + active: Whether the webhook is actively receiving events + + events: Event types to subscribe to. If omitted or empty, all events are sent. + + url: The HTTPS URL to receive webhook events + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._patch( + path_template("/v3/webhooks/{id}", id=id), + body=await async_maybe_transform( + { + "active": active, + "events": events, + "url": url, + }, + webhook_update_params.WebhookUpdateParams, + ), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookUpdateResponse, + ) + + async def list( + self, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookListResponse: + """List all webhook endpoints configured for a project.""" + return await self._get( + "/v3/webhooks", + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookListResponse, + ) + + async def delete( + self, + id: str, + *, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> WebhookDeleteResponse: + """Delete a webhook endpoint. + + It will no longer receive events. + + Args: + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + if not id: + raise ValueError(f"Expected a non-empty value for `id` but received {id!r}") + return await self._delete( + path_template("/v3/webhooks/{id}", id=id), + options=make_request_options( + extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout + ), + cast_to=WebhookDeleteResponse, + ) + + +class WebhooksResourceWithRawResponse: + def __init__(self, webhooks: WebhooksResource) -> None: + self._webhooks = webhooks + + self.create = to_raw_response_wrapper( + webhooks.create, + ) + self.retrieve = to_raw_response_wrapper( + webhooks.retrieve, + ) + self.update = to_raw_response_wrapper( + webhooks.update, + ) + self.list = to_raw_response_wrapper( + webhooks.list, + ) + self.delete = to_raw_response_wrapper( + webhooks.delete, + ) + + @cached_property + def rotate_secret(self) -> RotateSecretResourceWithRawResponse: + return RotateSecretResourceWithRawResponse(self._webhooks.rotate_secret) + + +class AsyncWebhooksResourceWithRawResponse: + def __init__(self, webhooks: AsyncWebhooksResource) -> None: + self._webhooks = webhooks + + self.create = async_to_raw_response_wrapper( + webhooks.create, + ) + self.retrieve = async_to_raw_response_wrapper( + webhooks.retrieve, + ) + self.update = async_to_raw_response_wrapper( + webhooks.update, + ) + self.list = async_to_raw_response_wrapper( + webhooks.list, + ) + self.delete = async_to_raw_response_wrapper( + webhooks.delete, + ) + + @cached_property + def rotate_secret(self) -> AsyncRotateSecretResourceWithRawResponse: + return AsyncRotateSecretResourceWithRawResponse(self._webhooks.rotate_secret) + + +class WebhooksResourceWithStreamingResponse: + def __init__(self, webhooks: WebhooksResource) -> None: + self._webhooks = webhooks + + self.create = to_streamed_response_wrapper( + webhooks.create, + ) + self.retrieve = to_streamed_response_wrapper( + webhooks.retrieve, + ) + self.update = to_streamed_response_wrapper( + webhooks.update, + ) + self.list = to_streamed_response_wrapper( + webhooks.list, + ) + self.delete = to_streamed_response_wrapper( + webhooks.delete, + ) + + @cached_property + def rotate_secret(self) -> RotateSecretResourceWithStreamingResponse: + return RotateSecretResourceWithStreamingResponse(self._webhooks.rotate_secret) + + +class AsyncWebhooksResourceWithStreamingResponse: + def __init__(self, webhooks: AsyncWebhooksResource) -> None: + self._webhooks = webhooks + + self.create = async_to_streamed_response_wrapper( + webhooks.create, + ) + self.retrieve = async_to_streamed_response_wrapper( + webhooks.retrieve, + ) + self.update = async_to_streamed_response_wrapper( + webhooks.update, + ) + self.list = async_to_streamed_response_wrapper( + webhooks.list, + ) + self.delete = async_to_streamed_response_wrapper( + webhooks.delete, + ) + + @cached_property + def rotate_secret(self) -> AsyncRotateSecretResourceWithStreamingResponse: + return AsyncRotateSecretResourceWithStreamingResponse(self._webhooks.rotate_secret) diff --git a/src/unlayer/types/__init__.py b/src/unlayer/types/__init__.py index c11e0fa..d2ae90a 100644 --- a/src/unlayer/types/__init__.py +++ b/src/unlayer/types/__init__.py @@ -2,11 +2,28 @@ from __future__ import annotations +from .email_list_params import EmailListParams as EmailListParams +from .email_create_params import EmailCreateParams as EmailCreateParams +from .email_list_response import EmailListResponse as EmailListResponse +from .domain_create_params import DomainCreateParams as DomainCreateParams +from .domain_list_response import DomainListResponse as DomainListResponse from .template_list_params import TemplateListParams as TemplateListParams +from .email_create_response import EmailCreateResponse as EmailCreateResponse +from .webhook_create_params import WebhookCreateParams as WebhookCreateParams +from .webhook_list_response import WebhookListResponse as WebhookListResponse +from .webhook_update_params import WebhookUpdateParams as WebhookUpdateParams +from .domain_create_response import DomainCreateResponse as DomainCreateResponse +from .domain_delete_response import DomainDeleteResponse as DomainDeleteResponse from .template_list_response import TemplateListResponse as TemplateListResponse +from .email_retrieve_response import EmailRetrieveResponse as EmailRetrieveResponse +from .webhook_create_response import WebhookCreateResponse as WebhookCreateResponse +from .webhook_delete_response import WebhookDeleteResponse as WebhookDeleteResponse +from .webhook_update_response import WebhookUpdateResponse as WebhookUpdateResponse from .workspace_list_response import WorkspaceListResponse as WorkspaceListResponse +from .domain_retrieve_response import DomainRetrieveResponse as DomainRetrieveResponse from .template_retrieve_params import TemplateRetrieveParams as TemplateRetrieveParams from .project_retrieve_response import ProjectRetrieveResponse as ProjectRetrieveResponse +from .webhook_retrieve_response import WebhookRetrieveResponse as WebhookRetrieveResponse from .template_retrieve_response import TemplateRetrieveResponse as TemplateRetrieveResponse from .workspace_retrieve_response import WorkspaceRetrieveResponse as WorkspaceRetrieveResponse from .editor_session_create_params import EditorSessionCreateParams as EditorSessionCreateParams diff --git a/src/unlayer/types/domain_create_params.py b/src/unlayer/types/domain_create_params.py new file mode 100644 index 0000000..eaaa90c --- /dev/null +++ b/src/unlayer/types/domain_create_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["DomainCreateParams"] + + +class DomainCreateParams(TypedDict, total=False): + domain: Required[str] + """Domain name to register, such as example.com.""" diff --git a/src/unlayer/types/domain_create_response.py b/src/unlayer/types/domain_create_response.py new file mode 100644 index 0000000..6800763 --- /dev/null +++ b/src/unlayer/types/domain_create_response.py @@ -0,0 +1,39 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["DomainCreateResponse", "Data", "DataDNSRecord"] + + +class DataDNSRecord(BaseModel): + name: Optional[str] = None + + purpose: Optional[str] = None + + type: Optional[str] = None + + value: Optional[str] = None + + +class Data(BaseModel): + id: Optional[float] = None + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + dkim_tokens: Optional[List[str]] = FieldInfo(alias="dkimTokens", default=None) + + dns_records: Optional[List[DataDNSRecord]] = FieldInfo(alias="dnsRecords", default=None) + + domain: Optional[str] = None + + status: Optional[Literal["pending", "verified", "failed"]] = None + + +class DomainCreateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/domain_delete_response.py b/src/unlayer/types/domain_delete_response.py new file mode 100644 index 0000000..f539e6d --- /dev/null +++ b/src/unlayer/types/domain_delete_response.py @@ -0,0 +1,15 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel + +__all__ = ["DomainDeleteResponse", "Data"] + + +class Data(BaseModel): + success: Optional[bool] = None + + +class DomainDeleteResponse(BaseModel): + data: Optional[Data] = None diff --git a/src/unlayer/types/domain_list_response.py b/src/unlayer/types/domain_list_response.py new file mode 100644 index 0000000..9820cce --- /dev/null +++ b/src/unlayer/types/domain_list_response.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["DomainListResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + domain: Optional[str] = None + + status: Optional[Literal["pending", "verified", "failed"]] = None + + +class DomainListResponse(BaseModel): + data: List[Data] diff --git a/src/unlayer/types/domain_retrieve_response.py b/src/unlayer/types/domain_retrieve_response.py new file mode 100644 index 0000000..93c2ef7 --- /dev/null +++ b/src/unlayer/types/domain_retrieve_response.py @@ -0,0 +1,38 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["DomainRetrieveResponse", "Data", "DataDNSRecord"] + + +class DataDNSRecord(BaseModel): + name: Optional[str] = None + + purpose: Optional[str] = None + + type: Optional[str] = None + + value: Optional[str] = None + + +class Data(BaseModel): + id: Optional[float] = None + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + dkim_tokens: Optional[List[str]] = FieldInfo(alias="dkimTokens", default=None) + + dns_records: Optional[List[DataDNSRecord]] = FieldInfo(alias="dnsRecords", default=None) + + domain: Optional[str] = None + + status: Optional[str] = None + + +class DomainRetrieveResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/domains/__init__.py b/src/unlayer/types/domains/__init__.py new file mode 100644 index 0000000..ef5d8f6 --- /dev/null +++ b/src/unlayer/types/domains/__init__.py @@ -0,0 +1,5 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .verify_create_response import VerifyCreateResponse as VerifyCreateResponse diff --git a/src/unlayer/types/domains/verify_create_response.py b/src/unlayer/types/domains/verify_create_response.py new file mode 100644 index 0000000..5d74c81 --- /dev/null +++ b/src/unlayer/types/domains/verify_create_response.py @@ -0,0 +1,33 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional + +from ..._models import BaseModel + +__all__ = ["VerifyCreateResponse", "Data", "DataDkim", "DataOwnership"] + + +class DataDkim(BaseModel): + status: Optional[str] = None + + tokens: Optional[List[str]] = None + + +class DataOwnership(BaseModel): + verified: Optional[bool] = None + + +class Data(BaseModel): + id: Optional[float] = None + + dkim: Optional[DataDkim] = None + + domain: Optional[str] = None + + ownership: Optional[DataOwnership] = None + + status: Optional[str] = None + + +class VerifyCreateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/email_create_params.py b/src/unlayer/types/email_create_params.py new file mode 100644 index 0000000..541b76e --- /dev/null +++ b/src/unlayer/types/email_create_params.py @@ -0,0 +1,114 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Iterable +from typing_extensions import Literal, Required, Annotated, TypedDict + +from .._types import SequenceNotStr +from .._utils import PropertyInfo + +__all__ = ["EmailCreateParams", "Attachment"] + + +class EmailCreateParams(TypedDict, total=False): + from_: Required[Annotated[str, PropertyInfo(alias="from")]] + """Sender email address or "Name " format. Domain must be verified.""" + + html: Required[str] + """HTML content of the email""" + + subject: Required[str] + """Email subject line""" + + to: Required[SequenceNotStr[str]] + """Exactly one recipient. Each request creates one independently tracked delivery.""" + + attachments: Iterable[Attachment] + """File attachments. + + Max 10 files per email, max 5 MB total payload size (including headers and + base64 overhead). + """ + + bcc: Iterable[object] + """BCC is not supported by this endpoint.""" + + cc: Iterable[object] + """CC is not supported by this endpoint.""" + + headers: Dict[str, str] + """Custom email headers. + + Up to 9 printable-ASCII X-\\** headers are allowed (e.g. {"X-Entity-Ref-ID": + "abc123"}). Header names may contain up to 126 characters and each name plus + value may contain up to 996 characters. + """ + + reply_to: Annotated[str, PropertyInfo(alias="replyTo")] + """Reply-To email address""" + + tags: Dict[str, str] + """Key-value tags for categorizing the email (e.g. + + {"campaign": "welcome"}). Max 10 tags. Keys (1-64 chars) and values (up to 256 + chars) may only contain letters, numbers, underscores, and hyphens (the Amazon + SES message-tag character set). + """ + + text: str + """Plain text version of the email. + + If provided, a multipart/alternative message is sent. + """ + + idempotency_key: Annotated[str, PropertyInfo(alias="idempotency-key")] + + +class Attachment(TypedDict, total=False): + content: Required[str] + """Base64-encoded file content. + + Whitespace and MIME line wrapping are removed before validation; invalid base64 + is rejected with a 400 error. + """ + + content_type: Required[ + Annotated[ + Literal[ + "application/pdf", + "application/zip", + "application/json", + "application/xml", + "application/csv", + "application/msword", + "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "application/vnd.ms-excel", + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "application/vnd.ms-powerpoint", + "application/vnd.openxmlformats-officedocument.presentationml.presentation", + "text/plain", + "text/html", + "text/csv", + "text/xml", + "text/calendar", + "image/png", + "image/jpeg", + "image/gif", + "image/webp", + "image/svg+xml", + "audio/mpeg", + "audio/wav", + "video/mp4", + ], + PropertyInfo(alias="contentType"), + ] + ] + """MIME type of the attachment. Required; must be one of the allowed types.""" + + filename: Required[str] + """The filename as it will appear to the recipient. + + Line breaks are rejected; quotes are stripped before it is written into the + message. + """ diff --git a/src/unlayer/types/email_create_response.py b/src/unlayer/types/email_create_response.py new file mode 100644 index 0000000..a6b3aab --- /dev/null +++ b/src/unlayer/types/email_create_response.py @@ -0,0 +1,48 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["EmailCreateResponse", "Data"] + + +class Data(BaseModel): + id: Optional[str] = None + """Unique email ID (UUID). + + Use this with GET /v3/emails/:id to retrieve delivery status and events. + """ + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the email was accepted and queued for delivery (ISO-8601).""" + + from_: Optional[str] = FieldInfo(alias="from", default=None) + """ + The sender address the email was sent from, either a plain email or "Name + " format. + """ + + status: Optional[Literal["queued", "sending", "sent", "delivered", "bounced", "complained", "failed"]] = None + """Usually "queued" for a fresh send. + + An idempotent replay of a previously accepted request returns that email's + current status instead. Use webhooks or GET /v3/emails/:id for live delivery + status. + """ + + subject: Optional[str] = None + """The subject line of the email that was sent.""" + + to: Optional[List[str]] = None + """The single accepted recipient address.""" + + +class EmailCreateResponse(BaseModel): + """Email accepted and queued for delivery""" + + data: Data diff --git a/src/unlayer/types/email_list_params.py b/src/unlayer/types/email_list_params.py new file mode 100644 index 0000000..db65128 --- /dev/null +++ b/src/unlayer/types/email_list_params.py @@ -0,0 +1,45 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Union +from datetime import date +from typing_extensions import Literal, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["EmailListParams"] + + +class EmailListParams(TypedDict, total=False): + cursor: str + """Pagination cursor from previous response""" + + from_: Annotated[Union[str, date], PropertyInfo(alias="from", format="iso8601")] + """Start date (ISO date). + + Bounds acceptance time normally, or status transition time when status is + supplied. + """ + + limit: int + """Number of emails to return (1-100)""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """Project ID (auto-resolved for API key auth)""" + + search: str + """Search recipient addresses and subjects by case-sensitive substring""" + + status: Literal["queued", "sending", "sent", "delivered", "bounced", "complained", "failed"] + """Filter by email delivery status""" + + tag: str + """Filter by tag in "key=value" format (e.g. "campaign=welcome")""" + + to: Annotated[Union[str, date], PropertyInfo(format="iso8601")] + """End date (ISO date). + + Bounds acceptance time normally, or status transition time when status is + supplied. + """ diff --git a/src/unlayer/types/email_list_response.py b/src/unlayer/types/email_list_response.py new file mode 100644 index 0000000..3a75410 --- /dev/null +++ b/src/unlayer/types/email_list_response.py @@ -0,0 +1,40 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["EmailListResponse", "Data"] + + +class Data(BaseModel): + id: Optional[str] = None + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + from_: Optional[str] = FieldInfo(alias="from", default=None) + + status: Optional[str] = None + + status_updated_at: Optional[datetime] = FieldInfo(alias="statusUpdatedAt", default=None) + """When the email entered its current status. + + For a newly queued email, this equals createdAt. + """ + + subject: Optional[str] = None + + to: Optional[object] = None + + +class EmailListResponse(BaseModel): + data: List[Data] + + has_more: bool + """Whether there are more results after this page""" + + next_cursor: Optional[str] = None + """Cursor for the next page. Null if no more results.""" diff --git a/src/unlayer/types/email_retrieve_response.py b/src/unlayer/types/email_retrieve_response.py new file mode 100644 index 0000000..94475e7 --- /dev/null +++ b/src/unlayer/types/email_retrieve_response.py @@ -0,0 +1,36 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["EmailRetrieveResponse", "Data"] + + +class Data(BaseModel): + id: Optional[str] = None + + bcc: Optional[List[str]] = None + + cc: Optional[List[str]] = None + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + failure_reason: Optional[str] = FieldInfo(alias="failureReason", default=None) + + from_: Optional[str] = FieldInfo(alias="from", default=None) + + status: Optional[str] = None + + subject: Optional[str] = None + + tags: Optional[Dict[str, str]] = None + + to: Optional[object] = None + + +class EmailRetrieveResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/__init__.py b/src/unlayer/types/emails/__init__.py new file mode 100644 index 0000000..d2c07f3 --- /dev/null +++ b/src/unlayer/types/emails/__init__.py @@ -0,0 +1,22 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .render_create_params import RenderCreateParams as RenderCreateParams +from .stat_retrieve_params import StatRetrieveParams as StatRetrieveParams +from .setting_update_params import SettingUpdateParams as SettingUpdateParams +from .render_create_response import RenderCreateResponse as RenderCreateResponse +from .stat_retrieve_response import StatRetrieveResponse as StatRetrieveResponse +from .template_create_params import TemplateCreateParams as TemplateCreateParams +from .event_retrieve_response import EventRetrieveResponse as EventRetrieveResponse +from .setting_update_response import SettingUpdateResponse as SettingUpdateResponse +from .template_create_response import TemplateCreateResponse as TemplateCreateResponse +from .setting_retrieve_response import SettingRetrieveResponse as SettingRetrieveResponse +from .suppression_create_params import SuppressionCreateParams as SuppressionCreateParams +from .suppression_delete_params import SuppressionDeleteParams as SuppressionDeleteParams +from .suppression_create_response import SuppressionCreateResponse as SuppressionCreateResponse +from .suppression_delete_response import SuppressionDeleteResponse as SuppressionDeleteResponse +from .suppression_retrieve_params import SuppressionRetrieveParams as SuppressionRetrieveParams +from .suppression_retrieve_response import SuppressionRetrieveResponse as SuppressionRetrieveResponse +from .suppressions_check_retrieve_params import SuppressionsCheckRetrieveParams as SuppressionsCheckRetrieveParams +from .suppressions_check_retrieve_response import SuppressionsCheckRetrieveResponse as SuppressionsCheckRetrieveResponse diff --git a/src/unlayer/types/emails/event_retrieve_response.py b/src/unlayer/types/emails/event_retrieve_response.py new file mode 100644 index 0000000..2853ace --- /dev/null +++ b/src/unlayer/types/emails/event_retrieve_response.py @@ -0,0 +1,21 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional +from datetime import datetime + +from ..._models import BaseModel + +__all__ = ["EventRetrieveResponse", "Data"] + + +class Data(BaseModel): + metadata: Optional[Dict[str, object]] = None + + timestamp: Optional[datetime] = None + + type: Optional[str] = None + """Event type (send, delivery, bounce, complaint)""" + + +class EventRetrieveResponse(BaseModel): + data: List[Data] diff --git a/src/unlayer/types/emails/render_create_params.py b/src/unlayer/types/emails/render_create_params.py new file mode 100644 index 0000000..99f1a4c --- /dev/null +++ b/src/unlayer/types/emails/render_create_params.py @@ -0,0 +1,18 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["RenderCreateParams"] + + +class RenderCreateParams(TypedDict, total=False): + template_id: Required[Annotated[str, PropertyInfo(alias="templateId")]] + """Template ID to render""" + + variables: Dict[str, str] + """Merge variables to substitute. Use {{key}} syntax in your template.""" diff --git a/src/unlayer/types/emails/render_create_response.py b/src/unlayer/types/emails/render_create_response.py new file mode 100644 index 0000000..d9b1c82 --- /dev/null +++ b/src/unlayer/types/emails/render_create_response.py @@ -0,0 +1,19 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["RenderCreateResponse", "Data"] + + +class Data(BaseModel): + html: Optional[str] = None + """Rendered HTML content""" + + subject: Optional[str] = None + """Template name (can be used as default subject)""" + + +class RenderCreateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/setting_retrieve_response.py b/src/unlayer/types/emails/setting_retrieve_response.py new file mode 100644 index 0000000..6fbed8c --- /dev/null +++ b/src/unlayer/types/emails/setting_retrieve_response.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["SettingRetrieveResponse", "Data"] + + +class Data(BaseModel): + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the settings row was first created.""" + + default_from_name: Optional[str] = FieldInfo(alias="defaultFromName", default=None) + """Default sender display name""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + """When the settings were last updated.""" + + +class SettingRetrieveResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/setting_update_params.py b/src/unlayer/types/emails/setting_update_params.py new file mode 100644 index 0000000..faa6f5b --- /dev/null +++ b/src/unlayer/types/emails/setting_update_params.py @@ -0,0 +1,14 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SettingUpdateParams"] + + +class SettingUpdateParams(TypedDict, total=False): + default_from_name: Annotated[str, PropertyInfo(alias="defaultFromName")] + """Default sender display name""" diff --git a/src/unlayer/types/emails/setting_update_response.py b/src/unlayer/types/emails/setting_update_response.py new file mode 100644 index 0000000..79c230f --- /dev/null +++ b/src/unlayer/types/emails/setting_update_response.py @@ -0,0 +1,25 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["SettingUpdateResponse", "Data"] + + +class Data(BaseModel): + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the settings row was first created.""" + + default_from_name: Optional[str] = FieldInfo(alias="defaultFromName", default=None) + """Default sender display name""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + """When the settings were last updated.""" + + +class SettingUpdateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/stat_retrieve_params.py b/src/unlayer/types/emails/stat_retrieve_params.py new file mode 100644 index 0000000..f1ed13f --- /dev/null +++ b/src/unlayer/types/emails/stat_retrieve_params.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["StatRetrieveParams"] + + +class StatRetrieveParams(TypedDict, total=False): + group_by: Annotated[Literal["day"], PropertyInfo(alias="groupBy")] + """Group results by day for chart data""" + + period: Literal["7d", "30d", "90d"] + """Time period for stats""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """Project ID (auto-resolved for API key auth)""" diff --git a/src/unlayer/types/emails/stat_retrieve_response.py b/src/unlayer/types/emails/stat_retrieve_response.py new file mode 100644 index 0000000..1af64da --- /dev/null +++ b/src/unlayer/types/emails/stat_retrieve_response.py @@ -0,0 +1,66 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +import datetime +from typing import List, Union, Optional +from typing_extensions import Literal, TypeAlias + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["StatRetrieveResponse", "Data", "DataUnionMember0", "DataUnionMember1"] + + +class DataUnionMember0(BaseModel): + """Aggregated totals for the requested period (default response).""" + + bounced: Optional[float] = None + """Number of emails that were bounced by the recipient mail server.""" + + bounce_rate: Optional[float] = FieldInfo(alias="bounceRate", default=None) + """Bounced / sent as a percentage (0-100, 2 decimal places).""" + + complained: Optional[float] = None + """Number of spam complaint events received.""" + + delivered: Optional[float] = None + """Number of successfully delivered emails.""" + + delivery_rate: Optional[float] = FieldInfo(alias="deliveryRate", default=None) + """Delivered / sent as a percentage (0-100, 2 decimal places).""" + + period: Optional[Literal["7d", "30d", "90d"]] = None + """The period these stats cover.""" + + sent: Optional[float] = None + """Total emails sent (one per recipient).""" + + +class DataUnionMember1(BaseModel): + bounced: Optional[float] = None + """Emails bounced on this day.""" + + complained: Optional[float] = None + """Spam complaints received for this send cohort.""" + + date: Optional[datetime.date] = None + """The email send-cohort day in YYYY-MM-DD format.""" + + delivered: Optional[float] = None + """Emails from this send cohort that were delivered.""" + + sent: Optional[float] = None + """Emails sent on this day.""" + + +Data: TypeAlias = Union[DataUnionMember0, List[DataUnionMember1]] + + +class StatRetrieveResponse(BaseModel): + """Email statistics. + + Shape depends on the `groupBy` query parameter: an aggregated totals object by default, or a daily breakdown array when groupBy=day. + """ + + data: Data + """Aggregated totals for the requested period (default response).""" diff --git a/src/unlayer/types/emails/suppression_create_params.py b/src/unlayer/types/emails/suppression_create_params.py new file mode 100644 index 0000000..95f845d --- /dev/null +++ b/src/unlayer/types/emails/suppression_create_params.py @@ -0,0 +1,12 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, TypedDict + +__all__ = ["SuppressionCreateParams"] + + +class SuppressionCreateParams(TypedDict, total=False): + email: Required[str] + """Email address to suppress""" diff --git a/src/unlayer/types/emails/suppression_create_response.py b/src/unlayer/types/emails/suppression_create_response.py new file mode 100644 index 0000000..fc0f0cc --- /dev/null +++ b/src/unlayer/types/emails/suppression_create_response.py @@ -0,0 +1,22 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["SuppressionCreateResponse", "Data"] + + +class Data(BaseModel): + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + email: Optional[str] = None + + reason: Optional[str] = None + + +class SuppressionCreateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/suppression_delete_params.py b/src/unlayer/types/emails/suppression_delete_params.py new file mode 100644 index 0000000..5d08bc5 --- /dev/null +++ b/src/unlayer/types/emails/suppression_delete_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SuppressionDeleteParams"] + + +class SuppressionDeleteParams(TypedDict, total=False): + email: Required[str] + """Email address to unsuppress""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """Project ID (auto-resolved for API key auth)""" diff --git a/src/unlayer/types/emails/suppression_delete_response.py b/src/unlayer/types/emails/suppression_delete_response.py new file mode 100644 index 0000000..a685976 --- /dev/null +++ b/src/unlayer/types/emails/suppression_delete_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["SuppressionDeleteResponse", "Data"] + + +class Data(BaseModel): + email: Optional[str] = None + + removed: Optional[bool] = None + + +class SuppressionDeleteResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/suppression_retrieve_params.py b/src/unlayer/types/emails/suppression_retrieve_params.py new file mode 100644 index 0000000..29db6dc --- /dev/null +++ b/src/unlayer/types/emails/suppression_retrieve_params.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SuppressionRetrieveParams"] + + +class SuppressionRetrieveParams(TypedDict, total=False): + cursor: str + """Pagination cursor from a previous response. Omit to start from the beginning.""" + + limit: int + """Max number of results (1-200)""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """Project ID (auto-resolved for API key auth)""" diff --git a/src/unlayer/types/emails/suppression_retrieve_response.py b/src/unlayer/types/emails/suppression_retrieve_response.py new file mode 100644 index 0000000..ee98195 --- /dev/null +++ b/src/unlayer/types/emails/suppression_retrieve_response.py @@ -0,0 +1,27 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["SuppressionRetrieveResponse", "Data"] + + +class Data(BaseModel): + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + email: Optional[str] = None + + reason: Optional[Literal["hard_bounce", "complaint", "manual", "unsubscribe"]] = None + + +class SuppressionRetrieveResponse(BaseModel): + data: List[Data] + + has_more: bool + + next_cursor: Optional[str] = None diff --git a/src/unlayer/types/emails/suppressions_check_retrieve_params.py b/src/unlayer/types/emails/suppressions_check_retrieve_params.py new file mode 100644 index 0000000..e404f04 --- /dev/null +++ b/src/unlayer/types/emails/suppressions_check_retrieve_params.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SuppressionsCheckRetrieveParams"] + + +class SuppressionsCheckRetrieveParams(TypedDict, total=False): + email: Required[str] + """Email address to check""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """Project ID (auto-resolved for API key auth)""" diff --git a/src/unlayer/types/emails/suppressions_check_retrieve_response.py b/src/unlayer/types/emails/suppressions_check_retrieve_response.py new file mode 100644 index 0000000..aa6fe69 --- /dev/null +++ b/src/unlayer/types/emails/suppressions_check_retrieve_response.py @@ -0,0 +1,17 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from ..._models import BaseModel + +__all__ = ["SuppressionsCheckRetrieveResponse", "Data"] + + +class Data(BaseModel): + email: Optional[str] = None + + suppressed: Optional[bool] = None + + +class SuppressionsCheckRetrieveResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/emails/template_create_params.py b/src/unlayer/types/emails/template_create_params.py new file mode 100644 index 0000000..ccee88b --- /dev/null +++ b/src/unlayer/types/emails/template_create_params.py @@ -0,0 +1,115 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, Iterable +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._types import SequenceNotStr +from ..._utils import PropertyInfo + +__all__ = ["TemplateCreateParams", "Attachment"] + + +class TemplateCreateParams(TypedDict, total=False): + from_: Required[Annotated[str, PropertyInfo(alias="from")]] + """Sender email address or "Name " format. Domain must be verified.""" + + template_id: Required[Annotated[str, PropertyInfo(alias="templateId")]] + """Template ID to use for the email body""" + + to: Required[SequenceNotStr[str]] + """Exactly one recipient. Each request creates one independently tracked delivery.""" + + attachments: Iterable[Attachment] + """File attachments. Max 10 files per email, max 5 MB total payload size.""" + + bcc: Iterable[object] + """BCC is not supported by this endpoint.""" + + cc: Iterable[object] + """CC is not supported by this endpoint.""" + + headers: Dict[str, str] + """Custom email headers. + + Up to 9 printable-ASCII X-\\** headers are allowed. Header names may contain up to + 126 characters and each name plus value may contain up to 996 characters. + """ + + reply_to: Annotated[str, PropertyInfo(alias="replyTo")] + """Reply-To email address""" + + subject: str + """Email subject line. + + Supports {{variable}} merge syntax. Defaults to template name if omitted. + """ + + tags: Dict[str, str] + """Key-value tags for categorizing the email (e.g. + + {"campaign": "welcome"}). Max 10 tags. Keys (1-64 chars) and values (up to 256 + chars) may only contain letters, numbers, underscores, and hyphens (the Amazon + SES message-tag character set). + """ + + text: str + """Plain text version of the email. Supports {{variable}} merge syntax.""" + + variables: Dict[str, str] + """Merge variables to substitute in the template and subject. + + Use {{key}} syntax in your template. + """ + + idempotency_key: Annotated[str, PropertyInfo(alias="idempotency-key")] + + +class Attachment(TypedDict, total=False): + content: Required[str] + """Base64-encoded file content. + + Whitespace and MIME line wrapping are removed before validation; invalid base64 + is rejected with a 400 error. + """ + + content_type: Required[ + Annotated[ + Literal[ + "application/pdf", + "application/zip", + "application/json", + "application/xml", + "application/csv", + "application/msword", + "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "application/vnd.ms-excel", + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", + "application/vnd.ms-powerpoint", + "application/vnd.openxmlformats-officedocument.presentationml.presentation", + "text/plain", + "text/html", + "text/csv", + "text/xml", + "text/calendar", + "image/png", + "image/jpeg", + "image/gif", + "image/webp", + "image/svg+xml", + "audio/mpeg", + "audio/wav", + "video/mp4", + ], + PropertyInfo(alias="contentType"), + ] + ] + """MIME type of the attachment. Required; must be one of the allowed types.""" + + filename: Required[str] + """The filename as it will appear to the recipient. + + Line breaks are rejected; quotes are stripped before it is written into the + message. + """ diff --git a/src/unlayer/types/emails/template_create_response.py b/src/unlayer/types/emails/template_create_response.py new file mode 100644 index 0000000..c654d78 --- /dev/null +++ b/src/unlayer/types/emails/template_create_response.py @@ -0,0 +1,45 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["TemplateCreateResponse", "Data"] + + +class Data(BaseModel): + id: Optional[str] = None + """Unique email ID (UUID). + + Use this with GET /v3/emails/:id to retrieve delivery status and events. + """ + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the email was accepted and queued for delivery (ISO-8601).""" + + from_: Optional[str] = FieldInfo(alias="from", default=None) + """The sender address the email was sent from.""" + + status: Optional[Literal["queued", "sending", "sent", "delivered", "bounced", "complained", "failed"]] = None + """Usually "queued" for a fresh send. + + An idempotent replay of a previously accepted request returns that email's + current status instead. Use webhooks or GET /v3/emails/:id for live delivery + status. + """ + + subject: Optional[str] = None + """The resolved subject line after merge variables were applied.""" + + to: Optional[List[str]] = None + """The single accepted recipient address.""" + + +class TemplateCreateResponse(BaseModel): + """Email accepted and queued for delivery""" + + data: Data diff --git a/src/unlayer/types/templates/__init__.py b/src/unlayer/types/templates/__init__.py index bfc0663..6cf21b6 100644 --- a/src/unlayer/types/templates/__init__.py +++ b/src/unlayer/types/templates/__init__.py @@ -5,9 +5,12 @@ from .import_create_params import ImportCreateParams as ImportCreateParams from .generate_create_params import GenerateCreateParams as GenerateCreateParams from .import_create_response import ImportCreateResponse as ImportCreateResponse +from .schema_retrieve_params import SchemaRetrieveParams as SchemaRetrieveParams +from .validate_create_params import ValidateCreateParams as ValidateCreateParams from .export_pdf_create_params import ExportPdfCreateParams as ExportPdfCreateParams from .export_zip_create_params import ExportZipCreateParams as ExportZipCreateParams from .generate_create_response import GenerateCreateResponse as GenerateCreateResponse +from .validate_create_response import ValidateCreateResponse as ValidateCreateResponse from .export_html_create_params import ExportHTMLCreateParams as ExportHTMLCreateParams from .export_image_create_params import ExportImageCreateParams as ExportImageCreateParams from .export_pdf_create_response import ExportPdfCreateResponse as ExportPdfCreateResponse diff --git a/src/unlayer/types/templates/convert_full_to_simple_create_params.py b/src/unlayer/types/templates/convert_full_to_simple_create_params.py index 739b363..5950d5d 100644 --- a/src/unlayer/types/templates/convert_full_to_simple_create_params.py +++ b/src/unlayer/types/templates/convert_full_to_simple_create_params.py @@ -14,6 +14,13 @@ class ConvertFullToSimpleCreateParams(TypedDict, total=False): design: Required[Design] display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Display mode of the design (email, web, document, popup). + + Defaults to "email", matching /v3/templates/validate. Mode-specific repairs + apply during conversion (email caps contentWidth at 900px, for example), so pass + the design's actual mode — a web design converted under the email default can be + altered. + """ include_conversion: Annotated[bool, PropertyInfo(alias="includeConversion")] """When true, includes \\__conversion metadata in the response. diff --git a/src/unlayer/types/templates/convert_simple_to_full_create_params.py b/src/unlayer/types/templates/convert_simple_to_full_create_params.py index 4ee6a26..34db2a5 100644 --- a/src/unlayer/types/templates/convert_simple_to_full_create_params.py +++ b/src/unlayer/types/templates/convert_simple_to_full_create_params.py @@ -14,6 +14,13 @@ class ConvertSimpleToFullCreateParams(TypedDict, total=False): design: Required[Design] display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Display mode of the design (email, web, document, popup). + + Defaults to "email", matching /v3/templates/validate. Mode-specific repairs + apply during conversion (email caps contentWidth at 900px, for example), so pass + the design's actual mode — a web design converted under the email default can be + altered. + """ include_default_values: Annotated[bool, PropertyInfo(alias="includeDefaultValues")] diff --git a/src/unlayer/types/templates/schema_retrieve_params.py b/src/unlayer/types/templates/schema_retrieve_params.py new file mode 100644 index 0000000..c80d6ae --- /dev/null +++ b/src/unlayer/types/templates/schema_retrieve_params.py @@ -0,0 +1,20 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["SchemaRetrieveParams"] + + +class SchemaRetrieveParams(TypedDict, total=False): + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Display mode whose rules the schema describes (email, web, document, popup). + + Defaults to "email". + """ + + simple: bool + """When true, returns the Simple schema instead of the Full schema.""" diff --git a/src/unlayer/types/templates/validate_create_params.py b/src/unlayer/types/templates/validate_create_params.py new file mode 100644 index 0000000..0db5c8b --- /dev/null +++ b/src/unlayer/types/templates/validate_create_params.py @@ -0,0 +1,68 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import Dict, List, Iterable +from typing_extensions import Literal, Required, Annotated, TypedDict + +from ..._utils import PropertyInfo + +__all__ = ["ValidateCreateParams", "CustomTool", "CustomToolOptions"] + + +class ValidateCreateParams(TypedDict, total=False): + design: Required[Dict[str, object]] + """The design JSON to validate.""" + + custom_tools: Annotated[Iterable[CustomTool], PropertyInfo(alias="customTools")] + """Custom tool declarations, in the same shape passed to unlayer.registerTool. + + When provided, blocks matching a declared tool have their values checked against + the tool's declared options (wrong types are reported at their exact path). + Blocks of undeclared tools keep envelope-only validation. + """ + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Display mode for the design (email, web, document, popup). + + Some validation rules differ per mode. Defaults to "email" — without a default, + options from every mode would apply at once, the strictest possible check, and + real editor-saved designs could be reported invalid. + """ + + migrate: bool + """ + When true (default), a full-form design with an older schemaVersion is upgraded + to the current schema before validating — matching how the editor and the + convert endpoints treat stored designs. Designs without a schemaVersion predate + versioning and are fully migrated the same way. Set to false to check strict + conformance with the current schema version. Designs with a newer schemaVersion + than this API knows are validated as-if-current. + """ + + schema: Literal["full", "simple"] + """Which form of the schema to validate against. Defaults to "full".""" + + +class CustomToolOptions(TypedDict, total=False): + options: object + + +class CustomTool( # type: ignore[call-arg] + TypedDict, + total=False, + extra_items=object, # pyright: ignore[reportGeneralTypeIssues] +): + options: Required[Dict[str, CustomToolOptions]] + + slug: Required[str] + + label: str + + supported_display_modes: Annotated[ + List[Literal["email", "web", "popup", "document"]], PropertyInfo(alias="supportedDisplayModes") + ] + + type: str + + values: Dict[str, object] diff --git a/src/unlayer/types/templates/validate_create_response.py b/src/unlayer/types/templates/validate_create_response.py new file mode 100644 index 0000000..6d72606 --- /dev/null +++ b/src/unlayer/types/templates/validate_create_response.py @@ -0,0 +1,47 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["ValidateCreateResponse", "Data", "DataError"] + + +class DataError(BaseModel): + code: str + + message: str + + path: str + + +class Data(BaseModel): + valid: bool + + error_count: Optional[float] = FieldInfo(alias="errorCount", default=None) + """ + Total number of issues found; greater than errors.length when the list was + capped. + """ + + errors: Optional[List[DataError]] = None + """Populated when valid is false, capped at 100 entries. + + Each issue carries the dotted path to the offending field, a human-readable + message, and the underlying Zod issue code. + """ + + migrated_from: Optional[float] = FieldInfo(alias="migratedFrom", default=None) + """ + Present when the design was upgraded from an older schemaVersion before + validation; carries the original version number. + """ + + +class ValidateCreateResponse(BaseModel): + data: Data + + success: Literal[True] diff --git a/src/unlayer/types/webhook_create_params.py b/src/unlayer/types/webhook_create_params.py new file mode 100644 index 0000000..a686967 --- /dev/null +++ b/src/unlayer/types/webhook_create_params.py @@ -0,0 +1,19 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import List +from typing_extensions import Literal, Required, TypedDict + +__all__ = ["WebhookCreateParams"] + + +class WebhookCreateParams(TypedDict, total=False): + url: Required[str] + """The HTTPS URL to receive webhook events""" + + active: bool + """Whether the webhook is active""" + + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] + """Event types to subscribe to. If omitted or empty, all events are sent.""" diff --git a/src/unlayer/types/webhook_create_response.py b/src/unlayer/types/webhook_create_response.py new file mode 100644 index 0000000..46e0bf5 --- /dev/null +++ b/src/unlayer/types/webhook_create_response.py @@ -0,0 +1,38 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["WebhookCreateResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + """Webhook ID""" + + active: Optional[bool] = None + """Whether the webhook is actively receiving events""" + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the webhook was created""" + + events: Optional[List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]]] = None + """Event types this webhook is subscribed to""" + + secret: Optional[str] = None + """Signing secret — only returned on creation. + + Store it securely; you will not be able to retrieve it again. + """ + + url: Optional[str] = None + """The HTTPS URL receiving webhook events""" + + +class WebhookCreateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/webhook_delete_response.py b/src/unlayer/types/webhook_delete_response.py new file mode 100644 index 0000000..3932042 --- /dev/null +++ b/src/unlayer/types/webhook_delete_response.py @@ -0,0 +1,15 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional + +from .._models import BaseModel + +__all__ = ["WebhookDeleteResponse", "Data"] + + +class Data(BaseModel): + success: Optional[bool] = None + + +class WebhookDeleteResponse(BaseModel): + data: Optional[Data] = None diff --git a/src/unlayer/types/webhook_list_response.py b/src/unlayer/types/webhook_list_response.py new file mode 100644 index 0000000..d904987 --- /dev/null +++ b/src/unlayer/types/webhook_list_response.py @@ -0,0 +1,32 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["WebhookListResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + """Webhook ID""" + + active: Optional[bool] = None + """Whether the webhook is actively receiving events""" + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the webhook was created""" + + events: Optional[List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]]] = None + """Event types this webhook is subscribed to""" + + url: Optional[str] = None + """The HTTPS URL receiving webhook events""" + + +class WebhookListResponse(BaseModel): + data: List[Data] diff --git a/src/unlayer/types/webhook_retrieve_response.py b/src/unlayer/types/webhook_retrieve_response.py new file mode 100644 index 0000000..6db69fe --- /dev/null +++ b/src/unlayer/types/webhook_retrieve_response.py @@ -0,0 +1,35 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["WebhookRetrieveResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + """Webhook ID""" + + active: Optional[bool] = None + """Whether the webhook is actively receiving events""" + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + """When the webhook was created""" + + events: Optional[List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]]] = None + """Event types this webhook is subscribed to""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + """When the webhook was last updated""" + + url: Optional[str] = None + """The HTTPS URL receiving webhook events""" + + +class WebhookRetrieveResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/webhook_update_params.py b/src/unlayer/types/webhook_update_params.py new file mode 100644 index 0000000..703e60d --- /dev/null +++ b/src/unlayer/types/webhook_update_params.py @@ -0,0 +1,19 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing import List +from typing_extensions import Literal, TypedDict + +__all__ = ["WebhookUpdateParams"] + + +class WebhookUpdateParams(TypedDict, total=False): + active: bool + """Whether the webhook is actively receiving events""" + + events: List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]] + """Event types to subscribe to. If omitted or empty, all events are sent.""" + + url: str + """The HTTPS URL to receive webhook events""" diff --git a/src/unlayer/types/webhook_update_response.py b/src/unlayer/types/webhook_update_response.py new file mode 100644 index 0000000..6276d70 --- /dev/null +++ b/src/unlayer/types/webhook_update_response.py @@ -0,0 +1,32 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import List, Optional +from datetime import datetime +from typing_extensions import Literal + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["WebhookUpdateResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + """Webhook ID""" + + active: Optional[bool] = None + """Whether the webhook is actively receiving events""" + + events: Optional[List[Literal["email.sent", "email.delivered", "email.bounced", "email.complained"]]] = None + """Event types this webhook is subscribed to""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + """When the webhook was last updated""" + + url: Optional[str] = None + """The HTTPS URL receiving webhook events""" + + +class WebhookUpdateResponse(BaseModel): + data: Data diff --git a/src/unlayer/types/webhooks/__init__.py b/src/unlayer/types/webhooks/__init__.py new file mode 100644 index 0000000..65b4c8a --- /dev/null +++ b/src/unlayer/types/webhooks/__init__.py @@ -0,0 +1,5 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from .rotate_secret_create_response import RotateSecretCreateResponse as RotateSecretCreateResponse diff --git a/src/unlayer/types/webhooks/rotate_secret_create_response.py b/src/unlayer/types/webhooks/rotate_secret_create_response.py new file mode 100644 index 0000000..bef282a --- /dev/null +++ b/src/unlayer/types/webhooks/rotate_secret_create_response.py @@ -0,0 +1,23 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from ..._models import BaseModel + +__all__ = ["RotateSecretCreateResponse", "Data"] + + +class Data(BaseModel): + id: Optional[float] = None + + secret: Optional[str] = None + """New signing secret — only returned once. Store it securely.""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + + +class RotateSecretCreateResponse(BaseModel): + data: Data diff --git a/tests/api_resources/domains/__init__.py b/tests/api_resources/domains/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/domains/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/domains/test_verify.py b/tests/api_resources/domains/test_verify.py new file mode 100644 index 0000000..7711ac3 --- /dev/null +++ b/tests/api_resources/domains/test_verify.py @@ -0,0 +1,100 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.domains import VerifyCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestVerify: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + verify = client.domains.verify.create( + "id", + ) + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.domains.verify.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verify = response.parse() + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.domains.verify.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verify = response.parse() + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.domains.verify.with_raw_response.create( + "", + ) + + +class TestAsyncVerify: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + verify = await async_client.domains.verify.create( + "id", + ) + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.domains.verify.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + verify = await response.parse() + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.domains.verify.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + verify = await response.parse() + assert_matches_type(VerifyCreateResponse, verify, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.domains.verify.with_raw_response.create( + "", + ) diff --git a/tests/api_resources/emails/__init__.py b/tests/api_resources/emails/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/emails/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/emails/test_events.py b/tests/api_resources/emails/test_events.py new file mode 100644 index 0000000..7477c1d --- /dev/null +++ b/tests/api_resources/emails/test_events.py @@ -0,0 +1,100 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import EventRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestEvents: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + event = client.emails.events.retrieve( + "id", + ) + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.events.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + event = response.parse() + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.events.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + event = response.parse() + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.emails.events.with_raw_response.retrieve( + "", + ) + + +class TestAsyncEvents: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + event = await async_client.emails.events.retrieve( + "id", + ) + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.events.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + event = await response.parse() + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.events.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + event = await response.parse() + assert_matches_type(EventRetrieveResponse, event, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.emails.events.with_raw_response.retrieve( + "", + ) diff --git a/tests/api_resources/emails/test_render.py b/tests/api_resources/emails/test_render.py new file mode 100644 index 0000000..d7c4233 --- /dev/null +++ b/tests/api_resources/emails/test_render.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import RenderCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestRender: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + render = client.emails.render.create( + template_id="496", + ) + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + render = client.emails.render.create( + template_id="496", + variables={"foo": "string"}, + ) + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.emails.render.with_raw_response.create( + template_id="496", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + render = response.parse() + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.emails.render.with_streaming_response.create( + template_id="496", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + render = response.parse() + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncRender: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + render = await async_client.emails.render.create( + template_id="496", + ) + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + render = await async_client.emails.render.create( + template_id="496", + variables={"foo": "string"}, + ) + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.render.with_raw_response.create( + template_id="496", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + render = await response.parse() + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.render.with_streaming_response.create( + template_id="496", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + render = await response.parse() + assert_matches_type(RenderCreateResponse, render, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/emails/test_settings.py b/tests/api_resources/emails/test_settings.py new file mode 100644 index 0000000..cb6d782 --- /dev/null +++ b/tests/api_resources/emails/test_settings.py @@ -0,0 +1,138 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import SettingUpdateResponse, SettingRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSettings: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + setting = client.emails.settings.retrieve() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.settings.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + setting = response.parse() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.settings.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + setting = response.parse() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_update(self, client: Unlayer) -> None: + setting = client.emails.settings.update() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + def test_method_update_with_all_params(self, client: Unlayer) -> None: + setting = client.emails.settings.update( + default_from_name="defaultFromName", + ) + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + def test_raw_response_update(self, client: Unlayer) -> None: + response = client.emails.settings.with_raw_response.update() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + setting = response.parse() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + def test_streaming_response_update(self, client: Unlayer) -> None: + with client.emails.settings.with_streaming_response.update() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + setting = response.parse() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncSettings: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + setting = await async_client.emails.settings.retrieve() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.settings.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + setting = await response.parse() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.settings.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + setting = await response.parse() + assert_matches_type(SettingRetrieveResponse, setting, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_update(self, async_client: AsyncUnlayer) -> None: + setting = await async_client.emails.settings.update() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + async def test_method_update_with_all_params(self, async_client: AsyncUnlayer) -> None: + setting = await async_client.emails.settings.update( + default_from_name="defaultFromName", + ) + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + async def test_raw_response_update(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.settings.with_raw_response.update() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + setting = await response.parse() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + @parametrize + async def test_streaming_response_update(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.settings.with_streaming_response.update() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + setting = await response.parse() + assert_matches_type(SettingUpdateResponse, setting, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/emails/test_stats.py b/tests/api_resources/emails/test_stats.py new file mode 100644 index 0000000..7e21686 --- /dev/null +++ b/tests/api_resources/emails/test_stats.py @@ -0,0 +1,92 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import StatRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestStats: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + stat = client.emails.stats.retrieve() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + stat = client.emails.stats.retrieve( + group_by="day", + period="7d", + project_id="projectId", + ) + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.stats.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + stat = response.parse() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.stats.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + stat = response.parse() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncStats: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + stat = await async_client.emails.stats.retrieve() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + stat = await async_client.emails.stats.retrieve( + group_by="day", + period="7d", + project_id="projectId", + ) + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.stats.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + stat = await response.parse() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.stats.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + stat = await response.parse() + assert_matches_type(StatRetrieveResponse, stat, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/emails/test_suppressions.py b/tests/api_resources/emails/test_suppressions.py new file mode 100644 index 0000000..8998662 --- /dev/null +++ b/tests/api_resources/emails/test_suppressions.py @@ -0,0 +1,236 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import ( + SuppressionCreateResponse, + SuppressionDeleteResponse, + SuppressionRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSuppressions: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + suppression = client.emails.suppressions.create( + email="dev@stainless.com", + ) + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.emails.suppressions.with_raw_response.create( + email="dev@stainless.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = response.parse() + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.emails.suppressions.with_streaming_response.create( + email="dev@stainless.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = response.parse() + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + suppression = client.emails.suppressions.retrieve() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + suppression = client.emails.suppressions.retrieve( + cursor="cursor", + limit=1, + project_id="projectId", + ) + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.suppressions.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = response.parse() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.suppressions.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = response.parse() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_delete(self, client: Unlayer) -> None: + suppression = client.emails.suppressions.delete( + email="email", + ) + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + def test_method_delete_with_all_params(self, client: Unlayer) -> None: + suppression = client.emails.suppressions.delete( + email="email", + project_id="projectId", + ) + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + def test_raw_response_delete(self, client: Unlayer) -> None: + response = client.emails.suppressions.with_raw_response.delete( + email="email", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = response.parse() + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + def test_streaming_response_delete(self, client: Unlayer) -> None: + with client.emails.suppressions.with_streaming_response.delete( + email="email", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = response.parse() + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncSuppressions: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + suppression = await async_client.emails.suppressions.create( + email="dev@stainless.com", + ) + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.suppressions.with_raw_response.create( + email="dev@stainless.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = await response.parse() + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.suppressions.with_streaming_response.create( + email="dev@stainless.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = await response.parse() + assert_matches_type(SuppressionCreateResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + suppression = await async_client.emails.suppressions.retrieve() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + suppression = await async_client.emails.suppressions.retrieve( + cursor="cursor", + limit=1, + project_id="projectId", + ) + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.suppressions.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = await response.parse() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.suppressions.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = await response.parse() + assert_matches_type(SuppressionRetrieveResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_delete(self, async_client: AsyncUnlayer) -> None: + suppression = await async_client.emails.suppressions.delete( + email="email", + ) + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + async def test_method_delete_with_all_params(self, async_client: AsyncUnlayer) -> None: + suppression = await async_client.emails.suppressions.delete( + email="email", + project_id="projectId", + ) + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.suppressions.with_raw_response.delete( + email="email", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppression = await response.parse() + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.suppressions.with_streaming_response.delete( + email="email", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppression = await response.parse() + assert_matches_type(SuppressionDeleteResponse, suppression, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/emails/test_suppressions_check.py b/tests/api_resources/emails/test_suppressions_check.py new file mode 100644 index 0000000..b5df317 --- /dev/null +++ b/tests/api_resources/emails/test_suppressions_check.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import SuppressionsCheckRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSuppressionsCheck: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + suppressions_check = client.emails.suppressions_check.retrieve( + email="email", + ) + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + suppressions_check = client.emails.suppressions_check.retrieve( + email="email", + project_id="projectId", + ) + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.suppressions_check.with_raw_response.retrieve( + email="email", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppressions_check = response.parse() + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.suppressions_check.with_streaming_response.retrieve( + email="email", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppressions_check = response.parse() + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncSuppressionsCheck: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + suppressions_check = await async_client.emails.suppressions_check.retrieve( + email="email", + ) + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + suppressions_check = await async_client.emails.suppressions_check.retrieve( + email="email", + project_id="projectId", + ) + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.suppressions_check.with_raw_response.retrieve( + email="email", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + suppressions_check = await response.parse() + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.suppressions_check.with_streaming_response.retrieve( + email="email", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + suppressions_check = await response.parse() + assert_matches_type(SuppressionsCheckRetrieveResponse, suppressions_check, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/emails/test_template.py b/tests/api_resources/emails/test_template.py new file mode 100644 index 0000000..ff2e000 --- /dev/null +++ b/tests/api_resources/emails/test_template.py @@ -0,0 +1,148 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.emails import TemplateCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestTemplate: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + template = client.emails.template.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + template = client.emails.template.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + attachments=[ + { + "content": "content", + "content_type": "application/pdf", + "filename": "filename", + } + ], + bcc=[], + cc=[], + headers={"foo": "J!Q0Ok0bzJb7"}, + reply_to="dev@stainless.com", + subject="subject", + tags={"foo": "_1"}, + text="text", + variables={"foo": "string"}, + idempotency_key="idempotency-key", + ) + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.emails.template.with_raw_response.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + template = response.parse() + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.emails.template.with_streaming_response.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + template = response.parse() + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncTemplate: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + template = await async_client.emails.template.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + template = await async_client.emails.template.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + attachments=[ + { + "content": "content", + "content_type": "application/pdf", + "filename": "filename", + } + ], + bcc=[], + cc=[], + headers={"foo": "J!Q0Ok0bzJb7"}, + reply_to="dev@stainless.com", + subject="subject", + tags={"foo": "_1"}, + text="text", + variables={"foo": "string"}, + idempotency_key="idempotency-key", + ) + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.template.with_raw_response.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + template = await response.parse() + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.template.with_streaming_response.create( + from_="from", + template_id="496", + to=["dev@stainless.com"], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + template = await response.parse() + assert_matches_type(TemplateCreateResponse, template, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_schema.py b/tests/api_resources/templates/test_schema.py new file mode 100644 index 0000000..516f8f3 --- /dev/null +++ b/tests/api_resources/templates/test_schema.py @@ -0,0 +1,88 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestSchema: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + schema = client.templates.schema.retrieve() + assert schema is None + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + schema = client.templates.schema.retrieve( + display_mode="email", + simple=True, + ) + assert schema is None + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.templates.schema.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + schema = response.parse() + assert schema is None + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.templates.schema.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + schema = response.parse() + assert schema is None + + assert cast(Any, response.is_closed) is True + + +class TestAsyncSchema: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + schema = await async_client.templates.schema.retrieve() + assert schema is None + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + schema = await async_client.templates.schema.retrieve( + display_mode="email", + simple=True, + ) + assert schema is None + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.schema.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + schema = await response.parse() + assert schema is None + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.schema.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + schema = await response.parse() + assert schema is None + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/templates/test_validate.py b/tests/api_resources/templates/test_validate.py new file mode 100644 index 0000000..ffd5d99 --- /dev/null +++ b/tests/api_resources/templates/test_validate.py @@ -0,0 +1,126 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.templates import ValidateCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestValidate: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + validate = client.templates.validate.create( + design={"foo": "bar"}, + ) + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + validate = client.templates.validate.create( + design={"foo": "bar"}, + custom_tools=[ + { + "options": {"foo": {"options": {}}}, + "slug": "slug", + "label": "label", + "supported_display_modes": ["email"], + "type": "type", + "values": {"foo": "bar"}, + } + ], + display_mode="email", + migrate=True, + schema="full", + ) + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.templates.validate.with_raw_response.create( + design={"foo": "bar"}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + validate = response.parse() + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.templates.validate.with_streaming_response.create( + design={"foo": "bar"}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + validate = response.parse() + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncValidate: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + validate = await async_client.templates.validate.create( + design={"foo": "bar"}, + ) + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + validate = await async_client.templates.validate.create( + design={"foo": "bar"}, + custom_tools=[ + { + "options": {"foo": {"options": {}}}, + "slug": "slug", + "label": "label", + "supported_display_modes": ["email"], + "type": "type", + "values": {"foo": "bar"}, + } + ], + display_mode="email", + migrate=True, + schema="full", + ) + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.templates.validate.with_raw_response.create( + design={"foo": "bar"}, + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + validate = await response.parse() + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.templates.validate.with_streaming_response.create( + design={"foo": "bar"}, + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + validate = await response.parse() + assert_matches_type(ValidateCreateResponse, validate, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_domains.py b/tests/api_resources/test_domains.py new file mode 100644 index 0000000..9530769 --- /dev/null +++ b/tests/api_resources/test_domains.py @@ -0,0 +1,293 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types import ( + DomainListResponse, + DomainCreateResponse, + DomainDeleteResponse, + DomainRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestDomains: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + domain = client.domains.create( + domain="domain", + ) + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.domains.with_raw_response.create( + domain="domain", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = response.parse() + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.domains.with_streaming_response.create( + domain="domain", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = response.parse() + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + domain = client.domains.retrieve( + "id", + ) + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.domains.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = response.parse() + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.domains.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = response.parse() + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.domains.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_list(self, client: Unlayer) -> None: + domain = client.domains.list() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: Unlayer) -> None: + response = client.domains.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = response.parse() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: Unlayer) -> None: + with client.domains.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = response.parse() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_delete(self, client: Unlayer) -> None: + domain = client.domains.delete( + "id", + ) + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + @parametrize + def test_raw_response_delete(self, client: Unlayer) -> None: + response = client.domains.with_raw_response.delete( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = response.parse() + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + @parametrize + def test_streaming_response_delete(self, client: Unlayer) -> None: + with client.domains.with_streaming_response.delete( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = response.parse() + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_delete(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.domains.with_raw_response.delete( + "", + ) + + +class TestAsyncDomains: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + domain = await async_client.domains.create( + domain="domain", + ) + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.domains.with_raw_response.create( + domain="domain", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = await response.parse() + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.domains.with_streaming_response.create( + domain="domain", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = await response.parse() + assert_matches_type(DomainCreateResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + domain = await async_client.domains.retrieve( + "id", + ) + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.domains.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = await response.parse() + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.domains.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = await response.parse() + assert_matches_type(DomainRetrieveResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.domains.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncUnlayer) -> None: + domain = await async_client.domains.list() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncUnlayer) -> None: + response = await async_client.domains.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = await response.parse() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncUnlayer) -> None: + async with async_client.domains.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = await response.parse() + assert_matches_type(DomainListResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_delete(self, async_client: AsyncUnlayer) -> None: + domain = await async_client.domains.delete( + "id", + ) + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncUnlayer) -> None: + response = await async_client.domains.with_raw_response.delete( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + domain = await response.parse() + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncUnlayer) -> None: + async with async_client.domains.with_streaming_response.delete( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + domain = await response.parse() + assert_matches_type(DomainDeleteResponse, domain, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_delete(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.domains.with_raw_response.delete( + "", + ) diff --git a/tests/api_resources/test_emails.py b/tests/api_resources/test_emails.py new file mode 100644 index 0000000..22fba10 --- /dev/null +++ b/tests/api_resources/test_emails.py @@ -0,0 +1,311 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types import ( + EmailListResponse, + EmailCreateResponse, + EmailRetrieveResponse, +) +from unlayer._utils import parse_date + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestEmails: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + email = client.emails.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + email = client.emails.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + attachments=[ + { + "content": "content", + "content_type": "application/pdf", + "filename": "filename", + } + ], + bcc=[], + cc=[], + headers={"foo": "J!Q0Ok0bzJb7"}, + reply_to="dev@stainless.com", + tags={"foo": "_1"}, + text="text", + idempotency_key="idempotency-key", + ) + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.emails.with_raw_response.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = response.parse() + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.emails.with_streaming_response.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = response.parse() + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + email = client.emails.retrieve( + "id", + ) + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.emails.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = response.parse() + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.emails.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = response.parse() + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.emails.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_list(self, client: Unlayer) -> None: + email = client.emails.list() + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + def test_method_list_with_all_params(self, client: Unlayer) -> None: + email = client.emails.list( + cursor="cursor", + from_=parse_date("2019-12-27"), + limit=1, + project_id="projectId", + search="search", + status="queued", + tag="tag", + to=parse_date("2019-12-27"), + ) + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: Unlayer) -> None: + response = client.emails.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = response.parse() + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: Unlayer) -> None: + with client.emails.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = response.parse() + assert_matches_type(EmailListResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncEmails: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + email = await async_client.emails.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + email = await async_client.emails.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + attachments=[ + { + "content": "content", + "content_type": "application/pdf", + "filename": "filename", + } + ], + bcc=[], + cc=[], + headers={"foo": "J!Q0Ok0bzJb7"}, + reply_to="dev@stainless.com", + tags={"foo": "_1"}, + text="text", + idempotency_key="idempotency-key", + ) + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.with_raw_response.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = await response.parse() + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.with_streaming_response.create( + from_="from", + html="html", + subject="subject", + to=["dev@stainless.com"], + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = await response.parse() + assert_matches_type(EmailCreateResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + email = await async_client.emails.retrieve( + "id", + ) + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = await response.parse() + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = await response.parse() + assert_matches_type(EmailRetrieveResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.emails.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncUnlayer) -> None: + email = await async_client.emails.list() + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + async def test_method_list_with_all_params(self, async_client: AsyncUnlayer) -> None: + email = await async_client.emails.list( + cursor="cursor", + from_=parse_date("2019-12-27"), + limit=1, + project_id="projectId", + search="search", + status="queued", + tag="tag", + to=parse_date("2019-12-27"), + ) + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncUnlayer) -> None: + response = await async_client.emails.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + email = await response.parse() + assert_matches_type(EmailListResponse, email, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncUnlayer) -> None: + async with async_client.emails.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + email = await response.parse() + assert_matches_type(EmailListResponse, email, path=["response"]) + + assert cast(Any, response.is_closed) is True diff --git a/tests/api_resources/test_webhooks.py b/tests/api_resources/test_webhooks.py new file mode 100644 index 0000000..99e1d07 --- /dev/null +++ b/tests/api_resources/test_webhooks.py @@ -0,0 +1,408 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types import ( + WebhookListResponse, + WebhookCreateResponse, + WebhookDeleteResponse, + WebhookUpdateResponse, + WebhookRetrieveResponse, +) + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestWebhooks: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + webhook = client.webhooks.create( + url="https://example.com", + ) + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + def test_method_create_with_all_params(self, client: Unlayer) -> None: + webhook = client.webhooks.create( + url="https://example.com", + active=True, + events=["email.sent"], + ) + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.webhooks.with_raw_response.create( + url="https://example.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = response.parse() + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.webhooks.with_streaming_response.create( + url="https://example.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = response.parse() + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + webhook = client.webhooks.retrieve( + "id", + ) + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.webhooks.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = response.parse() + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.webhooks.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = response.parse() + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_retrieve(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.webhooks.with_raw_response.retrieve( + "", + ) + + @parametrize + def test_method_update(self, client: Unlayer) -> None: + webhook = client.webhooks.update( + id="id", + ) + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + def test_method_update_with_all_params(self, client: Unlayer) -> None: + webhook = client.webhooks.update( + id="id", + active=True, + events=["email.sent"], + url="https://example.com", + ) + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + def test_raw_response_update(self, client: Unlayer) -> None: + response = client.webhooks.with_raw_response.update( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = response.parse() + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + def test_streaming_response_update(self, client: Unlayer) -> None: + with client.webhooks.with_streaming_response.update( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = response.parse() + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_update(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.webhooks.with_raw_response.update( + id="", + ) + + @parametrize + def test_method_list(self, client: Unlayer) -> None: + webhook = client.webhooks.list() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + @parametrize + def test_raw_response_list(self, client: Unlayer) -> None: + response = client.webhooks.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = response.parse() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + @parametrize + def test_streaming_response_list(self, client: Unlayer) -> None: + with client.webhooks.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = response.parse() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_method_delete(self, client: Unlayer) -> None: + webhook = client.webhooks.delete( + "id", + ) + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + @parametrize + def test_raw_response_delete(self, client: Unlayer) -> None: + response = client.webhooks.with_raw_response.delete( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = response.parse() + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + @parametrize + def test_streaming_response_delete(self, client: Unlayer) -> None: + with client.webhooks.with_streaming_response.delete( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = response.parse() + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_delete(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.webhooks.with_raw_response.delete( + "", + ) + + +class TestAsyncWebhooks: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.create( + url="https://example.com", + ) + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + async def test_method_create_with_all_params(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.create( + url="https://example.com", + active=True, + events=["email.sent"], + ) + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.with_raw_response.create( + url="https://example.com", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = await response.parse() + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.with_streaming_response.create( + url="https://example.com", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = await response.parse() + assert_matches_type(WebhookCreateResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.retrieve( + "id", + ) + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.with_raw_response.retrieve( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = await response.parse() + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.with_streaming_response.retrieve( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = await response.parse() + assert_matches_type(WebhookRetrieveResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_retrieve(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.webhooks.with_raw_response.retrieve( + "", + ) + + @parametrize + async def test_method_update(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.update( + id="id", + ) + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + async def test_method_update_with_all_params(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.update( + id="id", + active=True, + events=["email.sent"], + url="https://example.com", + ) + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + async def test_raw_response_update(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.with_raw_response.update( + id="id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = await response.parse() + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + @parametrize + async def test_streaming_response_update(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.with_streaming_response.update( + id="id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = await response.parse() + assert_matches_type(WebhookUpdateResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_update(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.webhooks.with_raw_response.update( + id="", + ) + + @parametrize + async def test_method_list(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.list() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + @parametrize + async def test_raw_response_list(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.with_raw_response.list() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = await response.parse() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + @parametrize + async def test_streaming_response_list(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.with_streaming_response.list() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = await response.parse() + assert_matches_type(WebhookListResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_method_delete(self, async_client: AsyncUnlayer) -> None: + webhook = await async_client.webhooks.delete( + "id", + ) + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + @parametrize + async def test_raw_response_delete(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.with_raw_response.delete( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + webhook = await response.parse() + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + @parametrize + async def test_streaming_response_delete(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.with_streaming_response.delete( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + webhook = await response.parse() + assert_matches_type(WebhookDeleteResponse, webhook, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_delete(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.webhooks.with_raw_response.delete( + "", + ) diff --git a/tests/api_resources/webhooks/__init__.py b/tests/api_resources/webhooks/__init__.py new file mode 100644 index 0000000..fd8019a --- /dev/null +++ b/tests/api_resources/webhooks/__init__.py @@ -0,0 +1 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. diff --git a/tests/api_resources/webhooks/test_rotate_secret.py b/tests/api_resources/webhooks/test_rotate_secret.py new file mode 100644 index 0000000..ccc9ebd --- /dev/null +++ b/tests/api_resources/webhooks/test_rotate_secret.py @@ -0,0 +1,100 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types.webhooks import RotateSecretCreateResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestRotateSecret: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_create(self, client: Unlayer) -> None: + rotate_secret = client.webhooks.rotate_secret.create( + "id", + ) + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + @parametrize + def test_raw_response_create(self, client: Unlayer) -> None: + response = client.webhooks.rotate_secret.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + rotate_secret = response.parse() + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + @parametrize + def test_streaming_response_create(self, client: Unlayer) -> None: + with client.webhooks.rotate_secret.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + rotate_secret = response.parse() + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + def test_path_params_create(self, client: Unlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + client.webhooks.rotate_secret.with_raw_response.create( + "", + ) + + +class TestAsyncRotateSecret: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_create(self, async_client: AsyncUnlayer) -> None: + rotate_secret = await async_client.webhooks.rotate_secret.create( + "id", + ) + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + @parametrize + async def test_raw_response_create(self, async_client: AsyncUnlayer) -> None: + response = await async_client.webhooks.rotate_secret.with_raw_response.create( + "id", + ) + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + rotate_secret = await response.parse() + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + @parametrize + async def test_streaming_response_create(self, async_client: AsyncUnlayer) -> None: + async with async_client.webhooks.rotate_secret.with_streaming_response.create( + "id", + ) as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + rotate_secret = await response.parse() + assert_matches_type(RotateSecretCreateResponse, rotate_secret, path=["response"]) + + assert cast(Any, response.is_closed) is True + + @parametrize + async def test_path_params_create(self, async_client: AsyncUnlayer) -> None: + with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"): + await async_client.webhooks.rotate_secret.with_raw_response.create( + "", + ) From cd35d3b93bedcbc3834beb79c1085b45b81c46ce Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 3 Aug 2026 11:13:07 +0000 Subject: [PATCH 45/46] feat(api): api update --- .stats.yml | 8 +- api.md | 12 + src/unlayer/_client.py | 57 +++- src/unlayer/resources/__init__.py | 14 + src/unlayer/resources/blocks.py | 261 +++++++++++++++++++ src/unlayer/types/__init__.py | 2 + src/unlayer/types/block_retrieve_params.py | 43 +++ src/unlayer/types/block_retrieve_response.py | 59 +++++ tests/api_resources/test_blocks.py | 102 ++++++++ 9 files changed, 553 insertions(+), 5 deletions(-) create mode 100644 src/unlayer/resources/blocks.py create mode 100644 src/unlayer/types/block_retrieve_params.py create mode 100644 src/unlayer/types/block_retrieve_response.py create mode 100644 tests/api_resources/test_blocks.py diff --git a/.stats.yml b/.stats.yml index b5c4710..022e0e6 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 50 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-112356d364a4c9b7cf7f8d272937732568d750f9574ecc0c07516eca112cdddf.yml -openapi_spec_hash: 283e15c9bc02c4d7c69189873b1da9d4 -config_hash: c65b47a2f20400d392a50837c0a10945 +configured_endpoints: 51 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/unlayer/unlayer-92f6b863c3ee96cd2d4dd5b6a38d2820b0a56bf1006a0429a3d6fb756530d781.yml +openapi_spec_hash: 204d0db45842998a761ec507960eae9f +config_hash: 31bbe4c50af7bd9aea5582d9a2ab786d diff --git a/api.md b/api.md index 42f2916..d9ce59e 100644 --- a/api.md +++ b/api.md @@ -1,3 +1,15 @@ +# Blocks + +Types: + +```python +from unlayer.types import BlockRetrieveResponse +``` + +Methods: + +- client.blocks.retrieve(\*\*params) -> BlockRetrieveResponse + # Domains Types: diff --git a/src/unlayer/_client.py b/src/unlayer/_client.py index 9c811c9..239c071 100644 --- a/src/unlayer/_client.py +++ b/src/unlayer/_client.py @@ -36,8 +36,9 @@ ) if TYPE_CHECKING: - from .resources import me, emails, domains, projects, webhooks, templates, workspaces, editor_sessions + from .resources import me, blocks, emails, domains, projects, webhooks, templates, workspaces, editor_sessions from .resources.me.me import MeResource, AsyncMeResource + from .resources.blocks import BlocksResource, AsyncBlocksResource from .resources.workspaces import WorkspacesResource, AsyncWorkspacesResource from .resources.emails.emails import EmailsResource, AsyncEmailsResource from .resources.domains.domains import DomainsResource, AsyncDomainsResource @@ -124,6 +125,15 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def blocks(self) -> BlocksResource: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import BlocksResource + + return BlocksResource(self) + @cached_property def domains(self) -> DomainsResource: from .resources.domains import DomainsResource @@ -392,6 +402,15 @@ def __init__( _strict_response_validation=_strict_response_validation, ) + @cached_property + def blocks(self) -> AsyncBlocksResource: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import AsyncBlocksResource + + return AsyncBlocksResource(self) + @cached_property def domains(self) -> AsyncDomainsResource: from .resources.domains import AsyncDomainsResource @@ -591,6 +610,15 @@ class UnlayerWithRawResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def blocks(self) -> blocks.BlocksResourceWithRawResponse: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import BlocksResourceWithRawResponse + + return BlocksResourceWithRawResponse(self._client.blocks) + @cached_property def domains(self) -> domains.DomainsResourceWithRawResponse: from .resources.domains import DomainsResourceWithRawResponse @@ -651,6 +679,15 @@ class AsyncUnlayerWithRawResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def blocks(self) -> blocks.AsyncBlocksResourceWithRawResponse: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import AsyncBlocksResourceWithRawResponse + + return AsyncBlocksResourceWithRawResponse(self._client.blocks) + @cached_property def domains(self) -> domains.AsyncDomainsResourceWithRawResponse: from .resources.domains import AsyncDomainsResourceWithRawResponse @@ -711,6 +748,15 @@ class UnlayerWithStreamedResponse: def __init__(self, client: Unlayer) -> None: self._client = client + @cached_property + def blocks(self) -> blocks.BlocksResourceWithStreamingResponse: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import BlocksResourceWithStreamingResponse + + return BlocksResourceWithStreamingResponse(self._client.blocks) + @cached_property def domains(self) -> domains.DomainsResourceWithStreamingResponse: from .resources.domains import DomainsResourceWithStreamingResponse @@ -771,6 +817,15 @@ class AsyncUnlayerWithStreamedResponse: def __init__(self, client: AsyncUnlayer) -> None: self._client = client + @cached_property + def blocks(self) -> blocks.AsyncBlocksResourceWithStreamingResponse: + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + from .resources.blocks import AsyncBlocksResourceWithStreamingResponse + + return AsyncBlocksResourceWithStreamingResponse(self._client.blocks) + @cached_property def domains(self) -> domains.AsyncDomainsResourceWithStreamingResponse: from .resources.domains import AsyncDomainsResourceWithStreamingResponse diff --git a/src/unlayer/resources/__init__.py b/src/unlayer/resources/__init__.py index dbeb66f..fd2aaa5 100644 --- a/src/unlayer/resources/__init__.py +++ b/src/unlayer/resources/__init__.py @@ -8,6 +8,14 @@ MeResourceWithStreamingResponse, AsyncMeResourceWithStreamingResponse, ) +from .blocks import ( + BlocksResource, + AsyncBlocksResource, + BlocksResourceWithRawResponse, + AsyncBlocksResourceWithRawResponse, + BlocksResourceWithStreamingResponse, + AsyncBlocksResourceWithStreamingResponse, +) from .emails import ( EmailsResource, AsyncEmailsResource, @@ -66,6 +74,12 @@ ) __all__ = [ + "BlocksResource", + "AsyncBlocksResource", + "BlocksResourceWithRawResponse", + "AsyncBlocksResourceWithRawResponse", + "BlocksResourceWithStreamingResponse", + "AsyncBlocksResourceWithStreamingResponse", "DomainsResource", "AsyncDomainsResource", "DomainsResourceWithRawResponse", diff --git a/src/unlayer/resources/blocks.py b/src/unlayer/resources/blocks.py new file mode 100644 index 0000000..4d4d849 --- /dev/null +++ b/src/unlayer/resources/blocks.py @@ -0,0 +1,261 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal + +import httpx + +from ..types import block_retrieve_params +from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given +from .._utils import maybe_transform, async_maybe_transform +from .._compat import cached_property +from .._resource import SyncAPIResource, AsyncAPIResource +from .._response import ( + to_raw_response_wrapper, + to_streamed_response_wrapper, + async_to_raw_response_wrapper, + async_to_streamed_response_wrapper, +) +from .._base_client import make_request_options +from ..types.block_retrieve_response import BlockRetrieveResponse + +__all__ = ["BlocksResource", "AsyncBlocksResource"] + + +class BlocksResource(SyncAPIResource): + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + + @cached_property + def with_raw_response(self) -> BlocksResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return BlocksResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> BlocksResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return BlocksResourceWithStreamingResponse(self) + + def retrieve( + self, + *, + category: str | Omit = omit, + cursor: str | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + include_data: bool | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + scope: Literal["all", "shared", "user"] | Omit = omit, + user_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BlockRetrieveResponse: + """List blocks with cursor-based pagination. + + Returns both shared project blocks and + blocks saved by end-users; each user-saved block carries the userId it was saved + under (null for shared blocks), so usage can be aggregated per end-user without + enumerating user IDs. Returns blocks in descending order by creation. + + Args: + category: Filter by category (case-insensitive search) + + cursor: Pagination cursor from previous response + + display_mode: Filter by display mode + + include_data: Include the block design JSON in each item. Pass false for lightweight sweeps + (e.g. usage reports). + + limit: Number of blocks to return (1-100) + + project_id: The project ID to list blocks for + + scope: Filter by block ownership: shared project blocks, end-user saved blocks, or both + + user_id: Only blocks saved by this end-user (exact match on the user id your app passes + to the editor) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return self._get( + "/v3/blocks", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=maybe_transform( + { + "category": category, + "cursor": cursor, + "display_mode": display_mode, + "include_data": include_data, + "limit": limit, + "project_id": project_id, + "scope": scope, + "user_id": user_id, + }, + block_retrieve_params.BlockRetrieveParams, + ), + ), + cast_to=BlockRetrieveResponse, + ) + + +class AsyncBlocksResource(AsyncAPIResource): + """ + Reusable design blocks — list shared project blocks and end-user saved blocks for backup, migration, and usage reporting. + """ + + @cached_property + def with_raw_response(self) -> AsyncBlocksResourceWithRawResponse: + """ + This property can be used as a prefix for any HTTP method call to return + the raw response object instead of the parsed content. + + For more information, see https://www.github.com/unlayer/unlayer-python#accessing-raw-response-data-eg-headers + """ + return AsyncBlocksResourceWithRawResponse(self) + + @cached_property + def with_streaming_response(self) -> AsyncBlocksResourceWithStreamingResponse: + """ + An alternative to `.with_raw_response` that doesn't eagerly read the response body. + + For more information, see https://www.github.com/unlayer/unlayer-python#with_streaming_response + """ + return AsyncBlocksResourceWithStreamingResponse(self) + + async def retrieve( + self, + *, + category: str | Omit = omit, + cursor: str | Omit = omit, + display_mode: Literal["email", "web", "popup", "document"] | Omit = omit, + include_data: bool | Omit = omit, + limit: int | Omit = omit, + project_id: str | Omit = omit, + scope: Literal["all", "shared", "user"] | Omit = omit, + user_id: str | Omit = omit, + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. + # The extra values given here take precedence over values defined on the client or passed to this method. + extra_headers: Headers | None = None, + extra_query: Query | None = None, + extra_body: Body | None = None, + timeout: float | httpx.Timeout | None | NotGiven = not_given, + ) -> BlockRetrieveResponse: + """List blocks with cursor-based pagination. + + Returns both shared project blocks and + blocks saved by end-users; each user-saved block carries the userId it was saved + under (null for shared blocks), so usage can be aggregated per end-user without + enumerating user IDs. Returns blocks in descending order by creation. + + Args: + category: Filter by category (case-insensitive search) + + cursor: Pagination cursor from previous response + + display_mode: Filter by display mode + + include_data: Include the block design JSON in each item. Pass false for lightweight sweeps + (e.g. usage reports). + + limit: Number of blocks to return (1-100) + + project_id: The project ID to list blocks for + + scope: Filter by block ownership: shared project blocks, end-user saved blocks, or both + + user_id: Only blocks saved by this end-user (exact match on the user id your app passes + to the editor) + + extra_headers: Send extra headers + + extra_query: Add additional query parameters to the request + + extra_body: Add additional JSON properties to the request + + timeout: Override the client-level default timeout for this request, in seconds + """ + return await self._get( + "/v3/blocks", + options=make_request_options( + extra_headers=extra_headers, + extra_query=extra_query, + extra_body=extra_body, + timeout=timeout, + query=await async_maybe_transform( + { + "category": category, + "cursor": cursor, + "display_mode": display_mode, + "include_data": include_data, + "limit": limit, + "project_id": project_id, + "scope": scope, + "user_id": user_id, + }, + block_retrieve_params.BlockRetrieveParams, + ), + ), + cast_to=BlockRetrieveResponse, + ) + + +class BlocksResourceWithRawResponse: + def __init__(self, blocks: BlocksResource) -> None: + self._blocks = blocks + + self.retrieve = to_raw_response_wrapper( + blocks.retrieve, + ) + + +class AsyncBlocksResourceWithRawResponse: + def __init__(self, blocks: AsyncBlocksResource) -> None: + self._blocks = blocks + + self.retrieve = async_to_raw_response_wrapper( + blocks.retrieve, + ) + + +class BlocksResourceWithStreamingResponse: + def __init__(self, blocks: BlocksResource) -> None: + self._blocks = blocks + + self.retrieve = to_streamed_response_wrapper( + blocks.retrieve, + ) + + +class AsyncBlocksResourceWithStreamingResponse: + def __init__(self, blocks: AsyncBlocksResource) -> None: + self._blocks = blocks + + self.retrieve = async_to_streamed_response_wrapper( + blocks.retrieve, + ) diff --git a/src/unlayer/types/__init__.py b/src/unlayer/types/__init__.py index d2ae90a..a66c424 100644 --- a/src/unlayer/types/__init__.py +++ b/src/unlayer/types/__init__.py @@ -8,6 +8,7 @@ from .domain_create_params import DomainCreateParams as DomainCreateParams from .domain_list_response import DomainListResponse as DomainListResponse from .template_list_params import TemplateListParams as TemplateListParams +from .block_retrieve_params import BlockRetrieveParams as BlockRetrieveParams from .email_create_response import EmailCreateResponse as EmailCreateResponse from .webhook_create_params import WebhookCreateParams as WebhookCreateParams from .webhook_list_response import WebhookListResponse as WebhookListResponse @@ -15,6 +16,7 @@ from .domain_create_response import DomainCreateResponse as DomainCreateResponse from .domain_delete_response import DomainDeleteResponse as DomainDeleteResponse from .template_list_response import TemplateListResponse as TemplateListResponse +from .block_retrieve_response import BlockRetrieveResponse as BlockRetrieveResponse from .email_retrieve_response import EmailRetrieveResponse as EmailRetrieveResponse from .webhook_create_response import WebhookCreateResponse as WebhookCreateResponse from .webhook_delete_response import WebhookDeleteResponse as WebhookDeleteResponse diff --git a/src/unlayer/types/block_retrieve_params.py b/src/unlayer/types/block_retrieve_params.py new file mode 100644 index 0000000..904dec6 --- /dev/null +++ b/src/unlayer/types/block_retrieve_params.py @@ -0,0 +1,43 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +from typing_extensions import Literal, Annotated, TypedDict + +from .._utils import PropertyInfo + +__all__ = ["BlockRetrieveParams"] + + +class BlockRetrieveParams(TypedDict, total=False): + category: str + """Filter by category (case-insensitive search)""" + + cursor: str + """Pagination cursor from previous response""" + + display_mode: Annotated[Literal["email", "web", "popup", "document"], PropertyInfo(alias="displayMode")] + """Filter by display mode""" + + include_data: Annotated[bool, PropertyInfo(alias="includeData")] + """Include the block design JSON in each item. + + Pass false for lightweight sweeps (e.g. usage reports). + """ + + limit: int + """Number of blocks to return (1-100)""" + + project_id: Annotated[str, PropertyInfo(alias="projectId")] + """The project ID to list blocks for""" + + scope: Literal["all", "shared", "user"] + """ + Filter by block ownership: shared project blocks, end-user saved blocks, or both + """ + + user_id: Annotated[str, PropertyInfo(alias="userId")] + """ + Only blocks saved by this end-user (exact match on the user id your app passes + to the editor) + """ diff --git a/src/unlayer/types/block_retrieve_response.py b/src/unlayer/types/block_retrieve_response.py new file mode 100644 index 0000000..b3e3f8b --- /dev/null +++ b/src/unlayer/types/block_retrieve_response.py @@ -0,0 +1,59 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from typing import Dict, List, Optional +from datetime import datetime + +from pydantic import Field as FieldInfo + +from .._models import BaseModel + +__all__ = ["BlockRetrieveResponse", "Data"] + + +class Data(BaseModel): + id: Optional[str] = None + """Block ID""" + + category: Optional[str] = None + """Block category""" + + created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None) + + data: Optional[Dict[str, object]] = None + """The block design JSON. Omitted when includeData=false is passed.""" + + display_mode: Optional[str] = FieldInfo(alias="displayMode", default=None) + """Display mode the block was saved for: email, web, popup, or document""" + + is_sync_enabled: Optional[bool] = FieldInfo(alias="isSyncEnabled", default=None) + """Whether the block is currently a synced block""" + + sync_id: Optional[str] = FieldInfo(alias="syncId", default=None) + """Synced-block ID referenced by designs using this block. + + Null when the block has never been synced. + """ + + tags: Optional[List[str]] = None + """Block tags""" + + thumbnail_url: Optional[str] = FieldInfo(alias="thumbnailUrl", default=None) + """URL of the auto-generated block thumbnail, if available""" + + updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None) + + user_id: Optional[str] = FieldInfo(alias="userId", default=None) + """ + End-user ID the block was saved under (the user id your app passes to the + editor). Null for shared project blocks. + """ + + +class BlockRetrieveResponse(BaseModel): + data: List[Data] + + has_more: bool + """Whether there are more results after this page""" + + next_cursor: Optional[str] = None + """Cursor for the next page. Null if no more results.""" diff --git a/tests/api_resources/test_blocks.py b/tests/api_resources/test_blocks.py new file mode 100644 index 0000000..b82fb9f --- /dev/null +++ b/tests/api_resources/test_blocks.py @@ -0,0 +1,102 @@ +# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. + +from __future__ import annotations + +import os +from typing import Any, cast + +import pytest + +from unlayer import Unlayer, AsyncUnlayer +from tests.utils import assert_matches_type +from unlayer.types import BlockRetrieveResponse + +base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010") + + +class TestBlocks: + parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"]) + + @parametrize + def test_method_retrieve(self, client: Unlayer) -> None: + block = client.blocks.retrieve() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + def test_method_retrieve_with_all_params(self, client: Unlayer) -> None: + block = client.blocks.retrieve( + category="category", + cursor="cursor", + display_mode="email", + include_data=True, + limit=1, + project_id="projectId", + scope="all", + user_id="userId", + ) + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + def test_raw_response_retrieve(self, client: Unlayer) -> None: + response = client.blocks.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + block = response.parse() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + def test_streaming_response_retrieve(self, client: Unlayer) -> None: + with client.blocks.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + block = response.parse() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + assert cast(Any, response.is_closed) is True + + +class TestAsyncBlocks: + parametrize = pytest.mark.parametrize( + "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"] + ) + + @parametrize + async def test_method_retrieve(self, async_client: AsyncUnlayer) -> None: + block = await async_client.blocks.retrieve() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + async def test_method_retrieve_with_all_params(self, async_client: AsyncUnlayer) -> None: + block = await async_client.blocks.retrieve( + category="category", + cursor="cursor", + display_mode="email", + include_data=True, + limit=1, + project_id="projectId", + scope="all", + user_id="userId", + ) + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + async def test_raw_response_retrieve(self, async_client: AsyncUnlayer) -> None: + response = await async_client.blocks.with_raw_response.retrieve() + + assert response.is_closed is True + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + block = await response.parse() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + @parametrize + async def test_streaming_response_retrieve(self, async_client: AsyncUnlayer) -> None: + async with async_client.blocks.with_streaming_response.retrieve() as response: + assert not response.is_closed + assert response.http_request.headers.get("X-Stainless-Lang") == "python" + + block = await response.parse() + assert_matches_type(BlockRetrieveResponse, block, path=["response"]) + + assert cast(Any, response.is_closed) is True From b6eb2396d1161b6da86d64f55774cb6688679089 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 3 Aug 2026 11:13:37 +0000 Subject: [PATCH 46/46] release: 0.2.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 64 +++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- src/unlayer/_version.py | 2 +- 4 files changed, 67 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 3d2ac0b..10f3091 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0" + ".": "0.2.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3935a47..52b7841 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,69 @@ # Changelog +## 0.2.0 (2026-08-03) + +Full Changelog: [v0.1.0...v0.2.0](https://github.com/unlayer/unlayer-python/compare/v0.1.0...v0.2.0) + +### Features + +* **api:** api update ([cd35d3b](https://github.com/unlayer/unlayer-python/commit/cd35d3b93bedcbc3834beb79c1085b45b81c46ce)) +* **api:** api update ([8e7ad05](https://github.com/unlayer/unlayer-python/commit/8e7ad05d2c31ac5e30d8336c0a2c612c37225298)) +* **api:** api update ([c6b629b](https://github.com/unlayer/unlayer-python/commit/c6b629ba3d6183805e939a2c7dca278bbbb7fed1)) +* **api:** api update ([afa74d0](https://github.com/unlayer/unlayer-python/commit/afa74d05a94c6614ff92ee5f714288bca8d13d7d)) +* **api:** api update ([a19b633](https://github.com/unlayer/unlayer-python/commit/a19b633a992b7f3c7fea7d3e0086d6df4d417b7f)) +* **api:** api update ([c85f087](https://github.com/unlayer/unlayer-python/commit/c85f0878584b737bc83016c20c0bba9fc81d498b)) +* **api:** api update ([808556a](https://github.com/unlayer/unlayer-python/commit/808556a0dad1364117d5b63c2285f47fa2bb641f)) +* **api:** api update ([7b6ee51](https://github.com/unlayer/unlayer-python/commit/7b6ee5197eff6de84b71685f2ceded7cac99d6a5)) +* **api:** api update ([167b11e](https://github.com/unlayer/unlayer-python/commit/167b11e590fda9652ca3f3c798b9d0c90c6b2ce1)) +* **api:** api update ([d8c02a2](https://github.com/unlayer/unlayer-python/commit/d8c02a28202f28aff216e1c51b4dc183bf758246)) +* **client:** add compatibility aliases for old type names ([65987ba](https://github.com/unlayer/unlayer-python/commit/65987ba2ea7ff4f674f3fca91869b3685af4fc55)) +* **internal:** implement indices array format for query and form serialization ([e8555c7](https://github.com/unlayer/unlayer-python/commit/e8555c785eb5ac3fd4f46eba86514c83279c8455)) +* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([1105634](https://github.com/unlayer/unlayer-python/commit/1105634587e7908392c26243a3a22c44d5fa63e7)) + + +### Bug Fixes + +* **client:** preserve hardcoded query params when merging with user params ([75acb50](https://github.com/unlayer/unlayer-python/commit/75acb50baa973b93439b0e1e803e34ec5ea0f891)) +* **deps:** bump minimum typing-extensions version ([b7baa1e](https://github.com/unlayer/unlayer-python/commit/b7baa1e5d138b5a33b63bed9dae37bfabb6d968d)) +* ensure file data are only sent as 1 parameter ([16c4a95](https://github.com/unlayer/unlayer-python/commit/16c4a958a038f89843bfd0287656f14c222bbc9a)) +* **pydantic:** do not pass `by_alias` unless set ([d31637b](https://github.com/unlayer/unlayer-python/commit/d31637bd182be359df4af936cb715cc554d9a14b)) +* sanitize endpoint path params ([bc0d6b6](https://github.com/unlayer/unlayer-python/commit/bc0d6b6b147d33cd2f65855284e7f435bdee09f9)) +* **types:** avoid type-checker errors on params with additional properties ([d03691f](https://github.com/unlayer/unlayer-python/commit/d03691f5182f0919ab3cdbfe66692fd287471f1b)) + + +### Performance Improvements + +* **client:** optimize file structure copying in multipart requests ([9e8bba9](https://github.com/unlayer/unlayer-python/commit/9e8bba9900b5252766dae4d7cd835fb264136ed4)) + + +### Chores + +* **ci:** skip lint on metadata-only changes ([3343492](https://github.com/unlayer/unlayer-python/commit/33434927ad6ab7c508d758335944cdc4123a5e17)) +* **ci:** skip uploading artifacts on stainless-internal branches ([907041a](https://github.com/unlayer/unlayer-python/commit/907041a9070f3c4a86605a21c9ab9a004a9bf553)) +* **internal:** codegen related update ([f6dbe33](https://github.com/unlayer/unlayer-python/commit/f6dbe33abfbb2b8231e0ffc0250e426e0e26f14c)) +* **internal:** codegen related update ([0e34552](https://github.com/unlayer/unlayer-python/commit/0e34552078692776f7e709082aba188a8609f37f)) +* **internal:** codegen related update ([59d0d24](https://github.com/unlayer/unlayer-python/commit/59d0d244b61420a3358eef33ace74de3c8c3bda3)) +* **internal:** codegen related update ([c76b368](https://github.com/unlayer/unlayer-python/commit/c76b3685383f50f9446c8d0c6844aed7ad8f3696)) +* **internal:** codegen related update ([d58e1b8](https://github.com/unlayer/unlayer-python/commit/d58e1b80f026a3fbb93c51e57af8afedcdb866e9)) +* **internal:** make `test_proxy_environment_variables` more resilient to env ([caea803](https://github.com/unlayer/unlayer-python/commit/caea803e4fc873ade6fbc9b9b66ff67938780f65)) +* **internal:** more robust bootstrap script ([2543d0b](https://github.com/unlayer/unlayer-python/commit/2543d0b9a29711c39f5b8b5bfeac15dfc66b79b3)) +* **internal:** tweak CI branches ([4e152dc](https://github.com/unlayer/unlayer-python/commit/4e152dccd0191c2dd4d321e8ca7b6550dc6bc3f0)) +* **internal:** update gitignore ([5a510e6](https://github.com/unlayer/unlayer-python/commit/5a510e6edf2e26d612be067b6c95e70780d01d57)) +* **test:** do not count install time for mock server timeout ([3ad7bbb](https://github.com/unlayer/unlayer-python/commit/3ad7bbb203d27a7b7f69fda2d0f3aebea329c49e)) +* **tests:** bump steady to v0.19.4 ([775fe46](https://github.com/unlayer/unlayer-python/commit/775fe461f02f96ebc4b7cd6ff2d8cab4c52d291d)) +* **tests:** bump steady to v0.19.5 ([9ef3615](https://github.com/unlayer/unlayer-python/commit/9ef3615041ea171a462a29f8cfd268133df0c6fc)) +* **tests:** bump steady to v0.19.6 ([33d721e](https://github.com/unlayer/unlayer-python/commit/33d721e46826c23bf5b1ce78477d003cb9cd83da)) +* **tests:** bump steady to v0.19.7 ([3d09621](https://github.com/unlayer/unlayer-python/commit/3d09621f6d61c74d431b9af1336c6c51d8396d4f)) +* **tests:** bump steady to v0.20.1 ([649317d](https://github.com/unlayer/unlayer-python/commit/649317dda33455a5b5e25aedeb0210a746b767f2)) +* **tests:** bump steady to v0.20.2 ([2c51cba](https://github.com/unlayer/unlayer-python/commit/2c51cba746385da9a9e5ec0ea00bf6c4cdee2bbd)) +* **tests:** bump steady to v0.22.1 ([0a6f60a](https://github.com/unlayer/unlayer-python/commit/0a6f60a8acb8c85a937166884ba523cc59821b8f)) + + +### Refactors + +* **tests:** switch from prism to steady ([d2618bd](https://github.com/unlayer/unlayer-python/commit/d2618bd109fcd053b5845009bc8221090930a369)) +* **types:** use `extra_items` from PEP 728 ([19677f4](https://github.com/unlayer/unlayer-python/commit/19677f4a04cd989500eecce93cbb0506cf1ebf32)) + ## 0.1.0 (2026-02-24) Full Changelog: [v0.0.1...v0.1.0](https://github.com/unlayer/unlayer-python/compare/v0.0.1...v0.1.0) diff --git a/pyproject.toml b/pyproject.toml index b650df0..a6ec046 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "unlayer" -version = "0.1.0" +version = "0.2.0" description = "The official Python library for the unlayer API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/unlayer/_version.py b/src/unlayer/_version.py index 47398ca..b0af64e 100644 --- a/src/unlayer/_version.py +++ b/src/unlayer/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "unlayer" -__version__ = "0.1.0" # x-release-please-version +__version__ = "0.2.0" # x-release-please-version