workwire 0.5.0__tar.gz → 0.7.0__tar.gz

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

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.7.0](https://github.com/workwire/workwire-python/compare/v0.6.0...v0.7.0) (2026-11-01)
+
+
+### Features
+
+* **WOR-569:** backend v1.81.0's spec — jobs.update(reference=), PartyJob and JobRow gain reference ([#28](https://github.com/workwire/workwire-python/issues/28)) ([b94e055](https://github.com/workwire/workwire-python/commit/b94e0556429fbebacbda2f1d444d86f7b755838f))
+
+## [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.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: workwire
-Version: 0.5.0
+Version: 0.7.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,
@@ -101,8 +101,10 @@ with `--go-live`.
 Every project has a location tree under one `site` root
 (`project.root_location_id`). A party's scope is the locations its work
 covers, and it gets one Job (`JOB-…`) per scope location. A Job's
-`your_reference`, `quantity` and `checked_at` are your org's own, never
-shown to the other side.
+`reference`, `quantity` and `checked_at` are your org's own, never shown to
+the other side. `your_reference` is the deprecated spelling of `reference`
+— still served beside it with the same value, and still accepted by
+`client.jobs.update` (one or the other, never both).
 
 ```python
 from workwire import LocationNode, Party
@@ -130,7 +132,7 @@ client.wires.create(
     ],
 )
 page = client.jobs.list(project=project.id)  # page.quantity_unit is your org's unit
-client.jobs.update(page.data[0].id, your_reference="PO-4471-A", quantity="12.5", checked=True)
+client.jobs.update(page.data[0].id, reference="PO-4471-A", quantity="12.5", checked=True)
 ```
 
 A party Job — each of `client.wires.retrieve(...).parties[i].jobs`, and the

{workwire-0.5.0 → workwire-0.7.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,
@@ -78,8 +78,10 @@ with `--go-live`.
 Every project has a location tree under one `site` root
 (`project.root_location_id`). A party's scope is the locations its work
 covers, and it gets one Job (`JOB-…`) per scope location. A Job's
-`your_reference`, `quantity` and `checked_at` are your org's own, never
-shown to the other side.
+`reference`, `quantity` and `checked_at` are your org's own, never shown to
+the other side. `your_reference` is the deprecated spelling of `reference`
+— still served beside it with the same value, and still accepted by
+`client.jobs.update` (one or the other, never both).
 
 ```python
 from workwire import LocationNode, Party
@@ -107,7 +109,7 @@ client.wires.create(
     ],
 )
 page = client.jobs.list(project=project.id)  # page.quantity_unit is your org's unit
-client.jobs.update(page.data[0].id, your_reference="PO-4471-A", quantity="12.5", checked=True)
+client.jobs.update(page.data[0].id, reference="PO-4471-A", quantity="12.5", checked=True)
 ```
 
 A party Job — each of `client.wires.retrieve(...).parties[i].jobs`, and the

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

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

{workwire-0.5.0 → workwire-0.7.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,
     },
@@ -147,7 +147,7 @@ OPERATIONS: dict[str, dict[str, object]] = {
     "updateJob": {
         "method": "PATCH",
         "path": "/v1/jobs/{id}",
-        "request_fields": {"your_reference", "quantity", "checked"},
+        "request_fields": {"reference", "your_reference", "quantity", "checked"},
         "query_params": set(),
         "response_model": _models.PartyJob,
     },

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

@@ -184,10 +184,12 @@ class PartyJob(WorkwireObject):
     """One Job on a wire party (``JOB-…``) — the party's work at one location
     of its scope. ``location_name``, ``location_kind`` and ``location_path``
     (the ancestors, root first; empty at the site root) are the server's
-    description of where the Job sits in the GC's tree; ``your_reference``,
+    description of where the Job sits in the GC's tree; ``reference``,
     ``quantity`` and ``checked_at`` are **your org's own** fields, never the
     other side's. ``location_unit_type`` is the location's ``unit_type`` — the
-    label a builder gives a unit's plan, ``None`` when unset."""
+    label a builder gives a unit's plan, ``None`` when unset.
+    ``your_reference`` is deprecated — still served, the same value as
+    ``reference``, which replaces it."""
 
     _nested = {"location_path": JobPathLocation}
 
@@ -198,6 +200,7 @@ class PartyJob(WorkwireObject):
     location_kind: str
     location_unit_type: str | None
     location_path: list[JobPathLocation]
+    reference: str | None
     your_reference: str | None
     quantity: str | None
     checked_at: str | None
@@ -266,21 +269,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 +308,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 +333,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
@@ -365,15 +403,18 @@ class JobMilestones(WorkwireObject):
 
 class JobRow(WorkwireObject):
     """One row of :meth:`Jobs.list`: the Job with its party, wire, project,
-    location and counterparty context. ``your_reference``, ``quantity`` and
+    location and counterparty context. ``reference``, ``quantity`` and
     ``checked_at`` are your org's own fields, never the other side's.
     ``location_unit_type`` is the location's ``unit_type`` — the label a
-    builder gives a unit's plan, ``None`` when unset."""
+    builder gives a unit's plan, ``None`` when unset. ``your_reference`` is
+    deprecated — still served, the same value as ``reference``, which
+    replaces it."""
 
     _nested = {"location_path": JobPathLocation, "milestones": JobMilestones}
 
     id: str
     display_id: str
+    reference: str | None
     your_reference: str | None
     quantity: str | None
     checked_at: str | None

{workwire-0.5.0 → workwire-0.7.0}/src/workwire/resources/jobs.py

@@ -5,8 +5,10 @@ Jobs are derived: a party gets one per scope location
 (``scope_location_ids`` on ``Party.partnered(...)`` /
 ``Party.cold_invite(...)``; absent, the whole project), and nothing creates,
 names or closes one. Each org keeps its own private fields on a Job —
-``your_reference``, ``quantity`` (in the org's ``quantity_unit``) and
-``checked_at`` — never shown to the other side.
+``reference``, ``quantity`` (in the org's ``quantity_unit``) and
+``checked_at`` — never shown to the other side. ``your_reference`` is the
+deprecated spelling of ``reference``: still served beside it, the same
+value, and still accepted by :meth:`Jobs.update`.
 """
 
 from __future__ import annotations
@@ -121,6 +123,7 @@ class Jobs:
         self,
         job_id: str,
         *,
+        reference: str | None | NotGiven = NOT_GIVEN,
         your_reference: str | None | NotGiven = NOT_GIVEN,
         quantity: str | Decimal | None | NotGiven = NOT_GIVEN,
         checked: bool | None | NotGiven = NOT_GIVEN,
@@ -134,7 +137,10 @@ class Jobs:
         and the server keeps that field; an explicit ``None`` is sent as
         ``null`` and clears it. At least one is required.
 
-        - ``your_reference`` — your own reference (≤200 characters).
+        - ``reference`` — your own reference (≤200 characters).
+        - ``your_reference`` — deprecated: still accepted in place of
+          ``reference`` and sent as ``your_reference``. Pass one or the
+          other, never both (``None`` counts as passed).
         - ``quantity`` — a decimal string (``"12.5"``) or a
           ``decimal.Decimal``, in your org's ``quantity_unit``; at most 2
           decimal places. Never a float.
@@ -145,7 +151,13 @@ class Jobs:
         your org is not a side of — a draft's Job, for the sub — is a
         ``NotFoundError``. Returns the Job as your org now sees it.
         """
+        if not isinstance(reference, NotGiven) and not isinstance(your_reference, NotGiven):
+            raise ValueError("pass reference or your_reference, not both")
         body: dict[str, Any] = {}
+        if not isinstance(reference, NotGiven):
+            if reference is not None and not isinstance(reference, str):
+                raise TypeError("reference must be a str or None")
+            body["reference"] = reference
         if not isinstance(your_reference, NotGiven):
             if your_reference is not None and not isinstance(your_reference, str):
                 raise TypeError("your_reference must be a str or None")
@@ -158,7 +170,7 @@ class Jobs:
             body["checked"] = checked
         if not body:
             raise ValueError(
-                "pass at least one of your_reference, quantity, checked "
+                "pass at least one of reference, quantity, checked "
                 "(None clears a field; leaving one out keeps it)"
             )
         data, request_id = self._client._request(

{workwire-0.5.0 → workwire-0.7.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
         )