stackshift 1.0.1__tar.gz → 1.1.0__tar.gz

{stackshift-1.0.1 → stackshift-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackshift
-Version: 1.0.1
+Version: 1.1.0
 Summary: Official Python SDK for StackShift.
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -213,3 +213,40 @@ upload = stackshift.assets.signed_upload_url(
 Then upload the browser `File` to `upload["url"]` from your frontend. Do not expose your StackShift API key to browser code.
 
 The SDK only talks to the StackShift REST API. Storage placement, replication, disks, and repair are StackShift internals.
+
+### Campaign drafts and engagement
+
+`mail.campaigns.create(content={...})` accepts a private campaign content snapshot; template/version inputs still work. Save the complete draft with `update(id, revision=revision, **draft)` (draft keys use API camelCase). `preview`, `test`, `send(id, revision=revision)`, and `schedule(id, send_at, revision=revision)` protect the reviewed content. Stale revisions return 409.
+
+Send methods accept `tracking={"opens": False, "clicks": True}`. Omitted fields inherit workspace defaults. `mail.tracking` exposes `settings`, `update_settings`, `message`, `campaign`, and branded-domain methods. Deployment capability flags control availability. Opens are approximate; detailed activity expires after 90 days. OTPs and tests never track.
+
+### Isolated testing, brands, migration, and spending
+
+Use a `sspat_test_` credential and `simulation={"scenario": "delayed"}` for a 60-second simulated delay. Delivered, bounced, and complained outcomes are also supported. Test resources are isolated; no real email is delivered.
+
+```python
+brand = client.mail.brands.create(name="Product", editable_fields=["company"])
+audience = client.mail.audiences.create(brand_id=brand["id"], name="Product news")
+```
+
+Audience creation requires an explicit `brand_id`. Shared profile fields belong to the brand; consent stays per audience. `mail.automations`, `mail.forms`, and `mail.segments` expose create/list methods; their input dictionaries use API camelCase keys.
+
+`mail.migration` supports public DNS audits/plans and authenticated checklists. `mail.billing.summary()` and `mail.campaigns.estimate(id)` expose allowance and credit. Pass `approved_max_kobo=0` (or another approved maximum) alongside `revision` when sending/scheduling campaigns. Billing remains inactive until a rate card is explicitly published and activated; funding and spending opt-in are separate owner-only dashboard actions.
+
+## Native video, governed DAM and product rendering
+
+Use the space-scoped DAM and video clients for collaborators, metadata schemas, bucket governance, reviewed publications, picker capabilities, model preparation, product rendering, galleries, version-pinned encoding, captions and playback sessions.
+
+```python
+dam = sdk.assets.dam.for_space(space_id)
+video = sdk.assets.video.for_space(space_id)
+schema = dam.create_metadata_schema({"name": "Products", "fields": [{
+    "key": "product_name", "label": "Product name", "type": "text", "required": True,
+}]})
+published = dam.publish_metadata_schema(schema["id"], schema["revision"])
+workspace = video.workspace(asset_id)
+```
+
+Mutations carry the supplied revision in `If-Match`. Model preparation and rendering carry an idempotency key; render submission also carries the accepted maximum units. Playback renewal and events authenticate with the session credential, not the account key. Keep these clients on your backend and return grants with `Cache-Control: private, no-store`.
+
+See the [Assets SDK guide](https://docs.stackshift.cloud/assets/sdk-media-workflows) and its linked feature guides for complete language examples, inputs, permissions, review transitions and browser callbacks.

{stackshift-1.0.1 → stackshift-1.1.0}/README.md

@@ -205,3 +205,40 @@ upload = stackshift.assets.signed_upload_url(
 Then upload the browser `File` to `upload["url"]` from your frontend. Do not expose your StackShift API key to browser code.
 
 The SDK only talks to the StackShift REST API. Storage placement, replication, disks, and repair are StackShift internals.
+
+### Campaign drafts and engagement
+
+`mail.campaigns.create(content={...})` accepts a private campaign content snapshot; template/version inputs still work. Save the complete draft with `update(id, revision=revision, **draft)` (draft keys use API camelCase). `preview`, `test`, `send(id, revision=revision)`, and `schedule(id, send_at, revision=revision)` protect the reviewed content. Stale revisions return 409.
+
+Send methods accept `tracking={"opens": False, "clicks": True}`. Omitted fields inherit workspace defaults. `mail.tracking` exposes `settings`, `update_settings`, `message`, `campaign`, and branded-domain methods. Deployment capability flags control availability. Opens are approximate; detailed activity expires after 90 days. OTPs and tests never track.
+
+### Isolated testing, brands, migration, and spending
+
+Use a `sspat_test_` credential and `simulation={"scenario": "delayed"}` for a 60-second simulated delay. Delivered, bounced, and complained outcomes are also supported. Test resources are isolated; no real email is delivered.
+
+```python
+brand = client.mail.brands.create(name="Product", editable_fields=["company"])
+audience = client.mail.audiences.create(brand_id=brand["id"], name="Product news")
+```
+
+Audience creation requires an explicit `brand_id`. Shared profile fields belong to the brand; consent stays per audience. `mail.automations`, `mail.forms`, and `mail.segments` expose create/list methods; their input dictionaries use API camelCase keys.
+
+`mail.migration` supports public DNS audits/plans and authenticated checklists. `mail.billing.summary()` and `mail.campaigns.estimate(id)` expose allowance and credit. Pass `approved_max_kobo=0` (or another approved maximum) alongside `revision` when sending/scheduling campaigns. Billing remains inactive until a rate card is explicitly published and activated; funding and spending opt-in are separate owner-only dashboard actions.
+
+## Native video, governed DAM and product rendering
+
+Use the space-scoped DAM and video clients for collaborators, metadata schemas, bucket governance, reviewed publications, picker capabilities, model preparation, product rendering, galleries, version-pinned encoding, captions and playback sessions.
+
+```python
+dam = sdk.assets.dam.for_space(space_id)
+video = sdk.assets.video.for_space(space_id)
+schema = dam.create_metadata_schema({"name": "Products", "fields": [{
+    "key": "product_name", "label": "Product name", "type": "text", "required": True,
+}]})
+published = dam.publish_metadata_schema(schema["id"], schema["revision"])
+workspace = video.workspace(asset_id)
+```
+
+Mutations carry the supplied revision in `If-Match`. Model preparation and rendering carry an idempotency key; render submission also carries the accepted maximum units. Playback renewal and events authenticate with the session credential, not the account key. Keep these clients on your backend and return grants with `Cache-Control: private, no-store`.
+
+See the [Assets SDK guide](https://docs.stackshift.cloud/assets/sdk-media-workflows) and its linked feature guides for complete language examples, inputs, permissions, review transitions and browser callbacks.

{stackshift-1.0.1 → stackshift-1.1.0}/pyproject.toml

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

{stackshift-1.0.1 → stackshift-1.1.0}/stackshift/__init__.py

@@ -13,6 +13,7 @@ from .mail_streams import MailStreamsClient
 from .mail_campaigns import MailAudiencesClient, MailCampaignsClient
 from .mail_exports import MailExportsClient
 from .projects import ProjectsClient
+from .workload_security import WorkloadSecurityClient
 
 __all__ = [
     "StackShift",
@@ -33,6 +34,7 @@ __all__ = [
     "MailCampaignsClient",
     "MailExportsClient",
     "ProjectsClient",
+    "WorkloadSecurityClient",
     "asset_transform_options",
     "asset_transform_spec",
     "get_asset_transform_preset",

{stackshift-1.0.1 → stackshift-1.1.0}/stackshift/assets.py

@@ -7,6 +7,8 @@ from typing import Any, BinaryIO
 from urllib.parse import quote
 
 from .assets_workflows import AssetWorkflowsMixin
+from .assets_dam import AssetDAMClient
+from .assets_video import AssetVideoClient
 
 
 ASSET_TRANSFORM_PRESETS: list[dict[str, Any]] = [
@@ -52,6 +54,8 @@ def asset_transform_spec(**options: Any) -> str:
 class AssetsClient(AssetWorkflowsMixin):
     def __init__(self, client: Any) -> None:
         self._client = client
+        self.dam = AssetDAMClient(client)
+        self.video = AssetVideoClient(client)
 
     def upload(
         self,

stackshift-1.1.0/stackshift/assets_dam.py

@@ -0,0 +1,193 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import quote
+
+from .assets_media import AssetMediaClient
+
+
+class AssetDAMClient(AssetMediaClient):
+    def spaces(self):
+        return self._request("GET", f"/assets/spaces")
+
+    def collaborators(self):
+        return self._request("GET", f"/assets/collaborators")
+
+    def invite(self, input: dict[str, Any]):
+        return self._request("POST", f"/assets/collaborators", body=input)
+
+    def accept_invitation(self, id: str):
+        return self._request("POST", f"/assets/invitations/{quote(id, safe='')}/accept")
+
+    def update_collaborator(self, id: str, revision: int, actions: list[str]):
+        return self._request(
+            "PUT",
+            f"/assets/collaborators/{quote(id, safe='')}",
+            body={"actions": actions},
+            revision=revision,
+        )
+
+    def revoke_collaborator(self, id: str, revision: int):
+        return self._request(
+            "DELETE", f"/assets/collaborators/{quote(id, safe='')}", revision=revision
+        )
+
+    def metadata_schemas(self):
+        return self._request("GET", f"/assets/metadata-schemas")
+
+    def metadata_editor(self, asset_id: str):
+        return self._request(
+            "GET", f"/assets/{quote(asset_id, safe='')}/metadata-editor"
+        )
+
+    def create_metadata_schema(self, input: dict[str, Any]):
+        return self._request("POST", f"/assets/metadata-schemas", body=input)
+
+    def update_metadata_schema(self, id: str, revision: int, input: dict[str, Any]):
+        return self._request(
+            "PUT",
+            f"/assets/metadata-schemas/{quote(id, safe='')}",
+            body=input,
+            revision=revision,
+        )
+
+    def publish_metadata_schema(self, id: str, revision: int):
+        return self._request(
+            "POST",
+            f"/assets/metadata-schemas/{quote(id, safe='')}/publish",
+            revision=revision,
+        )
+
+    def bucket_governance(self, id: str):
+        return self._request("GET", f"/assets/buckets/{quote(id, safe='')}/governance")
+
+    def save_bucket_governance(self, id: str, input: dict[str, Any]):
+        return self._request(
+            "PUT", f"/assets/buckets/{quote(id, safe='')}/governance", body=input
+        )
+
+    def migrate_bucket_governance(self, id: str, revision: int):
+        return self._request(
+            "POST",
+            f"/assets/buckets/{quote(id, safe='')}/governance/migrate",
+            revision=revision,
+        )
+
+    def publications(self, query: dict[str, Any] | None = None):
+        return self._request("GET", f"/assets/publications", query=query)
+
+    def publication_renditions(self, asset_id: str):
+        return self._request(
+            "GET", f"/assets/{quote(asset_id, safe='')}/publication-renditions"
+        )
+
+    def create_publication(self, input: dict[str, Any]):
+        return self._request("POST", f"/assets/publications", body=input)
+
+    def update_publication(self, id: str, revision: int, input: dict[str, Any]):
+        return self._request(
+            "PUT",
+            f"/assets/publications/{quote(id, safe='')}",
+            body=input,
+            revision=revision,
+        )
+
+    def transition_publication(self, id: str, revision: int, action: str, note: str):
+        return self._request(
+            "POST",
+            f"/assets/publications/{quote(id, safe='')}/{quote(action, safe='')}",
+            body={"note": note},
+            revision=revision,
+        )
+
+    def resolve_publication(self, id: str):
+        return self._request(
+            "GET", f"/assets/publications/{quote(id, safe='')}/resolve"
+        )
+
+    def preview_publication(self, id: str):
+        return self._request(
+            "GET", f"/assets/publications/{quote(id, safe='')}/preview"
+        )
+
+    def resolve_publication_ar(self, id: str):
+        return self._request("POST", f"/assets/publications/{quote(id, safe='')}/ar")
+
+    def create_picker_capability(self, input: dict[str, Any]):
+        return self._request("POST", f"/assets/picker-capabilities", body=input)
+
+    def revoke_picker_capability(self, id: str):
+        return self._request(
+            "DELETE", f"/assets/picker-capabilities/{quote(id, safe='')}"
+        )
+
+    def models(self, asset_id: str):
+        return self._request("GET", f"/assets/{quote(asset_id, safe='')}/models")
+
+    def estimate_render(self, asset_id: str, revision: int, input: dict[str, Any]):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/models",
+            body={**input, "operation": "estimate"},
+            revision=revision,
+        )
+
+    def render_product(
+        self,
+        asset_id: str,
+        revision: int,
+        idempotency_key: str,
+        input: dict[str, Any],
+        maximum_units: int,
+    ):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/models",
+            body={**input, "operation": "render", "maximum_units": maximum_units},
+            revision=revision,
+            idempotency_key=idempotency_key,
+        )
+
+    def process_model(self, asset_id: str, revision: int, idempotency_key: str):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/models",
+            revision=revision,
+            idempotency_key=idempotency_key,
+        )
+
+    def galleries(self, query: dict[str, Any] | None = None):
+        return self._request("GET", f"/assets/galleries", query=query)
+
+    def create_gallery(self, input: dict[str, Any]):
+        return self._request("POST", f"/assets/galleries", body=input)
+
+    def update_gallery(self, id: str, revision: int, input: dict[str, Any]):
+        return self._request(
+            "PUT",
+            f"/assets/galleries/{quote(id, safe='')}",
+            body=input,
+            revision=revision,
+        )
+
+    def transition_gallery(self, id: str, revision: int, action: str):
+        return self._request(
+            "POST",
+            f"/assets/galleries/{quote(id, safe='')}/{quote(action, safe='')}",
+            revision=revision,
+        )
+
+    def resolve_gallery(self, id: str):
+        return self._request("GET", f"/assets/galleries/{quote(id, safe='')}/resolve")
+
+    def preview_gallery(self, id: str):
+        return self._request(
+            "GET", f"/assets/galleries/{quote(id, safe='')}/resolve?preview=true"
+        )
+
+    def resolve_gallery_ar(self, id: str, publication_id: str):
+        return self._request(
+            "POST",
+            f"/assets/galleries/{quote(id, safe='')}/ar",
+            body={"publication_id": publication_id},
+        )

stackshift-1.1.0/stackshift/assets_media.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import urlsplit
+
+
+class AssetMediaClient:
+    def __init__(self, client: Any, space_id: str = "") -> None:
+        self._client = client
+        self._space_id = space_id
+
+    def for_space(self, space_id: str):
+        return type(self)(self._client, space_id)
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        *,
+        body=None,
+        revision=None,
+        idempotency_key=None,
+        query=None,
+    ):
+        headers = {}
+        if self._space_id:
+            headers["X-Asset-Space-ID"] = self._space_id
+        if revision is not None:
+            headers["If-Match"] = f'"{revision}"'
+        if idempotency_key is not None:
+            headers["Idempotency-Key"] = idempotency_key
+        return self._client.request(
+            method, path, json=body, headers=headers, params=query
+        )
+
+    def _playback(self, path: str, credential: str, body: dict[str, Any]):
+        from .client import StackShift
+
+        if not credential.strip():
+            raise ValueError("Playback credential is required")
+        base = urlsplit(self._client.base_url)
+        # A separate client prevents account authentication from replacing the session credential.
+        playback = StackShift(
+            api_key=credential,
+            base_url=f"{base.scheme}://{base.netloc}",
+            session=self._client.session,
+        )
+        return playback.request("POST", "/playback" + path, json=body)

stackshift-1.1.0/stackshift/assets_video.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import quote
+
+from .assets_media import AssetMediaClient
+
+
+class AssetVideoClient(AssetMediaClient):
+    def workspace(self, asset_id: str):
+        return self._request("GET", f"/assets/{quote(asset_id, safe='')}/video")
+
+    def process(self, asset_id: str, version_id: str):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/versions/{quote(version_id, safe='')}/video",
+        )
+
+    def create_session(self, asset_id: str):
+        return self._request(
+            "POST", f"/assets/{quote(asset_id, safe='')}/playback-sessions"
+        )
+
+    def revoke_session(self, asset_id: str, session_id: str):
+        return self._request(
+            "DELETE",
+            f"/assets/{quote(asset_id, safe='')}/playback-sessions/{quote(session_id, safe='')}",
+        )
+
+    def captions(self, asset_id: str, version_id: str):
+        return self._request(
+            "GET",
+            f"/assets/{quote(asset_id, safe='')}/versions/{quote(version_id, safe='')}/video/captions",
+        )
+
+    def add_caption(self, asset_id: str, version_id: str, input: dict[str, Any]):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/versions/{quote(version_id, safe='')}/video/captions",
+            body=input,
+        )
+
+    def remove_caption(self, asset_id: str, version_id: str, caption_id: str):
+        return self._request(
+            "DELETE",
+            f"/assets/{quote(asset_id, safe='')}/versions/{quote(version_id, safe='')}/video/captions/{quote(caption_id, safe='')}",
+        )
+
+    def review(self, asset_id: str, version_id: str, decision: str, reason: str):
+        return self._request(
+            "POST",
+            f"/assets/{quote(asset_id, safe='')}/versions/{quote(version_id, safe='')}/video/review",
+            body={"decision": decision, "reason": reason},
+        )
+
+    def analytics(self, asset_id: str):
+        return self._request(
+            "GET", f"/assets/{quote(asset_id, safe='')}/video/analytics"
+        )
+
+    def renew_session(self, credential: str):
+        return self._playback("/sessions/renew", credential, {})
+
+    def events(self, credential: str, events: list[dict[str, Any]]):
+        return self._playback("/events", credential, {"events": events})

{stackshift-1.0.1 → stackshift-1.1.0}/stackshift/client.py

@@ -29,10 +29,12 @@ class StackShift:
         from .assets import AssetsClient
         from .mail import MailClient
         from .projects import ProjectsClient
+        from .workload_security import WorkloadSecurityClient
 
         self.projects = ProjectsClient(self)
         self.assets = AssetsClient(self)
         self.mail = MailClient(self)
+        self.workload_security = WorkloadSecurityClient(self)
 
     def request(self, method: str, path: str, **kwargs: Any) -> Any:
         return self._request(self.base_url, method, path, **kwargs)

{stackshift-1.0.1 → stackshift-1.1.0}/stackshift/mail.py

@@ -7,8 +7,13 @@ from .mail_advanced import MailAnalyticsClient, MailBatchClient, MailInboundClie
 from .mail_events_webhooks import MailEventsClient, MailWebhooksClient
 from .mail_reputation import MailLimitsClient, MailReputationClient
 from .mail_streams import MailStreamsClient
+from .mail_brands import MailBrandsClient
+from .mail_billing import MailBillingClient
+from .mail_marketing import MailAutomationsClient, MailFormsClient, MailSegmentsClient
+from .mail_migration import MailMigrationClient
 from .mail_campaigns import MailAudiencesClient, MailCampaignsClient
 from .mail_exports import MailExportsClient
+from .mail_tracking import MailTrackingClient
 
 
 class MailClient:
@@ -23,8 +28,15 @@ class MailClient:
         self.events = MailEventsClient(client)
         self.webhooks = MailWebhooksClient(client)
         self.streams = MailStreamsClient(client)
+        self.brands = MailBrandsClient(client)
+        self.billing = MailBillingClient(client)
+        self.automations = MailAutomationsClient(client)
+        self.forms = MailFormsClient(client)
+        self.segments = MailSegmentsClient(client)
+        self.migration = MailMigrationClient(client)
         self.audiences = MailAudiencesClient(client)
         self.campaigns = MailCampaignsClient(client)
+        self.tracking = MailTrackingClient(client)
         self.exports = MailExportsClient(client)
         self.limits = MailLimitsClient(client)
         self.reputation = MailReputationClient(client)
@@ -49,6 +61,8 @@ class MailClient:
         headers: dict[str, str] | None = None,
         tags: dict[str, str] | None = None,
         stream: str | None = None,
+        tracking: dict[str, bool] | None = None,
+        simulation: dict[str, str] | None = None,
     ) -> dict[str, Any]:
         payload = {
             "from": from_,
@@ -64,6 +78,8 @@ class MailClient:
             "headers": headers,
             "tags": tags,
             "stream": stream,
+            "tracking": tracking,
+            "simulation": simulation,
         }
         clean = {key: value for key, value in payload.items() if value is not None}
         return self._client.mail_request("POST", "/mail/send", json=clean)
@@ -84,6 +100,8 @@ class MailClient:
         headers: dict[str, str] | None = None,
         tags: dict[str, str] | None = None,
         stream: str | None = None,
+        tracking: dict[str, bool] | None = None,
+        simulation: dict[str, str] | None = None,
     ) -> dict[str, Any]:
         payload = {
             "template": template,
@@ -99,6 +117,8 @@ class MailClient:
             "headers": headers,
             "tags": tags,
             "stream": stream,
+            "tracking": tracking,
+            "simulation": simulation,
         }
         clean = {key: value for key, value in payload.items() if value is not None}
         return self._client.mail_request("POST", "/mail/send-template", json=clean)
@@ -201,8 +221,9 @@ class MailTemplatesClient:
         data: dict[str, Any],
         from_: str | dict[str, str] | None = None,
         version_id: str | None = None,
+        simulation: dict[str, str] | None = None,
     ) -> dict[str, Any]:
-        payload = {"to": to, "from": from_, "data": data, "versionId": version_id}
+        payload = {"simulation": simulation, "to": to, "from": from_, "data": data, "versionId": version_id}
         clean = {key: value for key, value in payload.items() if value is not None}
         return self._client.mail_request("POST", f"/mail/templates/{quote(template_id)}/test-send", json=clean)
 
@@ -348,6 +369,7 @@ class MailOTPClient:
         idempotency_key: str | None = None,
         subject: str | None = None,
         brand_name: str | None = None,
+        simulation: dict[str, str] | None = None,
     ) -> dict[str, Any]:
         payload = {
             "to": to,
@@ -359,6 +381,7 @@ class MailOTPClient:
             "idempotencyKey": idempotency_key,
             "subject": subject,
             "brandName": brand_name,
+            "simulation": simulation,
         }
         clean = {key: value for key, value in payload.items() if value is not None}
         return self._client.mail_request("POST", "/mail/otp/send", json=clean)

{stackshift-1.0.1 → stackshift-1.1.0}/stackshift/mail_advanced.py

@@ -39,6 +39,8 @@ class MailBatchClient:
         headers: dict[str, str] | None = None,
         tags: dict[str, str] | None = None,
         stream: str | None = None,
+        tracking: dict[str, bool] | None = None,
+        simulation: dict[str, str] | None = None,
     ) -> dict[str, Any]:
         payload = {
             "template": template,
@@ -48,6 +50,8 @@ class MailBatchClient:
             "headers": headers,
             "tags": tags,
             "stream": stream,
+            "tracking": tracking,
+            "simulation": simulation,
         }
         clean = {key: value for key, value in payload.items() if value is not None}
         return self._client.mail_request("POST", "/mail/batch-template", json=clean)

stackshift-1.1.0/stackshift/mail_billing.py

@@ -0,0 +1,9 @@
+from typing import Any
+
+
+class MailBillingClient:
+    def __init__(self, client: Any) -> None:
+        self._client = client
+
+    def summary(self) -> dict[str, Any]:
+        return self._client.mail_request("GET", "/mail/billing")

stackshift-1.1.0/stackshift/mail_brands.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from typing import Any
+from urllib.parse import quote
+
+
+class MailBrandsClient:
+    def __init__(self, client: Any) -> None:
+        self._client = client
+
+    def create(self, *, name: str, **fields: Any) -> dict[str, Any]:
+        return self._client.mail_request("POST", "/mail/brands", json={"name": name, **_brand_fields(fields)})
+
+    def list(self) -> dict[str, Any]:
+        return self._client.mail_request("GET", "/mail/brands")
+
+    def get(self, brand_id: str) -> dict[str, Any]:
+        return self._client.mail_request("GET", f"/mail/brands/{quote(brand_id, safe='')}")
+
+    def update(self, brand_id: str, *, revision: int, name: str, **fields: Any) -> dict[str, Any]:
+        return self._client.mail_request(
+            "PUT", f"/mail/brands/{quote(brand_id, safe='')}",
+            json={"revision": revision, "name": name, **_brand_fields(fields)},
+        )
+
+    def archive(self, brand_id: str) -> dict[str, Any]:
+        return self._client.mail_request("POST", f"/mail/brands/{quote(brand_id, safe='')}/archive")
+
+
+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"}
+    unknown = fields.keys() - names.keys() - set(names.values())
+    if unknown:
+        raise ValueError("Unknown brand fields: " + ", ".join(sorted(unknown)))
+    return {names.get(key, key): value for key, value in fields.items()}