growsurf-python 0.0.2__py3-none-any.whl

growsurf/types/campaign/participant_add_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantAddParams"]
+
+
+class ParticipantAddParams(TypedDict, total=False):
+    email: Required[str]
+
+    fingerprint: str
+
+    first_name: Annotated[str, PropertyInfo(alias="firstName")]
+
+    ip_address: Annotated[str, PropertyInfo(alias="ipAddress")]
+
+    last_name: Annotated[str, PropertyInfo(alias="lastName")]
+
+    metadata: Dict[str, object]
+    """Shallow custom metadata object."""
+
+    referral_status: Annotated[Literal["CREDIT_PENDING", "CREDIT_AWARDED"], PropertyInfo(alias="referralStatus")]
+
+    referred_by: Annotated[str, PropertyInfo(alias="referredBy")]
+    """Referrer participant ID or email address."""

growsurf/types/campaign/participant_delete_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["ParticipantDeleteResponse"]
+
+
+class ParticipantDeleteResponse(BaseModel):
+    success: bool

growsurf/types/campaign/participant_list_commissions_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantListCommissionsParams"]
+
+
+class ParticipantListCommissionsParams(TypedDict, total=False):
+    id: Required[str]
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    status: Literal["PENDING", "APPROVED", "PAID", "REVERSED", "DELETED"]
+    """Participant commission status."""

growsurf/types/campaign/participant_list_payouts_params.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantListPayoutsParams"]
+
+
+class ParticipantListPayoutsParams(TypedDict, total=False):
+    id: Required[str]
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    status: Literal["UPCOMING", "QUEUED", "ISSUED", "FAILED"]
+    """Participant payout status."""

growsurf/types/campaign/participant_list_referrals_params.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+from .referral_status import ReferralStatus
+
+__all__ = ["ParticipantListReferralsParams"]
+
+
+class ParticipantListReferralsParams(TypedDict, total=False):
+    id: Required[str]
+
+    desc: bool
+    """Return results in descending order when true."""
+
+    email: str
+    """URL-encoded email value to filter referral results."""
+
+    first_name: Annotated[str, PropertyInfo(alias="firstName")]
+    """First name value to filter results."""
+
+    last_name: Annotated[str, PropertyInfo(alias="lastName")]
+    """Last name value to filter results."""
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    offset: int
+    """Offset number used to skip through a result set."""
+
+    referral_status: Annotated[ReferralStatus, PropertyInfo(alias="referralStatus")]
+
+    sort_by: Annotated[
+        Literal["updatedAt", "createdAt", "email", "firstName", "lastName", "referralStatus", "referralTriggeredAt"],
+        PropertyInfo(alias="sortBy"),
+    ]
+    """Field used to sort referral results."""

growsurf/types/campaign/participant_list_rewards_params.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantListRewardsParams"]
+
+
+class ParticipantListRewardsParams(TypedDict, total=False):
+    id: Required[str]
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""

growsurf/types/campaign/participant_list_rewards_response.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from .participant_reward import ParticipantReward
+
+__all__ = ["ParticipantListRewardsResponse"]
+
+
+class ParticipantListRewardsResponse(BaseModel):
+    limit: int
+
+    next_id: Optional[str] = FieldInfo(alias="nextId", default=None)
+
+    rewards: List[ParticipantReward]

growsurf/types/campaign/participant_record_transaction_params.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Iterable
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantRecordTransactionParams"]
+
+
+class ParticipantRecordTransactionParams(TypedDict, total=False):
+    id: Required[str]
+
+    currency: Required[str]
+
+    gross_amount: Required[Annotated[int, PropertyInfo(alias="grossAmount")]]
+
+    amount_cash_net: Annotated[int, PropertyInfo(alias="amountCashNet")]
+
+    amount_paid: Annotated[int, PropertyInfo(alias="amountPaid")]
+
+    charge_id: Annotated[str, PropertyInfo(alias="chargeId")]
+
+    customer_id: Annotated[str, PropertyInfo(alias="customerId")]
+
+    description: str
+
+    external_id: Annotated[str, PropertyInfo(alias="externalId")]
+
+    invoice_id: Annotated[str, PropertyInfo(alias="invoiceId")]
+
+    invoice_subtotal_excluding_tax: Annotated[int, PropertyInfo(alias="invoiceSubtotalExcludingTax")]
+
+    invoice_total: Annotated[int, PropertyInfo(alias="invoiceTotal")]
+
+    invoice_total_excluding_tax: Annotated[int, PropertyInfo(alias="invoiceTotalExcludingTax")]
+
+    net_amount: Annotated[int, PropertyInfo(alias="netAmount")]
+
+    order_id: Annotated[str, PropertyInfo(alias="orderId")]
+
+    paid_at: Annotated[int, PropertyInfo(alias="paidAt")]
+
+    payment_id: Annotated[str, PropertyInfo(alias="paymentId")]
+
+    payment_intent_id: Annotated[str, PropertyInfo(alias="paymentIntentId")]
+
+    subscription_id: Annotated[str, PropertyInfo(alias="subscriptionId")]
+
+    tax_amount: Annotated[int, PropertyInfo(alias="taxAmount")]
+
+    total_tax_amount: Annotated[int, PropertyInfo(alias="totalTaxAmount")]
+
+    total_tax_amounts: Annotated[Iterable[Dict[str, object]], PropertyInfo(alias="totalTaxAmounts")]
+
+    total_taxes: Annotated[Iterable[Dict[str, object]], PropertyInfo(alias="totalTaxes")]
+
+    transaction_id: Annotated[str, PropertyInfo(alias="transactionId")]

growsurf/types/campaign/participant_record_transaction_response.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ParticipantRecordTransactionResponse", "UnionMember0", "UnionMember1"]
+
+
+class UnionMember0(BaseModel):
+    duplicate: Literal[False]
+
+    first_sale: bool = FieldInfo(alias="firstSale")
+
+    message: str
+
+    success: Literal[True]
+
+
+class UnionMember1(BaseModel):
+    commissions_created: int = FieldInfo(alias="commissionsCreated")
+
+    duplicate: Literal[True]
+
+    duplicate_fields: List[str] = FieldInfo(alias="duplicateFields")
+
+    matching_commission_ids: List[str] = FieldInfo(alias="matchingCommissionIds")
+
+    message: str
+
+    success: Literal[False]
+
+
+ParticipantRecordTransactionResponse: TypeAlias = Union[UnionMember0, UnionMember1]

growsurf/types/campaign/participant_reward.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from ..commission_structure import CommissionStructure
+
+__all__ = ["ParticipantReward"]
+
+
+class ParticipantReward(BaseModel):
+    id: str
+
+    reward_id: str = FieldInfo(alias="rewardId")
+
+    status: Literal["PENDING", "FULFILLED"]
+
+    approved: Optional[bool] = None
+
+    approved_at: Optional[int] = FieldInfo(alias="approvedAt", default=None)
+
+    commission_structure: Optional[CommissionStructure] = FieldInfo(alias="commissionStructure", default=None)
+
+    fulfilled_at: Optional[int] = FieldInfo(alias="fulfilledAt", default=None)
+
+    is_available: Optional[bool] = FieldInfo(alias="isAvailable", default=None)
+
+    is_fulfilled: Optional[bool] = FieldInfo(alias="isFulfilled", default=None)
+
+    is_referrer: Optional[bool] = FieldInfo(alias="isReferrer", default=None)
+
+    referred_id: Optional[str] = FieldInfo(alias="referredId", default=None)
+
+    referrer_id: Optional[str] = FieldInfo(alias="referrerId", default=None)
+
+    unread: Optional[bool] = None

growsurf/types/campaign/participant_send_invites_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantSendInvitesParams"]
+
+
+class ParticipantSendInvitesParams(TypedDict, total=False):
+    id: Required[str]
+
+    email_addresses: Required[Annotated[SequenceNotStr[str], PropertyInfo(alias="emailAddresses")]]
+
+    message_text: Required[Annotated[str, PropertyInfo(alias="messageText")]]
+
+    subject_text: Required[Annotated[str, PropertyInfo(alias="subjectText")]]

growsurf/types/campaign/participant_send_invites_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ParticipantSendInvitesResponse"]
+
+
+class ParticipantSendInvitesResponse(BaseModel):
+    invites_sent: int = FieldInfo(alias="invitesSent")
+
+    message_type: str = FieldInfo(alias="messageType")
+
+    success: bool

growsurf/types/campaign/participant_trigger_referral_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ParticipantTriggerReferralResponse"]
+
+
+class ParticipantTriggerReferralResponse(BaseModel):
+    success: bool
+
+    message: Optional[str] = None

growsurf/types/campaign/participant_update_params.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["ParticipantUpdateParams"]
+
+
+class ParticipantUpdateParams(TypedDict, total=False):
+    id: Required[str]
+
+    email: str
+
+    first_name: Annotated[str, PropertyInfo(alias="firstName")]
+
+    last_name: Annotated[str, PropertyInfo(alias="lastName")]
+
+    metadata: Dict[str, object]
+    """Shallow custom metadata object."""
+
+    referral_status: Annotated[
+        Literal["CREDIT_PENDING", "CREDIT_AWARDED", "CREDIT_EXPIRED"], PropertyInfo(alias="referralStatus")
+    ]
+
+    referred_by: Annotated[str, PropertyInfo(alias="referredBy")]
+
+    unsubscribed: bool
+
+    vanity_keys: Annotated[SequenceNotStr[str], PropertyInfo(alias="vanityKeys")]

growsurf/types/campaign/referral_source.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ReferralSource"]
+
+ReferralSource: TypeAlias = Literal["DIRECT", "PARTICIPANT"]

growsurf/types/campaign/referral_status.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ReferralStatus"]
+
+ReferralStatus: TypeAlias = Literal["CREDIT_PENDING", "CREDIT_AWARDED", "CREDIT_EXPIRED", "INVITE_SENT"]

growsurf/types/campaign/reward_approve_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["RewardApproveParams"]
+
+
+class RewardApproveParams(TypedDict, total=False):
+    id: Required[str]
+
+    fulfill: bool
+    """Set true to mark the reward as fulfilled after approval."""

growsurf/types/campaign/reward_approve_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["RewardApproveResponse"]
+
+
+class RewardApproveResponse(BaseModel):
+    success: bool

growsurf/types/campaign/reward_delete_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["RewardDeleteResponse"]
+
+
+class RewardDeleteResponse(BaseModel):
+    success: bool

growsurf/types/campaign/reward_fulfill_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["RewardFulfillResponse"]
+
+
+class RewardFulfillResponse(BaseModel):
+    success: bool

growsurf/types/campaign_list_commissions_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["CampaignListCommissionsParams"]
+
+
+class CampaignListCommissionsParams(TypedDict, total=False):
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    status: Literal["PENDING", "APPROVED", "PAID", "REVERSED", "DELETED"]
+    """Participant commission status."""

growsurf/types/campaign_list_leaderboard_params.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["CampaignListLeaderboardParams"]
+
+
+class CampaignListLeaderboardParams(TypedDict, total=False):
+    is_monthly: Annotated[bool, PropertyInfo(alias="isMonthly")]
+    """Deprecated. Use `leaderboardType=CURRENT_MONTH` instead."""
+
+    leaderboard_type: Annotated[
+        Literal[
+            "ALL_TIME",
+            "CURRENT_MONTH",
+            "PREV_MONTH",
+            "TOTAL_IMPRESSION_COUNT",
+            "UNIQUE_IMPRESSION_COUNT",
+            "BY_COMMISSIONS",
+            "BY_REVENUE",
+            "BY_REFERRALS",
+            "BY_LEADS",
+        ],
+        PropertyInfo(alias="leaderboardType"),
+    ]
+    """Leaderboard ordering mode."""
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""

growsurf/types/campaign_list_participants_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["CampaignListParticipantsParams"]
+
+
+class CampaignListParticipantsParams(TypedDict, total=False):
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""

growsurf/types/campaign_list_payouts_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["CampaignListPayoutsParams"]
+
+
+class CampaignListPayoutsParams(TypedDict, total=False):
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    status: Literal["UPCOMING", "QUEUED", "ISSUED", "FAILED"]
+    """Participant payout status."""

growsurf/types/campaign_list_referrals_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .campaign.referral_status import ReferralStatus
+
+__all__ = ["CampaignListReferralsParams"]
+
+
+class CampaignListReferralsParams(TypedDict, total=False):
+    desc: bool
+    """Return results in descending order when true."""
+
+    email: str
+    """URL-encoded email value to filter referral results."""
+
+    first_name: Annotated[str, PropertyInfo(alias="firstName")]
+    """First name value to filter results."""
+
+    last_name: Annotated[str, PropertyInfo(alias="lastName")]
+    """Last name value to filter results."""
+
+    limit: int
+    """Number of results to return. Maximum 100."""
+
+    next_id: Annotated[str, PropertyInfo(alias="nextId")]
+    """ID to start the next paged result set with."""
+
+    offset: int
+    """Offset number used to skip through a result set."""
+
+    referral_status: Annotated[ReferralStatus, PropertyInfo(alias="referralStatus")]
+
+    sort_by: Annotated[
+        Literal["updatedAt", "createdAt", "email", "firstName", "lastName", "referralStatus", "referralTriggeredAt"],
+        PropertyInfo(alias="sortBy"),
+    ]
+    """Field used to sort referral results."""

growsurf/types/campaign_list_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+from .campaign.campaign import Campaign
+
+__all__ = ["CampaignListResponse"]
+
+
+class CampaignListResponse(BaseModel):
+    campaigns: List[Campaign]

growsurf/types/campaign_retrieve_analytics_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["CampaignRetrieveAnalyticsParams"]
+
+
+class CampaignRetrieveAnalyticsParams(TypedDict, total=False):
+    days: int
+    """Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825."""
+
+    end_date: Annotated[int, PropertyInfo(alias="endDate")]
+    """End date of the analytics timeframe as a Unix timestamp in milliseconds.
+
+    Required if `days` is not set.
+    """
+
+    start_date: Annotated[int, PropertyInfo(alias="startDate")]
+    """Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+
+    Required if `days` is not set.
+    """