growsurf-python 1.16.0__py3-none-any.whl → 1.18.0__py3-none-any.whl

growsurf/_client.py

@@ -36,9 +36,8 @@ from ._base_client import (
 )
 
 if TYPE_CHECKING:
-    from .resources import team, account, campaign
+    from .resources import team, campaign
     from .resources.team import TeamResource, AsyncTeamResource
-    from .resources.account import AccountResource, AsyncAccountResource
     from .resources.campaign.campaign import CampaignResource, AsyncCampaignResource
 
 __all__ = [
@@ -116,12 +115,6 @@ class Growsurf(SyncAPIClient):
         )
         self._idempotency_header = "Idempotency-Key"
 
-    @cached_property
-    def account(self) -> AccountResource:
-        from .resources.account import AccountResource
-
-        return AccountResource(self)
-
     @cached_property
     def team(self) -> TeamResource:
         from .resources.team import TeamResource
@@ -319,12 +312,6 @@ class AsyncGrowsurf(AsyncAPIClient):
         )
         self._idempotency_header = "Idempotency-Key"
 
-    @cached_property
-    def account(self) -> AsyncAccountResource:
-        from .resources.account import AsyncAccountResource
-
-        return AsyncAccountResource(self)
-
     @cached_property
     def team(self) -> AsyncTeamResource:
         from .resources.team import AsyncTeamResource
@@ -465,12 +452,6 @@ class GrowsurfWithRawResponse:
     def __init__(self, client: Growsurf) -> None:
         self._client = client
 
-    @cached_property
-    def account(self) -> account.AccountResourceWithRawResponse:
-        from .resources.account import AccountResourceWithRawResponse
-
-        return AccountResourceWithRawResponse(self._client.account)
-
     @cached_property
     def team(self) -> team.TeamResourceWithRawResponse:
         from .resources.team import TeamResourceWithRawResponse
@@ -490,12 +471,6 @@ class AsyncGrowsurfWithRawResponse:
     def __init__(self, client: AsyncGrowsurf) -> None:
         self._client = client
 
-    @cached_property
-    def account(self) -> account.AsyncAccountResourceWithRawResponse:
-        from .resources.account import AsyncAccountResourceWithRawResponse
-
-        return AsyncAccountResourceWithRawResponse(self._client.account)
-
     @cached_property
     def team(self) -> team.AsyncTeamResourceWithRawResponse:
         from .resources.team import AsyncTeamResourceWithRawResponse
@@ -515,12 +490,6 @@ class GrowsurfWithStreamedResponse:
     def __init__(self, client: Growsurf) -> None:
         self._client = client
 
-    @cached_property
-    def account(self) -> account.AccountResourceWithStreamingResponse:
-        from .resources.account import AccountResourceWithStreamingResponse
-
-        return AccountResourceWithStreamingResponse(self._client.account)
-
     @cached_property
     def team(self) -> team.TeamResourceWithStreamingResponse:
         from .resources.team import TeamResourceWithStreamingResponse
@@ -540,12 +509,6 @@ class AsyncGrowsurfWithStreamedResponse:
     def __init__(self, client: AsyncGrowsurf) -> None:
         self._client = client
 
-    @cached_property
-    def account(self) -> account.AsyncAccountResourceWithStreamingResponse:
-        from .resources.account import AsyncAccountResourceWithStreamingResponse
-
-        return AsyncAccountResourceWithStreamingResponse(self._client.account)
-
     @cached_property
     def team(self) -> team.AsyncTeamResourceWithStreamingResponse:
         from .resources.team import AsyncTeamResourceWithStreamingResponse

growsurf/_exceptions.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Dict, List, cast
 from typing_extensions import Literal
 
 import httpx
@@ -60,11 +61,79 @@ class APIStatusError(APIError):
     response: httpx.Response
     status_code: int
 
+    # Documented error-body fields. Each is `None` when the body omits it or sends another
+    # type; `body` keeps the complete response body, including fields added later.
+    error_name: str | None
+    """Error name returned for the failed request."""
+
+    error_code: str | None
+    """Stable machine-readable error code."""
+
+    error_message: str | None
+    """Human-readable error message."""
+
+    errors: List[Dict[str, object]] | None
+    """Optional validation details for specific request fields."""
+
+    support_url: str | None
+    """Support URL related to the error, when available."""
+
+    policy_name: str | None
+    """Rate-limit policy name for `429` errors, when available."""
+
+    level: str | None
+    """Error severity level, when available."""
+
+    timestamp: str | None
+    """When the error response was created."""
+
+    fraud_risk_level: str | None
+    """Fraud risk level assigned to the blocked signup."""
+
+    fraud_reason_code: str | None
+    """Machine-readable reason code for the fraud decision."""
+
+    matched_participant_ids: List[str] | None
+    """Existing participant IDs related to the fraud match."""
+
+    email: str | None
+    """Email address from the blocked signup attempt."""
+
+    referrer_id: str | None
+    """Referrer participant ID supplied with the blocked signup, or `null`."""
+
+    ip_address: str | None
+    """IP address supplied with the blocked signup, or `null`."""
+
+    fingerprint: str | None
+    """Browser fingerprint supplied with the blocked signup, or `null`."""
+
+    blocked_at: str | None
+    """When the signup was blocked."""
+
     def __init__(self, message: str, *, response: httpx.Response, body: object | None) -> None:
         super().__init__(message, response.request, body=body)
         self.response = response
         self.status_code = response.status_code
 
+        fields = cast(Dict[str, object], body) if isinstance(body, dict) else {}
+        self.error_name = _str_or_none(fields.get("name"))
+        self.error_code = _str_or_none(fields.get("code"))
+        self.error_message = _str_or_none(fields.get("message"))
+        self.errors = _record_list_or_none(fields.get("errors"))
+        self.support_url = _str_or_none(fields.get("supportUrl"))
+        self.policy_name = _str_or_none(fields.get("policyName"))
+        self.level = _str_or_none(fields.get("level"))
+        self.timestamp = _str_or_none(fields.get("timestamp"))
+        self.fraud_risk_level = _str_or_none(fields.get("fraudRiskLevel"))
+        self.fraud_reason_code = _str_or_none(fields.get("fraudReasonCode"))
+        self.matched_participant_ids = _str_list_or_none(fields.get("matchedParticipantIds"))
+        self.email = _str_or_none(fields.get("email"))
+        self.referrer_id = _str_or_none(fields.get("referrerId"))
+        self.ip_address = _str_or_none(fields.get("ipAddress"))
+        self.fingerprint = _str_or_none(fields.get("fingerprint"))
+        self.blocked_at = _str_or_none(fields.get("blockedAt"))
+
 
 class APIConnectionError(APIError):
     def __init__(self, *, message: str = "Connection error.", request: httpx.Request) -> None:
@@ -106,3 +175,25 @@ class RateLimitError(APIStatusError):
 
 class InternalServerError(APIStatusError):
     pass
+
+
+def _str_or_none(value: object) -> str | None:
+    return value if isinstance(value, str) else None
+
+
+def _str_list_or_none(value: object) -> List[str] | None:
+    if not isinstance(value, list):
+        return None
+    items = cast(List[object], value)
+    if not all(isinstance(item, str) for item in items):
+        return None
+    return cast(List[str], items)
+
+
+def _record_list_or_none(value: object) -> List[Dict[str, object]] | None:
+    if not isinstance(value, list):
+        return None
+    items = cast(List[object], value)
+    if not all(isinstance(item, dict) for item in items):
+        return None
+    return cast(List[Dict[str, object]], items)

growsurf/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "growsurf"
-__version__ = "1.16.0"  # x-release-please-version
+__version__ = "1.18.0"  # x-release-please-version

growsurf/resources/__init__.py

@@ -8,14 +8,6 @@ from .team import (
     TeamResourceWithStreamingResponse,
     AsyncTeamResourceWithStreamingResponse,
 )
-from .account import (
-    AccountResource,
-    AsyncAccountResource,
-    AccountResourceWithRawResponse,
-    AsyncAccountResourceWithRawResponse,
-    AccountResourceWithStreamingResponse,
-    AsyncAccountResourceWithStreamingResponse,
-)
 from .campaign import (
     CampaignResource,
     AsyncCampaignResource,
@@ -26,12 +18,6 @@ from .campaign import (
 )
 
 __all__ = [
-    "AccountResource",
-    "AsyncAccountResource",
-    "AccountResourceWithRawResponse",
-    "AsyncAccountResourceWithRawResponse",
-    "AccountResourceWithStreamingResponse",
-    "AsyncAccountResourceWithStreamingResponse",
     "TeamResource",
     "AsyncTeamResource",
     "TeamResourceWithRawResponse",

growsurf/resources/campaign/__init__.py

@@ -88,6 +88,14 @@ from .integrations import (
     IntegrationsResourceWithStreamingResponse,
     AsyncIntegrationsResourceWithStreamingResponse,
 )
+from .custom_domain import (
+    CustomDomainResource,
+    AsyncCustomDomainResource,
+    CustomDomainResourceWithRawResponse,
+    AsyncCustomDomainResourceWithRawResponse,
+    CustomDomainResourceWithStreamingResponse,
+    AsyncCustomDomainResourceWithStreamingResponse,
+)
 from .program_resources import (
     ProgramResourcesResource,
     AsyncProgramResourcesResource,
@@ -158,6 +166,12 @@ __all__ = [
     "AsyncInstallationResourceWithRawResponse",
     "InstallationResourceWithStreamingResponse",
     "AsyncInstallationResourceWithStreamingResponse",
+    "CustomDomainResource",
+    "AsyncCustomDomainResource",
+    "CustomDomainResourceWithRawResponse",
+    "AsyncCustomDomainResourceWithRawResponse",
+    "CustomDomainResourceWithStreamingResponse",
+    "AsyncCustomDomainResourceWithStreamingResponse",
     "CommissionResource",
     "AsyncCommissionResource",
     "CommissionResourceWithRawResponse",

growsurf/resources/campaign/campaign.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, Iterable
+from typing import Dict, Iterable, Optional
 from typing_extensions import Literal
 
 import httpx
@@ -113,6 +113,14 @@ from .integrations import (
     IntegrationsResourceWithStreamingResponse,
     AsyncIntegrationsResourceWithStreamingResponse,
 )
+from .custom_domain import (
+    CustomDomainResource,
+    AsyncCustomDomainResource,
+    CustomDomainResourceWithRawResponse,
+    AsyncCustomDomainResourceWithRawResponse,
+    CustomDomainResourceWithStreamingResponse,
+    AsyncCustomDomainResourceWithStreamingResponse,
+)
 from ..._base_client import make_request_options
 from ...types.campaign import ReferralStatus, reward_create_params
 from .program_resources import (
@@ -197,6 +205,11 @@ class CampaignResource(SyncAPIResource):
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return InstallationResource(self._client)
 
+    @cached_property
+    def custom_domain(self) -> CustomDomainResource:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return CustomDomainResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> CampaignResourceWithRawResponse:
         """
@@ -220,8 +233,8 @@ class CampaignResource(SyncAPIResource):
         self,
         *,
         type: Literal["REFERRAL", "AFFILIATE"],
-        company_logo_image_url: str | Omit = omit,
-        company_name: str | Omit = omit,
+        company_logo_image_url: Optional[str] | Omit = omit,
+        company_name: Optional[str] | Omit = omit,
         currency_iso: str | Omit = omit,
         goal: Literal[
             "CUSTOMERS",
@@ -329,8 +342,8 @@ class CampaignResource(SyncAPIResource):
         self,
         id: str,
         *,
-        company_logo_image_url: str | Omit = omit,
-        company_name: str | Omit = omit,
+        company_logo_image_url: Optional[str] | Omit = omit,
+        company_name: Optional[str] | Omit = omit,
         name: str | Omit = omit,
         status: Literal["IN_PROGRESS", "COMPLETE"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -347,8 +360,8 @@ class CampaignResource(SyncAPIResource):
         dedicated config sub-resources, not here. The program cannot be deleted via this
         endpoint.
         Changes to participant email content are checked before saving. Rejected content returns
-        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
-        change. A concurrent edit can return `409`; reload the program before retrying.
+        `400` and is not saved. A concurrent edit can return `409`; reload the program before
+        retrying.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -449,6 +462,7 @@ class CampaignResource(SyncAPIResource):
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
         referral_status: Literal["CREDIT_PENDING", "CREDIT_AWARDED"] | Omit = omit,
+        referred_at: Optional[int] | Omit = omit,
         referred_by: str | 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.
@@ -472,8 +486,14 @@ class CampaignResource(SyncAPIResource):
 
           is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
 
-          language: The language of the participant's portal and program emails. Must be one of the
-              program's languages. Applied only when this request creates the participant.
+          language: The language of the participant's portal and program emails. Stored when it is one of
+              the program's languages. A regional tag maps to its language (for example, `es-MX` is
+              stored as `es`). Any other value is ignored and the program's base language applies.
+              Applied only when this request creates the participant.
+
+          referred_at: When the participant was referred, in Unix milliseconds. Used only with a valid
+              `referredBy`. If you omit `referralStatus`, GrowSurf compares this time with the
+              program's referral credit window to set it. Defaults to the time of the request.
 
           referred_by: Referrer participant ID or email address.
 
@@ -501,6 +521,7 @@ class CampaignResource(SyncAPIResource):
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,
                     "referral_status": referral_status,
+                    "referred_at": referred_at,
                     "referred_by": referred_by,
                 },
                 campaign_create_mobile_participant_token_params.CampaignCreateMobileParticipantTokenParams,
@@ -793,10 +814,7 @@ class CampaignResource(SyncAPIResource):
         next_id: str | Omit = omit,
         offset: int | Omit = omit,
         referral_status: ReferralStatus | Omit = omit,
-        sort_by: Literal[
-            "updatedAt", "createdAt", "email", "firstName", "lastName", "referralStatus", "referralTriggeredAt"
-        ]
-        | Omit = omit,
+        sort_by: Literal["updatedAt", "createdAt", "email", "referralTriggeredAt"] | 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,
@@ -1432,6 +1450,11 @@ class AsyncCampaignResource(AsyncAPIResource):
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return AsyncInstallationResource(self._client)
 
+    @cached_property
+    def custom_domain(self) -> AsyncCustomDomainResource:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return AsyncCustomDomainResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> AsyncCampaignResourceWithRawResponse:
         """
@@ -1455,8 +1478,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         self,
         *,
         type: Literal["REFERRAL", "AFFILIATE"],
-        company_logo_image_url: str | Omit = omit,
-        company_name: str | Omit = omit,
+        company_logo_image_url: Optional[str] | Omit = omit,
+        company_name: Optional[str] | Omit = omit,
         currency_iso: str | Omit = omit,
         goal: Literal[
             "CUSTOMERS",
@@ -1564,8 +1587,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         self,
         id: str,
         *,
-        company_logo_image_url: str | Omit = omit,
-        company_name: str | Omit = omit,
+        company_logo_image_url: Optional[str] | Omit = omit,
+        company_name: Optional[str] | Omit = omit,
         name: str | Omit = omit,
         status: Literal["IN_PROGRESS", "COMPLETE"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1582,8 +1605,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         dedicated config sub-resources, not here. The program cannot be deleted via this
         endpoint.
         Changes to participant email content are checked before saving. Rejected content returns
-        `400`; if the check is unavailable, `503` asks you to retry. Neither response saves the
-        change. A concurrent edit can return `409`; reload the program before retrying.
+        `400` and is not saved. A concurrent edit can return `409`; reload the program before
+        retrying.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -1684,6 +1707,7 @@ class AsyncCampaignResource(AsyncAPIResource):
         metadata: Dict[str, object] | Omit = omit,
         mobile_instance_id: str | Omit = omit,
         referral_status: Literal["CREDIT_PENDING", "CREDIT_AWARDED"] | Omit = omit,
+        referred_at: Optional[int] | Omit = omit,
         referred_by: str | 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.
@@ -1707,8 +1731,14 @@ class AsyncCampaignResource(AsyncAPIResource):
 
           is_affiliate: Affiliate programs only. Controls affiliate enrollment for a new participant.
 
-          language: The language of the participant's portal and program emails. Must be one of the
-              program's languages. Applied only when this request creates the participant.
+          language: The language of the participant's portal and program emails. Stored when it is one of
+              the program's languages. A regional tag maps to its language (for example, `es-MX` is
+              stored as `es`). Any other value is ignored and the program's base language applies.
+              Applied only when this request creates the participant.
+
+          referred_at: When the participant was referred, in Unix milliseconds. Used only with a valid
+              `referredBy`. If you omit `referralStatus`, GrowSurf compares this time with the
+              program's referral credit window to set it. Defaults to the time of the request.
 
           referred_by: Referrer participant ID or email address.
 
@@ -1736,6 +1766,7 @@ class AsyncCampaignResource(AsyncAPIResource):
                     "metadata": metadata,
                     "mobile_instance_id": mobile_instance_id,
                     "referral_status": referral_status,
+                    "referred_at": referred_at,
                     "referred_by": referred_by,
                 },
                 campaign_create_mobile_participant_token_params.CampaignCreateMobileParticipantTokenParams,
@@ -2028,10 +2059,7 @@ class AsyncCampaignResource(AsyncAPIResource):
         next_id: str | Omit = omit,
         offset: int | Omit = omit,
         referral_status: ReferralStatus | Omit = omit,
-        sort_by: Literal[
-            "updatedAt", "createdAt", "email", "firstName", "lastName", "referralStatus", "referralTriggeredAt"
-        ]
-        | Omit = omit,
+        sort_by: Literal["updatedAt", "createdAt", "email", "referralTriggeredAt"] | 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,
@@ -2734,6 +2762,11 @@ class CampaignResourceWithRawResponse:
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return InstallationResourceWithRawResponse(self._campaign.installation)
 
+    @cached_property
+    def custom_domain(self) -> CustomDomainResourceWithRawResponse:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return CustomDomainResourceWithRawResponse(self._campaign.custom_domain)
+
 
 class AsyncCampaignResourceWithRawResponse:
     def __init__(self, campaign: AsyncCampaignResource) -> None:
@@ -2856,6 +2889,11 @@ class AsyncCampaignResourceWithRawResponse:
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return AsyncInstallationResourceWithRawResponse(self._campaign.installation)
 
+    @cached_property
+    def custom_domain(self) -> AsyncCustomDomainResourceWithRawResponse:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return AsyncCustomDomainResourceWithRawResponse(self._campaign.custom_domain)
+
 
 class CampaignResourceWithStreamingResponse:
     def __init__(self, campaign: CampaignResource) -> None:
@@ -2978,6 +3016,11 @@ class CampaignResourceWithStreamingResponse:
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return InstallationResourceWithStreamingResponse(self._campaign.installation)
 
+    @cached_property
+    def custom_domain(self) -> CustomDomainResourceWithStreamingResponse:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return CustomDomainResourceWithStreamingResponse(self._campaign.custom_domain)
+
 
 class AsyncCampaignResourceWithStreamingResponse:
     def __init__(self, campaign: AsyncCampaignResource) -> None:
@@ -3099,3 +3142,8 @@ class AsyncCampaignResourceWithStreamingResponse:
     def installation(self) -> AsyncInstallationResourceWithStreamingResponse:
         """Campaign installation (`CampaignInstallation`) — the Program Editor's Installation tab."""
         return AsyncInstallationResourceWithStreamingResponse(self._campaign.installation)
+
+    @cached_property
+    def custom_domain(self) -> AsyncCustomDomainResourceWithStreamingResponse:
+        """Campaign custom domain (`CampaignCustomDomain`) — the domain that serves a program's landing pages."""
+        return AsyncCustomDomainResourceWithStreamingResponse(self._campaign.custom_domain)