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

kard/transactions/types/visa_mid.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .visa_mid_details import VisaMidDetails
+
+
+class VisaMid(UniversalBaseModel):
+    mids: VisaMidDetails = pydantic.Field()
+    """
+    Merchant ID (MID) associated with the processor
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

kard/transactions/types/visa_mid_details.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class VisaMidDetails(UniversalBaseModel):
+    vmid: str = pydantic.Field()
+    """
+    Visa Merchant ID (VMID) associated with the transaction
+    """
+
+    vsid: str = pydantic.Field()
+    """
+    Visa Store ID (VSID) associated with the transaction
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

kard/users/__init__.py

@@ -0,0 +1,293 @@
+# 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 (
+        CreateUsersMultiStatusResponse,
+        CreateUsersObject,
+        DeleteUserResponseObject,
+        UpdateUserObject,
+        UserRequestAttributes,
+        UserRequestData,
+        UserRequestDataUnion,
+        UserRequestDataUnion_User,
+        UserResponseNoData,
+        UserResponseUnionNoData,
+        UserResponseUnionNoData_User,
+    )
+    from .errors import MultiStatus
+    from . import attributions, rewards, uploads
+    from .attributions import (
+        CreateAttributionRequestObject,
+        CreateAttributionRequestUnion,
+        CreateAttributionRequestUnion_NotificationAttribution,
+        CreateAttributionRequestUnion_OfferAttribution,
+        CreateAttributionResponse,
+        EventCode,
+        NotificationAttributionAttributes,
+        NotificationAttributionRequest,
+        NotificationMedium,
+        OfferAttributionAttributes,
+        OfferAttributionRequest,
+        OfferMedium,
+    )
+    from .rewards 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,
+    )
+    from .uploads import (
+        CreateUploadPartDataUnion,
+        CreateUploadPartDataUnion_HistoricalTransaction,
+        CreateUploadPartMultiStatusResponse,
+        CreateUploadPartRequestObject,
+        CreateUploadPartResponseData,
+        CreateUploadPartResponseDataUnion,
+        CreateUploadPartResponseDataUnion_HistoricalTransaction,
+        CreateUploadPartResponseObject,
+        CreateUploadRequestDataUnion,
+        CreateUploadRequestDataUnion_HistoricalTransactionStart,
+        CreateUploadRequestObject,
+        CreateUploadResponseData,
+        CreateUploadResponseDataUnion,
+        CreateUploadResponseDataUnion_HistoricalTransactionStart,
+        CreateUploadResponseObject,
+        HistoricalTransactionCompleteNoData,
+        StartHistoricalUploadNoData,
+        UpdateUploadRequestDataUnion,
+        UpdateUploadRequestDataUnion_HistoricalTransactionComplete,
+        UpdateUploadRequestObject,
+        UpdateUploadResponseData,
+        UpdateUploadResponseDataUnion,
+        UpdateUploadResponseDataUnion_HistoricalTransactionComplete,
+        UpdateUploadResponseObject,
+        UploadPartMultiStatus,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "Amount": ".rewards",
+    "AmountType": ".rewards",
+    "Asset": ".rewards",
+    "CategoryData": ".rewards",
+    "CategoryFields": ".rewards",
+    "CategoryIdentifier": ".rewards",
+    "CategoryIncluded": ".rewards",
+    "CategoryRelationship": ".rewards",
+    "CategoryRelationshipObject": ".rewards",
+    "Commission": ".rewards",
+    "Coordinates": ".rewards",
+    "CreateAttributionRequestObject": ".attributions",
+    "CreateAttributionRequestUnion": ".attributions",
+    "CreateAttributionRequestUnion_NotificationAttribution": ".attributions",
+    "CreateAttributionRequestUnion_OfferAttribution": ".attributions",
+    "CreateAttributionResponse": ".attributions",
+    "CreateUploadPartDataUnion": ".uploads",
+    "CreateUploadPartDataUnion_HistoricalTransaction": ".uploads",
+    "CreateUploadPartMultiStatusResponse": ".uploads",
+    "CreateUploadPartRequestObject": ".uploads",
+    "CreateUploadPartResponseData": ".uploads",
+    "CreateUploadPartResponseDataUnion": ".uploads",
+    "CreateUploadPartResponseDataUnion_HistoricalTransaction": ".uploads",
+    "CreateUploadPartResponseObject": ".uploads",
+    "CreateUploadRequestDataUnion": ".uploads",
+    "CreateUploadRequestDataUnion_HistoricalTransactionStart": ".uploads",
+    "CreateUploadRequestObject": ".uploads",
+    "CreateUploadResponseData": ".uploads",
+    "CreateUploadResponseDataUnion": ".uploads",
+    "CreateUploadResponseDataUnion_HistoricalTransactionStart": ".uploads",
+    "CreateUploadResponseObject": ".uploads",
+    "CreateUsersMultiStatusResponse": ".types",
+    "CreateUsersObject": ".types",
+    "DeleteUserResponseObject": ".types",
+    "EligibilityLocationAddress": ".rewards",
+    "EligibilityLocationIncluded": ".rewards",
+    "EligibilityOfferIncluded": ".rewards",
+    "EligibilityOfferRelationship": ".rewards",
+    "EventCode": ".attributions",
+    "HistoricalTransactionCompleteNoData": ".uploads",
+    "LocationAttributes": ".rewards",
+    "LocationData": ".rewards",
+    "LocationRelationships": ".rewards",
+    "LocationSortOptions": ".rewards",
+    "LocationsResponseObject": ".rewards",
+    "MultiStatus": ".errors",
+    "NotificationAttributionAttributes": ".attributions",
+    "NotificationAttributionRequest": ".attributions",
+    "NotificationMedium": ".attributions",
+    "OfferAttributionAttributes": ".attributions",
+    "OfferAttributionRequest": ".attributions",
+    "OfferCommonFields": ".rewards",
+    "OfferDataUnion": ".rewards",
+    "OfferDataUnion_StandardOffer": ".rewards",
+    "OfferMedium": ".attributions",
+    "OfferRelationship": ".rewards",
+    "OfferSortOptions": ".rewards",
+    "OffersResponseObject": ".rewards",
+    "OperationHours": ".rewards",
+    "OperationPeriod": ".rewards",
+    "OperationTime": ".rewards",
+    "StandardOffer": ".rewards",
+    "StandardOfferCore": ".rewards",
+    "StandardOfferFields": ".rewards",
+    "StartHistoricalUploadNoData": ".uploads",
+    "UpdateUploadRequestDataUnion": ".uploads",
+    "UpdateUploadRequestDataUnion_HistoricalTransactionComplete": ".uploads",
+    "UpdateUploadRequestObject": ".uploads",
+    "UpdateUploadResponseData": ".uploads",
+    "UpdateUploadResponseDataUnion": ".uploads",
+    "UpdateUploadResponseDataUnion_HistoricalTransactionComplete": ".uploads",
+    "UpdateUploadResponseObject": ".uploads",
+    "UpdateUserObject": ".types",
+    "UploadPartMultiStatus": ".uploads",
+    "UserRequestAttributes": ".types",
+    "UserRequestData": ".types",
+    "UserRequestDataUnion": ".types",
+    "UserRequestDataUnion_User": ".types",
+    "UserResponseNoData": ".types",
+    "UserResponseUnionNoData": ".types",
+    "UserResponseUnionNoData_User": ".types",
+    "attributions": ".attributions",
+    "rewards": ".rewards",
+    "uploads": ".uploads",
+}
+
+
+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",
+    "CreateAttributionRequestObject",
+    "CreateAttributionRequestUnion",
+    "CreateAttributionRequestUnion_NotificationAttribution",
+    "CreateAttributionRequestUnion_OfferAttribution",
+    "CreateAttributionResponse",
+    "CreateUploadPartDataUnion",
+    "CreateUploadPartDataUnion_HistoricalTransaction",
+    "CreateUploadPartMultiStatusResponse",
+    "CreateUploadPartRequestObject",
+    "CreateUploadPartResponseData",
+    "CreateUploadPartResponseDataUnion",
+    "CreateUploadPartResponseDataUnion_HistoricalTransaction",
+    "CreateUploadPartResponseObject",
+    "CreateUploadRequestDataUnion",
+    "CreateUploadRequestDataUnion_HistoricalTransactionStart",
+    "CreateUploadRequestObject",
+    "CreateUploadResponseData",
+    "CreateUploadResponseDataUnion",
+    "CreateUploadResponseDataUnion_HistoricalTransactionStart",
+    "CreateUploadResponseObject",
+    "CreateUsersMultiStatusResponse",
+    "CreateUsersObject",
+    "DeleteUserResponseObject",
+    "EligibilityLocationAddress",
+    "EligibilityLocationIncluded",
+    "EligibilityOfferIncluded",
+    "EligibilityOfferRelationship",
+    "EventCode",
+    "HistoricalTransactionCompleteNoData",
+    "LocationAttributes",
+    "LocationData",
+    "LocationRelationships",
+    "LocationSortOptions",
+    "LocationsResponseObject",
+    "MultiStatus",
+    "NotificationAttributionAttributes",
+    "NotificationAttributionRequest",
+    "NotificationMedium",
+    "OfferAttributionAttributes",
+    "OfferAttributionRequest",
+    "OfferCommonFields",
+    "OfferDataUnion",
+    "OfferDataUnion_StandardOffer",
+    "OfferMedium",
+    "OfferRelationship",
+    "OfferSortOptions",
+    "OffersResponseObject",
+    "OperationHours",
+    "OperationPeriod",
+    "OperationTime",
+    "StandardOffer",
+    "StandardOfferCore",
+    "StandardOfferFields",
+    "StartHistoricalUploadNoData",
+    "UpdateUploadRequestDataUnion",
+    "UpdateUploadRequestDataUnion_HistoricalTransactionComplete",
+    "UpdateUploadRequestObject",
+    "UpdateUploadResponseData",
+    "UpdateUploadResponseDataUnion",
+    "UpdateUploadResponseDataUnion_HistoricalTransactionComplete",
+    "UpdateUploadResponseObject",
+    "UpdateUserObject",
+    "UploadPartMultiStatus",
+    "UserRequestAttributes",
+    "UserRequestData",
+    "UserRequestDataUnion",
+    "UserRequestDataUnion_User",
+    "UserResponseNoData",
+    "UserResponseUnionNoData",
+    "UserResponseUnionNoData_User",
+    "attributions",
+    "rewards",
+    "uploads",
+]

kard/users/attributions/__init__.py

@@ -0,0 +1,73 @@
+# 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 (
+        CreateAttributionRequestObject,
+        CreateAttributionRequestUnion,
+        CreateAttributionRequestUnion_NotificationAttribution,
+        CreateAttributionRequestUnion_OfferAttribution,
+        CreateAttributionResponse,
+        EventCode,
+        NotificationAttributionAttributes,
+        NotificationAttributionRequest,
+        NotificationMedium,
+        OfferAttributionAttributes,
+        OfferAttributionRequest,
+        OfferMedium,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateAttributionRequestObject": ".types",
+    "CreateAttributionRequestUnion": ".types",
+    "CreateAttributionRequestUnion_NotificationAttribution": ".types",
+    "CreateAttributionRequestUnion_OfferAttribution": ".types",
+    "CreateAttributionResponse": ".types",
+    "EventCode": ".types",
+    "NotificationAttributionAttributes": ".types",
+    "NotificationAttributionRequest": ".types",
+    "NotificationMedium": ".types",
+    "OfferAttributionAttributes": ".types",
+    "OfferAttributionRequest": ".types",
+    "OfferMedium": ".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__ = [
+    "CreateAttributionRequestObject",
+    "CreateAttributionRequestUnion",
+    "CreateAttributionRequestUnion_NotificationAttribution",
+    "CreateAttributionRequestUnion_OfferAttribution",
+    "CreateAttributionResponse",
+    "EventCode",
+    "NotificationAttributionAttributes",
+    "NotificationAttributionRequest",
+    "NotificationMedium",
+    "OfferAttributionAttributes",
+    "OfferAttributionRequest",
+    "OfferMedium",
+]

kard/users/attributions/client.py

@@ -0,0 +1,229 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...commons.types.organization_id import OrganizationId
+from ...commons.types.user_id import UserId
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.request_options import RequestOptions
+from .raw_client import AsyncRawAttributionsClient, RawAttributionsClient
+from .types.create_attribution_request_union import CreateAttributionRequestUnion
+from .types.create_attribution_response import CreateAttributionResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AttributionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawAttributionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawAttributionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawAttributionsClient
+        """
+        return self._raw_client
+
+    def create(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        data: typing.Sequence[CreateAttributionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateAttributionResponse:
+        """
+        Call this endpoint to send attribution events made by a single enrolled user for processing. A maximum of 100 events can be included in a single request.
+
+        <b>Required scopes:</b> `attributions:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        data : typing.Sequence[CreateAttributionRequestUnion]
+            Discriminated union representing the request body for submitting attribution events.
+            Use `type` to distinguish between the two:
+            - `offerAttribution`: Events related to viewing or interacting with an offer.
+            - `notificationAttribution`: Events related to viewing or interacting with a notification.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateAttributionResponse
+
+        Examples
+        --------
+        import datetime
+
+        from kard import KardApi
+        from kard.users.attributions import (
+            CreateAttributionRequestUnion_NotificationAttribution,
+            CreateAttributionRequestUnion_OfferAttribution,
+            NotificationAttributionAttributes,
+            OfferAttributionAttributes,
+        )
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.users.attributions.create(
+            organization_id="organization-123",
+            user_id="user-123",
+            data=[
+                CreateAttributionRequestUnion_OfferAttribution(
+                    attributes=OfferAttributionAttributes(
+                        entity_id="60e4ba1da31c5a22a144c075",
+                        event_code="VIEW",
+                        medium="SEARCH",
+                        event_date=datetime.datetime.fromisoformat(
+                            "2025-01-01 00:00:00+00:00",
+                        ),
+                    ),
+                ),
+                CreateAttributionRequestUnion_OfferAttribution(
+                    attributes=OfferAttributionAttributes(
+                        entity_id="60e4ba1da31c5a22a144c077",
+                        event_code="IMPRESSION",
+                        medium="EMAIL",
+                        event_date=datetime.datetime.fromisoformat(
+                            "2025-01-01 00:00:00+00:00",
+                        ),
+                    ),
+                ),
+                CreateAttributionRequestUnion_NotificationAttribution(
+                    attributes=NotificationAttributionAttributes(
+                        entity_id="60e4ba1da31c5a22a144c076",
+                        event_code="IMPRESSION",
+                        medium="PUSH",
+                        event_date=datetime.datetime.fromisoformat(
+                            "2025-01-01 00:00:00+00:00",
+                        ),
+                    ),
+                ),
+            ],
+        )
+        """
+        _response = self._raw_client.create(organization_id, user_id, data=data, request_options=request_options)
+        return _response.data
+
+
+class AsyncAttributionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawAttributionsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawAttributionsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawAttributionsClient
+        """
+        return self._raw_client
+
+    async def create(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        data: typing.Sequence[CreateAttributionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateAttributionResponse:
+        """
+        Call this endpoint to send attribution events made by a single enrolled user for processing. A maximum of 100 events can be included in a single request.
+
+        <b>Required scopes:</b> `attributions:write`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        user_id : UserId
+
+        data : typing.Sequence[CreateAttributionRequestUnion]
+            Discriminated union representing the request body for submitting attribution events.
+            Use `type` to distinguish between the two:
+            - `offerAttribution`: Events related to viewing or interacting with an offer.
+            - `notificationAttribution`: Events related to viewing or interacting with a notification.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateAttributionResponse
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from kard import AsyncKardApi
+        from kard.users.attributions import (
+            CreateAttributionRequestUnion_NotificationAttribution,
+            CreateAttributionRequestUnion_OfferAttribution,
+            NotificationAttributionAttributes,
+            OfferAttributionAttributes,
+        )
+
+        client = AsyncKardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+
+
+        async def main() -> None:
+            await client.users.attributions.create(
+                organization_id="organization-123",
+                user_id="user-123",
+                data=[
+                    CreateAttributionRequestUnion_OfferAttribution(
+                        attributes=OfferAttributionAttributes(
+                            entity_id="60e4ba1da31c5a22a144c075",
+                            event_code="VIEW",
+                            medium="SEARCH",
+                            event_date=datetime.datetime.fromisoformat(
+                                "2025-01-01 00:00:00+00:00",
+                            ),
+                        ),
+                    ),
+                    CreateAttributionRequestUnion_OfferAttribution(
+                        attributes=OfferAttributionAttributes(
+                            entity_id="60e4ba1da31c5a22a144c077",
+                            event_code="IMPRESSION",
+                            medium="EMAIL",
+                            event_date=datetime.datetime.fromisoformat(
+                                "2025-01-01 00:00:00+00:00",
+                            ),
+                        ),
+                    ),
+                    CreateAttributionRequestUnion_NotificationAttribution(
+                        attributes=NotificationAttributionAttributes(
+                            entity_id="60e4ba1da31c5a22a144c076",
+                            event_code="IMPRESSION",
+                            medium="PUSH",
+                            event_date=datetime.datetime.fromisoformat(
+                                "2025-01-01 00:00:00+00:00",
+                            ),
+                        ),
+                    ),
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create(organization_id, user_id, data=data, request_options=request_options)
+        return _response.data