agentref 1.0.3__tar.gz → 2.0.0__tar.gz

{agentref-1.0.3 → agentref-2.0.0}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.4
+
+- **Fix:** `payout_info.update()` now sends `PATCH` instead of `PUT` to match the API contract.
+- Added optional `include` parameter to `affiliates.get(id, include='stats')` for fetching aggregated stats.
+
 ## 1.0.3
 
 - Added `search`, `sort_by`, `sort_order`, `status` parameters to `affiliates.list()`.

{agentref-1.0.3 → agentref-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agentref
-Version: 1.0.3
+Version: 2.0.0
 Summary: Official Python SDK for the AgentRef Affiliate API
 Author-email: AgentRef <hi@agentref.dev>
 License: MIT

{agentref-1.0.3 → agentref-2.0.0}/agentref/client.py

@@ -10,12 +10,16 @@ from .resources import (
     AsyncConversionsResource,
     AsyncFlagsResource,
     AsyncMerchantResource,
+    AsyncNotificationsResource,
+    AsyncPayoutInfoResource,
     AsyncPayoutsResource,
     AsyncProgramsResource,
     BillingResource,
     ConversionsResource,
     FlagsResource,
     MerchantResource,
+    NotificationsResource,
+    PayoutInfoResource,
     PayoutsResource,
     ProgramsResource,
 )
@@ -44,13 +48,15 @@ class AgentRef:
         self.flags = FlagsResource(self._http)
         self.billing = BillingResource(self._http)
         self.merchant = MerchantResource(self._http)
+        self.notifications = NotificationsResource(self._http)
+        self.payout_info = PayoutInfoResource(self._http)
 
     def close(self) -> None:
         self._http.close()
 
 
 class AsyncAgentRef:
-    """Async variant — use as async context manager for connection pooling."""
+    """Async variant -- use as async context manager for connection pooling."""
 
     def __init__(
         self,
@@ -74,6 +80,8 @@ class AsyncAgentRef:
         self.flags = AsyncFlagsResource(self._http)
         self.billing = AsyncBillingResource(self._http)
         self.merchant = AsyncMerchantResource(self._http)
+        self.notifications = AsyncNotificationsResource(self._http)
+        self.payout_info = AsyncPayoutInfoResource(self._http)
 
     async def __aenter__(self) -> "AsyncAgentRef":
         await self._http.__aenter__()

{agentref-1.0.3 → agentref-2.0.0}/agentref/resources/__init__.py

@@ -3,6 +3,8 @@ from .billing import AsyncBillingResource, BillingResource
 from .conversions import AsyncConversionsResource, ConversionsResource
 from .flags import AsyncFlagsResource, FlagsResource
 from .merchant import AsyncMerchantResource, MerchantResource
+from .notifications import AsyncNotificationsResource, NotificationsResource
+from .payout_info import AsyncPayoutInfoResource, PayoutInfoResource
 from .payouts import AsyncPayoutsResource, PayoutsResource
 from .programs import AsyncProgramsResource, ProgramsResource
 
@@ -14,6 +16,8 @@ __all__ = [
     "FlagsResource",
     "BillingResource",
     "MerchantResource",
+    "NotificationsResource",
+    "PayoutInfoResource",
     "AsyncProgramsResource",
     "AsyncAffiliatesResource",
     "AsyncConversionsResource",
@@ -21,4 +25,6 @@ __all__ = [
     "AsyncFlagsResource",
     "AsyncBillingResource",
     "AsyncMerchantResource",
+    "AsyncNotificationsResource",
+    "AsyncPayoutInfoResource",
 ]

{agentref-1.0.3 → agentref-2.0.0}/agentref/resources/affiliates.py

@@ -1,10 +1,14 @@
 from __future__ import annotations
 
-from typing import Optional
+from typing import Literal, Optional
 
 from .._http import AsyncHttpClient, SyncHttpClient
 from ..types.models import Affiliate, PaginatedResponse
 
+_SORT_BY = Literal["createdAt", "totalClicks", "totalRevenue", "name"]
+_SORT_ORDER = Literal["asc", "desc"]
+_STATUS = Literal["approved", "pending", "blocked"]
+
 
 class AffiliatesResource:
     def __init__(self, http: SyncHttpClient) -> None:
@@ -15,6 +19,10 @@ class AffiliatesResource:
         *,
         program_id: Optional[str] = None,
         include_blocked: Optional[bool] = None,
+        search: Optional[str] = None,
+        sort_by: Optional[_SORT_BY] = None,
+        sort_order: Optional[_SORT_ORDER] = None,
+        status: Optional[_STATUS] = None,
         cursor: Optional[str] = None,
         limit: Optional[int] = None,
         page: Optional[int] = None,
@@ -27,6 +35,10 @@ class AffiliatesResource:
             params={
                 "programId": program_id,
                 "includeBlocked": include_blocked,
+                "search": search,
+                "sortBy": sort_by,
+                "sortOrder": sort_order,
+                "status": status,
                 "cursor": cursor,
                 "limit": limit,
                 "page": page,
@@ -36,8 +48,9 @@ class AffiliatesResource:
         )
         return PaginatedResponse[Affiliate].model_validate(envelope)
 
-    def get(self, id: str) -> Affiliate:
-        envelope = self._http.request("GET", f"/affiliates/{id}")
+    def get(self, id: str, *, include: Optional[str] = None) -> Affiliate:
+        params = {"include": include} if include else None
+        envelope = self._http.request("GET", f"/affiliates/{id}", params=params)
         return Affiliate.model_validate(envelope["data"])
 
     def approve(self, id: str, *, idempotency_key: Optional[str] = None) -> Affiliate:
@@ -73,6 +86,10 @@ class AsyncAffiliatesResource:
         *,
         program_id: Optional[str] = None,
         include_blocked: Optional[bool] = None,
+        search: Optional[str] = None,
+        sort_by: Optional[_SORT_BY] = None,
+        sort_order: Optional[_SORT_ORDER] = None,
+        status: Optional[_STATUS] = None,
         cursor: Optional[str] = None,
         limit: Optional[int] = None,
         page: Optional[int] = None,
@@ -85,6 +102,10 @@ class AsyncAffiliatesResource:
             params={
                 "programId": program_id,
                 "includeBlocked": include_blocked,
+                "search": search,
+                "sortBy": sort_by,
+                "sortOrder": sort_order,
+                "status": status,
                 "cursor": cursor,
                 "limit": limit,
                 "page": page,
@@ -94,8 +115,9 @@ class AsyncAffiliatesResource:
         )
         return PaginatedResponse[Affiliate].model_validate(envelope)
 
-    async def get(self, id: str) -> Affiliate:
-        envelope = await self._http.request("GET", f"/affiliates/{id}")
+    async def get(self, id: str, *, include: Optional[str] = None) -> Affiliate:
+        params = {"include": include} if include else None
+        envelope = await self._http.request("GET", f"/affiliates/{id}", params=params)
         return Affiliate.model_validate(envelope["data"])
 
     async def approve(self, id: str, *, idempotency_key: Optional[str] = None) -> Affiliate:

{agentref-1.0.3 → agentref-2.0.0}/agentref/resources/merchant.py

@@ -23,6 +23,9 @@ class MerchantResource:
         timezone: Optional[str] = None,
         default_cookie_duration: Optional[int] = None,
         default_payout_threshold: Optional[int] = None,
+        tracking_requires_consent: Optional[bool] = None,
+        tracking_param_aliases: Optional[list[str]] = None,
+        tracking_legacy_metadata_fallback_enabled: Optional[bool] = None,
     ) -> Merchant:
         payload = UpdateMerchantParams(
             company_name=company_name,
@@ -31,6 +34,9 @@ class MerchantResource:
             timezone=timezone,
             default_cookie_duration=default_cookie_duration,
             default_payout_threshold=default_payout_threshold,
+            tracking_requires_consent=tracking_requires_consent,
+            tracking_param_aliases=tracking_param_aliases,
+            tracking_legacy_metadata_fallback_enabled=tracking_legacy_metadata_fallback_enabled,
         ).model_dump(by_alias=True, exclude_none=True)
         envelope = self._http.request("PATCH", "/merchant", json=payload)
         return Merchant.model_validate(envelope["data"])
@@ -61,6 +67,9 @@ class AsyncMerchantResource:
         timezone: Optional[str] = None,
         default_cookie_duration: Optional[int] = None,
         default_payout_threshold: Optional[int] = None,
+        tracking_requires_consent: Optional[bool] = None,
+        tracking_param_aliases: Optional[list[str]] = None,
+        tracking_legacy_metadata_fallback_enabled: Optional[bool] = None,
     ) -> Merchant:
         payload = UpdateMerchantParams(
             company_name=company_name,
@@ -69,6 +78,9 @@ class AsyncMerchantResource:
             timezone=timezone,
             default_cookie_duration=default_cookie_duration,
             default_payout_threshold=default_payout_threshold,
+            tracking_requires_consent=tracking_requires_consent,
+            tracking_param_aliases=tracking_param_aliases,
+            tracking_legacy_metadata_fallback_enabled=tracking_legacy_metadata_fallback_enabled,
         ).model_dump(by_alias=True, exclude_none=True)
         envelope = await self._http.request("PATCH", "/merchant", json=payload)
         return Merchant.model_validate(envelope["data"])

agentref-2.0.0/agentref/resources/notifications.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from typing import Optional
+
+from .._http import AsyncHttpClient, SyncHttpClient
+from ..types.models import NotificationPreferences, UpdateNotificationPreferencesParams
+
+
+class NotificationsResource:
+    def __init__(self, http: SyncHttpClient) -> None:
+        self._http = http
+
+    def get(self) -> NotificationPreferences:
+        envelope = self._http.request("GET", "/merchant/notifications")
+        return NotificationPreferences.model_validate(envelope["data"])
+
+    def update(
+        self,
+        *,
+        new_affiliate: Optional[bool] = None,
+        new_conversion: Optional[bool] = None,
+        commission_approved: Optional[bool] = None,
+        payout_processed: Optional[bool] = None,
+        weekly_digest: Optional[bool] = None,
+    ) -> NotificationPreferences:
+        payload = UpdateNotificationPreferencesParams(
+            new_affiliate=new_affiliate,
+            new_conversion=new_conversion,
+            commission_approved=commission_approved,
+            payout_processed=payout_processed,
+            weekly_digest=weekly_digest,
+        ).model_dump(by_alias=True, exclude_none=True)
+        envelope = self._http.request("PUT", "/merchant/notifications", json=payload)
+        return NotificationPreferences.model_validate(envelope["data"])
+
+
+class AsyncNotificationsResource:
+    def __init__(self, http: AsyncHttpClient) -> None:
+        self._http = http
+
+    async def get(self) -> NotificationPreferences:
+        envelope = await self._http.request("GET", "/merchant/notifications")
+        return NotificationPreferences.model_validate(envelope["data"])
+
+    async def update(
+        self,
+        *,
+        new_affiliate: Optional[bool] = None,
+        new_conversion: Optional[bool] = None,
+        commission_approved: Optional[bool] = None,
+        payout_processed: Optional[bool] = None,
+        weekly_digest: Optional[bool] = None,
+    ) -> NotificationPreferences:
+        payload = UpdateNotificationPreferencesParams(
+            new_affiliate=new_affiliate,
+            new_conversion=new_conversion,
+            commission_approved=commission_approved,
+            payout_processed=payout_processed,
+            weekly_digest=weekly_digest,
+        ).model_dump(by_alias=True, exclude_none=True)
+        envelope = await self._http.request("PUT", "/merchant/notifications", json=payload)
+        return NotificationPreferences.model_validate(envelope["data"])

agentref-2.0.0/agentref/resources/payout_info.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+from typing import Optional
+
+from .._http import AsyncHttpClient, SyncHttpClient
+from ..types.models import PayoutInfo, UpdatePayoutInfoParams
+
+
+class PayoutInfoResource:
+    def __init__(self, http: SyncHttpClient) -> None:
+        self._http = http
+
+    def get(self) -> PayoutInfo:
+        envelope = self._http.request("GET", "/me/payout-info")
+        return PayoutInfo.model_validate(envelope["data"])
+
+    def update(
+        self,
+        *,
+        payout_method: Optional[str] = None,
+        paypal_email: Optional[str] = None,
+        bank_account_holder: Optional[str] = None,
+        bank_iban: Optional[str] = None,
+        bank_bic: Optional[str] = None,
+        first_name: Optional[str] = None,
+        last_name: Optional[str] = None,
+        address_line1: Optional[str] = None,
+        address_line2: Optional[str] = None,
+        city: Optional[str] = None,
+        state: Optional[str] = None,
+        postal_code: Optional[str] = None,
+        vat_id: Optional[str] = None,
+    ) -> PayoutInfo:
+        payload = UpdatePayoutInfoParams(
+            payout_method=payout_method,
+            paypal_email=paypal_email,
+            bank_account_holder=bank_account_holder,
+            bank_iban=bank_iban,
+            bank_bic=bank_bic,
+            first_name=first_name,
+            last_name=last_name,
+            address_line1=address_line1,
+            address_line2=address_line2,
+            city=city,
+            state=state,
+            postal_code=postal_code,
+            vat_id=vat_id,
+        ).model_dump(by_alias=True, exclude_none=True)
+        envelope = self._http.request("PATCH", "/me/payout-info", json=payload)
+        return PayoutInfo.model_validate(envelope["data"])
+
+
+class AsyncPayoutInfoResource:
+    def __init__(self, http: AsyncHttpClient) -> None:
+        self._http = http
+
+    async def get(self) -> PayoutInfo:
+        envelope = await self._http.request("GET", "/me/payout-info")
+        return PayoutInfo.model_validate(envelope["data"])
+
+    async def update(
+        self,
+        *,
+        payout_method: Optional[str] = None,
+        paypal_email: Optional[str] = None,
+        bank_account_holder: Optional[str] = None,
+        bank_iban: Optional[str] = None,
+        bank_bic: Optional[str] = None,
+        first_name: Optional[str] = None,
+        last_name: Optional[str] = None,
+        address_line1: Optional[str] = None,
+        address_line2: Optional[str] = None,
+        city: Optional[str] = None,
+        state: Optional[str] = None,
+        postal_code: Optional[str] = None,
+        vat_id: Optional[str] = None,
+    ) -> PayoutInfo:
+        payload = UpdatePayoutInfoParams(
+            payout_method=payout_method,
+            paypal_email=paypal_email,
+            bank_account_holder=bank_account_holder,
+            bank_iban=bank_iban,
+            bank_bic=bank_bic,
+            first_name=first_name,
+            last_name=last_name,
+            address_line1=address_line1,
+            address_line2=address_line2,
+            city=city,
+            state=state,
+            postal_code=postal_code,
+            vat_id=vat_id,
+        ).model_dump(by_alias=True, exclude_none=True)
+        envelope = await self._http.request("PATCH", "/me/payout-info", json=payload)
+        return PayoutInfo.model_validate(envelope["data"])

{agentref-1.0.3 → agentref-2.0.0}/agentref/resources/programs.py

@@ -68,6 +68,8 @@ class ProgramsResource:
         description: Optional[str] = None,
         landing_page_url: Optional[str] = None,
         commission_limit_months: Optional[int] = None,
+        portal_slug: Optional[str] = None,
+        currency: Optional[str] = None,
         idempotency_key: Optional[str] = None,
     ) -> Program:
         body: Dict[str, Any] = {
@@ -80,6 +82,8 @@ class ProgramsResource:
             "description": description,
             "landingPageUrl": landing_page_url,
             "commissionLimitMonths": commission_limit_months,
+            "portalSlug": portal_slug,
+            "currency": currency,
         }
         envelope = self._http.request(
             "POST",
@@ -102,8 +106,9 @@ class ProgramsResource:
         description: Optional[str] = None,
         landing_page_url: Optional[str] = None,
         status: Optional[Literal["active", "paused", "archived"]] = None,
-        is_public: Optional[bool] = None,
         commission_limit_months: Optional[int] = None,
+        portal_slug: Optional[str] = None,
+        currency: Optional[str] = None,
     ) -> Program:
         body: Dict[str, Any] = {
             "name": name,
@@ -115,8 +120,9 @@ class ProgramsResource:
             "description": description,
             "landingPageUrl": landing_page_url,
             "status": status,
-            "isPublic": is_public,
             "commissionLimitMonths": commission_limit_months,
+            "portalSlug": portal_slug,
+            "currency": currency,
         }
         envelope = self._http.request("PATCH", f"/programs/{id}", json={k: v for k, v in body.items() if v is not None})
         return Program.model_validate(envelope["data"])
@@ -191,6 +197,8 @@ class ProgramsResource:
         is_public: Optional[bool] = None,
         usage_limit: Optional[int] = None,
         expires_in_days: Optional[int] = None,
+        tracking_code: Optional[str] = None,
+        skip_onboarding: Optional[bool] = None,
         idempotency_key: Optional[str] = None,
     ) -> Invite:
         body = {
@@ -199,6 +207,8 @@ class ProgramsResource:
             "isPublic": is_public,
             "usageLimit": usage_limit,
             "expiresInDays": expires_in_days,
+            "trackingCode": tracking_code,
+            "skipOnboarding": skip_onboarding,
         }
         envelope = self._http.request(
             "POST",
@@ -223,7 +233,7 @@ class ProgramsResource:
         self,
         id: str,
         *,
-        status: Optional[Literal["private", "public"]] = None,
+        status: Optional[Literal["private", "pending", "public"]] = None,
         category: Optional[str] = None,
         description: Optional[str] = None,
         logo_url: Optional[str] = None,
@@ -293,6 +303,8 @@ class AsyncProgramsResource:
         description: Optional[str] = None,
         landing_page_url: Optional[str] = None,
         commission_limit_months: Optional[int] = None,
+        portal_slug: Optional[str] = None,
+        currency: Optional[str] = None,
         idempotency_key: Optional[str] = None,
     ) -> Program:
         body: Dict[str, Any] = {
@@ -305,6 +317,8 @@ class AsyncProgramsResource:
             "description": description,
             "landingPageUrl": landing_page_url,
             "commissionLimitMonths": commission_limit_months,
+            "portalSlug": portal_slug,
+            "currency": currency,
         }
         envelope = await self._http.request(
             "POST",
@@ -327,8 +341,9 @@ class AsyncProgramsResource:
         description: Optional[str] = None,
         landing_page_url: Optional[str] = None,
         status: Optional[Literal["active", "paused", "archived"]] = None,
-        is_public: Optional[bool] = None,
         commission_limit_months: Optional[int] = None,
+        portal_slug: Optional[str] = None,
+        currency: Optional[str] = None,
     ) -> Program:
         body: Dict[str, Any] = {
             "name": name,
@@ -340,8 +355,9 @@ class AsyncProgramsResource:
             "description": description,
             "landingPageUrl": landing_page_url,
             "status": status,
-            "isPublic": is_public,
             "commissionLimitMonths": commission_limit_months,
+            "portalSlug": portal_slug,
+            "currency": currency,
         }
         envelope = await self._http.request("PATCH", f"/programs/{id}", json={k: v for k, v in body.items() if v is not None})
         return Program.model_validate(envelope["data"])
@@ -416,6 +432,8 @@ class AsyncProgramsResource:
         is_public: Optional[bool] = None,
         usage_limit: Optional[int] = None,
         expires_in_days: Optional[int] = None,
+        tracking_code: Optional[str] = None,
+        skip_onboarding: Optional[bool] = None,
         idempotency_key: Optional[str] = None,
     ) -> Invite:
         body = {
@@ -424,6 +442,8 @@ class AsyncProgramsResource:
             "isPublic": is_public,
             "usageLimit": usage_limit,
             "expiresInDays": expires_in_days,
+            "trackingCode": tracking_code,
+            "skipOnboarding": skip_onboarding,
         }
         envelope = await self._http.request(
             "POST",
@@ -448,7 +468,7 @@ class AsyncProgramsResource:
         self,
         id: str,
         *,
-        status: Optional[Literal["private", "public"]] = None,
+        status: Optional[Literal["private", "pending", "public"]] = None,
         category: Optional[str] = None,
         description: Optional[str] = None,
         logo_url: Optional[str] = None,

{agentref-1.0.3 → agentref-2.0.0}/agentref/types/__init__.py

@@ -11,8 +11,10 @@ from .models import (
     Invite,
     Merchant,
     MerchantDomainStatus,
+    NotificationPreferences,
     PaginatedResponse,
     PaginationMeta,
+    PayoutInfo,
     PendingAffiliate,
     Payout,
     PayoutStats,
@@ -21,6 +23,8 @@ from .models import (
     ResolveFlagParams,
     StripeConnectSession,
     UpdateMerchantParams,
+    UpdateNotificationPreferencesParams,
+    UpdatePayoutInfoParams,
     UpdateProgramMarketplaceParams,
 )
 
@@ -48,4 +52,8 @@ __all__ = [
     "UpdateProgramMarketplaceParams",
     "Coupon",
     "Invite",
+    "PayoutInfo",
+    "UpdatePayoutInfoParams",
+    "NotificationPreferences",
+    "UpdateNotificationPreferencesParams",
 ]