growsurf-python 0.0.2__py3-none-any.whl

growsurf/types/campaign_retrieve_analytics_response.py

@@ -0,0 +1,75 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CampaignRetrieveAnalyticsResponse", "Analytics"]
+
+
+class Analytics(BaseModel):
+    bluesky_shares: Optional[int] = FieldInfo(alias="blueskyShares", default=None)
+
+    email_shares: Optional[int] = FieldInfo(alias="emailShares", default=None)
+
+    facebook_shares: Optional[int] = FieldInfo(alias="facebookShares", default=None)
+
+    impressions: Optional[int] = None
+
+    invites: Optional[int] = None
+
+    linked_in_shares: Optional[int] = FieldInfo(alias="linkedInShares", default=None)
+
+    messenger_shares: Optional[int] = FieldInfo(alias="messengerShares", default=None)
+
+    participants: Optional[int] = None
+
+    pinterest_shares: Optional[int] = FieldInfo(alias="pinterestShares", default=None)
+
+    qrcode_shares: Optional[int] = FieldInfo(alias="qrcodeShares", default=None)
+
+    reddit_shares: Optional[int] = FieldInfo(alias="redditShares", default=None)
+
+    referral_credit_expireds: Optional[int] = FieldInfo(alias="referralCreditExpireds", default=None)
+
+    referral_credit_pendings: Optional[int] = FieldInfo(alias="referralCreditPendings", default=None)
+
+    referrals: Optional[int] = None
+
+    sms_shares: Optional[int] = FieldInfo(alias="smsShares", default=None)
+
+    telegram_shares: Optional[int] = FieldInfo(alias="telegramShares", default=None)
+
+    threads_shares: Optional[int] = FieldInfo(alias="threadsShares", default=None)
+
+    total_commission_count: Optional[int] = FieldInfo(alias="totalCommissionCount", default=None)
+    """Affiliate programs only. Number of commission records."""
+
+    total_commissions: Optional[int] = FieldInfo(alias="totalCommissions", default=None)
+    """Affiliate programs only.
+
+    Commissions in the smallest unit of the program currency.
+    """
+
+    total_revenue: Optional[int] = FieldInfo(alias="totalRevenue", default=None)
+    """Affiliate programs only. Revenue in the smallest unit of the program currency."""
+
+    tumblr_shares: Optional[int] = FieldInfo(alias="tumblrShares", default=None)
+
+    twitter_shares: Optional[int] = FieldInfo(alias="twitterShares", default=None)
+
+    unique_impressions: Optional[int] = FieldInfo(alias="uniqueImpressions", default=None)
+
+    wechat_shares: Optional[int] = FieldInfo(alias="wechatShares", default=None)
+
+    whats_app_shares: Optional[int] = FieldInfo(alias="whatsAppShares", default=None)
+
+
+class CampaignRetrieveAnalyticsResponse(BaseModel):
+    analytics: Analytics
+
+    end_date: int = FieldInfo(alias="endDate")
+
+    start_date: int = FieldInfo(alias="startDate")

growsurf/types/commission_structure.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import TYPE_CHECKING, Dict, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["CommissionStructure"]
+
+
+class CommissionStructure(BaseModel):
+    amount: Optional[int] = None
+
+    approval_required: Optional[bool] = FieldInfo(alias="approvalRequired", default=None)
+
+    duration: Optional[str] = None
+
+    duration_in_months: Optional[int] = FieldInfo(alias="durationInMonths", default=None)
+
+    event: Optional[str] = None
+
+    has_intro: Optional[bool] = FieldInfo(alias="hasIntro", default=None)
+
+    has_max_amount: Optional[bool] = FieldInfo(alias="hasMaxAmount", default=None)
+
+    hold_duration: Optional[int] = FieldInfo(alias="holdDuration", default=None)
+
+    intro_amount: Optional[int] = FieldInfo(alias="introAmount", default=None)
+
+    intro_amount_iso: Optional[str] = FieldInfo(alias="introAmountISO", default=None)
+
+    intro_duration: Optional[str] = FieldInfo(alias="introDuration", default=None)
+
+    intro_duration_in_months: Optional[int] = FieldInfo(alias="introDurationInMonths", default=None)
+
+    intro_percent: Optional[float] = FieldInfo(alias="introPercent", default=None)
+
+    intro_type: Optional[str] = FieldInfo(alias="introType", default=None)
+
+    max_amount: Optional[int] = FieldInfo(alias="maxAmount", default=None)
+
+    max_amount_iso: Optional[str] = FieldInfo(alias="maxAmountISO", default=None)
+
+    min_paid_referrals: Optional[int] = FieldInfo(alias="minPaidReferrals", default=None)
+
+    percent: Optional[float] = None
+
+    type: Optional[Literal["PERCENT", "AMOUNT"]] = None
+
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]

growsurf/types/participant_commission_list.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ParticipantCommissionList", "Commission"]
+
+
+class Commission(BaseModel):
+    id: str
+
+    amount: int
+
+    created_at: int = FieldInfo(alias="createdAt")
+
+    currency_iso: str = FieldInfo(alias="currencyISO")
+
+    referred_id: str = FieldInfo(alias="referredId")
+
+    referrer_id: str = FieldInfo(alias="referrerId")
+
+    sale_amount: int = FieldInfo(alias="saleAmount")
+
+    status: Literal["PENDING", "APPROVED", "PAID", "REVERSED", "DELETED"]
+
+    amount_in_campaign_currency: Optional[int] = FieldInfo(alias="amountInCampaignCurrency", default=None)
+
+    approved_at: Optional[int] = FieldInfo(alias="approvedAt", default=None)
+
+    campaign_currency_iso: Optional[str] = FieldInfo(alias="campaignCurrencyISO", default=None)
+
+    exchange_rate: Optional[float] = FieldInfo(alias="exchangeRate", default=None)
+
+    exchange_rate_at: Optional[int] = FieldInfo(alias="exchangeRateAt", default=None)
+
+    fx_error: Optional[str] = FieldInfo(alias="fxError", default=None)
+
+    hold_duration: Optional[int] = FieldInfo(alias="holdDuration", default=None)
+
+    paid_at: Optional[int] = FieldInfo(alias="paidAt", default=None)
+
+    payout_queued_at: Optional[int] = FieldInfo(alias="payoutQueuedAt", default=None)
+
+    provider: Optional[str] = None
+
+    reversed_at: Optional[int] = FieldInfo(alias="reversedAt", default=None)
+
+    sale_amount_amount_in_campaign_currency: Optional[int] = FieldInfo(
+        alias="saleAmountAmountInCampaignCurrency", default=None
+    )
+
+
+class ParticipantCommissionList(BaseModel):
+    commissions: List[Commission]
+
+    limit: int
+
+    next_id: Optional[str] = FieldInfo(alias="nextId", default=None)

growsurf/types/participant_list.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 .campaign.participant import Participant
+
+__all__ = ["ParticipantList"]
+
+
+class ParticipantList(BaseModel):
+    limit: int
+
+    next_id: Optional[str] = FieldInfo(alias="nextId", default=None)
+
+    participants: List[Participant]

growsurf/types/participant_payout_list.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ParticipantPayoutList", "Payout"]
+
+
+class Payout(BaseModel):
+    id: str
+
+    amount: int
+
+    commission_ids: List[str] = FieldInfo(alias="commissionIds")
+
+    created_at: int = FieldInfo(alias="createdAt")
+
+    currency_iso: str = FieldInfo(alias="currencyISO")
+
+    participant_id: str = FieldInfo(alias="participantId")
+
+    status: Literal["UPCOMING", "QUEUED", "ISSUED", "FAILED"]
+
+    amount_in_campaign_currency: Optional[int] = FieldInfo(alias="amountInCampaignCurrency", default=None)
+
+    campaign_currency_iso: Optional[str] = FieldInfo(alias="campaignCurrencyISO", default=None)
+
+    exchange_rate: Optional[float] = FieldInfo(alias="exchangeRate", default=None)
+
+    exchange_rate_at: Optional[int] = FieldInfo(alias="exchangeRateAt", default=None)
+
+    failed_at: Optional[int] = FieldInfo(alias="failedAt", default=None)
+
+    fx_error: Optional[str] = FieldInfo(alias="fxError", default=None)
+
+    issued_at: Optional[int] = FieldInfo(alias="issuedAt", default=None)
+
+    provider: Optional[str] = None
+
+
+class ParticipantPayoutList(BaseModel):
+    limit: int
+
+    next_id: Optional[str] = FieldInfo(alias="nextId", default=None)
+
+    payouts: List[Payout]

growsurf/types/referral_list.py

@@ -0,0 +1,40 @@
+# 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 .campaign.referral_status import ReferralStatus
+
+__all__ = ["ReferralList", "Referral"]
+
+
+class Referral(BaseModel):
+    id: str
+
+    created_at: int = FieldInfo(alias="createdAt")
+
+    email: str
+
+    referral_status: ReferralStatus = FieldInfo(alias="referralStatus")
+
+    referred_by: str = FieldInfo(alias="referredBy")
+
+    updated_at: int = FieldInfo(alias="updatedAt")
+
+    first_name: Optional[str] = FieldInfo(alias="firstName", default=None)
+
+    last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
+
+
+class ReferralList(BaseModel):
+    limit: int
+
+    more: bool
+
+    referrals: List[Referral]
+
+    next_id: Optional[str] = FieldInfo(alias="nextId", default=None)
+
+    next_offset: Optional[int] = FieldInfo(alias="nextOffset", default=None)