workwire 0.5.0__tar.gz → 0.6.0__tar.gz

{workwire-0.5.0 → workwire-0.6.0}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/workwire/workwire-python/compare/v0.5.0...v0.6.0) (2026-10-30)
+
+
+### Features
+
+* **WOR-547:** backend v1.71.1's spec — partnerships name the counterparty, the wire list carries viewer_party_id ([#26](https://github.com/workwire/workwire-python/issues/26)) ([e5199ba](https://github.com/workwire/workwire-python/commit/e5199ba1e6c2bf95136815e475698fc0a93da02c))
+
 ## [0.5.0](https://github.com/workwire/workwire-python/compare/v0.4.0...v0.5.0) (2026-10-24)
 
 

{workwire-0.5.0 → workwire-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: workwire
-Version: 0.5.0
+Version: 0.6.0
 Summary: Official Python SDK for the Workwire API
 Project-URL: Homepage, https://github.com/workwire/workwire-python
 Project-URL: Changelog, https://github.com/workwire/workwire-python/blob/main/CHANGELOG.md
@@ -54,7 +54,7 @@ project = client.projects.create(name="Elm St. Townhomes")
 
 # The partnership with your sub — create one (see below) or pick an
 # established one from client.partnerships.list().
-partnership = client.partnerships.create(sub_org_id="...")
+partnership = client.partnerships.create(org_id="...")
 
 wire = client.wires.create(
     project_id=project.id,

{workwire-0.5.0 → workwire-0.6.0}/README.md

@@ -31,7 +31,7 @@ project = client.projects.create(name="Elm St. Townhomes")
 
 # The partnership with your sub — create one (see below) or pick an
 # established one from client.partnerships.list().
-partnership = client.partnerships.create(sub_org_id="...")
+partnership = client.partnerships.create(org_id="...")
 
 wire = client.wires.create(
     project_id=project.id,

{workwire-0.5.0 → workwire-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "workwire"
-version = "0.5.0"
+version = "0.6.0"
 description = "Official Python SDK for the Workwire API"
 readme = "README.md"
 license = "MIT"

{workwire-0.5.0 → workwire-0.6.0}/src/workwire/_coverage.py

@@ -116,7 +116,7 @@ OPERATIONS: dict[str, dict[str, object]] = {
     "createPartnership": {
         "method": "POST",
         "path": "/v1/partnerships",
-        "request_fields": {"sub_org_id", "cold_invite"},
+        "request_fields": {"org_id", "sub_org_id", "cold_invite"},
         "query_params": set(),
         "response_model": _models.Partnership,
     },

{workwire-0.5.0 → workwire-0.6.0}/src/workwire/_models.py

@@ -266,21 +266,36 @@ class Wire(WorkwireObject):
 
 
 class WireListItem(WorkwireObject):
+    """One row of :meth:`Wires.list`. ``viewer_party_id`` is your org's one
+    party on the wire when your org is its sub — ``None`` when your org is
+    the wire's origin or holds more than one party on it."""
+
     id: str
     display_id: str
     project_id: str
     title: str
     state: str
     party_count: int
+    viewer_party_id: str | None
     created_at: str
     sent_at: str | None
     closed_at: str | None
 
 
 class Partnership(WorkwireObject):
+    """A partnership as created, read from your org's side:
+    ``counterparty_org_id`` is the other org and ``initiated_by_org_id`` is
+    the org that asked for the partnership — equal to ``counterparty_org_id``
+    when the other org asked, your org's id otherwise. ``gc_org_id`` and
+    ``sub_org_id`` are deprecated — still served, replaced by
+    ``counterparty_org_id`` and ``initiated_by_org_id``. ``invitation_id`` is
+    set on the cold-invite path only."""
+
     id: str
     gc_org_id: str
     sub_org_id: str
+    counterparty_org_id: str
+    initiated_by_org_id: str
     status: str
     initiation_path: str
     created_at: str
@@ -290,9 +305,21 @@ class Partnership(WorkwireObject):
 
 
 class PartnershipDetail(WorkwireObject):
+    """One partnership read from your org's side: ``counterparty_org_id`` and
+    ``counterparty_name`` (``None`` while the other org has no name yet) are
+    the other org; ``initiated_by_org_id`` is the org that asked for the
+    partnership — equal to ``counterparty_org_id`` when the other org asked,
+    your org's id otherwise. Deprecated — still served: ``gc_org_id`` and
+    ``sub_org_id`` (replaced by ``counterparty_org_id`` and
+    ``initiated_by_org_id``), ``gc_org_name`` and ``sub_org_name`` (replaced
+    by ``counterparty_name``)."""
+
     id: str
     gc_org_id: str
     sub_org_id: str
+    counterparty_org_id: str
+    counterparty_name: str | None
+    initiated_by_org_id: str
     status: str
     initiation_path: str
     created_at: str
@@ -303,10 +330,18 @@ class PartnershipDetail(WorkwireObject):
 
 
 class PartnershipListItem(WorkwireObject):
+    """One row of :meth:`Partnerships.list`, read from your org's side:
+    ``counterparty_org_id`` and ``counterparty_name`` are the other org;
+    ``initiated_by_org_id`` is the org that asked for the partnership — equal
+    to ``counterparty_org_id`` when the other org asked, your org's id
+    otherwise. ``role`` is deprecated — still served, replaced by
+    ``initiated_by_org_id``."""
+
     id: str
     role: str
     counterparty_org_id: str
     counterparty_name: str | None
+    initiated_by_org_id: str
     status: str
     initiation_path: str
     created_at: str

{workwire-0.5.0 → workwire-0.6.0}/src/workwire/resources/partnerships.py

@@ -1,9 +1,15 @@
 """Partnerships — the GC↔sub relationship Wires require.
 
-Create one against a known Workwire org (``sub_org_id=``) or cold-invite a
-sub by email (``cold_invite=ColdInvite(...)`` — the partnership, the
-invitation, and the email are created atomically). Exactly one of the two;
-the invitation email greets the recipient **as your organization**.
+Create one against a known Workwire org (``org_id=``; the deprecated
+``sub_org_id=`` is still accepted in its place) or cold-invite a sub by email
+(``cold_invite=ColdInvite(...)`` — the partnership, the invitation, and the
+email are created atomically). Exactly one of them; the invitation email
+greets the recipient **as your organization**.
+
+A partnership reads from your organization's side: ``counterparty_org_id``
+is the other organization and ``initiated_by_org_id`` is the organization
+that asked for the partnership — equal to ``counterparty_org_id`` when the
+other organization asked, yours otherwise.
 """
 
 from __future__ import annotations
@@ -29,13 +35,20 @@ class Partnerships:
     def create(
         self,
         *,
+        org_id: str | None = None,
         sub_org_id: str | None = None,
         cold_invite: ColdInvite | None = None,
         idempotency_key: str | None = None,
         timeout: float | None = None,
     ) -> Partnership:
         """Create a partnership. Requires ``partnerships:write``. Pass
-        exactly one of ``sub_org_id`` or ``cold_invite``.
+        exactly one of ``org_id`` (an organization already on Workwire) or
+        ``cold_invite``. ``sub_org_id`` is deprecated — still accepted in
+        place of ``org_id`` and sent as ``sub_org_id``.
+
+        The partnership comes back read from your side:
+        ``initiated_by_org_id`` is the organization that asked — yours, on a
+        create.
 
         The cold-invite path **emails a real person**, counts against the
         100/org/rolling-24h machine invitation quota (breach raises
@@ -43,10 +56,12 @@ class Partnerships:
         ``partnership_invites_per_org_per_day``), and returns the
         partnership with ``invitation_id`` set.
         """
-        if (sub_org_id is None) == (cold_invite is None):
-            raise ValueError("pass exactly one of sub_org_id or cold_invite")
+        if sum(arg is not None for arg in (org_id, sub_org_id, cold_invite)) != 1:
+            raise ValueError("pass exactly one of org_id, sub_org_id or cold_invite")
         body: dict[str, Any]
-        if sub_org_id is not None:
+        if org_id is not None:
+            body = {"org_id": org_id}
+        elif sub_org_id is not None:
             body = {"sub_org_id": sub_org_id}
         else:
             assert cold_invite is not None
@@ -65,8 +80,11 @@ class Partnerships:
     def retrieve(
         self, partnership_id: str, *, timeout: float | None = None
     ) -> PartnershipDetail:
-        """Fetch one partnership your org is a side of, with both org
-        names. Requires ``partnerships:read``."""
+        """Fetch one partnership your org is a side of, read from your
+        side: ``counterparty_org_id`` and ``counterparty_name`` are the other
+        organization, and ``initiated_by_org_id`` is the organization that
+        asked. The deprecated ``gc_org_id`` / ``sub_org_id`` and both org
+        names are still served. Requires ``partnerships:read``."""
         data, request_id = self._client._request(
             "GET", f"/v1/partnerships/{partnership_id}", timeout=timeout
         )