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

kard/notifications/types/earned_reward_settled_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 .earned_reward_relationships import EarnedRewardRelationships
+from .earned_reward_settled_attributes import EarnedRewardSettledAttributes
+
+
+class EarnedRewardSettledData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: EarnedRewardSettledAttributes
+    relationships: EarnedRewardRelationships
+
+    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/failed_transaction_attributes.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class FailedTransactionAttributes(UniversalBaseModel):
+    message: str = pydantic.Field()
+    """
+    The display message associated to the notification
+    """
+
+    reason: str = pydantic.Field()
+    """
+    The reason for the transaction failure
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the merchant
+    """
+
+    card_product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardProductId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The ID of the card product
+    """
+
+    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/failed_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 .failed_transaction_attributes import FailedTransactionAttributes
+from .failed_transaction_relationships import FailedTransactionRelationships
+
+
+class FailedTransactionData(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The internal ID of the notification
+    """
+
+    attributes: FailedTransactionAttributes
+    relationships: FailedTransactionRelationships
+
+    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/failed_transaction_relationships.py

@@ -0,0 +1,22 @@
+# 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 FailedTransactionRelationships(UniversalBaseModel):
+    user: RelationshipSingle
+    offer: RelationshipSingle
+    transaction: 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/location_address.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class LocationAddress(UniversalBaseModel):
+    street: str = pydantic.Field()
+    """
+    The street address
+    """
+
+    city: str = pydantic.Field()
+    """
+    The city
+    """
+
+    state: str = pydantic.Field()
+    """
+    The state or province
+    """
+
+    zip_code: typing_extensions.Annotated[str, FieldMetadata(alias="zipCode")] = pydantic.Field()
+    """
+    The postal or ZIP code
+    """
+
+    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/location_coordinates.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 LocationCoordinates(UniversalBaseModel):
+    longitude: float = pydantic.Field()
+    """
+    The longitude coordinate
+    """
+
+    latitude: float = pydantic.Field()
+    """
+    The latitude coordinate
+    """
+
+    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/location_status.py

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

kard/notifications/types/merchant_source.py

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

kard/notifications/types/notification_data_union.py

@@ -0,0 +1,203 @@
+# 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 .audit_update_attributes import AuditUpdateAttributes
+from .audit_update_relationships import AuditUpdateRelationships
+from .earned_reward_attributes import EarnedRewardAttributes
+from .earned_reward_relationships import EarnedRewardRelationships
+from .earned_reward_settled_attributes import EarnedRewardSettledAttributes
+from .failed_transaction_attributes import FailedTransactionAttributes
+from .failed_transaction_relationships import FailedTransactionRelationships
+from .transaction_relationships import TransactionRelationships
+from .valid_transaction_attributes import ValidTransactionAttributes
+from .webhook_locations_attributes import WebhookLocationsAttributes
+from .webhook_locations_relationships import WebhookLocationsRelationships
+from .webhook_merchant_attributes import WebhookMerchantAttributes
+from .webhook_merchant_relationships import WebhookMerchantRelationships
+from .webhook_offer_attributes import WebhookOfferAttributes
+from .webhook_offer_relationships import WebhookOfferRelationships
+from .webhook_user_offer_attributes import WebhookUserOfferAttributes
+from .webhook_user_offer_relationships import WebhookUserOfferRelationships
+
+
+class NotificationDataUnion_EarnedRewardApproved(UniversalBaseModel):
+    type: typing.Literal["earnedRewardApproved"] = "earnedRewardApproved"
+    id: str
+    attributes: EarnedRewardAttributes
+    relationships: EarnedRewardRelationships
+
+    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 NotificationDataUnion_EarnedRewardSettled(UniversalBaseModel):
+    type: typing.Literal["earnedRewardSettled"] = "earnedRewardSettled"
+    id: str
+    attributes: EarnedRewardSettledAttributes
+    relationships: EarnedRewardRelationships
+
+    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 NotificationDataUnion_ValidTransaction(UniversalBaseModel):
+    type: typing.Literal["validTransaction"] = "validTransaction"
+    id: str
+    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
+
+
+class NotificationDataUnion_FailedTransaction(UniversalBaseModel):
+    type: typing.Literal["failedTransaction"] = "failedTransaction"
+    id: str
+    attributes: FailedTransactionAttributes
+    relationships: FailedTransactionRelationships
+
+    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 NotificationDataUnion_Clawback(UniversalBaseModel):
+    type: typing.Literal["clawback"] = "clawback"
+    id: str
+    attributes: FailedTransactionAttributes
+    relationships: FailedTransactionRelationships
+
+    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 NotificationDataUnion_Offer(UniversalBaseModel):
+    type: typing.Literal["offer"] = "offer"
+    id: str
+    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
+
+
+class NotificationDataUnion_Merchant(UniversalBaseModel):
+    type: typing.Literal["merchant"] = "merchant"
+    id: str
+    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
+
+
+class NotificationDataUnion_Location(UniversalBaseModel):
+    type: typing.Literal["location"] = "location"
+    id: str
+    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
+
+
+class NotificationDataUnion_UserOffer(UniversalBaseModel):
+    type: typing.Literal["userOffer"] = "userOffer"
+    id: str
+    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
+
+
+class NotificationDataUnion_AuditUpdate(UniversalBaseModel):
+    type: typing.Literal["auditUpdate"] = "auditUpdate"
+    id: str
+    attributes: AuditUpdateAttributes
+    relationships: AuditUpdateRelationships
+
+    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
+
+
+NotificationDataUnion = typing_extensions.Annotated[
+    typing.Union[
+        NotificationDataUnion_EarnedRewardApproved,
+        NotificationDataUnion_EarnedRewardSettled,
+        NotificationDataUnion_ValidTransaction,
+        NotificationDataUnion_FailedTransaction,
+        NotificationDataUnion_Clawback,
+        NotificationDataUnion_Offer,
+        NotificationDataUnion_Merchant,
+        NotificationDataUnion_Location,
+        NotificationDataUnion_UserOffer,
+        NotificationDataUnion_AuditUpdate,
+    ],
+    pydantic.Field(discriminator="type"),
+]

kard/notifications/types/notification_metadata.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class NotificationMetadata(UniversalBaseModel):
+    issuer_id: typing_extensions.Annotated[str, FieldMetadata(alias="issuerId")]
+    issuer_name: typing_extensions.Annotated[str, FieldMetadata(alias="issuerName")]
+
+    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/notification_payload.py

@@ -0,0 +1,65 @@
+# 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_data_union import NotificationDataUnion
+from .notification_metadata import NotificationMetadata
+
+
+class NotificationPayload(UniversalBaseModel):
+    """
+    Examples
+    --------
+    from kard.commons import CommissionValue, RelationshipData, RelationshipSingle
+    from kard.notifications import (
+        EarnedRewardRelationships,
+        EarnedRewardSettledAttributes,
+        NotificationDataUnion_EarnedRewardSettled,
+        NotificationPayload,
+    )
+
+    NotificationPayload(
+        data=NotificationDataUnion_EarnedRewardSettled(
+            id="d80a6f28-1b24-4d65-9e42-e1cf3379bc98",
+            attributes=EarnedRewardSettledAttributes(
+                message="You have earned a 72 cent reward on your transaction at McDonald's",
+                name="McDonald's",
+                commission_earned=CommissionValue(
+                    type="cents",
+                    value=72,
+                ),
+                attribution_url="www.attribution.com/token",
+                survey_url="www.survey.com",
+                card_product_id="card_product_123",
+            ),
+            relationships=EarnedRewardRelationships(
+                user=RelationshipSingle(
+                    data=RelationshipData(
+                        type="user",
+                        id="1234567890",
+                    ),
+                ),
+                transaction=RelationshipSingle(
+                    data=RelationshipData(
+                        type="transaction",
+                        id="0987654321",
+                    ),
+                ),
+            ),
+        ),
+    )
+    """
+
+    data: NotificationDataUnion
+    meta: typing.Optional[NotificationMetadata] = 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/offer_status.py

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

kard/notifications/types/offer_type.py

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

kard/notifications/types/reward_notification_attributes.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class RewardNotificationAttributes(UniversalBaseModel):
+    message: str = pydantic.Field()
+    """
+    The display message associated to the notification
+    """
+
+    name: str = pydantic.Field()
+    """
+    The name of the merchant
+    """
+
+    attribution_url: typing_extensions.Annotated[str, FieldMetadata(alias="attributionUrl")] = pydantic.Field()
+    """
+    The attribution URL to track user's interactions with the notification
+    """
+
+    survey_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="surveyUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    Post experience survey URL, if available. This will be present for rewards associated with local offers.
+    """
+
+    card_product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cardProductId")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The ID of the card product
+    """
+
+    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/time_period.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 TimePeriod(UniversalBaseModel):
+    day: int = pydantic.Field()
+    """
+    Day of week (0=Sunday, 1=Monday, etc.)
+    """
+
+    time: str = pydantic.Field()
+    """
+    Time in 24-hour format (e.g. "0900" for 9:00 AM)
+    """
+
+    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/transaction_relationships.py

@@ -0,0 +1,22 @@
+# 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 TransactionRelationships(UniversalBaseModel):
+    user: RelationshipSingle
+    offer: RelationshipSingle
+    transaction: 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/user_offer_status.py

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

kard/notifications/types/valid_transaction_attributes.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.serialization import FieldMetadata
+from .reward_notification_attributes import RewardNotificationAttributes
+from .valid_transaction_commission_earned import ValidTransactionCommissionEarned
+
+
+class ValidTransactionAttributes(RewardNotificationAttributes):
+    commission_earned: typing_extensions.Annotated[
+        ValidTransactionCommissionEarned, FieldMetadata(alias="commissionEarned")
+    ]
+
+    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/valid_transaction_commission_earned.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.commission_value import CommissionValue
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class ValidTransactionCommissionEarned(UniversalBaseModel):
+    issuer: CommissionValue
+    user: CommissionValue
+
+    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