workwire 0.6.0__tar.gz → 0.7.0__tar.gz

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

@@ -1,5 +1,12 @@
 # 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)
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: workwire
-Version: 0.6.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
@@ -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.6.0 → workwire-0.7.0}/README.md

@@ -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.6.0 → workwire-0.7.0}/pyproject.toml

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

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

@@ -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.6.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
@@ -400,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.6.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(