sequenzy 2.0.0__py3-none-any.whl

sequenzy/ab_tests/client.py

@@ -0,0 +1,1229 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.email_block import EmailBlock
+from .raw_client import AsyncRawAbTestsClient, RawAbTestsClient
+from .types.add_variant_ab_tests_response import AddVariantAbTestsResponse
+from .types.create_ab_tests_request_test_type import CreateAbTestsRequestTestType
+from .types.create_ab_tests_request_variants_item import CreateAbTestsRequestVariantsItem
+from .types.create_ab_tests_request_winner_criteria import CreateAbTestsRequestWinnerCriteria
+from .types.create_ab_tests_response import CreateAbTestsResponse
+from .types.delete_ab_tests_response import DeleteAbTestsResponse
+from .types.delete_variant_ab_tests_response import DeleteVariantAbTestsResponse
+from .types.get_ab_tests_response import GetAbTestsResponse
+from .types.get_stats_ab_tests_request_period import GetStatsAbTestsRequestPeriod
+from .types.get_stats_ab_tests_response import GetStatsAbTestsResponse
+from .types.list_ab_tests_response import ListAbTestsResponse
+from .types.restart_ab_tests_request_test_type import RestartAbTestsRequestTestType
+from .types.restart_ab_tests_response import RestartAbTestsResponse
+from .types.update_ab_tests_request_test_type import UpdateAbTestsRequestTestType
+from .types.update_ab_tests_request_winner_criteria import UpdateAbTestsRequestWinnerCriteria
+from .types.update_ab_tests_response import UpdateAbTestsResponse
+from .types.update_variant_ab_tests_response import UpdateVariantAbTestsResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AbTestsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAbTestsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAbTestsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAbTestsClient
+        """
+        return self._raw_client
+
+    def add_variant(
+        self,
+        ab_test_id: str,
+        *,
+        subject: str,
+        blocks: typing.Optional[typing.Sequence[EmailBlock]] = OMIT,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AddVariantAbTestsResponse:
+        """
+        Adds a variant to a draft campaign or sequence A/B test. Sequence variants receive an independent email template. The body defaults to the control email when blocks are omitted. Sequence tests whose parent sequence is active require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        subject : str
+            Variant subject line.
+
+        blocks : typing.Optional[typing.Sequence[EmailBlock]]
+            Variant body blocks. Defaults to the campaign or sequence control email blocks.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the A/B test belongs to an active sequence, because new variants immediately enter the live rotation.
+
+        preview_text : typing.Optional[str]
+            Variant preview text.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AddVariantAbTestsResponse
+            Variant added
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.add_variant(
+            ab_test_id="abTestId",
+            subject="subject",
+        )
+        """
+        _response = self._raw_client.add_variant(
+            ab_test_id,
+            subject=subject,
+            blocks=blocks,
+            confirm_live_change=confirm_live_change,
+            preview_text=preview_text,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create(
+        self,
+        *,
+        automation_node_id: typing.Optional[str] = OMIT,
+        campaign_id: typing.Optional[str] = OMIT,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        test_duration_minutes: typing.Optional[int] = OMIT,
+        test_percentage: typing.Optional[int] = OMIT,
+        test_type: typing.Optional[CreateAbTestsRequestTestType] = OMIT,
+        variants: typing.Optional[typing.Sequence[CreateAbTestsRequestVariantsItem]] = OMIT,
+        winner_criteria: typing.Optional[CreateAbTestsRequestWinnerCriteria] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateAbTestsResponse:
+        """
+        Creates a draft campaign A/B test or converts a sequence email node to action_ab_test. Provide exactly one owner. Variant A is copied into an independent email for sequences; sequence conversions require at least one extra variant.
+
+        Parameters
+        ----------
+        automation_node_id : typing.Optional[str]
+            Sequence action_email node to convert. Mutually exclusive with campaignId.
+
+        campaign_id : typing.Optional[str]
+            Campaign to attach the test to. Must be in draft or rejected status. Mutually exclusive with automationNodeId.
+
+        confirm_live_change : typing.Optional[bool]
+            Must be true when converting an email node in an active sequence.
+
+        name : typing.Optional[str]
+            Test name. Defaults to "A/B Test for <campaign name>".
+
+        test_duration_minutes : typing.Optional[int]
+            Campaign-only duration before winner selection. Sequence tests select after winnerThreshold recipients.
+
+        test_percentage : typing.Optional[int]
+            Campaign-only share of the audience that receives test sends. Sequence tests use winnerThreshold.
+
+        test_type : typing.Optional[CreateAbTestsRequestTestType]
+            Sequence variant strategy. Subject defaults to open_rate and content defaults to click_rate unless winnerCriteria is explicit.
+
+        variants : typing.Optional[typing.Sequence[CreateAbTestsRequestVariantsItem]]
+            Extra variants beyond the control. Required (min 1) when converting with automationNodeId. Total variants cannot exceed 5.
+
+        winner_criteria : typing.Optional[CreateAbTestsRequestWinnerCriteria]
+            Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default.
+
+        winner_threshold : typing.Optional[int]
+            Number of sequence recipients in the test sample.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateAbTestsResponse
+            A/B test created
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.create()
+        """
+        _response = self._raw_client.create(
+            automation_node_id=automation_node_id,
+            campaign_id=campaign_id,
+            confirm_live_change=confirm_live_change,
+            name=name,
+            test_duration_minutes=test_duration_minutes,
+            test_percentage=test_percentage,
+            test_type=test_type,
+            variants=variants,
+            winner_criteria=winner_criteria,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def delete(
+        self, ab_test_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteAbTestsResponse:
+        """
+        Deletes a campaign A/B test and its variants. Running tests cannot be deleted, and the linked campaign must be in draft or rejected status.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteAbTestsResponse
+            A/B test deleted
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.delete(
+            ab_test_id="abTestId",
+        )
+        """
+        _response = self._raw_client.delete(ab_test_id, request_options=request_options)
+        return _response.data
+
+    def delete_variant(
+        self,
+        ab_test_id: str,
+        variant_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteVariantAbTestsResponse:
+        """
+        Removes a variant from a draft campaign or sequence A/B test. The control variant A cannot be deleted, and at least 2 variants must remain. Deleting a sequence variant also deletes its dedicated email template; sequence tests whose parent sequence is active require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        variant_id : str
+            Variant ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the A/B test belongs to an active sequence, because deletion immediately changes the live rotation.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteVariantAbTestsResponse
+            Variant deleted
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.delete_variant(
+            ab_test_id="abTestId",
+            variant_id="variantId",
+        )
+        """
+        _response = self._raw_client.delete_variant(
+            ab_test_id, variant_id, confirm_live_change=confirm_live_change, request_options=request_options
+        )
+        return _response.data
+
+    def get(self, ab_test_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetAbTestsResponse:
+        """
+        Returns one A/B test with variants and variant localization status.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAbTestsResponse
+            A/B test returned
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.get(
+            ab_test_id="abTestId",
+        )
+        """
+        _response = self._raw_client.get(ab_test_id, request_options=request_options)
+        return _response.data
+
+    def get_stats(
+        self,
+        ab_test_id: str,
+        *,
+        end: typing.Optional[dt.datetime] = None,
+        include_machine_engagement: typing.Optional[bool] = None,
+        period: typing.Optional[GetStatsAbTestsRequestPeriod] = None,
+        start: typing.Optional[dt.datetime] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetStatsAbTestsResponse:
+        """
+        Returns aggregate and per-variant engagement stats for an A/B test.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        end : typing.Optional[dt.datetime]
+            Custom range end. Requires start.
+
+        include_machine_engagement : typing.Optional[bool]
+            Include detected scanner, preview, and tracked asset open/click events.
+
+        period : typing.Optional[GetStatsAbTestsRequestPeriod]
+            Optional period filter.
+
+        start : typing.Optional[dt.datetime]
+            Custom range start. Requires end.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetStatsAbTestsResponse
+            A/B test stats returned
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.get_stats(
+            ab_test_id="abTestId",
+        )
+        """
+        _response = self._raw_client.get_stats(
+            ab_test_id,
+            end=end,
+            include_machine_engagement=include_machine_engagement,
+            period=period,
+            start=start,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def list(
+        self, *, sequence_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListAbTestsResponse:
+        """
+        Lists A/B tests and variants for the authenticated company, optionally filtered by sequence.
+
+        Parameters
+        ----------
+        sequence_id : typing.Optional[str]
+            Optional sequence ID filter for automation A/B tests.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListAbTestsResponse
+            A/B tests returned
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.list()
+        """
+        _response = self._raw_client.list(sequence_id=sequence_id, request_options=request_options)
+        return _response.data
+
+    def restart(
+        self,
+        ab_test_id: str,
+        *,
+        source_variant_id: typing.Optional[str] = OMIT,
+        test_type: typing.Optional[RestartAbTestsRequestTestType] = OMIT,
+        variant_count: typing.Optional[int] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> RestartAbTestsResponse:
+        """
+        Starts a new draft sequence A/B test from the selected control variant after a winner has been selected. The new test becomes active after generated variants are ready.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID to restart.
+
+        source_variant_id : typing.Optional[str]
+            Variant ID to use as the new control email. Defaults to the selected winner.
+
+        test_type : typing.Optional[RestartAbTestsRequestTestType]
+            Test type for generated variants.
+
+        variant_count : typing.Optional[int]
+            Total variants including the control.
+
+        winner_threshold : typing.Optional[int]
+            Subscribers before selecting a winner.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RestartAbTestsResponse
+            A/B test restarted
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.restart(
+            ab_test_id="abTestId",
+        )
+        """
+        _response = self._raw_client.restart(
+            ab_test_id,
+            source_variant_id=source_variant_id,
+            test_type=test_type,
+            variant_count=variant_count,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def update(
+        self,
+        ab_test_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        test_duration_minutes: typing.Optional[int] = OMIT,
+        test_percentage: typing.Optional[int] = OMIT,
+        test_type: typing.Optional[UpdateAbTestsRequestTestType] = OMIT,
+        winner_criteria: typing.Optional[UpdateAbTestsRequestWinnerCriteria] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateAbTestsResponse:
+        """
+        Updates a draft campaign test or the effective settings for a sequence test. Campaigns use testPercentage and testDurationMinutes; sequences use testType and winnerThreshold. Sequence changes that affect a live or already-used test require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required when sequence settings affect an active test or a test with recorded activity.
+
+        name : typing.Optional[str]
+
+        test_duration_minutes : typing.Optional[int]
+            Campaign-only test duration.
+
+        test_percentage : typing.Optional[int]
+            Campaign-only test audience percentage.
+
+        test_type : typing.Optional[UpdateAbTestsRequestTestType]
+            Sequence-only variant strategy.
+
+        winner_criteria : typing.Optional[UpdateAbTestsRequestWinnerCriteria]
+            Winner metric for campaign or sequence tests.
+
+        winner_threshold : typing.Optional[int]
+            Sequence-only recipient threshold.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateAbTestsResponse
+            A/B test settings updated
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.update(
+            ab_test_id="abTestId",
+        )
+        """
+        _response = self._raw_client.update(
+            ab_test_id,
+            confirm_live_change=confirm_live_change,
+            name=name,
+            test_duration_minutes=test_duration_minutes,
+            test_percentage=test_percentage,
+            test_type=test_type,
+            winner_criteria=winner_criteria,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def update_variant(
+        self,
+        ab_test_id: str,
+        variant_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        blocks: typing.Optional[typing.Sequence[EmailBlock]] = OMIT,
+        html: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateVariantAbTestsResponse:
+        """
+        Updates an A/B test variant's subject, preview text, or body content. Campaign variants remain editable only while the test is in draft. Sequence variants can be edited later with confirmLiveChange when the sequence is active, the test is no longer a draft, or the test has recorded activity; earlier sends remain unchanged, so combined results may no longer be accurate.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        variant_id : str
+            Variant ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the sequence is active, the test is no longer a draft, or the test has recorded activity. Earlier sends remain unchanged, so combined results may no longer be accurate.
+
+        preview_text : typing.Optional[str]
+
+        subject : typing.Optional[str]
+
+        blocks : typing.Optional[typing.Sequence[EmailBlock]]
+            Structured email blocks. Provide either blocks or html, not both. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
+
+        html : typing.Optional[str]
+            Raw HTML body. Provide either html or blocks, not both.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateVariantAbTestsResponse
+            Variant updated
+
+        Examples
+        --------
+        from sequenzy import Sequenzy
+
+        client = Sequenzy(
+            api_key="YOUR_API_KEY",
+        )
+        client.ab_tests.update_variant(
+            ab_test_id="abTestId",
+            variant_id="variantId",
+        )
+        """
+        _response = self._raw_client.update_variant(
+            ab_test_id,
+            variant_id,
+            confirm_live_change=confirm_live_change,
+            preview_text=preview_text,
+            subject=subject,
+            blocks=blocks,
+            html=html,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncAbTestsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAbTestsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAbTestsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAbTestsClient
+        """
+        return self._raw_client
+
+    async def add_variant(
+        self,
+        ab_test_id: str,
+        *,
+        subject: str,
+        blocks: typing.Optional[typing.Sequence[EmailBlock]] = OMIT,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AddVariantAbTestsResponse:
+        """
+        Adds a variant to a draft campaign or sequence A/B test. Sequence variants receive an independent email template. The body defaults to the control email when blocks are omitted. Sequence tests whose parent sequence is active require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        subject : str
+            Variant subject line.
+
+        blocks : typing.Optional[typing.Sequence[EmailBlock]]
+            Variant body blocks. Defaults to the campaign or sequence control email blocks.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the A/B test belongs to an active sequence, because new variants immediately enter the live rotation.
+
+        preview_text : typing.Optional[str]
+            Variant preview text.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AddVariantAbTestsResponse
+            Variant added
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.add_variant(
+                ab_test_id="abTestId",
+                subject="subject",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.add_variant(
+            ab_test_id,
+            subject=subject,
+            blocks=blocks,
+            confirm_live_change=confirm_live_change,
+            preview_text=preview_text,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create(
+        self,
+        *,
+        automation_node_id: typing.Optional[str] = OMIT,
+        campaign_id: typing.Optional[str] = OMIT,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        test_duration_minutes: typing.Optional[int] = OMIT,
+        test_percentage: typing.Optional[int] = OMIT,
+        test_type: typing.Optional[CreateAbTestsRequestTestType] = OMIT,
+        variants: typing.Optional[typing.Sequence[CreateAbTestsRequestVariantsItem]] = OMIT,
+        winner_criteria: typing.Optional[CreateAbTestsRequestWinnerCriteria] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateAbTestsResponse:
+        """
+        Creates a draft campaign A/B test or converts a sequence email node to action_ab_test. Provide exactly one owner. Variant A is copied into an independent email for sequences; sequence conversions require at least one extra variant.
+
+        Parameters
+        ----------
+        automation_node_id : typing.Optional[str]
+            Sequence action_email node to convert. Mutually exclusive with campaignId.
+
+        campaign_id : typing.Optional[str]
+            Campaign to attach the test to. Must be in draft or rejected status. Mutually exclusive with automationNodeId.
+
+        confirm_live_change : typing.Optional[bool]
+            Must be true when converting an email node in an active sequence.
+
+        name : typing.Optional[str]
+            Test name. Defaults to "A/B Test for <campaign name>".
+
+        test_duration_minutes : typing.Optional[int]
+            Campaign-only duration before winner selection. Sequence tests select after winnerThreshold recipients.
+
+        test_percentage : typing.Optional[int]
+            Campaign-only share of the audience that receives test sends. Sequence tests use winnerThreshold.
+
+        test_type : typing.Optional[CreateAbTestsRequestTestType]
+            Sequence variant strategy. Subject defaults to open_rate and content defaults to click_rate unless winnerCriteria is explicit.
+
+        variants : typing.Optional[typing.Sequence[CreateAbTestsRequestVariantsItem]]
+            Extra variants beyond the control. Required (min 1) when converting with automationNodeId. Total variants cannot exceed 5.
+
+        winner_criteria : typing.Optional[CreateAbTestsRequestWinnerCriteria]
+            Metric used to pick the winner. For sequence tests, an explicit value overrides the testType default.
+
+        winner_threshold : typing.Optional[int]
+            Number of sequence recipients in the test sample.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateAbTestsResponse
+            A/B test created
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.create()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(
+            automation_node_id=automation_node_id,
+            campaign_id=campaign_id,
+            confirm_live_change=confirm_live_change,
+            name=name,
+            test_duration_minutes=test_duration_minutes,
+            test_percentage=test_percentage,
+            test_type=test_type,
+            variants=variants,
+            winner_criteria=winner_criteria,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def delete(
+        self, ab_test_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> DeleteAbTestsResponse:
+        """
+        Deletes a campaign A/B test and its variants. Running tests cannot be deleted, and the linked campaign must be in draft or rejected status.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteAbTestsResponse
+            A/B test deleted
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.delete(
+                ab_test_id="abTestId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete(ab_test_id, request_options=request_options)
+        return _response.data
+
+    async def delete_variant(
+        self,
+        ab_test_id: str,
+        variant_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> DeleteVariantAbTestsResponse:
+        """
+        Removes a variant from a draft campaign or sequence A/B test. The control variant A cannot be deleted, and at least 2 variants must remain. Deleting a sequence variant also deletes its dedicated email template; sequence tests whose parent sequence is active require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        variant_id : str
+            Variant ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the A/B test belongs to an active sequence, because deletion immediately changes the live rotation.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        DeleteVariantAbTestsResponse
+            Variant deleted
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.delete_variant(
+                ab_test_id="abTestId",
+                variant_id="variantId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.delete_variant(
+            ab_test_id, variant_id, confirm_live_change=confirm_live_change, request_options=request_options
+        )
+        return _response.data
+
+    async def get(
+        self, ab_test_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetAbTestsResponse:
+        """
+        Returns one A/B test with variants and variant localization status.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAbTestsResponse
+            A/B test returned
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.get(
+                ab_test_id="abTestId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get(ab_test_id, request_options=request_options)
+        return _response.data
+
+    async def get_stats(
+        self,
+        ab_test_id: str,
+        *,
+        end: typing.Optional[dt.datetime] = None,
+        include_machine_engagement: typing.Optional[bool] = None,
+        period: typing.Optional[GetStatsAbTestsRequestPeriod] = None,
+        start: typing.Optional[dt.datetime] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetStatsAbTestsResponse:
+        """
+        Returns aggregate and per-variant engagement stats for an A/B test.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        end : typing.Optional[dt.datetime]
+            Custom range end. Requires start.
+
+        include_machine_engagement : typing.Optional[bool]
+            Include detected scanner, preview, and tracked asset open/click events.
+
+        period : typing.Optional[GetStatsAbTestsRequestPeriod]
+            Optional period filter.
+
+        start : typing.Optional[dt.datetime]
+            Custom range start. Requires end.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetStatsAbTestsResponse
+            A/B test stats returned
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.get_stats(
+                ab_test_id="abTestId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_stats(
+            ab_test_id,
+            end=end,
+            include_machine_engagement=include_machine_engagement,
+            period=period,
+            start=start,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def list(
+        self, *, sequence_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
+    ) -> ListAbTestsResponse:
+        """
+        Lists A/B tests and variants for the authenticated company, optionally filtered by sequence.
+
+        Parameters
+        ----------
+        sequence_id : typing.Optional[str]
+            Optional sequence ID filter for automation A/B tests.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ListAbTestsResponse
+            A/B tests returned
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list(sequence_id=sequence_id, request_options=request_options)
+        return _response.data
+
+    async def restart(
+        self,
+        ab_test_id: str,
+        *,
+        source_variant_id: typing.Optional[str] = OMIT,
+        test_type: typing.Optional[RestartAbTestsRequestTestType] = OMIT,
+        variant_count: typing.Optional[int] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> RestartAbTestsResponse:
+        """
+        Starts a new draft sequence A/B test from the selected control variant after a winner has been selected. The new test becomes active after generated variants are ready.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID to restart.
+
+        source_variant_id : typing.Optional[str]
+            Variant ID to use as the new control email. Defaults to the selected winner.
+
+        test_type : typing.Optional[RestartAbTestsRequestTestType]
+            Test type for generated variants.
+
+        variant_count : typing.Optional[int]
+            Total variants including the control.
+
+        winner_threshold : typing.Optional[int]
+            Subscribers before selecting a winner.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        RestartAbTestsResponse
+            A/B test restarted
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.restart(
+                ab_test_id="abTestId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.restart(
+            ab_test_id,
+            source_variant_id=source_variant_id,
+            test_type=test_type,
+            variant_count=variant_count,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def update(
+        self,
+        ab_test_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        name: typing.Optional[str] = OMIT,
+        test_duration_minutes: typing.Optional[int] = OMIT,
+        test_percentage: typing.Optional[int] = OMIT,
+        test_type: typing.Optional[UpdateAbTestsRequestTestType] = OMIT,
+        winner_criteria: typing.Optional[UpdateAbTestsRequestWinnerCriteria] = OMIT,
+        winner_threshold: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateAbTestsResponse:
+        """
+        Updates a draft campaign test or the effective settings for a sequence test. Campaigns use testPercentage and testDurationMinutes; sequences use testType and winnerThreshold. Sequence changes that affect a live or already-used test require confirmLiveChange.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required when sequence settings affect an active test or a test with recorded activity.
+
+        name : typing.Optional[str]
+
+        test_duration_minutes : typing.Optional[int]
+            Campaign-only test duration.
+
+        test_percentage : typing.Optional[int]
+            Campaign-only test audience percentage.
+
+        test_type : typing.Optional[UpdateAbTestsRequestTestType]
+            Sequence-only variant strategy.
+
+        winner_criteria : typing.Optional[UpdateAbTestsRequestWinnerCriteria]
+            Winner metric for campaign or sequence tests.
+
+        winner_threshold : typing.Optional[int]
+            Sequence-only recipient threshold.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateAbTestsResponse
+            A/B test settings updated
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.update(
+                ab_test_id="abTestId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update(
+            ab_test_id,
+            confirm_live_change=confirm_live_change,
+            name=name,
+            test_duration_minutes=test_duration_minutes,
+            test_percentage=test_percentage,
+            test_type=test_type,
+            winner_criteria=winner_criteria,
+            winner_threshold=winner_threshold,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def update_variant(
+        self,
+        ab_test_id: str,
+        variant_id: str,
+        *,
+        confirm_live_change: typing.Optional[bool] = OMIT,
+        preview_text: typing.Optional[str] = OMIT,
+        subject: typing.Optional[str] = OMIT,
+        blocks: typing.Optional[typing.Sequence[EmailBlock]] = OMIT,
+        html: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> UpdateVariantAbTestsResponse:
+        """
+        Updates an A/B test variant's subject, preview text, or body content. Campaign variants remain editable only while the test is in draft. Sequence variants can be edited later with confirmLiveChange when the sequence is active, the test is no longer a draft, or the test has recorded activity; earlier sends remain unchanged, so combined results may no longer be accurate.
+
+        Parameters
+        ----------
+        ab_test_id : str
+            A/B test ID.
+
+        variant_id : str
+            Variant ID.
+
+        confirm_live_change : typing.Optional[bool]
+            Required as true when the sequence is active, the test is no longer a draft, or the test has recorded activity. Earlier sends remain unchanged, so combined results may no longer be accurate.
+
+        preview_text : typing.Optional[str]
+
+        subject : typing.Optional[str]
+
+        blocks : typing.Optional[typing.Sequence[EmailBlock]]
+            Structured email blocks. Provide either blocks or html, not both. Put visual styling under styles; top-level style keys such as backgroundColor, backgroundOpacity, borderColor, borderWidth, and borderRadius are normalized into styles.
+
+        html : typing.Optional[str]
+            Raw HTML body. Provide either html or blocks, not both.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        UpdateVariantAbTestsResponse
+            Variant updated
+
+        Examples
+        --------
+        import asyncio
+
+        from sequenzy import AsyncSequenzy
+
+        client = AsyncSequenzy(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ab_tests.update_variant(
+                ab_test_id="abTestId",
+                variant_id="variantId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_variant(
+            ab_test_id,
+            variant_id,
+            confirm_live_change=confirm_live_change,
+            preview_text=preview_text,
+            subject=subject,
+            blocks=blocks,
+            html=html,
+            request_options=request_options,
+        )
+        return _response.data