stackshift 1.3.0__py3-none-any.whl → 1.3.1__py3-none-any.whl

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/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/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/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/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/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/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/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/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/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.dist-info → stackshift-1.3.1.dist-info}/METADATA

@@ -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.dist-info → stackshift-1.3.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
-stackshift/__init__.py,sha256=ZCrX0NbSdv2Df1hQ3ctmhqk0ocdTAPG6CTHVKxhxDx8,2700
+stackshift/__init__.py,sha256=B_V3evqxubv9l7wQvO5Tq1vTHv5jykhKvIgAZHpW3IE,2756
 stackshift/ai_credits.py,sha256=2u5zGSBo_spHqgYJhtmChaEiBq9jUVaTjR1uprxMpNQ,1142
-stackshift/assets.py,sha256=qjV59NFxQEF6_56GdMZVrN_QadExFbDWbcbiBFYXCt0,23292
+stackshift/assets.py,sha256=ElOFd7V6D2ceIprDnBcwXbqK4jnU9YXz63hWTtvnx9E,24127
 stackshift/assets_dam.py,sha256=dz0QgSZuQcwSSYoWFqy1pCx3xgMGYZLc9tCcQE0_kYo,6659
 stackshift/assets_media.py,sha256=S_7TWu6hm5I8WUPMfQsGE9U15mDiYRG4ygXJzWqwbDE,1523
 stackshift/assets_platform.py,sha256=w2Eke0YFXinmtHt1oaZlaiP_J32VymfhVWWLOYrX93M,4125
 stackshift/assets_video.py,sha256=KBIOTsVspHcMltkELsbTmfu-VB6_36dpYQ7HKTqAa2E,2374
-stackshift/assets_workflows.py,sha256=6L8_1d9huhfSrKovwP26tfGKc38o0sbSM-75dt__HRE,6950
-stackshift/client.py,sha256=hY-1AQjyiiim6zMQi4JriDQ7HfK5zyPE_WkkhbOkmvw,3224
-stackshift/mail.py,sha256=XWqEwmmlKEmKVLMpXKeJvkqb3el1KLAHkdUTzyryjQE,16491
+stackshift/assets_workflows.py,sha256=YDGVfzbMW-y5umPWqrHQ9Pp6tGjUC0fnIfNew73V7-c,7274
+stackshift/client.py,sha256=LY7MLo6ljOt1ASNH1HYqi-1k6KEW5pyu6Dz9QFOaLJM,3310
+stackshift/mail.py,sha256=PZCDfaJ8w-sTqVxRAPzGPnxmA_MNHpBH2Jz4ToKUrBY,16561
 stackshift/mail_advanced.py,sha256=sLte3we0Oy3pSuwjl5c4lfELH6gzaSUKug_WZDUB2DE,4363
-stackshift/mail_billing.py,sha256=n1SMNTHW5lVs7phJhZBiKw6ok-T3kbW0A3-4uF1w6Yg,232
-stackshift/mail_brands.py,sha256=aaOzETtfix0pFpaWBOHYPVrfUZezWqt53ZXJQk1F7mY,1627
-stackshift/mail_campaigns.py,sha256=wgEz2MD3k5db6p1jh-bMYP_aNxM73gekwmi4cNxTvBA,5438
-stackshift/mail_events_webhooks.py,sha256=iVYz_5DvGaE-Acw5uh_JN7P5LWvgfN-2bLnb_z1CMRU,5712
+stackshift/mail_billing.py,sha256=bxZlcZkhenugW2G6Qy6TQ9At2Xq10e-4w7keNjOkw8w,384
+stackshift/mail_brands.py,sha256=bNvE-thtrGo6iZkeVzuN3x0XQFUZt4fKD_DivMkqeT8,1658
+stackshift/mail_campaigns.py,sha256=KDFlLLOBbwL2pVya2RmgVGRMuoPXvSqxjQqowTrTmTs,5654
+stackshift/mail_events_webhooks.py,sha256=4w74jZx2C2WNt1RLRgXBBDHZATcwOYe3fEC6igkkt9c,6195
 stackshift/mail_exports.py,sha256=sbwBbypS1APv2DnunYmyViEjUHP1PMSrM0tVcbxcits,1054
 stackshift/mail_mailboxes.py,sha256=I5L1C2LyU0MGDZu6VZCh0J7oOqMiCnLSVWlbnkJZxq0,11872
 stackshift/mail_marketing.py,sha256=7uMZQYjU0siMyqFas_i5YWJTrwT9eYMrWElRThxZMr4,1077
@@ -20,6 +20,7 @@ stackshift/mail_migration.py,sha256=j-VvEbJP92ndQ5HMhdu7obJ4S_4gka7oqNRirIvYkyE,
 stackshift/mail_reputation.py,sha256=mPvPkZeqcQc5808PhBK7gYsgf4Fk_U19nRxSsJ60MGU,1112
 stackshift/mail_streams.py,sha256=F7iBzHtWhCFw1cTjwPixNJfCvxdjvsDprZQG2A9-NIs,504
 stackshift/mail_tracking.py,sha256=SRcWTI9Otm5fBIY7nJJ-5qZA13aybUuMdh_PqakBpUg,1575
+stackshift/partner.py,sha256=D_oFDXIQ52H4KrPJdbKRTRa6GAZbWLa0IqqUXxn6Lzc,4248
 stackshift/projects.py,sha256=oYWaE7xNRR6OXuPEwJH-oFFeOmDA9ozq6jJY09ANIHA,498
 stackshift/support_action_manifest.py,sha256=tCm3Qi_R3MidcJBPcsdKE-g8iaXw2xeU2PzxNuAaYbs,4088
 stackshift/support_action_receiver.py,sha256=PJtXpwt6XurE2sYE-mvjOeAhzWLUoBZsejwHGoC_dFI,3228
@@ -27,7 +28,7 @@ stackshift/support_action_sqlite.py,sha256=Ict1yNNbzp2eEGNF8S7QSlKb9-dQIYiFhJ2ET
 stackshift/support_action_types.py,sha256=i7xADrXFSIHJaqwcS77LU4jvni5JKrRUzot5WaWpLLU,2213
 stackshift/support_actions.py,sha256=tZYlb8gdE875SKZdzfN01jfEfIQTyH08XThgCYQ820o,8744
 stackshift/workload_security.py,sha256=5JtJH9fX1kqSY3ipXUa79JslUULWsN5_gyn9tTGfzlA,2941
-stackshift-1.3.0.dist-info/METADATA,sha256=ClHPib_juMAge4YKZ2AOnQVQAx0F9p8ejnnnRxVUZTo,13959
-stackshift-1.3.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
-stackshift-1.3.0.dist-info/top_level.txt,sha256=qe3uWsu_O9mNtq7bIck9Y8rjTIMrH0kzgAlGFDoRGqs,11
-stackshift-1.3.0.dist-info/RECORD,,
+stackshift-1.3.1.dist-info/METADATA,sha256=6eJPmX60mVa8nb3bCLcFBuG9l-BnjxXJvQoTrc4SXAk,15458
+stackshift-1.3.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+stackshift-1.3.1.dist-info/top_level.txt,sha256=qe3uWsu_O9mNtq7bIck9Y8rjTIMrH0kzgAlGFDoRGqs,11
+stackshift-1.3.1.dist-info/RECORD,,