growsurf-python 0.0.2__py3-none-any.whl

growsurf/resources/campaign/reward.py

@@ -0,0 +1,355 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import path_template, maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ..._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ..._base_client import make_request_options
+from ...types.campaign import reward_approve_params
+from ...types.campaign.reward_delete_response import RewardDeleteResponse
+from ...types.campaign.reward_approve_response import RewardApproveResponse
+from ...types.campaign.reward_fulfill_response import RewardFulfillResponse
+
+__all__ = ["RewardResource", "AsyncRewardResource"]
+
+
+class RewardResource(SyncAPIResource):
+    """Participant reward retrieval and manual reward operations."""
+
+    @cached_property
+    def with_raw_response(self) -> RewardResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/growsurf/growsurf-python#accessing-raw-response-data-eg-headers
+        """
+        return RewardResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> RewardResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/growsurf/growsurf-python#with_streaming_response
+        """
+        return RewardResourceWithStreamingResponse(self)
+
+    def delete(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardDeleteResponse:
+        """
+        Removes a manually approved participant reward that has not already been
+        approved.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return self._delete(
+            path_template("/campaign/{id}/reward/{reward_id}", id=id, reward_id=reward_id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardDeleteResponse,
+        )
+
+    def approve(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        fulfill: bool | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardApproveResponse:
+        """
+        Approves a manually approved reward earned by a participant.
+
+        Args:
+          fulfill: Set true to mark the reward as fulfilled after approval.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return self._post(
+            path_template("/campaign/{id}/reward/{reward_id}/approve", id=id, reward_id=reward_id),
+            body=maybe_transform({"fulfill": fulfill}, reward_approve_params.RewardApproveParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardApproveResponse,
+        )
+
+    def fulfill(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardFulfillResponse:
+        """
+        Marks an approved participant reward as fulfilled.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return self._post(
+            path_template("/campaign/{id}/reward/{reward_id}/fulfill", id=id, reward_id=reward_id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardFulfillResponse,
+        )
+
+
+class AsyncRewardResource(AsyncAPIResource):
+    """Participant reward retrieval and manual reward operations."""
+
+    @cached_property
+    def with_raw_response(self) -> AsyncRewardResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/growsurf/growsurf-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncRewardResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncRewardResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/growsurf/growsurf-python#with_streaming_response
+        """
+        return AsyncRewardResourceWithStreamingResponse(self)
+
+    async def delete(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardDeleteResponse:
+        """
+        Removes a manually approved participant reward that has not already been
+        approved.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return await self._delete(
+            path_template("/campaign/{id}/reward/{reward_id}", id=id, reward_id=reward_id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardDeleteResponse,
+        )
+
+    async def approve(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        fulfill: bool | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardApproveResponse:
+        """
+        Approves a manually approved reward earned by a participant.
+
+        Args:
+          fulfill: Set true to mark the reward as fulfilled after approval.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return await self._post(
+            path_template("/campaign/{id}/reward/{reward_id}/approve", id=id, reward_id=reward_id),
+            body=await async_maybe_transform({"fulfill": fulfill}, reward_approve_params.RewardApproveParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardApproveResponse,
+        )
+
+    async def fulfill(
+        self,
+        reward_id: str,
+        *,
+        id: str,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> RewardFulfillResponse:
+        """
+        Marks an approved participant reward as fulfilled.
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not reward_id:
+            raise ValueError(f"Expected a non-empty value for `reward_id` but received {reward_id!r}")
+        return await self._post(
+            path_template("/campaign/{id}/reward/{reward_id}/fulfill", id=id, reward_id=reward_id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=RewardFulfillResponse,
+        )
+
+
+class RewardResourceWithRawResponse:
+    def __init__(self, reward: RewardResource) -> None:
+        self._reward = reward
+
+        self.delete = to_raw_response_wrapper(
+            reward.delete,
+        )
+        self.approve = to_raw_response_wrapper(
+            reward.approve,
+        )
+        self.fulfill = to_raw_response_wrapper(
+            reward.fulfill,
+        )
+
+
+class AsyncRewardResourceWithRawResponse:
+    def __init__(self, reward: AsyncRewardResource) -> None:
+        self._reward = reward
+
+        self.delete = async_to_raw_response_wrapper(
+            reward.delete,
+        )
+        self.approve = async_to_raw_response_wrapper(
+            reward.approve,
+        )
+        self.fulfill = async_to_raw_response_wrapper(
+            reward.fulfill,
+        )
+
+
+class RewardResourceWithStreamingResponse:
+    def __init__(self, reward: RewardResource) -> None:
+        self._reward = reward
+
+        self.delete = to_streamed_response_wrapper(
+            reward.delete,
+        )
+        self.approve = to_streamed_response_wrapper(
+            reward.approve,
+        )
+        self.fulfill = to_streamed_response_wrapper(
+            reward.fulfill,
+        )
+
+
+class AsyncRewardResourceWithStreamingResponse:
+    def __init__(self, reward: AsyncRewardResource) -> None:
+        self._reward = reward
+
+        self.delete = async_to_streamed_response_wrapper(
+            reward.delete,
+        )
+        self.approve = async_to_streamed_response_wrapper(
+            reward.approve,
+        )
+        self.fulfill = async_to_streamed_response_wrapper(
+            reward.fulfill,
+        )

growsurf/types/__init__.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .campaign import Campaign as Campaign
+from .referral_list import ReferralList as ReferralList
+from .participant_list import ParticipantList as ParticipantList
+from .commission_structure import CommissionStructure as CommissionStructure
+from .campaign_list_response import CampaignListResponse as CampaignListResponse
+from .participant_payout_list import ParticipantPayoutList as ParticipantPayoutList
+from .participant_commission_list import ParticipantCommissionList as ParticipantCommissionList
+from .campaign_list_payouts_params import CampaignListPayoutsParams as CampaignListPayoutsParams
+from .campaign_list_referrals_params import CampaignListReferralsParams as CampaignListReferralsParams
+from .campaign_list_commissions_params import CampaignListCommissionsParams as CampaignListCommissionsParams
+from .campaign_list_leaderboard_params import CampaignListLeaderboardParams as CampaignListLeaderboardParams
+from .campaign_list_participants_params import CampaignListParticipantsParams as CampaignListParticipantsParams
+from .campaign_retrieve_analytics_params import CampaignRetrieveAnalyticsParams as CampaignRetrieveAnalyticsParams
+from .campaign_retrieve_analytics_response import CampaignRetrieveAnalyticsResponse as CampaignRetrieveAnalyticsResponse

growsurf/types/campaign/__init__.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .campaign import Campaign as Campaign
+from .participant import Participant as Participant
+from .referral_source import ReferralSource as ReferralSource
+from .referral_status import ReferralStatus as ReferralStatus
+from .fraud_risk_level import FraudRiskLevel as FraudRiskLevel
+from .participant_reward import ParticipantReward as ParticipantReward
+from .reward_approve_params import RewardApproveParams as RewardApproveParams
+from .participant_add_params import ParticipantAddParams as ParticipantAddParams
+from .reward_delete_response import RewardDeleteResponse as RewardDeleteResponse
+from .reward_approve_response import RewardApproveResponse as RewardApproveResponse
+from .reward_fulfill_response import RewardFulfillResponse as RewardFulfillResponse
+from .participant_update_params import ParticipantUpdateParams as ParticipantUpdateParams
+from .commission_delete_response import CommissionDeleteResponse as CommissionDeleteResponse
+from .commission_approve_response import CommissionApproveResponse as CommissionApproveResponse
+from .participant_delete_response import ParticipantDeleteResponse as ParticipantDeleteResponse
+from .participant_list_payouts_params import ParticipantListPayoutsParams as ParticipantListPayoutsParams
+from .participant_list_rewards_params import ParticipantListRewardsParams as ParticipantListRewardsParams
+from .participant_send_invites_params import ParticipantSendInvitesParams as ParticipantSendInvitesParams
+from .participant_list_referrals_params import ParticipantListReferralsParams as ParticipantListReferralsParams
+from .participant_list_rewards_response import ParticipantListRewardsResponse as ParticipantListRewardsResponse
+from .participant_send_invites_response import ParticipantSendInvitesResponse as ParticipantSendInvitesResponse
+from .participant_list_commissions_params import ParticipantListCommissionsParams as ParticipantListCommissionsParams
+from .participant_record_transaction_params import (
+    ParticipantRecordTransactionParams as ParticipantRecordTransactionParams,
+)
+from .participant_trigger_referral_response import (
+    ParticipantTriggerReferralResponse as ParticipantTriggerReferralResponse,
+)
+from .participant_record_transaction_response import (
+    ParticipantRecordTransactionResponse as ParticipantRecordTransactionResponse,
+)

growsurf/types/campaign/campaign.py

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from ..commission_structure import CommissionStructure
+
+__all__ = ["Campaign", "Reward"]
+
+
+class Reward(BaseModel):
+    id: str
+
+    is_unlimited: bool = FieldInfo(alias="isUnlimited")
+
+    metadata: Dict[str, object]
+    """Shallow custom metadata object."""
+
+    type: Literal["SINGLE_SIDED", "DOUBLE_SIDED", "MILESTONE", "LEADERBOARD", "AFFILIATE"]
+
+    commission_structure: Optional[CommissionStructure] = FieldInfo(alias="commissionStructure", default=None)
+
+    conversions_required: Optional[int] = FieldInfo(alias="conversionsRequired", default=None)
+
+    coupon_code: Optional[str] = FieldInfo(alias="couponCode", default=None)
+
+    description: Optional[str] = None
+
+    image_url: Optional[str] = FieldInfo(alias="imageUrl", default=None)
+
+    limit: Optional[int] = None
+    """`-1` represents an unlimited reward in REST responses."""
+
+    limit_duration: Optional[Literal["IN_TOTAL", "PER_MONTH"]] = FieldInfo(alias="limitDuration", default=None)
+
+    next_milestone_prefix: Optional[str] = FieldInfo(alias="nextMilestonePrefix", default=None)
+
+    next_milestone_suffix: Optional[str] = FieldInfo(alias="nextMilestoneSuffix", default=None)
+
+    number_of_winners: Optional[int] = FieldInfo(alias="numberOfWinners", default=None)
+
+    order: Optional[int] = None
+
+    referral_description: Optional[str] = FieldInfo(alias="referralDescription", default=None)
+
+    referred_reward_upfront: Optional[bool] = FieldInfo(alias="referredRewardUpfront", default=None)
+
+
+class Campaign(BaseModel):
+    id: str
+
+    impression_count: int = FieldInfo(alias="impressionCount")
+
+    invite_count: int = FieldInfo(alias="inviteCount")
+
+    name: str
+
+    participant_count: int = FieldInfo(alias="participantCount")
+
+    referral_count: int = FieldInfo(alias="referralCount")
+
+    rewards: List[Reward]
+
+    status: Literal["DRAFT", "IN_PROGRESS", "COMPLETE", "DELETED"]
+
+    type: Literal["REFERRAL", "AFFILIATE"]
+
+    winner_count: int = FieldInfo(alias="winnerCount")
+
+    currency_iso: Optional[str] = FieldInfo(alias="currencyISO", default=None)

growsurf/types/campaign/commission_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__ = ["CommissionApproveResponse"]
+
+
+class CommissionApproveResponse(BaseModel):
+    success: bool

growsurf/types/campaign/commission_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__ = ["CommissionDeleteResponse"]
+
+
+class CommissionDeleteResponse(BaseModel):
+    success: bool

growsurf/types/campaign/fraud_risk_level.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__ = ["FraudRiskLevel"]
+
+FraudRiskLevel: TypeAlias = Literal["LOW", "MEDIUM", "HIGH"]

growsurf/types/campaign/participant.py

@@ -0,0 +1,147 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from .referral_source import ReferralSource
+from .referral_status import ReferralStatus
+from .fraud_risk_level import FraudRiskLevel
+from .participant_reward import ParticipantReward
+
+__all__ = ["Participant", "Referrer"]
+
+
+class Referrer(BaseModel):
+    id: Optional[str] = None
+
+    created_at: Optional[int] = FieldInfo(alias="createdAt", default=None)
+
+    email: Optional[str] = None
+
+    fingerprint: Optional[str] = None
+
+    first_name: Optional[str] = FieldInfo(alias="firstName", default=None)
+
+    fraud_reason_code: Optional[str] = FieldInfo(alias="fraudReasonCode", default=None)
+
+    fraud_risk_level: Optional[FraudRiskLevel] = FieldInfo(alias="fraudRiskLevel", default=None)
+
+    impression_count: Optional[int] = FieldInfo(alias="impressionCount", default=None)
+
+    invite_count: Optional[int] = FieldInfo(alias="inviteCount", default=None)
+
+    ip_address: Optional[str] = FieldInfo(alias="ipAddress", default=None)
+
+    is_winner: Optional[bool] = FieldInfo(alias="isWinner", default=None)
+
+    last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
+
+    metadata: Optional[Dict[str, object]] = None
+    """Shallow custom metadata object."""
+
+    monthly_rank: Optional[int] = FieldInfo(alias="monthlyRank", default=None)
+
+    monthly_referral_count: Optional[int] = FieldInfo(alias="monthlyReferralCount", default=None)
+
+    monthly_referrals: Optional[List[str]] = FieldInfo(alias="monthlyReferrals", default=None)
+
+    prev_monthly_rank: Optional[int] = FieldInfo(alias="prevMonthlyRank", default=None)
+
+    prev_monthly_referral_count: Optional[int] = FieldInfo(alias="prevMonthlyReferralCount", default=None)
+
+    rank: Optional[int] = None
+
+    referral_count: Optional[int] = FieldInfo(alias="referralCount", default=None)
+
+    referrals: Optional[List[str]] = None
+
+    referral_source: Optional[ReferralSource] = FieldInfo(alias="referralSource", default=None)
+
+    referral_status: Optional[ReferralStatus] = FieldInfo(alias="referralStatus", default=None)
+
+    share_count: Optional[Dict[str, int]] = FieldInfo(alias="shareCount", default=None)
+
+    share_url: Optional[str] = FieldInfo(alias="shareUrl", default=None)
+
+    unique_impression_count: Optional[int] = FieldInfo(alias="uniqueImpressionCount", default=None)
+
+    unsubscribed: Optional[bool] = None
+
+
+class Participant(BaseModel):
+    id: str
+
+    email: str
+
+    monthly_rank: int = FieldInfo(alias="monthlyRank")
+
+    monthly_referral_count: int = FieldInfo(alias="monthlyReferralCount")
+
+    rank: int
+
+    referral_count: int = FieldInfo(alias="referralCount")
+
+    rewards: List[ParticipantReward]
+
+    share_url: str = FieldInfo(alias="shareUrl")
+
+    all_matching_fraudsters: Optional[List[Dict[str, object]]] = FieldInfo(alias="allMatchingFraudsters", default=None)
+
+    created_at: Optional[int] = FieldInfo(alias="createdAt", default=None)
+
+    fingerprint: Optional[str] = None
+
+    first_name: Optional[str] = FieldInfo(alias="firstName", default=None)
+
+    fraud_reason_code: Optional[str] = FieldInfo(alias="fraudReasonCode", default=None)
+
+    fraud_risk_level: Optional[FraudRiskLevel] = FieldInfo(alias="fraudRiskLevel", default=None)
+
+    impression_count: Optional[int] = FieldInfo(alias="impressionCount", default=None)
+
+    invite_count: Optional[int] = FieldInfo(alias="inviteCount", default=None)
+
+    ip_address: Optional[str] = FieldInfo(alias="ipAddress", default=None)
+
+    is_new: Optional[bool] = FieldInfo(alias="isNew", default=None)
+
+    is_winner: Optional[bool] = FieldInfo(alias="isWinner", default=None)
+
+    last_name: Optional[str] = FieldInfo(alias="lastName", default=None)
+
+    metadata: Optional[Dict[str, object]] = None
+    """Shallow custom metadata object."""
+
+    monthly_referrals: Optional[List[str]] = FieldInfo(alias="monthlyReferrals", default=None)
+
+    notes: Optional[str] = None
+
+    paypal_email_address: Optional[str] = FieldInfo(alias="paypalEmailAddress", default=None)
+
+    prev_monthly_rank: Optional[int] = FieldInfo(alias="prevMonthlyRank", default=None)
+
+    prev_monthly_referral_count: Optional[int] = FieldInfo(alias="prevMonthlyReferralCount", default=None)
+
+    referrals: Optional[List[str]] = None
+
+    referral_source: Optional[ReferralSource] = FieldInfo(alias="referralSource", default=None)
+
+    referral_status: Optional[ReferralStatus] = FieldInfo(alias="referralStatus", default=None)
+
+    referred_by: Optional[str] = FieldInfo(alias="referredBy", default=None)
+
+    referrer: Optional[Referrer] = None
+
+    share_count: Optional[Dict[str, int]] = FieldInfo(alias="shareCount", default=None)
+
+    unique_impression_count: Optional[int] = FieldInfo(alias="uniqueImpressionCount", default=None)
+
+    unread_commissions_count: Optional[int] = FieldInfo(alias="unreadCommissionsCount", default=None)
+
+    unread_payouts_count: Optional[int] = FieldInfo(alias="unreadPayoutsCount", default=None)
+
+    unsubscribed: Optional[bool] = None
+
+    vanity_keys: Optional[List[str]] = FieldInfo(alias="vanityKeys", default=None)