growsurf-python 1.1.2__tar.gz → 1.2.1__tar.gz

growsurf_python-1.2.1/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.2.1"
+}

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.2.1](https://github.com/growsurf/growsurf-python/compare/v1.2.0...v1.2.1) (2026-07-14)
+
+
+### Bug Fixes
+
+* align method docs with the REST v2 contract ([57e44e9](https://github.com/growsurf/growsurf-python/commit/57e44e906100c23d85d5dfbfabcd3821ef14d629))
+
+## [1.2.0](https://github.com/growsurf/growsurf-python/compare/v1.1.2...v1.2.0) (2026-07-13)
+
+
+### Features
+
+* **api:** add Team resource ([9efbfbd](https://github.com/growsurf/growsurf-python/commit/9efbfbdfec10336d473f9266a033d93c3e98bb9e))
+
 ## [1.1.2](https://github.com/growsurf/growsurf-python/compare/v1.1.1...v1.1.2) (2026-07-11)
 
 

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.1.2
+Version: 1.2.1
 Summary: The official Python library for the growsurf API
 Project-URL: Homepage, https://github.com/growsurf/growsurf-python
 Project-URL: Repository, https://github.com/growsurf/growsurf-python

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/api.md

@@ -4,8 +4,21 @@ Types:
 
 ```python
 from growsurf.types import (
-    Account,
     CreateAccountResponse,
+)
+```
+
+Methods:
+
+- <code title="post /accounts">client.account.<a href="./src/growsurf/resources/account.py">create</a>(\*\*<a href="src/growsurf/types/account_create_params.py">params</a>) -> <a href="./src/growsurf/types/create_account_response.py">CreateAccountResponse</a></code>
+
+# Team
+
+Types:
+
+```python
+from growsurf.types import (
+    Team,
     RotateApiKeyResponse,
     VerificationEmailResponse,
 )
@@ -13,12 +26,11 @@ from growsurf.types import (
 
 Methods:
 
-- <code title="post /accounts">client.account.<a href="./src/growsurf/resources/account.py">create</a>(\*\*<a href="src/growsurf/types/account_create_params.py">params</a>) -> <a href="./src/growsurf/types/create_account_response.py">CreateAccountResponse</a></code>
-- <code title="get /account">client.account.<a href="./src/growsurf/resources/account.py">retrieve</a>() -> <a href="./src/growsurf/types/account.py">Account</a></code>
-- <code title="patch /account">client.account.<a href="./src/growsurf/resources/account.py">update</a>(\*\*<a href="src/growsurf/types/account_update_params.py">params</a>) -> <a href="./src/growsurf/types/account.py">Account</a></code>
-- <code title="post /account/api-key">client.account.<a href="./src/growsurf/resources/account.py">rotate_api_key</a>() -> <a href="./src/growsurf/types/rotate_api_key_response.py">RotateApiKeyResponse</a></code>
-- <code title="post /account/verification-request">client.account.<a href="./src/growsurf/resources/account.py">request_verification</a>() -> <a href="./src/growsurf/types/account.py">Account</a></code>
-- <code title="post /account/verification-email">client.account.<a href="./src/growsurf/resources/account.py">resend_verification_email</a>() -> <a href="./src/growsurf/types/verification_email_response.py">VerificationEmailResponse</a></code>
+- <code title="get /team">client.team.<a href="./src/growsurf/resources/team.py">retrieve</a>() -> <a href="./src/growsurf/types/team.py">Team</a></code>
+- <code title="patch /team">client.team.<a href="./src/growsurf/resources/team.py">update</a>(\*\*<a href="src/growsurf/types/team_update_params.py">params</a>) -> <a href="./src/growsurf/types/team.py">Team</a></code>
+- <code title="post /api-key/rotate">client.team.<a href="./src/growsurf/resources/team.py">rotate_api_key</a>() -> <a href="./src/growsurf/types/rotate_api_key_response.py">RotateApiKeyResponse</a></code>
+- <code title="post /team/verification-request">client.team.<a href="./src/growsurf/resources/team.py">request_verification</a>() -> <a href="./src/growsurf/types/team.py">Team</a></code>
+- <code title="post /team/owner/verification-email">client.team.<a href="./src/growsurf/resources/team.py">resend_owner_verification_email</a>() -> <a href="./src/growsurf/types/verification_email_response.py">VerificationEmailResponse</a></code>
 
 # Campaign
 
@@ -134,7 +146,12 @@ Methods:
 Types:
 
 ```python
-from growsurf.types.campaign import Reward, RewardTaxValuation, CampaignRewardListResponse, DeleteRewardResponse
+from growsurf.types.campaign import (
+    Reward,
+    RewardTaxValuation,
+    CampaignRewardListResponse,
+    DeleteRewardResponse,
+)
 ```
 
 Methods:

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "growsurf-python"
-version = "1.1.2"
+version = "1.2.1"
 description = "The official Python library for the growsurf API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/src/growsurf/_client.py

@@ -28,7 +28,7 @@ from ._compat import cached_property
 from ._models import SecurityOptions
 from ._version import __version__
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
-from ._exceptions import GrowsurfError, APIStatusError
+from ._exceptions import APIStatusError
 from ._base_client import (
     DEFAULT_MAX_RETRIES,
     SyncAPIClient,
@@ -36,7 +36,8 @@ from ._base_client import (
 )
 
 if TYPE_CHECKING:
-    from .resources import account, campaign
+    from .resources import team, account, campaign
+    from .resources.team import TeamResource, AsyncTeamResource
     from .resources.account import AccountResource, AsyncAccountResource
     from .resources.campaign.campaign import CampaignResource, AsyncCampaignResource
 
@@ -86,9 +87,7 @@ class Growsurf(SyncAPIClient):
         if api_key is None:
             api_key = os.environ.get("GROWSURF_API_KEY")
         if api_key is None:
-            raise GrowsurfError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the GROWSURF_API_KEY environment variable"
-            )
+            api_key = ""
         self.api_key = api_key
 
         if base_url is None:
@@ -123,6 +122,12 @@ class Growsurf(SyncAPIClient):
 
         return AccountResource(self)
 
+    @cached_property
+    def team(self) -> TeamResource:
+        from .resources.team import TeamResource
+
+        return TeamResource(self)
+
     @cached_property
     def campaign(self) -> CampaignResource:
         from .resources.campaign import CampaignResource
@@ -153,6 +158,8 @@ class Growsurf(SyncAPIClient):
     @property
     def _api_key_auth(self) -> dict[str, str]:
         api_key = self.api_key
+        if not api_key:
+            return {}
         return {"Authorization": f"Bearer {api_key}"}
 
     @property
@@ -283,9 +290,7 @@ class AsyncGrowsurf(AsyncAPIClient):
         if api_key is None:
             api_key = os.environ.get("GROWSURF_API_KEY")
         if api_key is None:
-            raise GrowsurfError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the GROWSURF_API_KEY environment variable"
-            )
+            api_key = ""
         self.api_key = api_key
 
         if base_url is None:
@@ -320,6 +325,12 @@ class AsyncGrowsurf(AsyncAPIClient):
 
         return AsyncAccountResource(self)
 
+    @cached_property
+    def team(self) -> AsyncTeamResource:
+        from .resources.team import AsyncTeamResource
+
+        return AsyncTeamResource(self)
+
     @cached_property
     def campaign(self) -> AsyncCampaignResource:
         from .resources.campaign import AsyncCampaignResource
@@ -350,6 +361,8 @@ class AsyncGrowsurf(AsyncAPIClient):
     @property
     def _api_key_auth(self) -> dict[str, str]:
         api_key = self.api_key
+        if not api_key:
+            return {}
         return {"Authorization": f"Bearer {api_key}"}
 
     @property
@@ -458,6 +471,12 @@ class GrowsurfWithRawResponse:
 
         return AccountResourceWithRawResponse(self._client.account)
 
+    @cached_property
+    def team(self) -> team.TeamResourceWithRawResponse:
+        from .resources.team import TeamResourceWithRawResponse
+
+        return TeamResourceWithRawResponse(self._client.team)
+
     @cached_property
     def campaign(self) -> campaign.CampaignResourceWithRawResponse:
         from .resources.campaign import CampaignResourceWithRawResponse
@@ -477,6 +496,12 @@ class AsyncGrowsurfWithRawResponse:
 
         return AsyncAccountResourceWithRawResponse(self._client.account)
 
+    @cached_property
+    def team(self) -> team.AsyncTeamResourceWithRawResponse:
+        from .resources.team import AsyncTeamResourceWithRawResponse
+
+        return AsyncTeamResourceWithRawResponse(self._client.team)
+
     @cached_property
     def campaign(self) -> campaign.AsyncCampaignResourceWithRawResponse:
         from .resources.campaign import AsyncCampaignResourceWithRawResponse
@@ -496,6 +521,12 @@ class GrowsurfWithStreamedResponse:
 
         return AccountResourceWithStreamingResponse(self._client.account)
 
+    @cached_property
+    def team(self) -> team.TeamResourceWithStreamingResponse:
+        from .resources.team import TeamResourceWithStreamingResponse
+
+        return TeamResourceWithStreamingResponse(self._client.team)
+
     @cached_property
     def campaign(self) -> campaign.CampaignResourceWithStreamingResponse:
         from .resources.campaign import CampaignResourceWithStreamingResponse
@@ -515,6 +546,12 @@ class AsyncGrowsurfWithStreamedResponse:
 
         return AsyncAccountResourceWithStreamingResponse(self._client.account)
 
+    @cached_property
+    def team(self) -> team.AsyncTeamResourceWithStreamingResponse:
+        from .resources.team import AsyncTeamResourceWithStreamingResponse
+
+        return AsyncTeamResourceWithStreamingResponse(self._client.team)
+
     @cached_property
     def campaign(self) -> campaign.AsyncCampaignResourceWithStreamingResponse:
         from .resources.campaign import AsyncCampaignResourceWithStreamingResponse

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/src/growsurf/_version.py

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

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/src/growsurf/resources/__init__.py

@@ -1,5 +1,13 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from .team import (
+    TeamResource,
+    AsyncTeamResource,
+    TeamResourceWithRawResponse,
+    AsyncTeamResourceWithRawResponse,
+    TeamResourceWithStreamingResponse,
+    AsyncTeamResourceWithStreamingResponse,
+)
 from .account import (
     AccountResource,
     AsyncAccountResource,
@@ -24,6 +32,12 @@ __all__ = [
     "AsyncAccountResourceWithRawResponse",
     "AccountResourceWithStreamingResponse",
     "AsyncAccountResourceWithStreamingResponse",
+    "TeamResource",
+    "AsyncTeamResource",
+    "TeamResourceWithRawResponse",
+    "AsyncTeamResourceWithRawResponse",
+    "TeamResourceWithStreamingResponse",
+    "AsyncTeamResourceWithStreamingResponse",
     "CampaignResource",
     "AsyncCampaignResource",
     "CampaignResourceWithRawResponse",

growsurf_python-1.2.1/src/growsurf/resources/account.py

@@ -0,0 +1,205 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..types import account_create_params
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._utils import 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.create_account_response import CreateAccountResponse
+
+__all__ = ["AccountResource", "AsyncAccountResource"]
+
+
+class AccountResource(SyncAPIResource):
+    """Create a GrowSurf account and its initial API key."""
+
+    @cached_property
+    def with_raw_response(self) -> AccountResourceWithRawResponse:
+        """Return the raw response object instead of parsed content."""
+        return AccountResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AccountResourceWithStreamingResponse:
+        """Stream the response instead of reading it eagerly."""
+        return AccountResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        email: str,
+        company: str | Omit = omit,
+        first_name: str | Omit = omit,
+        last_name: str | Omit = omit,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> CreateAccountResponse:
+        """
+        Creates a new GrowSurf account. This is the only endpoint that does not require
+        an API key. The response includes an API key for the new account, shown once in
+        the response. The key is locked until the team owner's email address is
+        verified: authenticated program and resource endpoints return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+        /team/owner/verification-email`, then retry). A welcome email is sent to the
+        address with the verification link and a set-password link for dashboard access.
+        Accounts whose email is never verified are deleted automatically after 7 days.
+        For security, the API key is rotated the first time the account owner signs in
+        to the GrowSurf dashboard. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. By creating an account
+        you agree, on behalf of the account holder, to GrowSurf's [Terms of
+        Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy).
+
+        Args:
+          email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.
+
+          company: Company name for the new account.
+
+          first_name: First name for the new account owner.
+
+          last_name: Last name for the new account owner.
+
+          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
+        """
+        return self._post(
+            "/accounts",
+            body=maybe_transform(
+                {
+                    "email": email,
+                    "company": company,
+                    "first_name": first_name,
+                    "last_name": last_name,
+                },
+                account_create_params.AccountCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                security={"api_key_auth": False},
+            ),
+            cast_to=CreateAccountResponse,
+        )
+
+
+class AsyncAccountResource(AsyncAPIResource):
+    """Create a GrowSurf account and its initial API key."""
+
+    @cached_property
+    def with_raw_response(self) -> AsyncAccountResourceWithRawResponse:
+        """Return the raw response object instead of parsed content."""
+        return AsyncAccountResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncAccountResourceWithStreamingResponse:
+        """Stream the response instead of reading it eagerly."""
+        return AsyncAccountResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        email: str,
+        company: str | Omit = omit,
+        first_name: str | Omit = omit,
+        last_name: str | Omit = omit,
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> CreateAccountResponse:
+        """
+        Creates a new GrowSurf account. This is the only endpoint that does not require
+        an API key. The response includes an API key for the new account, shown once in
+        the response. The key is locked until the team owner's email address is
+        verified: authenticated program and resource endpoints return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+        /team/owner/verification-email`, then retry). A welcome email is sent to the
+        address with the verification link and a set-password link for dashboard access.
+        Accounts whose email is never verified are deleted automatically after 7 days.
+        For security, the API key is rotated the first time the account owner signs in
+        to the GrowSurf dashboard. Some actions (such as emailing participants)
+        additionally require GrowSurf to verify the team first. By creating an account
+        you agree, on behalf of the account holder, to GrowSurf's [Terms of
+        Service](https://growsurf.com/terms) and [Privacy
+        Policy](https://growsurf.com/privacy).
+
+        Args:
+          email: The email address for the new GrowSurf account. Personal emails and disposable email addresses are not accepted.
+
+          company: Company name for the new account.
+
+          first_name: First name for the new account owner.
+
+          last_name: Last name for the new account owner.
+
+          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
+        """
+        return await self._post(
+            "/accounts",
+            body=await async_maybe_transform(
+                {
+                    "email": email,
+                    "company": company,
+                    "first_name": first_name,
+                    "last_name": last_name,
+                },
+                account_create_params.AccountCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                security={"api_key_auth": False},
+            ),
+            cast_to=CreateAccountResponse,
+        )
+
+
+class AccountResourceWithRawResponse:
+    def __init__(self, account: AccountResource) -> None:
+        self._account = account
+        self.create = to_raw_response_wrapper(account.create)
+
+
+class AsyncAccountResourceWithRawResponse:
+    def __init__(self, account: AsyncAccountResource) -> None:
+        self._account = account
+        self.create = async_to_raw_response_wrapper(account.create)
+
+
+class AccountResourceWithStreamingResponse:
+    def __init__(self, account: AccountResource) -> None:
+        self._account = account
+        self.create = to_streamed_response_wrapper(account.create)
+
+
+class AsyncAccountResourceWithStreamingResponse:
+    def __init__(self, account: AsyncAccountResource) -> None:
+        self._account = account
+        self.create = async_to_streamed_response_wrapper(account.create)

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/campaign.py

@@ -196,9 +196,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Campaign:
         """
-        Creates a new program pre-populated with type-appropriate defaults, plus any
-        optional inline rewards. The new program is created in `DRAFT` status and owned
-        by the API key's account. Requires a verified account email.
+        Creates a new program, plus any optional program rewards. The new program is
+        created in `DRAFT` status and owned by the API key's bound team.
 
         Args:
           type: The program type. Immutable after creation.
@@ -289,8 +288,8 @@ class CampaignResource(SyncAPIResource):
         Updates a program's identity and lifecycle. Only the fields you send are
         changed. `type`, `urlId`, and `currencyISO` are immutable. Editor-tab
         configuration (design, emails, options, installation) is edited via the
-        dedicated config sub-resources, not here. The program cannot be deleted via
-        this endpoint.
+        dedicated config sub-resources, not here. The program cannot be deleted via this
+        endpoint.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -458,7 +457,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantCommissionList:
         """
-        Retrieves a paged list of all participant commissions in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant
+        commissions in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -628,7 +628,8 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantPayoutList:
         """
-        Retrieves a paged list of all participant payouts in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant payouts
+        in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -762,10 +763,9 @@ class CampaignResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignRetrieveAnalyticsResponse:
         """
-        Retrieves analytics for a program. Pass ``interval`` to also get a time-series
-        (``series``) alongside the totals, and ``include`` to add previous-period
-        totals, status breakdowns, or derived rates — useful for detecting trends over
-        time.
+        Retrieves analytics for a program. Pass `interval` to also get a time-series
+        (`series`) alongside the totals, and `include` to add previous-period totals,
+        status breakdowns, or derived rates — useful for detecting trends over time.
 
         Args:
           days: Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
@@ -898,9 +898,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Campaign:
         """
-        Creates a new program pre-populated with type-appropriate defaults, plus any
-        optional inline rewards. The new program is created in `DRAFT` status and owned
-        by the API key's account. Requires a verified account email.
+        Creates a new program, plus any optional program rewards. The new program is
+        created in `DRAFT` status and owned by the API key's bound team.
 
         Args:
           type: The program type. Immutable after creation.
@@ -991,8 +990,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         Updates a program's identity and lifecycle. Only the fields you send are
         changed. `type`, `urlId`, and `currencyISO` are immutable. Editor-tab
         configuration (design, emails, options, installation) is edited via the
-        dedicated config sub-resources, not here. The program cannot be deleted via
-        this endpoint.
+        dedicated config sub-resources, not here. The program cannot be deleted via this
+        endpoint.
 
         Args:
           status: The requested program status. `IN_PROGRESS` publishes or resumes the program;
@@ -1160,7 +1159,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantCommissionList:
         """
-        Retrieves a paged list of all participant commissions in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant
+        commissions in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -1330,7 +1330,8 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ParticipantPayoutList:
         """
-        Retrieves a paged list of all participant payouts in an affiliate program.
+        **Affiliate programs only.** Retrieves a paged list of all participant payouts
+        in an affiliate program.
 
         Args:
           limit: Number of results to return. Maximum 100.
@@ -1464,10 +1465,9 @@ class AsyncCampaignResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CampaignRetrieveAnalyticsResponse:
         """
-        Retrieves analytics for a program. Pass ``interval`` to also get a time-series
-        (``series``) alongside the totals, and ``include`` to add previous-period
-        totals, status breakdowns, or derived rates — useful for detecting trends over
-        time.
+        Retrieves analytics for a program. Pass `interval` to also get a time-series
+        (`series`) alongside the totals, and `include` to add previous-period totals,
+        status breakdowns, or derived rates — useful for detecting trends over time.
 
         Args:
           days: Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.

{growsurf_python-1.1.2 → growsurf_python-1.2.1}/src/growsurf/resources/campaign/commission.py

@@ -56,7 +56,7 @@ class CommissionResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionDeleteResponse:
         """
-        Removes a pending participant commission.
+        **Affiliate programs only.** Removes a pending participant commission.
 
         Args:
           extra_headers: Send extra headers
@@ -92,7 +92,8 @@ class CommissionResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionApproveResponse:
         """
-        Approves a pending participant commission so it can become eligible for payout.
+        **Affiliate programs only.** Approves a pending participant commission so it can
+        become eligible for payout.
 
         Args:
           extra_headers: Send extra headers
@@ -151,7 +152,7 @@ class AsyncCommissionResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionDeleteResponse:
         """
-        Removes a pending participant commission.
+        **Affiliate programs only.** Removes a pending participant commission.
 
         Args:
           extra_headers: Send extra headers
@@ -187,7 +188,8 @@ class AsyncCommissionResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CommissionApproveResponse:
         """
-        Approves a pending participant commission so it can become eligible for payout.
+        **Affiliate programs only.** Approves a pending participant commission so it can
+        become eligible for payout.
 
         Args:
           extra_headers: Send extra headers