stackshift 1.3.0__tar.gz → 1.3.1__tar.gz

{stackshift-1.3.0 → stackshift-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackshift
-Version: 1.3.0
+Version: 1.3.1
 Summary: Official Python SDK for StackShift.
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -16,6 +16,25 @@ Official Python SDK for StackShift.
 pip install stackshift
 ```
 
+## Partner platforms
+
+Staff-enabled partner accounts buy domains for merchants from their StackShift wallet. Use an API token with the `partner:manage` scope (and `mail:manage` to run campaigns) on your server:
+
+```python
+domain = stackshift.partner.purchase_domain(
+    domain="merchantshop.com",
+    years=1,
+    merchant_ref="m_123",
+    registrant={"first_name": "Ada", "last_name": "Obi", "email": "ada@merchantshop.com", "phone": "+2348012345678", "address": "1 Marina", "city": "Lagos", "state": "Lagos", "postal_code": "101001", "country": "NG"},
+    brand={"name": "Merchant Shop", "postalAddress": "1 Marina, Lagos, Nigeria"},
+    replies={"mode": "forward", "forwardTo": "ada@gmail.com"},
+    idempotency_key="order-m_123-1",
+)
+status = stackshift.partner.get_domain(domain["id"])
+```
+
+`partner` also exposes `overview`, `update_settings`, `list_domains` (with `q` and `attention` to find the merchants that need you), `retry_domain`, `get_diagnosis`, `restore_dns`, `transfer_out`, `resume_brand`, `get_complaints`, `list_complaint_sources`, `suppress_never_opened`, `undo_suppression`, `usage`, `list_requests` and `create_request`. `transfer_out` needs the `partner:transfer` scope (or `*`); `partner:manage` alone is refused. Purchases are capped at 30 per minute and, per partner, at 25 domains in a rolling 24 hours (429 `daily_purchase_limit`; staff can raise it). Validation errors are 400, state conflicts are 409. The `brand` and `replies` dictionaries use API camelCase keys.
+
 ## AI credits
 
 AI credits are account-scoped. Use the shared client to inspect usage, start a top-up, or select managed billing versus your own provider key:

{stackshift-1.3.0 → stackshift-1.3.1}/README.md

@@ -8,6 +8,25 @@ Official Python SDK for StackShift.
 pip install stackshift
 ```
 
+## Partner platforms
+
+Staff-enabled partner accounts buy domains for merchants from their StackShift wallet. Use an API token with the `partner:manage` scope (and `mail:manage` to run campaigns) on your server:
+
+```python
+domain = stackshift.partner.purchase_domain(
+    domain="merchantshop.com",
+    years=1,
+    merchant_ref="m_123",
+    registrant={"first_name": "Ada", "last_name": "Obi", "email": "ada@merchantshop.com", "phone": "+2348012345678", "address": "1 Marina", "city": "Lagos", "state": "Lagos", "postal_code": "101001", "country": "NG"},
+    brand={"name": "Merchant Shop", "postalAddress": "1 Marina, Lagos, Nigeria"},
+    replies={"mode": "forward", "forwardTo": "ada@gmail.com"},
+    idempotency_key="order-m_123-1",
+)
+status = stackshift.partner.get_domain(domain["id"])
+```
+
+`partner` also exposes `overview`, `update_settings`, `list_domains` (with `q` and `attention` to find the merchants that need you), `retry_domain`, `get_diagnosis`, `restore_dns`, `transfer_out`, `resume_brand`, `get_complaints`, `list_complaint_sources`, `suppress_never_opened`, `undo_suppression`, `usage`, `list_requests` and `create_request`. `transfer_out` needs the `partner:transfer` scope (or `*`); `partner:manage` alone is refused. Purchases are capped at 30 per minute and, per partner, at 25 domains in a rolling 24 hours (429 `daily_purchase_limit`; staff can raise it). Validation errors are 400, state conflicts are 409. The `brand` and `replies` dictionaries use API camelCase keys.
+
 ## AI credits
 
 AI credits are account-scoped. Use the shared client to inspect usage, start a top-up, or select managed billing versus your own provider key:

{stackshift-1.3.0 → stackshift-1.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "stackshift"
-version = "1.3.0"
+version = "1.3.1"
 description = "Official Python SDK for StackShift."
 readme = "README.md"
 requires-python = ">=3.9"

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/__init__.py

@@ -21,6 +21,7 @@ from .mail_mailboxes import (
     MailboxesClient,
     MailboxRoutesClient,
 )
+from .partner import PartnerClient
 from .projects import ProjectsClient
 from .workload_security import WorkloadSecurityClient
 
@@ -49,6 +50,7 @@ __all__ = [
     "MailboxImportsClient",
     "MailboxesClient",
     "MailboxRoutesClient",
+    "PartnerClient",
     "ProjectsClient",
     "WorkloadSecurityClient",
     "asset_transform_options",

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/assets.py

@@ -230,6 +230,23 @@ class AssetsClient(AssetWorkflowsMixin):
         headers = {"Idempotency-Key": idempotency_key} if idempotency_key else None
         return self._client.request("POST", path, headers=headers)
 
+    def usage(self, asset_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/assets/{quote(asset_id, safe='')}/usage")
+
+    def hold(self, asset_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/assets/{quote(asset_id, safe='')}/hold")
+
+    def create_reupload_request(
+        self, asset_id: str, *, email: str | None = None, message: str | None = None
+    ) -> dict[str, Any]:
+        payload = {key: value for key, value in {"email": email, "message": message}.items() if value}
+        return self._client.request(
+            "POST", f"/assets/{quote(asset_id, safe='')}/reupload-requests", json=payload
+        )
+
+    def reupload_requests(self, asset_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/assets/{quote(asset_id, safe='')}/reupload-requests")
+
     def versions(self, asset_id: str) -> dict[str, Any]:
         return self._client.request("GET", f"/assets/{asset_id}/versions")
 

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/assets_workflows.py

@@ -17,6 +17,14 @@ class AssetWorkflowsMixin:
             json={"name": name, "definition": definition, "eager": eager},
         )
 
+    def estimate_transform(
+        self, asset_id: str, version_id: str, definition: dict[str, Any]
+    ) -> dict[str, Any]:
+        return self._client.request(
+            "POST", f"/assets/{quote(asset_id, safe='')}/transforms/estimate",
+            json={"version_id": version_id, "definition": definition},
+        )
+
     def materialize_transform(
         self,
         asset_id: str,

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/client.py

@@ -29,6 +29,7 @@ class StackShift:
         from .ai_credits import AICreditsClient
         from .assets import AssetsClient
         from .mail import MailClient
+        from .partner import PartnerClient
         from .projects import ProjectsClient
         from .workload_security import WorkloadSecurityClient
 
@@ -36,6 +37,7 @@ class StackShift:
         self.projects = ProjectsClient(self)
         self.assets = AssetsClient(self)
         self.mail = MailClient(self)
+        self.partner = PartnerClient(self)
         self.workload_security = WorkloadSecurityClient(self)
 
     def request(self, method: str, path: str, **kwargs: Any) -> Any:

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/mail.py

@@ -311,12 +311,14 @@ class MailSuppressionsClient:
         *,
         email: str | None = None,
         reason: str | None = None,
+        brand_id: str | None = None,
         limit: int | None = None,
         cursor: str | None = None,
     ) -> dict[str, Any]:
         params = {
             "email": email,
             "reason": reason,
+            "brandId": brand_id,
             "limit": limit,
             "cursor": cursor,
         }

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/mail_billing.py

@@ -7,3 +7,6 @@ class MailBillingClient:
 
     def summary(self) -> dict[str, Any]:
         return self._client.mail_request("GET", "/mail/billing")
+
+    def period_usage(self, period: str) -> dict[str, Any]:
+        return self._client.mail_request("GET", "/mail/billing", params={"period": period})

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/mail_brands.py

@@ -28,7 +28,7 @@ class MailBrandsClient:
 
 
 def _brand_fields(fields: dict[str, Any]) -> dict[str, Any]:
-    names = {"logo_url": "logoUrl", "sending_domain_id": "sendingDomainId", "default_from": "defaultFrom", "reply_to": "replyTo", "postal_address": "postalAddress", "website": "website", "support_email": "supportEmail", "editable_fields": "editableFields"}
+    names = {"logo_url": "logoUrl", "sending_domain_id": "sendingDomainId", "default_from": "defaultFrom", "reply_to": "replyTo", "postal_address": "postalAddress", "website": "website", "support_email": "supportEmail", "editable_fields": "editableFields", "merchant_ref": "merchantRef"}
     unknown = fields.keys() - names.keys() - set(names.values())
     if unknown:
         raise ValueError("Unknown brand fields: " + ", ".join(sorted(unknown)))

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/mail_campaigns.py

@@ -12,8 +12,9 @@ class MailAudiencesClient:
         payload = {"brandId": brand_id, "name": name, "description": description}
         return self._client.mail_request("POST", "/mail/audiences", json={key: value for key, value in payload.items() if value is not None})
 
-    def list(self) -> dict[str, Any]:
-        return self._client.mail_request("GET", "/mail/audiences")
+    def list(self, *, brand_id: str | None = None) -> dict[str, Any]:
+        params = {"brandId": brand_id} if brand_id else None
+        return self._client.mail_request("GET", "/mail/audiences", params=params)
 
     def get(self, audience_id: str) -> dict[str, Any]:
         return self._client.mail_request("GET", f"/mail/audiences/{quote(audience_id, safe='')}")
@@ -83,8 +84,9 @@ class MailCampaignsClient:
         }
         return self._client.mail_request("POST", "/mail/campaigns", json={key: value for key, value in payload.items() if value is not None})
 
-    def list(self) -> dict[str, Any]:
-        return self._client.mail_request("GET", "/mail/campaigns")
+    def list(self, *, brand_id: str | None = None) -> dict[str, Any]:
+        params = {"brandId": brand_id} if brand_id else None
+        return self._client.mail_request("GET", "/mail/campaigns", params=params)
 
     def get(self, campaign_id: str) -> dict[str, Any]:
         return self._client.mail_request("GET", f"/mail/campaigns/{quote(campaign_id)}")

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift/mail_events_webhooks.py

@@ -79,6 +79,15 @@ class MailWebhooksClient:
     def rotate_secret(self, webhook_id: str) -> dict[str, Any]:
         return self._client.mail_request("POST", f"/mail/webhooks/{quote(webhook_id)}/rotate-secret")
 
+    def reveal_secret(self, webhook_id: str) -> dict[str, Any]:
+        return self._client.mail_request("POST", f"/mail/webhooks/{quote(webhook_id)}/reveal-secret")
+
+    def diagnosis(self, webhook_id: str) -> dict[str, Any]:
+        return self._client.mail_request("GET", f"/mail/webhooks/{quote(webhook_id)}/diagnosis")
+
+    def diagnose(self, webhook_id: str) -> dict[str, Any]:
+        return self._client.mail_request("POST", f"/mail/webhooks/{quote(webhook_id)}/diagnosis")
+
     def delete(self, webhook_id: str) -> None:
         self._client.mail_request("DELETE", f"/mail/webhooks/{quote(webhook_id)}")
 

stackshift-1.3.1/stackshift/partner.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import quote
+
+
+class PartnerClient:
+    def __init__(self, client: Any) -> None:
+        self._client = client
+
+    def overview(self) -> dict[str, Any]:
+        return self._client.request("GET", "/partner")
+
+    def update_settings(self, *, complaint_pause_rate: float, bounce_pause_rate: float) -> dict[str, Any]:
+        return self._client.request(
+            "PUT", "/partner/settings",
+            json={"complaintPauseRate": complaint_pause_rate, "bouncePauseRate": bounce_pause_rate},
+        )
+
+    def purchase_domain(
+        self,
+        *,
+        domain: str,
+        years: int,
+        merchant_ref: str,
+        registrant: dict[str, Any],
+        brand: dict[str, Any],
+        replies: dict[str, Any],
+        idempotency_key: str,
+        currency: str | None = None,
+    ) -> dict[str, Any]:
+        body = {"domain": domain, "years": years, "merchantRef": merchant_ref, "registrant": registrant, "brand": brand, "replies": replies}
+        if currency is not None:
+            body["currency"] = currency
+        return self._client.request("POST", "/partner/domains", headers={"Idempotency-Key": idempotency_key}, json=body)
+
+    def list_domains(
+        self,
+        *,
+        merchant_ref: str | None = None,
+        q: str | None = None,
+        attention: bool | None = None,
+        limit: int | None = None,
+        offset: int | None = None,
+    ) -> dict[str, Any]:
+        params = {"merchantRef": merchant_ref, "q": q, "attention": "true" if attention else None, "limit": limit, "offset": offset}
+        return self._client.request("GET", "/partner/domains", params={key: value for key, value in params.items() if value is not None})
+
+    def get_domain(self, domain_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/partner/domains/{quote(domain_id, safe='')}")
+
+    def retry_domain(self, domain_id: str) -> dict[str, Any]:
+        return self._client.request("POST", f"/partner/domains/{quote(domain_id, safe='')}/retry")
+
+    def transfer_out(self, domain_id: str) -> dict[str, Any]:
+        return self._client.request("POST", f"/partner/domains/{quote(domain_id, safe='')}/transfer-out")
+
+    def get_diagnosis(self, domain_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/partner/domains/{quote(domain_id, safe='')}/diagnosis")
+
+    def restore_dns(self, domain_id: str) -> dict[str, Any]:
+        return self._client.request("POST", f"/partner/domains/{quote(domain_id, safe='')}/restore-dns")
+
+    def resume_brand(self, brand_id: str) -> dict[str, Any]:
+        return self._client.request("POST", f"/partner/brands/{quote(brand_id, safe='')}/resume")
+
+    def get_complaints(self, brand_id: str) -> dict[str, Any]:
+        return self._client.request("GET", f"/partner/brands/{quote(brand_id, safe='')}/complaints")
+
+    def list_complaint_sources(self, brand_id: str) -> list[dict[str, Any]]:
+        return self._client.request("GET", f"/partner/brands/{quote(brand_id, safe='')}/complaints/sources")
+
+    def suppress_never_opened(self, brand_id: str, *, audience_id: str) -> dict[str, Any]:
+        return self._client.request(
+            "POST", f"/partner/brands/{quote(brand_id, safe='')}/suppressions/bulk",
+            json={"audienceId": audience_id, "reason": "never_opened"},
+        )
+
+    def undo_suppression(self, brand_id: str, bulk_id: str) -> dict[str, Any]:
+        return self._client.request("POST", f"/partner/brands/{quote(brand_id, safe='')}/suppressions/bulk/{quote(bulk_id, safe='')}/undo")
+
+    def usage(self, *, start: str | None = None, end: str | None = None) -> dict[str, Any]:
+        params = {"from": start, "to": end}
+        return self._client.request("GET", "/partner/usage", params={key: value for key, value in params.items() if value is not None})
+
+    def list_requests(self) -> dict[str, Any]:
+        return self._client.request("GET", "/partner/requests")
+
+    def create_request(self, *, kind: str, message: str | None = None) -> dict[str, Any]:
+        body = {"kind": kind}
+        if message is not None:
+            body["message"] = message
+        return self._client.request("POST", "/partner/requests", json=body)

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackshift
-Version: 1.3.0
+Version: 1.3.1
 Summary: Official Python SDK for StackShift.
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -16,6 +16,25 @@ Official Python SDK for StackShift.
 pip install stackshift
 ```
 
+## Partner platforms
+
+Staff-enabled partner accounts buy domains for merchants from their StackShift wallet. Use an API token with the `partner:manage` scope (and `mail:manage` to run campaigns) on your server:
+
+```python
+domain = stackshift.partner.purchase_domain(
+    domain="merchantshop.com",
+    years=1,
+    merchant_ref="m_123",
+    registrant={"first_name": "Ada", "last_name": "Obi", "email": "ada@merchantshop.com", "phone": "+2348012345678", "address": "1 Marina", "city": "Lagos", "state": "Lagos", "postal_code": "101001", "country": "NG"},
+    brand={"name": "Merchant Shop", "postalAddress": "1 Marina, Lagos, Nigeria"},
+    replies={"mode": "forward", "forwardTo": "ada@gmail.com"},
+    idempotency_key="order-m_123-1",
+)
+status = stackshift.partner.get_domain(domain["id"])
+```
+
+`partner` also exposes `overview`, `update_settings`, `list_domains` (with `q` and `attention` to find the merchants that need you), `retry_domain`, `get_diagnosis`, `restore_dns`, `transfer_out`, `resume_brand`, `get_complaints`, `list_complaint_sources`, `suppress_never_opened`, `undo_suppression`, `usage`, `list_requests` and `create_request`. `transfer_out` needs the `partner:transfer` scope (or `*`); `partner:manage` alone is refused. Purchases are capped at 30 per minute and, per partner, at 25 domains in a rolling 24 hours (429 `daily_purchase_limit`; staff can raise it). Validation errors are 400, state conflicts are 409. The `brand` and `replies` dictionaries use API camelCase keys.
+
 ## AI credits
 
 AI credits are account-scoped. Use the shared client to inspect usage, start a top-up, or select managed billing versus your own provider key:

{stackshift-1.3.0 → stackshift-1.3.1}/stackshift.egg-info/SOURCES.txt

@@ -22,6 +22,7 @@ stackshift/mail_migration.py
 stackshift/mail_reputation.py
 stackshift/mail_streams.py
 stackshift/mail_tracking.py
+stackshift/partner.py
 stackshift/projects.py
 stackshift/support_action_manifest.py
 stackshift/support_action_receiver.py
@@ -48,4 +49,5 @@ tests/test_mail_platform.py
 tests/test_mail_simulation.py
 tests/test_mail_subscribers.py
 tests/test_mail_tracking.py
+tests/test_partner.py
 tests/test_support_actions.py

{stackshift-1.3.0 → stackshift-1.3.1}/tests/test_assets_workflows.py

@@ -22,6 +22,23 @@ def test_transform_generation_and_workflow_routes():
     assert options["json"] == {"preset": "web-ready"}
     assert options["headers"]["Idempotency-Key"] == "render-1"
 
+    definition = {"version": 2, "media_kind": "image", "operations": [{"type": "remove_background"}], "output": {"kind": "image", "format": "webp"}}
+    assets.estimate_transform("asset/1", "version-1", definition)
+    method, path, options = transport.calls[-1]
+    assert (method, path) == ("POST", "/assets/asset%2F1/transforms/estimate")
+    assert options["json"] == {"version_id": "version-1", "definition": definition}
+
+    assets.usage("asset/1")
+    assert transport.calls[-1][:2] == ("GET", "/assets/asset%2F1/usage")
+    assets.hold("asset/1")
+    assert transport.calls[-1][:2] == ("GET", "/assets/asset%2F1/hold")
+    assets.create_reupload_request("asset/1", email="owner@example.com")
+    method, path, options = transport.calls[-1]
+    assert (method, path) == ("POST", "/assets/asset%2F1/reupload-requests")
+    assert options["json"] == {"email": "owner@example.com"}
+    assets.reupload_requests("asset/1")
+    assert transport.calls[-1][:2] == ("GET", "/assets/asset%2F1/reupload-requests")
+
     assets.generate(
         {"prompt": "A violet nebula", "size": "1024x1024", "format": "png", "bucket": "generated"},
         idempotency_key="generation-1",

{stackshift-1.3.0 → stackshift-1.3.1}/tests/test_mail_events_webhooks.py

@@ -43,6 +43,12 @@ class FakeSession:
             return FakeResponse(200, {"data": [webhook_response()], "nextCursor": None})
         if url.endswith("/mail/webhooks/wh_123/rotate-secret"):
             return FakeResponse(200, {"secret": "whsec_new"})
+        if url.endswith("/mail/webhooks/wh_123/reveal-secret"):
+            return FakeResponse(200, {"secret": "whsec_revealed"})
+        if url.endswith("/mail/webhooks/wh_123/diagnosis") and method == "POST":
+            return FakeResponse(200, {"diagnosis": {"checkedAt": "2026-05-09T12:00:00Z", "repliesRead": 3, "summary": "The endpoint answers 500 to every delivery."}})
+        if url.endswith("/mail/webhooks/wh_123/diagnosis"):
+            return FakeResponse(200, {"diagnosis": None})
         if url.endswith("/mail/webhooks/wh_123/deliveries"):
             return FakeResponse(200, {"data": [delivery_response("failed")], "nextCursor": None})
         if url.endswith("/mail/webhooks/wh_123") and method == "PATCH":
@@ -90,6 +96,19 @@ class MailEventsWebhooksSDKTest(unittest.TestCase):
         rotated = stackshift.mail.webhooks.rotate_secret("wh_123")
         self.assertEqual(rotated["secret"], "whsec_new")
 
+        revealed = stackshift.mail.webhooks.reveal_secret("wh_123")
+        self.assertEqual(revealed["secret"], "whsec_revealed")
+        self.assertEqual(session.calls[-1][0], "POST")
+
+        stored = stackshift.mail.webhooks.diagnosis("wh_123")
+        self.assertIsNone(stored["diagnosis"])
+        self.assertEqual(session.calls[-1][0], "GET")
+        self.assertTrue(session.calls[-1][1].endswith("/mail/webhooks/wh_123/diagnosis"))
+
+        diagnosed = stackshift.mail.webhooks.diagnose("wh_123")
+        self.assertEqual(diagnosed["diagnosis"]["repliesRead"], 3)
+        self.assertEqual(session.calls[-1][0], "POST")
+
         deliveries = stackshift.mail.webhooks.deliveries("wh_123", status="failed")
         self.assertEqual(deliveries["data"][0]["status"], "failed")
 

{stackshift-1.3.0 → stackshift-1.3.1}/tests/test_mail_platform.py

@@ -27,3 +27,27 @@ class MailPlatformTests(unittest.TestCase):
         self.assertEqual(transport.path, "/mail/billing")
         mail.migration.save_checklist("example.com", "resend", ["audit"], revision=1)
         self.assertEqual(transport.payload, {"domain": "example.com", "provider": "resend", "completed": ["audit"], "revision": 1})
+
+
+class ParamsTransport:
+    def mail_request(self, method, path, **kwargs):
+        self.method, self.path, self.params = method, path, kwargs.get("params")
+        return {"data": []}
+
+
+class MailBrandScopedReadTests(unittest.TestCase):
+    def test_billing_period_and_brand_filters(self):
+        transport = ParamsTransport()
+        mail = MailClient(transport)
+        mail.billing.period_usage("2026-09")
+        self.assertEqual((transport.method, transport.path, transport.params), ("GET", "/mail/billing", {"period": "2026-09"}))
+        mail.audiences.list(brand_id="brand_1")
+        self.assertEqual((transport.path, transport.params), ("/mail/audiences", {"brandId": "brand_1"}))
+        mail.audiences.list()
+        self.assertIsNone(transport.params)
+        mail.campaigns.list(brand_id="brand_1")
+        self.assertEqual((transport.path, transport.params), ("/mail/campaigns", {"brandId": "brand_1"}))
+        mail.campaigns.list()
+        self.assertIsNone(transport.params)
+        mail.suppressions.list(brand_id="brand_1", reason="complaint")
+        self.assertEqual((transport.path, transport.params), ("/mail/suppressions", {"reason": "complaint", "brandId": "brand_1"}))

stackshift-1.3.1/tests/test_partner.py

@@ -0,0 +1,82 @@
+import unittest
+
+from stackshift import StackShift
+from stackshift.partner import PartnerClient
+
+
+class RecordingClient:
+    def __init__(self):
+        self.calls = []
+
+    def request(self, *args, **kwargs):
+        self.calls.append((args, kwargs))
+        return {"id": "result"}
+
+
+class PartnerClientTests(unittest.TestCase):
+    def test_requests_use_the_partner_routes_and_purchase_idempotency(self):
+        client = RecordingClient()
+        partner = PartnerClient(client)
+        registrant = {"first_name": "Ada", "last_name": "Obi", "email": "ada@merchantshop.com", "phone": "+2348012345678", "address": "1 Marina", "city": "Lagos", "state": "Lagos", "postal_code": "101001", "country": "NG"}
+        brand = {"name": "Merchant Shop", "postalAddress": "1 Marina, Lagos"}
+        replies = {"mode": "forward", "forwardTo": "ada@gmail.com"}
+
+        self.assertEqual(partner.overview(), {"id": "result"})
+        partner.update_settings(complaint_pause_rate=0.002, bounce_pause_rate=0.04)
+        partner.purchase_domain(domain="merchantshop.com", years=1, merchant_ref="m_123", registrant=registrant, brand=brand, replies=replies, idempotency_key="order-1", currency="USD")
+        partner.list_domains(merchant_ref="m_123", limit=20)
+        partner.list_domains()
+        partner.get_domain("dom/1")
+        partner.retry_domain("dom_1")
+        partner.transfer_out("dom_1")
+        partner.resume_brand("brand_1")
+        partner.usage(start="2026-10-01T00:00:00Z", end="2026-11-01T00:00:00Z")
+        partner.list_domains(q="shop", attention=True)
+        partner.get_diagnosis("dom/1")
+        partner.restore_dns("dom_1")
+        partner.get_complaints("brand_1")
+        partner.list_complaint_sources("brand_1")
+        partner.suppress_never_opened("brand_1", audience_id="aud_1")
+        partner.undo_suppression("brand_1", "bulk/1")
+        partner.create_request(kind="purchase_limit", message="We onboard 100 merchants a day.")
+        partner.create_request(kind="dedicated_addresses")
+        partner.list_requests()
+        calls = client.calls
+
+        self.assertEqual(calls[0][0], ("GET", "/partner"))
+        self.assertEqual(calls[1][0], ("PUT", "/partner/settings"))
+        self.assertEqual(calls[1][1]["json"], {"complaintPauseRate": 0.002, "bouncePauseRate": 0.04})
+        self.assertEqual(calls[2][0], ("POST", "/partner/domains"))
+        self.assertEqual(calls[2][1]["headers"], {"Idempotency-Key": "order-1"})
+        self.assertEqual(calls[2][1]["json"], {"domain": "merchantshop.com", "years": 1, "merchantRef": "m_123", "registrant": registrant, "brand": brand, "replies": replies, "currency": "USD"})
+        self.assertEqual(calls[3][1]["params"], {"merchantRef": "m_123", "limit": 20})
+        self.assertEqual(calls[4][1]["params"], {})
+        self.assertEqual(calls[5][0], ("GET", "/partner/domains/dom%2F1"))
+        self.assertEqual(calls[6][0], ("POST", "/partner/domains/dom_1/retry"))
+        self.assertEqual(calls[7][0], ("POST", "/partner/domains/dom_1/transfer-out"))
+        self.assertEqual(calls[8][0], ("POST", "/partner/brands/brand_1/resume"))
+        self.assertEqual(calls[9][1]["params"], {"from": "2026-10-01T00:00:00Z", "to": "2026-11-01T00:00:00Z"})
+        self.assertEqual(calls[10][1]["params"], {"q": "shop", "attention": "true"})
+        self.assertEqual(calls[11][0], ("GET", "/partner/domains/dom%2F1/diagnosis"))
+        self.assertEqual(calls[12][0], ("POST", "/partner/domains/dom_1/restore-dns"))
+        self.assertEqual(calls[13][0], ("GET", "/partner/brands/brand_1/complaints"))
+        self.assertEqual(calls[14][0], ("GET", "/partner/brands/brand_1/complaints/sources"))
+        self.assertEqual(calls[15][0], ("POST", "/partner/brands/brand_1/suppressions/bulk"))
+        self.assertEqual(calls[15][1]["json"], {"audienceId": "aud_1", "reason": "never_opened"})
+        self.assertEqual(calls[16][0], ("POST", "/partner/brands/brand_1/suppressions/bulk/bulk%2F1/undo"))
+        self.assertEqual(calls[17][0], ("POST", "/partner/requests"))
+        self.assertEqual(calls[17][1]["json"], {"kind": "purchase_limit", "message": "We onboard 100 merchants a day."})
+        self.assertEqual(calls[18][1]["json"], {"kind": "dedicated_addresses"})
+        self.assertEqual(calls[19][0], ("GET", "/partner/requests"))
+
+    def test_shared_client_exposes_partner_and_brand_merchant_reference(self):
+        shared = StackShift(api_key="sspat_fixture")
+        self.assertIsInstance(shared.partner, PartnerClient)
+        calls = []
+        shared.mail_request = lambda *args, **kwargs: calls.append((args, kwargs)) or {}
+        shared.mail.brands.create(name="Shop", merchant_ref="m_123", postal_address="1 Marina")
+        self.assertEqual(calls[0][1]["json"], {"name": "Shop", "merchantRef": "m_123", "postalAddress": "1 Marina"})
+
+
+if __name__ == "__main__":
+    unittest.main()