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

kard/users/attributions/raw_client.py

@@ -0,0 +1,215 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ...commons.errors.internal_server_error import InternalServerError
+from ...commons.errors.invalid_request import InvalidRequest
+from ...commons.errors.unauthorized_error import UnauthorizedError
+from ...commons.types.error_response import ErrorResponse
+from ...commons.types.organization_id import OrganizationId
+from ...commons.types.user_id import UserId
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...core.http_response import AsyncHttpResponse, HttpResponse
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.pydantic_utilities import parse_obj_as
+from ...core.request_options import RequestOptions
+from ...core.serialization import convert_and_respect_annotation_metadata
+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 RawAttributionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        data: typing.Sequence[CreateAttributionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[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
+        -------
+        HttpResponse[CreateAttributionResponse]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v2/issuers/{jsonable_encoder(organization_id)}/users/{jsonable_encoder(user_id)}/attributions",
+            method="POST",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=typing.Sequence[CreateAttributionRequestUnion], direction="write"
+                ),
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateAttributionResponse,
+                    parse_obj_as(
+                        type_=CreateAttributionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise InvalidRequest(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawAttributionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        organization_id: OrganizationId,
+        user_id: UserId,
+        *,
+        data: typing.Sequence[CreateAttributionRequestUnion],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[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
+        -------
+        AsyncHttpResponse[CreateAttributionResponse]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v2/issuers/{jsonable_encoder(organization_id)}/users/{jsonable_encoder(user_id)}/attributions",
+            method="POST",
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=typing.Sequence[CreateAttributionRequestUnion], direction="write"
+                ),
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateAttributionResponse,
+                    parse_obj_as(
+                        type_=CreateAttributionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise InvalidRequest(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

kard/users/attributions/types/__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 .create_attribution_request_object import CreateAttributionRequestObject
+    from .create_attribution_request_union import (
+        CreateAttributionRequestUnion,
+        CreateAttributionRequestUnion_NotificationAttribution,
+        CreateAttributionRequestUnion_OfferAttribution,
+    )
+    from .create_attribution_response import CreateAttributionResponse
+    from .event_code import EventCode
+    from .notification_attribution_attributes import NotificationAttributionAttributes
+    from .notification_attribution_request import NotificationAttributionRequest
+    from .notification_medium import NotificationMedium
+    from .offer_attribution_attributes import OfferAttributionAttributes
+    from .offer_attribution_request import OfferAttributionRequest
+    from .offer_medium import OfferMedium
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateAttributionRequestObject": ".create_attribution_request_object",
+    "CreateAttributionRequestUnion": ".create_attribution_request_union",
+    "CreateAttributionRequestUnion_NotificationAttribution": ".create_attribution_request_union",
+    "CreateAttributionRequestUnion_OfferAttribution": ".create_attribution_request_union",
+    "CreateAttributionResponse": ".create_attribution_response",
+    "EventCode": ".event_code",
+    "NotificationAttributionAttributes": ".notification_attribution_attributes",
+    "NotificationAttributionRequest": ".notification_attribution_request",
+    "NotificationMedium": ".notification_medium",
+    "OfferAttributionAttributes": ".offer_attribution_attributes",
+    "OfferAttributionRequest": ".offer_attribution_request",
+    "OfferMedium": ".offer_medium",
+}
+
+
+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/types/create_attribution_request_object.py

@@ -0,0 +1,75 @@
+# 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 .create_attribution_request_union import CreateAttributionRequestUnion
+
+
+class CreateAttributionRequestObject(UniversalBaseModel):
+    """
+    Examples
+    --------
+    import datetime
+
+    from kard.users.attributions import (
+        CreateAttributionRequestObject,
+        CreateAttributionRequestUnion_NotificationAttribution,
+        CreateAttributionRequestUnion_OfferAttribution,
+        NotificationAttributionAttributes,
+        OfferAttributionAttributes,
+    )
+
+    CreateAttributionRequestObject(
+        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",
+                    ),
+                ),
+            ),
+        ],
+    )
+    """
+
+    data: typing.List[CreateAttributionRequestUnion] = pydantic.Field()
+    """
+    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.
+    """
+
+    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/attributions/types/create_attribution_request_union.py

@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+import typing_extensions
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .notification_attribution_attributes import NotificationAttributionAttributes
+from .offer_attribution_attributes import OfferAttributionAttributes
+
+
+class CreateAttributionRequestUnion_OfferAttribution(UniversalBaseModel):
+    type: typing.Literal["offerAttribution"] = "offerAttribution"
+    attributes: OfferAttributionAttributes
+
+    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
+
+
+class CreateAttributionRequestUnion_NotificationAttribution(UniversalBaseModel):
+    type: typing.Literal["notificationAttribution"] = "notificationAttribution"
+    attributes: NotificationAttributionAttributes
+
+    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
+
+
+CreateAttributionRequestUnion = typing_extensions.Annotated[
+    typing.Union[CreateAttributionRequestUnion_OfferAttribution, CreateAttributionRequestUnion_NotificationAttribution],
+    pydantic.Field(discriminator="type"),
+]

kard/users/attributions/types/create_attribution_response.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.job_response import JobResponse
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateAttributionResponse(UniversalBaseModel):
+    """
+    Examples
+    --------
+    from kard.commons import Job, JobResponse
+    from kard.users.attributions import CreateAttributionResponse
+
+    CreateAttributionResponse(
+        data=JobResponse(
+            type="job",
+            id="c94a93a7-beb9-4e58-960c-2c812f849398",
+            attributes=Job(
+                status="queued",
+                message="Attribution events are queued for processing",
+            ),
+        ),
+    )
+    """
+
+    data: JobResponse
+
+    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/attributions/types/event_code.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+EventCode = typing.Union[typing.Literal["IMPRESSION", "VIEW"], typing.Any]

kard/users/attributions/types/notification_attribution_attributes.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ....core.serialization import FieldMetadata
+from .event_code import EventCode
+from .notification_medium import NotificationMedium
+
+
+class NotificationAttributionAttributes(UniversalBaseModel):
+    entity_id: typing_extensions.Annotated[str, FieldMetadata(alias="entityId")] = pydantic.Field()
+    """
+    The notification ID
+    """
+
+    event_code: typing_extensions.Annotated[EventCode, FieldMetadata(alias="eventCode")]
+    medium: NotificationMedium
+    event_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="eventDate")] = pydantic.Field()
+    """
+    The timestamp of the attribution event.
+    Must be in ISO 8601 format (e.g., "2025-01-01T00:00:00Z").
+    """
+
+    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/attributions/types/notification_attribution_request.py

@@ -0,0 +1,20 @@
+# 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 .notification_attribution_attributes import NotificationAttributionAttributes
+
+
+class NotificationAttributionRequest(UniversalBaseModel):
+    attributes: NotificationAttributionAttributes
+
+    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/attributions/types/notification_medium.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+NotificationMedium = typing.Union[typing.Literal["PUSH"], typing.Any]

kard/users/attributions/types/offer_attribution_attributes.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ....core.serialization import FieldMetadata
+from .event_code import EventCode
+from .offer_medium import OfferMedium
+
+
+class OfferAttributionAttributes(UniversalBaseModel):
+    entity_id: typing_extensions.Annotated[str, FieldMetadata(alias="entityId")] = pydantic.Field()
+    """
+    The offer ID
+    """
+
+    event_code: typing_extensions.Annotated[EventCode, FieldMetadata(alias="eventCode")]
+    medium: OfferMedium
+    event_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="eventDate")] = pydantic.Field()
+    """
+    The timestamp of the attribution event.
+    Must be in ISO 8601 format (e.g., "2025-01-01T00:00:00Z").
+    """
+
+    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/attributions/types/offer_attribution_request.py

@@ -0,0 +1,20 @@
+# 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 .offer_attribution_attributes import OfferAttributionAttributes
+
+
+class OfferAttributionRequest(UniversalBaseModel):
+    attributes: OfferAttributionAttributes
+
+    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/attributions/types/offer_medium.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+OfferMedium = typing.Union[typing.Literal["BROWSE", "EMAIL", "MAP", "SEARCH"], typing.Any]