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

kard/notifications/types/valid_transaction_data.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
+from .transaction_relationships import TransactionRelationships
+from .valid_transaction_attributes import ValidTransactionAttributes
+
+
+class ValidTransactionData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: ValidTransactionAttributes
+    relationships: TransactionRelationships
+
+    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/notifications/types/webhook_locations_attributes.py

@@ -0,0 +1,71 @@
+# 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 .broker_operation_hours import BrokerOperationHours
+from .location_address import LocationAddress
+from .location_coordinates import LocationCoordinates
+from .location_status import LocationStatus
+
+
+class WebhookLocationsAttributes(UniversalBaseModel):
+    location_id: typing_extensions.Annotated[str, FieldMetadata(alias="locationId")] = pydantic.Field()
+    """
+    The Kard location ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the location
+    """
+
+    status: LocationStatus = pydantic.Field()
+    """
+    The status of the location
+    """
+
+    address: LocationAddress = pydantic.Field()
+    """
+    The physical address of the location
+    """
+
+    coordinates: LocationCoordinates = pydantic.Field()
+    """
+    The geographic coordinates of the location
+    """
+
+    phone: str = pydantic.Field()
+    """
+    The phone number of the location
+    """
+
+    operation_hours: typing_extensions.Annotated[BrokerOperationHours, FieldMetadata(alias="operationHours")] = (
+        pydantic.Field()
+    )
+    """
+    The hours of operation for the location
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the location was created
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the location was last updated
+    """
+
+    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/notifications/types/webhook_locations_data.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
+from .webhook_locations_attributes import WebhookLocationsAttributes
+from .webhook_locations_relationships import WebhookLocationsRelationships
+
+
+class WebhookLocationsData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: WebhookLocationsAttributes
+    relationships: WebhookLocationsRelationships
+
+    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/notifications/types/webhook_locations_relationships.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.relationship_single import RelationshipSingle
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WebhookLocationsRelationships(UniversalBaseModel):
+    merchant: RelationshipSingle
+
+    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/notifications/types/webhook_merchant_attributes.py

@@ -0,0 +1,67 @@
+# 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 .broker_asset import BrokerAsset
+from .merchant_source import MerchantSource
+
+
+class WebhookMerchantAttributes(UniversalBaseModel):
+    merchant_id: typing_extensions.Annotated[str, FieldMetadata(alias="merchantId")] = pydantic.Field()
+    """
+    The Kard merchant ID
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the merchant
+    """
+
+    description: str = pydantic.Field()
+    """
+    The description of the merchant
+    """
+
+    website_url: typing_extensions.Annotated[str, FieldMetadata(alias="websiteUrl")] = pydantic.Field()
+    """
+    The URL of the merchant's website
+    """
+
+    assets: typing.List[BrokerAsset] = pydantic.Field()
+    """
+    Media assets associated with the merchant
+    """
+
+    source: MerchantSource = pydantic.Field()
+    """
+    The source of the merchant data
+    """
+
+    category: str = pydantic.Field()
+    """
+    The category of the merchant
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the merchant was last updated
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the merchant was created
+    """
+
+    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/notifications/types/webhook_merchant_data.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
+from .webhook_merchant_attributes import WebhookMerchantAttributes
+from .webhook_merchant_relationships import WebhookMerchantRelationships
+
+
+class WebhookMerchantData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: WebhookMerchantAttributes
+    relationships: WebhookMerchantRelationships
+
+    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/notifications/types/webhook_merchant_relationships.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.relationship_multiple import RelationshipMultiple
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WebhookMerchantRelationships(UniversalBaseModel):
+    offer: typing.Optional[RelationshipMultiple] = None
+
+    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/notifications/types/webhook_offer_attributes.py

@@ -0,0 +1,143 @@
+# 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 .broker_amount import BrokerAmount
+from .broker_purchase_channel import BrokerPurchaseChannel
+from .broker_reward import BrokerReward
+from .offer_status import OfferStatus
+from .offer_type import OfferType
+
+
+class WebhookOfferAttributes(UniversalBaseModel):
+    offer_id: typing_extensions.Annotated[str, FieldMetadata(alias="offerId")] = pydantic.Field()
+    """
+    The Kard offer ID
+    """
+
+    offer_type: typing_extensions.Annotated[OfferType, FieldMetadata(alias="offerType")] = pydantic.Field()
+    """
+    The type of kard platform offer (e.g., "standardOffer")
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the offer
+    """
+
+    terms: str = pydantic.Field()
+    """
+    Terms and conditions for the offer
+    """
+
+    status: OfferStatus = pydantic.Field()
+    """
+    Current status of the offer
+    """
+
+    purchase_channel: typing_extensions.Annotated[
+        typing.List[BrokerPurchaseChannel], FieldMetadata(alias="purchaseChannel")
+    ] = pydantic.Field()
+    """
+    Channels where the offer can be redeemed
+    """
+
+    user_reward: typing_extensions.Annotated[BrokerReward, FieldMetadata(alias="userReward")] = pydantic.Field()
+    """
+    Reward details for the user
+    """
+
+    start_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="startDate")] = pydantic.Field()
+    """
+    When the offer becomes active
+    """
+
+    expiration_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="expirationDate")] = pydantic.Field()
+    """
+    When the offer expires
+    """
+
+    min_reward_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="minRewardAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Minimum reward amount
+    """
+
+    max_reward_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="maxRewardAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Maximum reward amount
+    """
+
+    min_user_reward_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="minUserRewardAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Minimum user reward amount
+    """
+
+    max_user_reward_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="maxUserRewardAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Maximum user reward amount
+    """
+
+    min_transaction_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="minTransactionAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Minimum transaction amount
+    """
+
+    max_transaction_amount: typing_extensions.Annotated[
+        typing.Optional[BrokerAmount], FieldMetadata(alias="maxTransactionAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Maximum transaction amount
+    """
+
+    max_redemptions: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="maxRedemptions")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Maximum number of times the offer can be redeemed
+    """
+
+    valid_mc_cs: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="validMCCs")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Required MCCs to redeem the offer. If this is empty or not present no MCCs are required.
+    """
+
+    is_targeted: typing_extensions.Annotated[bool, FieldMetadata(alias="isTargeted")] = pydantic.Field()
+    """
+    Whether the offer is targeted to specific users
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the offer was last updated
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the offer was created
+    """
+
+    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/notifications/types/webhook_offer_data.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
+from .webhook_offer_attributes import WebhookOfferAttributes
+from .webhook_offer_relationships import WebhookOfferRelationships
+
+
+class WebhookOfferData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: WebhookOfferAttributes
+    relationships: WebhookOfferRelationships
+
+    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/notifications/types/webhook_offer_relationships.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.relationship_single import RelationshipSingle
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WebhookOfferRelationships(UniversalBaseModel):
+    merchant: RelationshipSingle
+
+    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/notifications/types/webhook_user_offer_attributes.py

@@ -0,0 +1,41 @@
+# 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 .user_offer_status import UserOfferStatus
+
+
+class WebhookUserOfferAttributes(UniversalBaseModel):
+    status: UserOfferStatus = pydantic.Field()
+    """
+    Current status of the user offer
+    """
+
+    updated_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="updatedAt")] = pydantic.Field()
+    """
+    When the user offer was last updated
+    """
+
+    created_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="createdAt")] = pydantic.Field()
+    """
+    When the user offer was created
+    """
+
+    event_priority: typing_extensions.Annotated[float, FieldMetadata(alias="eventPriority")] = pydantic.Field()
+    """
+    The priority of the notification event. This will be a number between 1-10 with 1 being the highest priority.
+    """
+
+    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/notifications/types/webhook_user_offer_data.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
+from .webhook_user_offer_attributes import WebhookUserOfferAttributes
+from .webhook_user_offer_relationships import WebhookUserOfferRelationships
+
+
+class WebhookUserOfferData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: WebhookUserOfferAttributes
+    relationships: WebhookUserOfferRelationships
+
+    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/notifications/types/webhook_user_offer_relationships.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.relationship_single import RelationshipSingle
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WebhookUserOfferRelationships(UniversalBaseModel):
+    offer: RelationshipSingle
+    user: RelationshipSingle
+
+    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/ping/__init__.py

@@ -0,0 +1,39 @@
+# 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 NetworkBlockedErrorBody, PingResponseObject
+    from .errors import NetworkBlockedError
+_dynamic_imports: typing.Dict[str, str] = {
+    "NetworkBlockedError": ".errors",
+    "NetworkBlockedErrorBody": ".types",
+    "PingResponseObject": ".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__ = ["NetworkBlockedError", "NetworkBlockedErrorBody", "PingResponseObject"]

kard/ping/client.py

@@ -0,0 +1,100 @@
+# 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 .raw_client import AsyncRawPingClient, RawPingClient
+from .types.ping_response_object import PingResponseObject
+
+
+class PingClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawPingClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawPingClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawPingClient
+        """
+        return self._raw_client
+
+    def ping(self, *, request_options: typing.Optional[RequestOptions] = None) -> PingResponseObject:
+        """
+        Call this endpoint to verify network connectivity and service availability.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PingResponseObject
+
+        Examples
+        --------
+        from kard import KardApi
+
+        client = KardApi(
+            client_id="YOUR_CLIENT_ID",
+            client_secret="YOUR_CLIENT_SECRET",
+        )
+        client.ping.ping()
+        """
+        _response = self._raw_client.ping(request_options=request_options)
+        return _response.data
+
+
+class AsyncPingClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawPingClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawPingClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawPingClient
+        """
+        return self._raw_client
+
+    async def ping(self, *, request_options: typing.Optional[RequestOptions] = None) -> PingResponseObject:
+        """
+        Call this endpoint to verify network connectivity and service availability.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PingResponseObject
+
+        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.ping.ping()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.ping(request_options=request_options)
+        return _response.data