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

kard/users/rewards/types/locations_response_object.py

@@ -0,0 +1,215 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.links import Links
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .eligibility_location_included import EligibilityLocationIncluded
+from .location_data import LocationData
+
+
+class LocationsResponseObject(UniversalBaseModel):
+    """
+    Examples
+    --------
+    import datetime
+
+    from kard.commons import Links, RelationshipData, RelationshipMultiple
+    from kard.users.rewards import (
+        Amount,
+        Asset,
+        CategoryFields,
+        CategoryIncluded,
+        Commission,
+        Coordinates,
+        EligibilityLocationAddress,
+        LocationAttributes,
+        LocationData,
+        LocationRelationships,
+        LocationsResponseObject,
+        OfferDataUnion_StandardOffer,
+        OperationHours,
+        OperationPeriod,
+        OperationTime,
+        StandardOfferFields,
+    )
+
+    LocationsResponseObject(
+        data=[
+            LocationData(
+                id="5e27318c9b346f00087fba8l",
+                attributes=LocationAttributes(
+                    name="Worlds Greatest Chicken",
+                    address=EligibilityLocationAddress(
+                        street="120 Main St",
+                        city="Philadelphia",
+                        state="PA",
+                        zip_code="19147",
+                    ),
+                    coordinates=Coordinates(
+                        longitude=-75.1446869,
+                        latitude=39.9419429,
+                    ),
+                    phone="+1 (123) 555-8880",
+                    operation_hours=OperationHours(
+                        periods=[
+                            OperationPeriod(
+                                close=OperationTime(
+                                    day=1,
+                                    time="1700",
+                                ),
+                                open=OperationTime(
+                                    day=1,
+                                    time="0900",
+                                ),
+                            ),
+                            OperationPeriod(
+                                close=OperationTime(
+                                    day=2,
+                                    time="1700",
+                                ),
+                                open=OperationTime(
+                                    day=2,
+                                    time="0900",
+                                ),
+                            ),
+                            OperationPeriod(
+                                close=OperationTime(
+                                    day=3,
+                                    time="1700",
+                                ),
+                                open=OperationTime(
+                                    day=3,
+                                    time="0900",
+                                ),
+                            ),
+                            OperationPeriod(
+                                close=OperationTime(
+                                    day=4,
+                                    time="1700",
+                                ),
+                                open=OperationTime(
+                                    day=4,
+                                    time="0900",
+                                ),
+                            ),
+                            OperationPeriod(
+                                close=OperationTime(
+                                    day=5,
+                                    time="1700",
+                                ),
+                                open=OperationTime(
+                                    day=5,
+                                    time="0900",
+                                ),
+                            ),
+                        ],
+                        weekday_text=[
+                            "Monday: 9:00 AM – 5:00 PM",
+                            "Tuesday: 9:00 AM – 5:00 PM",
+                            "Wednesday: 9:00 AM – 5:00 PM",
+                            "Thursday: 9:00 AM – 5:00 PM",
+                            "Friday: 9:00 AM – 5:00 PM",
+                            "Saturday: Closed",
+                            "Sunday: Closed",
+                        ],
+                    ),
+                ),
+                relationships=LocationRelationships(
+                    offers=RelationshipMultiple(
+                        data=[
+                            RelationshipData(
+                                type="standardOffer",
+                                id="5e27318c9b346f00087fbb5b",
+                            )
+                        ],
+                    ),
+                    category=RelationshipMultiple(
+                        data=[
+                            RelationshipData(
+                                type="category",
+                                id="65920081b524d126068de24a",
+                            )
+                        ],
+                    ),
+                ),
+            )
+        ],
+        included=[
+            CategoryIncluded(
+                id="65920081b524d126068de24a",
+                attributes=CategoryFields(
+                    name="Food & Beverage",
+                ),
+            ),
+            OfferDataUnion_StandardOffer(
+                id="5e27318c9b346f00087fbb5c",
+                attributes=StandardOfferFields(
+                    name="Worlds Greatest Chicken",
+                    terms="Worlds Greatest Chicken offers are only available within US Locations.",
+                    purchase_channel=["INSTORE"],
+                    user_reward=Commission(
+                        type="PERCENT",
+                        value=5.7,
+                    ),
+                    start_date=datetime.datetime.fromisoformat(
+                        "2022-01-01 05:00:00+00:00",
+                    ),
+                    expiration_date=datetime.datetime.fromisoformat(
+                        "2022-01-01 05:00:00+00:00",
+                    ),
+                    min_reward_amount=Amount(
+                        type="CENTS",
+                        value=500,
+                    ),
+                    max_reward_amount=Amount(
+                        type="CENTS",
+                        value=2000,
+                    ),
+                    min_transaction_amount=Amount(
+                        type="CENTS",
+                        value=500,
+                    ),
+                    max_transaction_amount=Amount(
+                        type="CENTS",
+                        value=2000,
+                    ),
+                    max_redemptions=1,
+                    is_targeted=True,
+                    assets=[
+                        Asset(
+                            type="IMG_VIEW",
+                            url="http://assets.getkard.com/logo/img?attribution-tokens",
+                            alt="Worlds Greatest Chicken Logo Image",
+                        ),
+                        Asset(
+                            type="BANNER_VIEW",
+                            url="http://assets.getkard.com/banner/img?attribution-tokens",
+                            alt="Worlds Greatest Chicken Banner Image",
+                        ),
+                    ],
+                    website_url="http://worldsgreatestchickent.test.com",
+                    description="Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world.",
+                ),
+            ),
+        ],
+        links=Links(
+            self_="/v2/issuers/{organizationId}/users/{userId}/locations?page[size]=1&filter[latitude]=39.9419429&filter[longitude]=-75.1446869&filter[radius]=10&include=offers,categories",
+            next="/v2/issuers/{organizationId}/users/{userId}/locations?page[after]=NDMyNzQyODI3OTQw&page[size]=1&filter[latitude]=39.9419429&filter[longitude]=-75.1446869&filter[radius]=10&include=offers,categories",
+        ),
+    )
+    """
+
+    data: typing.List[LocationData]
+    links: Links
+    included: typing.Optional[typing.List[EligibilityLocationIncluded]] = 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/users/rewards/types/offer_common_fields.py

@@ -0,0 +1,103 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ....commons.types.purchase_channel import PurchaseChannel
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ....core.serialization import FieldMetadata
+from .amount import Amount
+from .asset import Asset
+from .commission import Commission
+
+
+class OfferCommonFields(UniversalBaseModel):
+    terms: str = pydantic.Field()
+    """
+    Terms and conditions on offer
+    """
+
+    max_redemptions: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="maxRedemptions")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Maximum times cardholder can redeem offer, if applicable
+    """
+
+    name: str = pydantic.Field()
+    """
+    Name of offer
+    """
+
+    purchase_channel: typing_extensions.Annotated[typing.List[PurchaseChannel], FieldMetadata(alias="purchaseChannel")]
+    user_reward: typing_extensions.Annotated[Commission, FieldMetadata(alias="userReward")]
+    assets: typing.List[Asset] = pydantic.Field()
+    """
+    Assets associated with offer
+    """
+
+    start_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="startDate")] = pydantic.Field()
+    """
+    Beginning date of offer (UTC)
+    """
+
+    expiration_date: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="expirationDate")] = pydantic.Field()
+    """
+    Expiration date of offer if applicable (UTC)
+    """
+
+    is_targeted: typing_extensions.Annotated[bool, FieldMetadata(alias="isTargeted")] = pydantic.Field()
+    """
+    True returns only targeted offers, false returns only non-targeted offers
+    """
+
+    min_transaction_amount: typing_extensions.Annotated[
+        typing.Optional[Amount], FieldMetadata(alias="minTransactionAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Minimum Transaction Amount required to redeem offer, if available on offer
+    """
+
+    max_transaction_amount: typing_extensions.Annotated[
+        typing.Optional[Amount], FieldMetadata(alias="maxTransactionAmount")
+    ] = pydantic.Field(default=None)
+    """
+    Maximum Transaction Amount allowed to redeem offer, if available on offer
+    """
+
+    min_reward_amount: typing_extensions.Annotated[typing.Optional[Amount], FieldMetadata(alias="minRewardAmount")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Minimum Reward Amount, if available on offer
+    """
+
+    max_reward_amount: typing_extensions.Annotated[typing.Optional[Amount], FieldMetadata(alias="maxRewardAmount")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Maximum Reward Amount, if available on offer
+    """
+
+    website_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="websiteUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    URL to the website of the offer provider
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description of the offer
+    """
+
+    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/rewards/types/offer_data_union.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import pydantic
+from ....commons.types.mongo_id import MongoId
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .eligibility_offer_relationship import EligibilityOfferRelationship
+from .standard_offer_fields import StandardOfferFields
+
+
+class OfferDataUnion_StandardOffer(UniversalBaseModel):
+    type: typing.Literal["standardOffer"] = "standardOffer"
+    relationships: typing.Optional[EligibilityOfferRelationship] = None
+    id: MongoId
+    attributes: StandardOfferFields
+
+    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
+
+
+OfferDataUnion = OfferDataUnion_StandardOffer

kard/users/rewards/types/offer_relationship.py

@@ -0,0 +1,21 @@
+# 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 OfferRelationship(UniversalBaseModel):
+    offers: RelationshipMultiple
+    category: RelationshipMultiple
+
+    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/rewards/types/offer_sort_options.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+OfferSortOptions = typing.Union[
+    typing.Literal["startDate", "-startDate", "expirationDate", "-expirationDate", "name", "-name"], typing.Any
+]

kard/users/rewards/types/offers_response_object.py

@@ -0,0 +1,130 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.links import Links
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .eligibility_offer_included import EligibilityOfferIncluded
+from .offer_data_union import OfferDataUnion
+
+
+class OffersResponseObject(UniversalBaseModel):
+    """
+    Examples
+    --------
+    import datetime
+
+    from kard.commons import Links
+    from kard.users.rewards import (
+        Amount,
+        Asset,
+        CategoryData,
+        CategoryFields,
+        CategoryIncluded,
+        CategoryRelationship,
+        CategoryRelationshipObject,
+        Commission,
+        OfferDataUnion_StandardOffer,
+        OffersResponseObject,
+        StandardOfferFields,
+    )
+
+    OffersResponseObject(
+        data=[
+            OfferDataUnion_StandardOffer(
+                id="5e27318c9b346f00087fbb5c",
+                attributes=StandardOfferFields(
+                    name="Worlds Greatest Chicken",
+                    terms="Worlds Greatest Chicken offers are only available within US Locations.",
+                    purchase_channel=["INSTORE"],
+                    user_reward=Commission(
+                        type="PERCENT",
+                        value=5.7,
+                    ),
+                    start_date=datetime.datetime.fromisoformat(
+                        "2024-11-17 05:00:00+00:00",
+                    ),
+                    expiration_date=datetime.datetime.fromisoformat(
+                        "2025-03-17 05:00:00+00:00",
+                    ),
+                    min_reward_amount=Amount(
+                        type="CENTS",
+                        value=500,
+                    ),
+                    max_reward_amount=Amount(
+                        type="CENTS",
+                        value=2000,
+                    ),
+                    min_transaction_amount=Amount(
+                        type="CENTS",
+                        value=500,
+                    ),
+                    max_transaction_amount=Amount(
+                        type="CENTS",
+                        value=10000,
+                    ),
+                    max_redemptions=1,
+                    is_targeted=True,
+                    assets=[
+                        Asset(
+                            type="IMG_VIEW",
+                            url="http://assets.getkard.com/logo/img?attribution-tokens",
+                            alt="Worlds Greatest Chicken Logo Image",
+                        ),
+                        Asset(
+                            type="BANNER_VIEW",
+                            url="http://assets.getkard.com/banner/img?attribution-tokens",
+                            alt="Worlds Greatest Chicken Banner Image",
+                        ),
+                    ],
+                    website_url="http://worldsgreatestchickent.test.com",
+                    description="Worlds Greatest Chicken brings you the tastiest crispy, double fried spicy chicken in the world.",
+                ),
+                relationships=CategoryRelationshipObject(
+                    category=CategoryRelationship(
+                        data=[
+                            CategoryData(
+                                id="65920081b524d126068de24a",
+                            ),
+                            CategoryData(
+                                id="65920081b524d126068de24c",
+                            ),
+                        ],
+                    ),
+                ),
+            )
+        ],
+        included=[
+            CategoryIncluded(
+                id="65920081b524d126068de24a",
+                attributes=CategoryFields(
+                    name="Food & Beverage",
+                ),
+            ),
+            CategoryIncluded(
+                id="65920081b524d126068de24c",
+                attributes=CategoryFields(
+                    name="Department Stores",
+                ),
+            ),
+        ],
+        links=Links(
+            self_="/v2/issuers/{organizationId}/users/{userId}/offers?page[size]=1?sort=-startDate",
+            next="/v2/issuers/{organizationId}/users/{userId}/offers?page[after]=NDMyNzQyODI3OTQw&page[size]=1?&sort=-startDate",
+        ),
+    )
+    """
+
+    data: typing.List[OfferDataUnion]
+    links: Links
+    included: typing.Optional[typing.List[EligibilityOfferIncluded]] = 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/users/rewards/types/operation_hours.py

@@ -0,0 +1,23 @@
+# 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
+from .operation_period import OperationPeriod
+
+
+class OperationHours(UniversalBaseModel):
+    periods: typing.List[OperationPeriod]
+    weekday_text: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="weekdayText")]
+
+    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/rewards/types/operation_period.py

@@ -0,0 +1,21 @@
+# 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 .operation_time import OperationTime
+
+
+class OperationPeriod(UniversalBaseModel):
+    close: OperationTime
+    open: OperationTime
+
+    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/rewards/types/operation_time.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
+
+
+class OperationTime(UniversalBaseModel):
+    day: int
+    time: str
+
+    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/rewards/types/standard_offer.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from .eligibility_offer_relationship import EligibilityOfferRelationship
+from .standard_offer_core import StandardOfferCore
+
+
+class StandardOffer(StandardOfferCore):
+    relationships: typing.Optional[EligibilityOfferRelationship] = 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/users/rewards/types/standard_offer_core.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....commons.types.mongo_id import MongoId
+from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .standard_offer_fields import StandardOfferFields
+
+
+class StandardOfferCore(UniversalBaseModel):
+    id: MongoId = pydantic.Field()
+    """
+    Offer ID in Kard's system
+    """
+
+    attributes: StandardOfferFields
+
+    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/rewards/types/standard_offer_fields.py

@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from .offer_common_fields import OfferCommonFields
+
+
+class StandardOfferFields(OfferCommonFields):
+    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