kard-financial-sdk 0.0.82__py3-none-any.whl

kard/users/rewards/__init__.py

@@ -0,0 +1,133 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        Amount,
+        AmountType,
+        Asset,
+        CategoryData,
+        CategoryFields,
+        CategoryIdentifier,
+        CategoryIncluded,
+        CategoryRelationship,
+        CategoryRelationshipObject,
+        Commission,
+        Coordinates,
+        EligibilityLocationAddress,
+        EligibilityLocationIncluded,
+        EligibilityOfferIncluded,
+        EligibilityOfferRelationship,
+        LocationAttributes,
+        LocationData,
+        LocationRelationships,
+        LocationSortOptions,
+        LocationsResponseObject,
+        OfferCommonFields,
+        OfferDataUnion,
+        OfferDataUnion_StandardOffer,
+        OfferRelationship,
+        OfferSortOptions,
+        OffersResponseObject,
+        OperationHours,
+        OperationPeriod,
+        OperationTime,
+        StandardOffer,
+        StandardOfferCore,
+        StandardOfferFields,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "Amount": ".types",
+    "AmountType": ".types",
+    "Asset": ".types",
+    "CategoryData": ".types",
+    "CategoryFields": ".types",
+    "CategoryIdentifier": ".types",
+    "CategoryIncluded": ".types",
+    "CategoryRelationship": ".types",
+    "CategoryRelationshipObject": ".types",
+    "Commission": ".types",
+    "Coordinates": ".types",
+    "EligibilityLocationAddress": ".types",
+    "EligibilityLocationIncluded": ".types",
+    "EligibilityOfferIncluded": ".types",
+    "EligibilityOfferRelationship": ".types",
+    "LocationAttributes": ".types",
+    "LocationData": ".types",
+    "LocationRelationships": ".types",
+    "LocationSortOptions": ".types",
+    "LocationsResponseObject": ".types",
+    "OfferCommonFields": ".types",
+    "OfferDataUnion": ".types",
+    "OfferDataUnion_StandardOffer": ".types",
+    "OfferRelationship": ".types",
+    "OfferSortOptions": ".types",
+    "OffersResponseObject": ".types",
+    "OperationHours": ".types",
+    "OperationPeriod": ".types",
+    "OperationTime": ".types",
+    "StandardOffer": ".types",
+    "StandardOfferCore": ".types",
+    "StandardOfferFields": ".types",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "Amount",
+    "AmountType",
+    "Asset",
+    "CategoryData",
+    "CategoryFields",
+    "CategoryIdentifier",
+    "CategoryIncluded",
+    "CategoryRelationship",
+    "CategoryRelationshipObject",
+    "Commission",
+    "Coordinates",
+    "EligibilityLocationAddress",
+    "EligibilityLocationIncluded",
+    "EligibilityOfferIncluded",
+    "EligibilityOfferRelationship",
+    "LocationAttributes",
+    "LocationData",
+    "LocationRelationships",
+    "LocationSortOptions",
+    "LocationsResponseObject",
+    "OfferCommonFields",
+    "OfferDataUnion",
+    "OfferDataUnion_StandardOffer",
+    "OfferRelationship",
+    "OfferSortOptions",
+    "OffersResponseObject",
+    "OperationHours",
+    "OperationPeriod",
+    "OperationTime",
+    "StandardOffer",
+    "StandardOfferCore",
+    "StandardOfferFields",
+]

kard/users/rewards/client.py

@@ -0,0 +1,448 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...commons.types.category_option import CategoryOption
+from ...commons.types.organization_id import OrganizationId
+from ...commons.types.purchase_channel import PurchaseChannel
+from ...commons.types.state import State
+from ...commons.types.user_id import UserId
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawRewardsClient, RawRewardsClient
+from .types.location_sort_options import LocationSortOptions
+from .types.locations_response_object import LocationsResponseObject
+from .types.offer_sort_options import OfferSortOptions
+from .types.offers_response_object import OffersResponseObject
+
+
+class RewardsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawRewardsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawRewardsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawRewardsClient
+        """
+        return self._raw_client
+
+    def offers(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        filter_purchase_channel: typing.Optional[typing.Sequence[PurchaseChannel]] = None,
+        filter_category: typing.Optional[CategoryOption] = None,
+        filter_is_targeted: typing.Optional[bool] = None,
+        sort: typing.Optional[typing.Union[OfferSortOptions, typing.Sequence[OfferSortOptions]]] = None,
+        include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OffersResponseObject:
+        """
+        Retrieve national brand offers that a specified user is eligible for. Call this endpoint to build out your
+        [targeted offers UX experience](/2024-10-01/api/getting-started#b-discover-a-lapsed-customer-clo). Local offers details
+        can be found by calling the [Get Eligible Locations](/2024-10-01/api/rewards/locations) endpoint with the
+        `includeLocal` query parameter.<br/>
+        <b>Required scopes:</b> `rewards:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        page_size : typing.Optional[int]
+
+        page_after : typing.Optional[str]
+
+        page_before : typing.Optional[str]
+
+        filter_purchase_channel : typing.Optional[typing.Sequence[PurchaseChannel]]
+
+        filter_category : typing.Optional[CategoryOption]
+
+        filter_is_targeted : typing.Optional[bool]
+
+        sort : typing.Optional[typing.Union[OfferSortOptions, typing.Sequence[OfferSortOptions]]]
+            If provided, response will be sorted by the specified fields
+
+        include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OffersResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.users.rewards.offers(
+            organization_id="organization-123",
+            user_id="user-123",
+            page_size=1,
+            filter_is_targeted=True,
+            sort="-startDate",
+        )
+        """
+        _response = self._raw_client.offers(
+            organization_id,
+            user_id,
+            page_size=page_size,
+            page_after=page_after,
+            page_before=page_before,
+            filter_purchase_channel=filter_purchase_channel,
+            filter_category=filter_category,
+            filter_is_targeted=filter_is_targeted,
+            sort=sort,
+            include=include,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def locations(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        filter_name: typing.Optional[str] = None,
+        filter_city: typing.Optional[str] = None,
+        filter_zip_code: typing.Optional[str] = None,
+        filter_state: typing.Optional[State] = None,
+        filter_category: typing.Optional[CategoryOption] = None,
+        filter_longitude: typing.Optional[float] = None,
+        filter_latitude: typing.Optional[float] = None,
+        filter_radius: typing.Optional[int] = None,
+        sort: typing.Optional[typing.Union[LocationSortOptions, typing.Sequence[LocationSortOptions]]] = None,
+        include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LocationsResponseObject:
+        """
+        Retrieve national and local geographic locations that a specified user has eligible in-store offers at. To
+        include local locations, add the `includeLocal` query parameter to your api call. Use this endpoint to build
+        out your [map-specific UX experiences](/2024-10-01/api/getting-started#c-discover-clos-near-you-map-view). Please note
+        that Longitude and Latitude fields are prioritized over State, City and Zipcode and are the recommended search
+        pattern.<br/>
+        <br/>
+        <b>Required scopes:</b> `rewards:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        page_size : typing.Optional[int]
+
+        page_after : typing.Optional[str]
+
+        page_before : typing.Optional[str]
+
+        filter_name : typing.Optional[str]
+
+        filter_city : typing.Optional[str]
+
+        filter_zip_code : typing.Optional[str]
+
+        filter_state : typing.Optional[State]
+
+        filter_category : typing.Optional[CategoryOption]
+
+        filter_longitude : typing.Optional[float]
+
+        filter_latitude : typing.Optional[float]
+
+        filter_radius : typing.Optional[int]
+
+        sort : typing.Optional[typing.Union[LocationSortOptions, typing.Sequence[LocationSortOptions]]]
+            If provided, response will be sorted by the specified fields
+
+        include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            CSV list of included resources in the response (e.g "offers,categories"). Allowed values are `offers` and `categories`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LocationsResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.users.rewards.locations(
+            organization_id="organization-123",
+            user_id="user-123",
+            page_size=1,
+            filter_latitude=39.9419429,
+            filter_longitude=-75.1446869,
+            filter_radius=10,
+            include="offers,categories",
+        )
+        """
+        _response = self._raw_client.locations(
+            organization_id,
+            user_id,
+            page_size=page_size,
+            page_after=page_after,
+            page_before=page_before,
+            filter_name=filter_name,
+            filter_city=filter_city,
+            filter_zip_code=filter_zip_code,
+            filter_state=filter_state,
+            filter_category=filter_category,
+            filter_longitude=filter_longitude,
+            filter_latitude=filter_latitude,
+            filter_radius=filter_radius,
+            sort=sort,
+            include=include,
+            request_options=request_options,
+        )
+        return _response.data
+
+
+class AsyncRewardsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawRewardsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawRewardsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawRewardsClient
+        """
+        return self._raw_client
+
+    async def offers(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        filter_purchase_channel: typing.Optional[typing.Sequence[PurchaseChannel]] = None,
+        filter_category: typing.Optional[CategoryOption] = None,
+        filter_is_targeted: typing.Optional[bool] = None,
+        sort: typing.Optional[typing.Union[OfferSortOptions, typing.Sequence[OfferSortOptions]]] = None,
+        include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OffersResponseObject:
+        """
+        Retrieve national brand offers that a specified user is eligible for. Call this endpoint to build out your
+        [targeted offers UX experience](/2024-10-01/api/getting-started#b-discover-a-lapsed-customer-clo). Local offers details
+        can be found by calling the [Get Eligible Locations](/2024-10-01/api/rewards/locations) endpoint with the
+        `includeLocal` query parameter.<br/>
+        <b>Required scopes:</b> `rewards:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        page_size : typing.Optional[int]
+
+        page_after : typing.Optional[str]
+
+        page_before : typing.Optional[str]
+
+        filter_purchase_channel : typing.Optional[typing.Sequence[PurchaseChannel]]
+
+        filter_category : typing.Optional[CategoryOption]
+
+        filter_is_targeted : typing.Optional[bool]
+
+        sort : typing.Optional[typing.Union[OfferSortOptions, typing.Sequence[OfferSortOptions]]]
+            If provided, response will be sorted by the specified fields
+
+        include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            CSV list of included resources in the response (e.g "categories"). Allowed value is `categories`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OffersResponseObject
+
+        Examples
+        --------
+        import asyncio
+
+        from kard import AsyncKardApi
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.users.rewards.offers(
+                organization_id="organization-123",
+                user_id="user-123",
+                page_size=1,
+                filter_is_targeted=True,
+                sort="-startDate",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.offers(
+            organization_id,
+            user_id,
+            page_size=page_size,
+            page_after=page_after,
+            page_before=page_before,
+            filter_purchase_channel=filter_purchase_channel,
+            filter_category=filter_category,
+            filter_is_targeted=filter_is_targeted,
+            sort=sort,
+            include=include,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def locations(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        filter_name: typing.Optional[str] = None,
+        filter_city: typing.Optional[str] = None,
+        filter_zip_code: typing.Optional[str] = None,
+        filter_state: typing.Optional[State] = None,
+        filter_category: typing.Optional[CategoryOption] = None,
+        filter_longitude: typing.Optional[float] = None,
+        filter_latitude: typing.Optional[float] = None,
+        filter_radius: typing.Optional[int] = None,
+        sort: typing.Optional[typing.Union[LocationSortOptions, typing.Sequence[LocationSortOptions]]] = None,
+        include: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LocationsResponseObject:
+        """
+        Retrieve national and local geographic locations that a specified user has eligible in-store offers at. To
+        include local locations, add the `includeLocal` query parameter to your api call. Use this endpoint to build
+        out your [map-specific UX experiences](/2024-10-01/api/getting-started#c-discover-clos-near-you-map-view). Please note
+        that Longitude and Latitude fields are prioritized over State, City and Zipcode and are the recommended search
+        pattern.<br/>
+        <br/>
+        <b>Required scopes:</b> `rewards:read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        page_size : typing.Optional[int]
+
+        page_after : typing.Optional[str]
+
+        page_before : typing.Optional[str]
+
+        filter_name : typing.Optional[str]
+
+        filter_city : typing.Optional[str]
+
+        filter_zip_code : typing.Optional[str]
+
+        filter_state : typing.Optional[State]
+
+        filter_category : typing.Optional[CategoryOption]
+
+        filter_longitude : typing.Optional[float]
+
+        filter_latitude : typing.Optional[float]
+
+        filter_radius : typing.Optional[int]
+
+        sort : typing.Optional[typing.Union[LocationSortOptions, typing.Sequence[LocationSortOptions]]]
+            If provided, response will be sorted by the specified fields
+
+        include : typing.Optional[typing.Union[str, typing.Sequence[str]]]
+            CSV list of included resources in the response (e.g "offers,categories"). Allowed values are `offers` and `categories`.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        LocationsResponseObject
+
+        Examples
+        --------
+        import asyncio
+
+        from kard import AsyncKardApi
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.users.rewards.locations(
+                organization_id="organization-123",
+                user_id="user-123",
+                page_size=1,
+                filter_latitude=39.9419429,
+                filter_longitude=-75.1446869,
+                filter_radius=10,
+                include="offers,categories",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.locations(
+            organization_id,
+            user_id,
+            page_size=page_size,
+            page_after=page_after,
+            page_before=page_before,
+            filter_name=filter_name,
+            filter_city=filter_city,
+            filter_zip_code=filter_zip_code,
+            filter_state=filter_state,
+            filter_category=filter_category,
+            filter_longitude=filter_longitude,
+            filter_latitude=filter_latitude,
+            filter_radius=filter_radius,
+            sort=sort,
+            include=include,
+            request_options=request_options,
+        )
+        return _response.data