growsurf-python 1.1.1__py3-none-any.whl → 1.1.2__py3-none-any.whl

growsurf/_client.py

@@ -115,6 +115,7 @@ class Growsurf(SyncAPIClient):
             custom_query=default_query,
             _strict_response_validation=_strict_response_validation,
         )
+        self._idempotency_header = "Idempotency-Key"
 
     @cached_property
     def account(self) -> AccountResource:
@@ -311,6 +312,7 @@ class AsyncGrowsurf(AsyncAPIClient):
             custom_query=default_query,
             _strict_response_validation=_strict_response_validation,
         )
+        self._idempotency_header = "Idempotency-Key"
 
     @cached_property
     def account(self) -> AsyncAccountResource:

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.1"  # x-release-please-version
+__version__ = "1.1.2"  # x-release-please-version

growsurf/resources/account.py

@@ -65,9 +65,10 @@ class AccountResource(SyncAPIResource):
         an API key, so you can call it on a client constructed with any placeholder
         `api_key`.
 
-        The response includes an API key for the new account, but the key is locked
-        until the account's email address is verified: authenticated endpoints outside
-        the Accounts group return a `403` with error code `EMAIL_NOT_VERIFIED_ERROR`
+        The response includes an API key for the new account, shown once in the
+        response. The key is locked until the account's email address is verified:
+        authenticated endpoints outside the Accounts group return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR`
         until then (resend the email via the resend-verification-email endpoint, 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
@@ -183,11 +184,13 @@ class AccountResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RotateApiKeyResponse:
         """
-        Generates a new API key and immediately revokes the old one.
+        Generates a new API key and invalidates the key used for the request.
 
-        The key used to make this request stops working as soon as the response is
-        returned — update every integration that used the old key with the new one. The
-        account owner is notified by email whenever the key is rotated.
+        The SDK sends a retry-safe `Idempotency-Key`, so automatic retries return the
+        same replacement. Store the returned key, then update every integration that
+        used the old key. The account owner is notified by email whenever the key is
+        rotated. Requires an API key with `api_key:rotate`. This operation is available
+        only through the REST API or a GrowSurf API SDK, not through MCP.
         """
         return self._post(
             "/account/api-key",
@@ -288,9 +291,10 @@ class AsyncAccountResource(AsyncAPIResource):
         an API key, so you can call it on a client constructed with any placeholder
         `api_key`.
 
-        The response includes an API key for the new account, but the key is locked
-        until the account's email address is verified: authenticated endpoints outside
-        the Accounts group return a `403` with error code `EMAIL_NOT_VERIFIED_ERROR`
+        The response includes an API key for the new account, shown once in the
+        response. The key is locked until the account's email address is verified:
+        authenticated endpoints outside the Accounts group return a `403` with error
+        code `EMAIL_NOT_VERIFIED_ERROR`
         until then (resend the email via the resend-verification-email endpoint, 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
@@ -406,11 +410,13 @@ class AsyncAccountResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RotateApiKeyResponse:
         """
-        Generates a new API key and immediately revokes the old one.
+        Generates a new API key and invalidates the key used for the request.
 
-        The key used to make this request stops working as soon as the response is
-        returned — update every integration that used the old key with the new one. The
-        account owner is notified by email whenever the key is rotated.
+        The SDK sends a retry-safe `Idempotency-Key`, so automatic retries return the
+        same replacement. Store the returned key, then update every integration that
+        used the old key. The account owner is notified by email whenever the key is
+        rotated. Requires an API key with `api_key:rotate`. This operation is available
+        only through the REST API or a GrowSurf API SDK, not through MCP.
         """
         return await self._post(
             "/account/api-key",

growsurf/resources/campaign/reward.py

@@ -96,7 +96,8 @@ class RewardResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardApproveResponse:
         """
-        Approves a manually approved reward earned by a participant.
+        Approves a manually approved reward earned by a participant. Requires
+        `reward:write`. Passing `fulfill=True` also requires `reward:fulfill`.
 
         Args:
           fulfill: Set true to mark the reward as fulfilled after approval.
@@ -135,7 +136,7 @@ class RewardResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardFulfillResponse:
         """
-        Marks an approved participant reward as fulfilled.
+        Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
 
         Args:
           extra_headers: Send extra headers
@@ -232,7 +233,8 @@ class AsyncRewardResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardApproveResponse:
         """
-        Approves a manually approved reward earned by a participant.
+        Approves a manually approved reward earned by a participant. Requires
+        `reward:write`. Passing `fulfill=True` also requires `reward:fulfill`.
 
         Args:
           fulfill: Set true to mark the reward as fulfilled after approval.
@@ -271,7 +273,7 @@ class AsyncRewardResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> RewardFulfillResponse:
         """
-        Marks an approved participant reward as fulfilled.
+        Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
 
         Args:
           extra_headers: Send extra headers

growsurf/types/rotate_api_key_response.py

@@ -9,4 +9,4 @@ __all__ = ["RotateApiKeyResponse"]
 
 class RotateApiKeyResponse(BaseModel):
     api_key: str = FieldInfo(alias="apiKey")
-    """The new API key. The previous key is revoked immediately."""
+    """The new API key. Store it now; the key used for rotation stops working immediately."""

{growsurf_python-1.1.1.dist-info → growsurf_python-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: growsurf-python
-Version: 1.1.1
+Version: 1.1.2
 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.1.dist-info → growsurf_python-1.1.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 growsurf/__init__.py,sha256=PVU29rH3G7u2LvpyJd5G00W8Saj2Cp_BNzw7JIg8068,2683
 growsurf/_base_client.py,sha256=4kz0Jq20J5tuau3uZ9dLIBp-EotPbXDIJ5AQ4rTE7AA,74561
-growsurf/_client.py,sha256=rjo8rx5CasE5X6xtufScduBfSyfp7Z7sTK0nxkW5nrk,19225
+growsurf/_client.py,sha256=suOVygcmn3NqVYwXaN4wzRYn3u0Yf9iecTpDaBzf7d0,19331
 growsurf/_compat.py,sha256=_9guQfzYnL3DNtudX5W7T2cdSskx89B5AFfhPQDxMUk,6811
 growsurf/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
 growsurf/_exceptions.py,sha256=3bEzw4WDc3VYTMnwkiOucauRjS8Vhr3L0Qb02P0ZKaE,3224
@@ -11,7 +11,7 @@ growsurf/_resource.py,sha256=oeDA0FL2ottIchoUi86M_8eUqmtrGQLYTgfKYEzrsWg,1112
 growsurf/_response.py,sha256=RTZ8t27W4S6ExkCjzCg4HbcDUTCdOMgiheiMAuAxgu4,28937
 growsurf/_streaming.py,sha256=9aJ_V6JtddntWCon2Cq_MOLMnySnhc7wuqeZx7sUtKU,10558
 growsurf/_types.py,sha256=r8hAVihrutiLUToaJhSDys9T9sMc8BMy2qUrr3W_8Wo,7751
-growsurf/_version.py,sha256=FXvEzJyTPiTjJO8C3OjpXCjj-qzuaDwWsDUOXW5jhM0,160
+growsurf/_version.py,sha256=8sTKEyG6dzm-lh9DQJ-rPuFC2-kMk2irKInDZRAzlKQ,160
 growsurf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 growsurf/_utils/__init__.py,sha256=nQq-iFa5YxTaWySaLigatew5rHgTR0M75FNYm4mrO1s,2313
 growsurf/_utils/_compat.py,sha256=33246eDcl3pwL6kWsEhVuT4Akrd8gZEW9LPTm465ohk,1231
@@ -29,7 +29,7 @@ growsurf/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,47
 growsurf/_utils/_utils.py,sha256=2nPOzDrPe2GADpLCRM4bNQS8Mu7LjEiCG_LJ2AAL6jg,13111
 growsurf/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 growsurf/resources/__init__.py,sha256=svo5sO2EsnyOM5xM5o8_U1aiqywVAO94WN1nTT156I4,1041
-growsurf/resources/account.py,sha256=Er1fuVU8tbKFA7a-D6cjDpZYDhhliKBflCgovEZRt4E,24033
+growsurf/resources/account.py,sha256=2t0yIO0MUaqfuXJpTtLBqlan3qJoVXal2HRlA0peOq4,24461
 growsurf/resources/campaign/__init__.py,sha256=XW5nmnR2dF-wzM0d9aoF5cZDC7c-XyyIOjdmPV8IPZ8,4875
 growsurf/resources/campaign/campaign.py,sha256=4-sl6-D0Q68d1Al-_33MPZhKaqF5YFbQeqwhcmcaEk8,75401
 growsurf/resources/campaign/commission.py,sha256=K5HmznRM7nO-VNiP2Jy1rIeW63rAx1Aa2M9DEJ9dB2I,10294
@@ -38,7 +38,7 @@ growsurf/resources/campaign/emails.py,sha256=wGGP1hTPKGb-O7wRAvkGsMflKaoPMhpXyq2
 growsurf/resources/campaign/installation.py,sha256=36WbjO6ZDh_dDR4VHLNRxrgjbtkwYb6CbaPSc3KdbSw,11234
 growsurf/resources/campaign/options.py,sha256=OfXOBysKf7VW3IJFv7bSOcPnMXSETolRGiV2n6Ff0pQ,11130
 growsurf/resources/campaign/participant.py,sha256=ADDC6f5K8UW-ihsU5rwYHJVOWwPNVn4KOyq1JlWWfro,106610
-growsurf/resources/campaign/reward.py,sha256=AVPDhttbglDXnZE4onrCvf6Br6PdAohVV9WJgF7DsjY,14034
+growsurf/resources/campaign/reward.py,sha256=CLRzQywVF6zpjVG2S4OIKyBhaS9B9Obrjk6ENOicb30,14264
 growsurf/resources/campaign/rewards.py,sha256=x-fZvvo0gx--SEw_r1t6HHEr6aU5Ir4kh2pqFTsxiqw,34425
 growsurf/resources/campaign/webhooks.py,sha256=DRJ8-8QDibGEq1hT7MTkrlE5kdbEapZXiZb2z_kKM68,22666
 growsurf/types/__init__.py,sha256=Yj4kkVWCtct-IM6FrmErkEjJSVWuzsdszLFHs8FSk2w,2335
@@ -63,7 +63,7 @@ growsurf/types/participant_commission_list.py,sha256=NodpaTxYHY30DNfBp3m09BPv0Zu
 growsurf/types/participant_list.py,sha256=5oety8iTXx5anr0W5wAjzCAIMPkQLPeVIc2TNuRbrMY,430
 growsurf/types/participant_payout_list.py,sha256=93fM0_gS3ej8KbEpkEPsU8GHWnV-un0duWkuxePr_IQ,1493
 growsurf/types/referral_list.py,sha256=SOU3s0cjeQLhbZVbeGoeCprVyrPTk-tvmMBMV25uG1o,969
-growsurf/types/rotate_api_key_response.py,sha256=VdHLkSGMQ7ZF2WPiURKllo9Ok4aOD2Pd2uukPGkES1g,350
+growsurf/types/rotate_api_key_response.py,sha256=dzF80t7wkpHAso5u9QciHNzYww3qTsEmE9LJ4XAQPGM,376
 growsurf/types/verification_email_response.py,sha256=UYhx3DiXpWWgumukaezuiuIq_OME-3QE2_vG0TnwR00,292
 growsurf/types/campaign/__init__.py,sha256=cRjsIrPhEbMXTyyWY0IWanGk1SUgRd1IJUd7_9kOoC8,4944
 growsurf/types/campaign/campaign.py,sha256=Mm2bYeZnGFnghAPxvXPPhrbq8fzqAiqjeyDd-u9tP_E,3111
@@ -120,7 +120,7 @@ growsurf/types/campaign/webhook_list_response.py,sha256=tSk9nTbcsj5Y-j4RjQwu9SZc
 growsurf/types/campaign/webhook_test_params.py,sha256=X1Osg9-4KGJbZauG_7rDqTE7cKCypeSzgumIhnxj9dk,468
 growsurf/types/campaign/webhook_test_response.py,sha256=AahcckKSLUeIgpwlosOOmbkioF62xREXgLbieHAPAdI,576
 growsurf/types/campaign/webhook_update_params.py,sha256=SavKhws8pfybC7O40ovtCreEmOwihEGPOCEX9Iua9cE,598
-growsurf_python-1.1.1.dist-info/METADATA,sha256=PTpi26xeIYtYY53H6mT5P-Zbv0JDfDRAQQzLVFHaU_4,13614
-growsurf_python-1.1.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-growsurf_python-1.1.1.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
-growsurf_python-1.1.1.dist-info/RECORD,,
+growsurf_python-1.1.2.dist-info/METADATA,sha256=NGZ9XyRKo6pp1Ovkml1j0KUDOODoZ6FGDe4G78Gvoaw,13614
+growsurf_python-1.1.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+growsurf_python-1.1.2.dist-info/licenses/LICENSE,sha256=kTHLVE-ra1gtTxcn395uFqcOzcErebE-mDdPNW7b8OU,11338
+growsurf_python-1.1.2.dist-info/RECORD,,