brevo-python 4.0.1__py3-none-any.whl

brevo/reward/client.py

@@ -0,0 +1,1285 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.redeem import Redeem
+from .raw_client import AsyncRawRewardClient, RawRewardClient
+from .types.create_reward_response import CreateRewardResponse
+from .types.create_voucher_response import CreateVoucherResponse
+from .types.get_code_count_response import GetCodeCountResponse
+from .types.get_loyalty_offer_programs_pid_offers_request_version import GetLoyaltyOfferProgramsPidOffersRequestVersion
+from .types.get_loyalty_offer_programs_pid_offers_response import GetLoyaltyOfferProgramsPidOffersResponse
+from .types.get_loyalty_offer_programs_pid_rewards_rid_request_version import (
+    GetLoyaltyOfferProgramsPidRewardsRidRequestVersion,
+)
+from .types.get_loyalty_offer_programs_pid_rewards_rid_response import GetLoyaltyOfferProgramsPidRewardsRidResponse
+from .types.get_loyalty_offer_programs_pid_vouchers_request_sort import GetLoyaltyOfferProgramsPidVouchersRequestSort
+from .types.get_loyalty_offer_programs_pid_vouchers_request_sort_field import (
+    GetLoyaltyOfferProgramsPidVouchersRequestSortField,
+)
+from .types.get_loyalty_offer_programs_pid_vouchers_response import GetLoyaltyOfferProgramsPidVouchersResponse
+from .types.redeem_voucher_request_order import RedeemVoucherRequestOrder
+from .types.validate_reward_response import ValidateRewardResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RewardClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawRewardClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawRewardClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawRewardClient
+        """
+        return self._raw_client
+
+    def get_code_count(
+        self, pid: str, cpid: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetCodeCountResponse:
+        """
+        Get code count
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        cpid : str
+            Code Pool ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCodeCountResponse
+            Code count successfully fetched
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.get_code_count(
+            pid="pid",
+            cpid="cpid",
+        )
+        """
+        _response = self._raw_client.get_code_count(pid, cpid, request_options=request_options)
+        return _response.data
+
+    def get_reward_page_api(
+        self,
+        pid: str,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        state: typing.Optional[str] = None,
+        version: typing.Optional[GetLoyaltyOfferProgramsPidOffersRequestVersion] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidOffersResponse:
+        """
+        Returns a reward page
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        limit : typing.Optional[int]
+            Page size
+
+        offset : typing.Optional[int]
+            Pagination offset
+
+        state : typing.Optional[str]
+            State of the reward
+
+        version : typing.Optional[GetLoyaltyOfferProgramsPidOffersRequestVersion]
+            Version
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidOffersResponse
+            Reward list successfully retrieved
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.get_reward_page_api(
+            pid="pid",
+        )
+        """
+        _response = self._raw_client.get_reward_page_api(
+            pid, limit=limit, offset=offset, state=state, version=version, request_options=request_options
+        )
+        return _response.data
+
+    def create_reward(
+        self,
+        pid: str,
+        *,
+        name: str,
+        public_description: typing.Optional[str] = OMIT,
+        public_image: typing.Optional[str] = OMIT,
+        public_name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateRewardResponse:
+        """
+        Creates a new reward in the loyalty program.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        name : str
+            Internal name of the reward
+
+        public_description : typing.Optional[str]
+            Public facing description of the reward
+
+        public_image : typing.Optional[str]
+            URL of the public image for the reward
+
+        public_name : typing.Optional[str]
+            Public facing name of the reward
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateRewardResponse
+            Reward successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.create_reward(
+            pid="pid",
+            name="name",
+        )
+        """
+        _response = self._raw_client.create_reward(
+            pid,
+            name=name,
+            public_description=public_description,
+            public_image=public_image,
+            public_name=public_name,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_voucher(
+        self,
+        pid: str,
+        *,
+        reward_id: str,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        expiration_date: typing.Optional[str] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        value: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateVoucherResponse:
+        """
+        Create a voucher and attribute it to a specific membership.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        reward_id : str
+            Reward id
+
+        code : typing.Optional[str]
+            Code generated to attribute reward to a contact
+
+        contact_id : typing.Optional[int]
+            Contact to attribute the reward
+
+        expiration_date : typing.Optional[str]
+            Reward expiration date
+
+        loyalty_subscription_id : typing.Optional[str]
+            One of contactId or loyaltySubscriptionId is required
+
+        meta : typing.Optional[typing.Dict[str, typing.Any]]
+            Offer meta information (key/value object)
+
+        value : typing.Optional[float]
+            Value of the selected reward config
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateVoucherResponse
+            Voucher successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.create_voucher(
+            pid="pid",
+            reward_id="rewardId",
+        )
+        """
+        _response = self._raw_client.create_voucher(
+            pid,
+            reward_id=reward_id,
+            code=code,
+            contact_id=contact_id,
+            expiration_date=expiration_date,
+            loyalty_subscription_id=loyalty_subscription_id,
+            meta=meta,
+            value=value,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def redeem_voucher(
+        self,
+        pid: str,
+        *,
+        attributed_reward_id: typing.Optional[str] = OMIT,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        order: typing.Optional[RedeemVoucherRequestOrder] = OMIT,
+        reward_id: typing.Optional[str] = OMIT,
+        ttl: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Redeem:
+        """
+        Creates a request to redeem a voucher.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_id : typing.Optional[str]
+            Unique identifier for the attributed reward
+
+        code : typing.Optional[str]
+            Redemption code for the reward
+
+        contact_id : typing.Optional[int]
+            Unique identifier for the contact
+
+        loyalty_subscription_id : typing.Optional[str]
+            Identifier for the loyalty subscription
+
+        meta : typing.Optional[typing.Dict[str, typing.Any]]
+            Additional metadata associated with the redeem request
+
+        order : typing.Optional[RedeemVoucherRequestOrder]
+            Order details for the redemption
+
+        reward_id : typing.Optional[str]
+            Unique identifier for the reward
+
+        ttl : typing.Optional[int]
+            Time to live in seconds for the redemption request
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Redeem
+            Redeem request successfully created
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.redeem_voucher(
+            pid="pid",
+        )
+        """
+        _response = self._raw_client.redeem_voucher(
+            pid,
+            attributed_reward_id=attributed_reward_id,
+            code=code,
+            contact_id=contact_id,
+            loyalty_subscription_id=loyalty_subscription_id,
+            meta=meta,
+            order=order,
+            reward_id=reward_id,
+            ttl=ttl,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def complete_redeem_transaction(
+        self, pid: str, tid: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Redeem:
+        """
+        Completes voucher redeem request.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        tid : str
+            Redeem transaction ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Redeem
+            Voucher Redeem completed
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.complete_redeem_transaction(
+            pid="pid",
+            tid="tid",
+        )
+        """
+        _response = self._raw_client.complete_redeem_transaction(pid, tid, request_options=request_options)
+        return _response.data
+
+    def revoke_vouchers(
+        self,
+        pid: str,
+        *,
+        attributed_reward_ids: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Revoke attributed vouchers.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_ids : typing.Optional[str]
+            Reward Attribution IDs (comma seperated)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.revoke_vouchers(
+            pid="pid",
+        )
+        """
+        _response = self._raw_client.revoke_vouchers(
+            pid, attributed_reward_ids=attributed_reward_ids, request_options=request_options
+        )
+        return _response.data
+
+    def validate_reward(
+        self,
+        pid: str,
+        *,
+        attributed_reward_id: typing.Optional[str] = OMIT,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        point_of_sell_id: typing.Optional[str] = OMIT,
+        reward_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ValidateRewardResponse:
+        """
+        Validates a reward.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_id : typing.Optional[str]
+            Unique identifier for the attributed reward
+
+        code : typing.Optional[str]
+            Validation code for the reward
+
+        contact_id : typing.Optional[int]
+            Unique identifier for the contact
+
+        loyalty_subscription_id : typing.Optional[str]
+            Identifier for the loyalty subscription
+
+        point_of_sell_id : typing.Optional[str]
+            Identifier for the point of sale
+
+        reward_id : typing.Optional[str]
+            Unique identifier for the reward
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ValidateRewardResponse
+            Reward successfully validated
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.validate_reward(
+            pid="pid",
+        )
+        """
+        _response = self._raw_client.validate_reward(
+            pid,
+            attributed_reward_id=attributed_reward_id,
+            code=code,
+            contact_id=contact_id,
+            loyalty_subscription_id=loyalty_subscription_id,
+            point_of_sell_id=point_of_sell_id,
+            reward_id=reward_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_reward_information(
+        self,
+        pid: str,
+        rid: str,
+        *,
+        version: typing.Optional[GetLoyaltyOfferProgramsPidRewardsRidRequestVersion] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidRewardsRidResponse:
+        """
+        Returns reward information.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        rid : str
+            Reward ID
+
+        version : typing.Optional[GetLoyaltyOfferProgramsPidRewardsRidRequestVersion]
+            Version
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidRewardsRidResponse
+            Successful retrieval of reward data
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.get_reward_information(
+            pid="pid",
+            rid="rid",
+        )
+        """
+        _response = self._raw_client.get_reward_information(pid, rid, version=version, request_options=request_options)
+        return _response.data
+
+    def get_voucher_for_a_contact(
+        self,
+        pid: str,
+        *,
+        contact_id: int,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSort] = None,
+        sort_field: typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSortField] = None,
+        metadata_key_value: typing.Optional[str] = None,
+        reward_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidVouchersResponse:
+        """
+        Get voucher for a contact
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        contact_id : int
+            Contact ID
+
+        limit : typing.Optional[int]
+            Page size
+
+        offset : typing.Optional[int]
+            Pagination offset
+
+        sort : typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSort]
+            Sort order
+
+        sort_field : typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSortField]
+            Sort field
+
+        metadata_key_value : typing.Optional[str]
+            Metadata value for a Key filter
+
+        reward_id : typing.Optional[str]
+            Reward ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidVouchersResponse
+            Voucher list successfully retrieved
+
+        Examples
+        --------
+        from brevo import Brevo
+
+        client = Brevo(
+            api_key="YOUR_API_KEY",
+        )
+        client.reward.get_voucher_for_a_contact(
+            pid="pid",
+            contact_id=1,
+        )
+        """
+        _response = self._raw_client.get_voucher_for_a_contact(
+            pid,
+            contact_id=contact_id,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            sort_field=sort_field,
+            metadata_key_value=metadata_key_value,
+            reward_id=reward_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncRewardClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawRewardClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawRewardClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawRewardClient
+        """
+        return self._raw_client
+
+    async def get_code_count(
+        self, pid: str, cpid: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetCodeCountResponse:
+        """
+        Get code count
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        cpid : str
+            Code Pool ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCodeCountResponse
+            Code count successfully fetched
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.get_code_count(
+                pid="pid",
+                cpid="cpid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_code_count(pid, cpid, request_options=request_options)
+        return _response.data
+
+    async def get_reward_page_api(
+        self,
+        pid: str,
+        *,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        state: typing.Optional[str] = None,
+        version: typing.Optional[GetLoyaltyOfferProgramsPidOffersRequestVersion] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidOffersResponse:
+        """
+        Returns a reward page
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        limit : typing.Optional[int]
+            Page size
+
+        offset : typing.Optional[int]
+            Pagination offset
+
+        state : typing.Optional[str]
+            State of the reward
+
+        version : typing.Optional[GetLoyaltyOfferProgramsPidOffersRequestVersion]
+            Version
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidOffersResponse
+            Reward list successfully retrieved
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.get_reward_page_api(
+                pid="pid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_reward_page_api(
+            pid, limit=limit, offset=offset, state=state, version=version, request_options=request_options
+        )
+        return _response.data
+
+    async def create_reward(
+        self,
+        pid: str,
+        *,
+        name: str,
+        public_description: typing.Optional[str] = OMIT,
+        public_image: typing.Optional[str] = OMIT,
+        public_name: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateRewardResponse:
+        """
+        Creates a new reward in the loyalty program.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        name : str
+            Internal name of the reward
+
+        public_description : typing.Optional[str]
+            Public facing description of the reward
+
+        public_image : typing.Optional[str]
+            URL of the public image for the reward
+
+        public_name : typing.Optional[str]
+            Public facing name of the reward
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateRewardResponse
+            Reward successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.create_reward(
+                pid="pid",
+                name="name",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_reward(
+            pid,
+            name=name,
+            public_description=public_description,
+            public_image=public_image,
+            public_name=public_name,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_voucher(
+        self,
+        pid: str,
+        *,
+        reward_id: str,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        expiration_date: typing.Optional[str] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        value: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateVoucherResponse:
+        """
+        Create a voucher and attribute it to a specific membership.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        reward_id : str
+            Reward id
+
+        code : typing.Optional[str]
+            Code generated to attribute reward to a contact
+
+        contact_id : typing.Optional[int]
+            Contact to attribute the reward
+
+        expiration_date : typing.Optional[str]
+            Reward expiration date
+
+        loyalty_subscription_id : typing.Optional[str]
+            One of contactId or loyaltySubscriptionId is required
+
+        meta : typing.Optional[typing.Dict[str, typing.Any]]
+            Offer meta information (key/value object)
+
+        value : typing.Optional[float]
+            Value of the selected reward config
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateVoucherResponse
+            Voucher successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.create_voucher(
+                pid="pid",
+                reward_id="rewardId",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_voucher(
+            pid,
+            reward_id=reward_id,
+            code=code,
+            contact_id=contact_id,
+            expiration_date=expiration_date,
+            loyalty_subscription_id=loyalty_subscription_id,
+            meta=meta,
+            value=value,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def redeem_voucher(
+        self,
+        pid: str,
+        *,
+        attributed_reward_id: typing.Optional[str] = OMIT,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        meta: typing.Optional[typing.Dict[str, typing.Any]] = OMIT,
+        order: typing.Optional[RedeemVoucherRequestOrder] = OMIT,
+        reward_id: typing.Optional[str] = OMIT,
+        ttl: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Redeem:
+        """
+        Creates a request to redeem a voucher.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_id : typing.Optional[str]
+            Unique identifier for the attributed reward
+
+        code : typing.Optional[str]
+            Redemption code for the reward
+
+        contact_id : typing.Optional[int]
+            Unique identifier for the contact
+
+        loyalty_subscription_id : typing.Optional[str]
+            Identifier for the loyalty subscription
+
+        meta : typing.Optional[typing.Dict[str, typing.Any]]
+            Additional metadata associated with the redeem request
+
+        order : typing.Optional[RedeemVoucherRequestOrder]
+            Order details for the redemption
+
+        reward_id : typing.Optional[str]
+            Unique identifier for the reward
+
+        ttl : typing.Optional[int]
+            Time to live in seconds for the redemption request
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Redeem
+            Redeem request successfully created
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.redeem_voucher(
+                pid="pid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.redeem_voucher(
+            pid,
+            attributed_reward_id=attributed_reward_id,
+            code=code,
+            contact_id=contact_id,
+            loyalty_subscription_id=loyalty_subscription_id,
+            meta=meta,
+            order=order,
+            reward_id=reward_id,
+            ttl=ttl,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def complete_redeem_transaction(
+        self, pid: str, tid: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> Redeem:
+        """
+        Completes voucher redeem request.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        tid : str
+            Redeem transaction ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Redeem
+            Voucher Redeem completed
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.complete_redeem_transaction(
+                pid="pid",
+                tid="tid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.complete_redeem_transaction(pid, tid, request_options=request_options)
+        return _response.data
+
+    async def revoke_vouchers(
+        self,
+        pid: str,
+        *,
+        attributed_reward_ids: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Revoke attributed vouchers.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_ids : typing.Optional[str]
+            Reward Attribution IDs (comma seperated)
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.revoke_vouchers(
+                pid="pid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.revoke_vouchers(
+            pid, attributed_reward_ids=attributed_reward_ids, request_options=request_options
+        )
+        return _response.data
+
+    async def validate_reward(
+        self,
+        pid: str,
+        *,
+        attributed_reward_id: typing.Optional[str] = OMIT,
+        code: typing.Optional[str] = OMIT,
+        contact_id: typing.Optional[int] = OMIT,
+        loyalty_subscription_id: typing.Optional[str] = OMIT,
+        point_of_sell_id: typing.Optional[str] = OMIT,
+        reward_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ValidateRewardResponse:
+        """
+        Validates a reward.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        attributed_reward_id : typing.Optional[str]
+            Unique identifier for the attributed reward
+
+        code : typing.Optional[str]
+            Validation code for the reward
+
+        contact_id : typing.Optional[int]
+            Unique identifier for the contact
+
+        loyalty_subscription_id : typing.Optional[str]
+            Identifier for the loyalty subscription
+
+        point_of_sell_id : typing.Optional[str]
+            Identifier for the point of sale
+
+        reward_id : typing.Optional[str]
+            Unique identifier for the reward
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ValidateRewardResponse
+            Reward successfully validated
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.validate_reward(
+                pid="pid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.validate_reward(
+            pid,
+            attributed_reward_id=attributed_reward_id,
+            code=code,
+            contact_id=contact_id,
+            loyalty_subscription_id=loyalty_subscription_id,
+            point_of_sell_id=point_of_sell_id,
+            reward_id=reward_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_reward_information(
+        self,
+        pid: str,
+        rid: str,
+        *,
+        version: typing.Optional[GetLoyaltyOfferProgramsPidRewardsRidRequestVersion] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidRewardsRidResponse:
+        """
+        Returns reward information.
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        rid : str
+            Reward ID
+
+        version : typing.Optional[GetLoyaltyOfferProgramsPidRewardsRidRequestVersion]
+            Version
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidRewardsRidResponse
+            Successful retrieval of reward data
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.get_reward_information(
+                pid="pid",
+                rid="rid",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_reward_information(
+            pid, rid, version=version, request_options=request_options
+        )
+        return _response.data
+
+    async def get_voucher_for_a_contact(
+        self,
+        pid: str,
+        *,
+        contact_id: int,
+        limit: typing.Optional[int] = None,
+        offset: typing.Optional[int] = None,
+        sort: typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSort] = None,
+        sort_field: typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSortField] = None,
+        metadata_key_value: typing.Optional[str] = None,
+        reward_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetLoyaltyOfferProgramsPidVouchersResponse:
+        """
+        Get voucher for a contact
+
+        Parameters
+        ----------
+        pid : str
+            Loyalty Program ID
+
+        contact_id : int
+            Contact ID
+
+        limit : typing.Optional[int]
+            Page size
+
+        offset : typing.Optional[int]
+            Pagination offset
+
+        sort : typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSort]
+            Sort order
+
+        sort_field : typing.Optional[GetLoyaltyOfferProgramsPidVouchersRequestSortField]
+            Sort field
+
+        metadata_key_value : typing.Optional[str]
+            Metadata value for a Key filter
+
+        reward_id : typing.Optional[str]
+            Reward ID
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetLoyaltyOfferProgramsPidVouchersResponse
+            Voucher list successfully retrieved
+
+        Examples
+        --------
+        import asyncio
+
+        from brevo import AsyncBrevo
+
+        client = AsyncBrevo(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.reward.get_voucher_for_a_contact(
+                pid="pid",
+                contact_id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_voucher_for_a_contact(
+            pid,
+            contact_id=contact_id,
+            limit=limit,
+            offset=offset,
+            sort=sort,
+            sort_field=sort_field,
+            metadata_key_value=metadata_key_value,
+            reward_id=reward_id,
+            request_options=request_options,
+        )
+        return _response.data