feat: sync SDK to OnePin API v0.41.155

.spec-sha

@@ -1 +1 @@
-8c8c6f7f8bdffec317e65c2abf9e2af93692424f
+da90f167064000a4c5ff595855e1e266dfd43d8f

guards.log

@@ -1,13 +1,13 @@
 ........................................................................ [ 17%]
 ..................................................................s..... [ 34%]
-........................................................................ [ 51%]
-.........F.............................................................. [ 68%]
+...........................................................F....F....... [ 51%]
+................F....................................................... [ 68%]
 ........................................................................ [ 85%]
 ...............................................................          [100%]
 =================================== FAILURES ===================================
-__________________ test_no_unexposed_sdk_params[voices.list] ___________________
+_________________ test_no_unexposed_sdk_params[workflows.list] _________________
 
-cmd = Cmd(group='voices', name='list', method='voices.list', help='List available voices.', subgroup=None, args=[], options=...ider', 'gender', 'category'], success_msg=None, destructive=False, redact=False, fallback_methods=(), gate='buildable')
+cmd = Cmd(group='workflows', name='list', method='workflows.list', help='List workflows in the workspace.', subgroup=None, a...', 'last_run_status', 'updated_at'], success_msg=None, destructive=False, redact=False, fallback_methods=(), gate=None)
 
     @pytest.mark.parametrize("cmd", TABLE, ids=lambda c: ".".join(c.path))
     def test_no_unexposed_sdk_params(cmd: Cmd) -> None:
@@ -24,10 +24,60 @@ cmd = Cmd(group='voices', name='list', method='voices.list', help='List availabl
             f"for it. Either add an Opt(...) to the row in _spec.py, or record the decision in "
             f"_INTENTIONALLY_UNEXPOSED with the reason."
         )
-E       AssertionError: voices.list: voices.list accepts ['provider_voice_id'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
-E       assert not {'provider_voice_id'}
+E       AssertionError: workflows.list: workflows.list accepts ['exclude_empty'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+E       assert not {'exclude_empty'}
+
+tests/build/test_sdk_contract.py:233: AssertionError
+_______________ test_no_unexposed_sdk_params[workflows.uploads] ________________
+
+cmd = Cmd(group='workflows', name='uploads', method='workflows.list_workflow_uploads', help="List a workflow's uploads.", su...'category', 'status', 'size_bytes'], success_msg=None, destructive=False, redact=False, fallback_methods=(), gate=None)
+
+    @pytest.mark.parametrize("cmd", TABLE, ids=lambda c: ".".join(c.path))
+    def test_no_unexposed_sdk_params(cmd: Cmd) -> None:
+        """Every param the SDK accepts is reachable from the CLI, or allowlisted with a reason.
+
+        This is the drift check the regen PR runs: the generated client gains a param, no
+        hand-written flag gains with it, and this goes red naming the command and the param
+        instead of leaving the gap to be found in use months later.
+        """
+        missing = _unexposed_params(cmd) - set(_INTENTIONALLY_UNEXPOSED.get(cmd.path, {}))
+
+>       assert not missing, (
+            f"{'.'.join(cmd.path)}: {cmd.method} accepts {sorted(missing)} but the CLI has no flag "
+            f"for it. Either add an Opt(...) to the row in _spec.py, or record the decision in "
+            f"_INTENTIONALLY_UNEXPOSED with the reason."
+        )
+E       AssertionError: workflows.uploads: workflows.list_workflow_uploads accepts ['category'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+E       assert not {'category'}
+
+tests/build/test_sdk_contract.py:233: AssertionError
+_________________ test_no_unexposed_sdk_params[uploads.delete] _________________
+
+cmd = Cmd(group='uploads', name='delete', method='uploads.delete', help='Delete an upload.', subgroup=None, args=[('upload_i... columns=[], success_msg='Deleted upload {upload_id}.', destructive=True, redact=False, fallback_methods=(), gate=None)
+
+    @pytest.mark.parametrize("cmd", TABLE, ids=lambda c: ".".join(c.path))
+    def test_no_unexposed_sdk_params(cmd: Cmd) -> None:
+        """Every param the SDK accepts is reachable from the CLI, or allowlisted with a reason.
+
+        This is the drift check the regen PR runs: the generated client gains a param, no
+        hand-written flag gains with it, and this goes red naming the command and the param
+        instead of leaving the gap to be found in use months later.
+        """
+        missing = _unexposed_params(cmd) - set(_INTENTIONALLY_UNEXPOSED.get(cmd.path, {}))
+
+>       assert not missing, (
+            f"{'.'.join(cmd.path)}: {cmd.method} accepts {sorted(missing)} but the CLI has no flag "
+            f"for it. Either add an Opt(...) to the row in _spec.py, or record the decision in "
+            f"_INTENTIONALLY_UNEXPOSED with the reason."
+        )
+E       AssertionError: uploads.delete: uploads.delete accepts ['if_unreferenced'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+E       assert not {'if_unreferenced'}
 
 tests/build/test_sdk_contract.py:233: AssertionError
 =========================== short test summary info ============================
-FAILED tests/build/test_sdk_contract.py::test_no_unexposed_sdk_params[voices.list] - AssertionError: voices.list: voices.list accepts ['provider_voice_id'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
-assert not {'provider_voice_id'}
+FAILED tests/build/test_sdk_contract.py::test_no_unexposed_sdk_params[workflows.list] - AssertionError: workflows.list: workflows.list accepts ['exclude_empty'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+assert not {'exclude_empty'}
+FAILED tests/build/test_sdk_contract.py::test_no_unexposed_sdk_params[workflows.uploads] - AssertionError: workflows.uploads: workflows.list_workflow_uploads accepts ['category'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+assert not {'category'}
+FAILED tests/build/test_sdk_contract.py::test_no_unexposed_sdk_params[uploads.delete] - AssertionError: uploads.delete: uploads.delete accepts ['if_unreferenced'] but the CLI has no flag for it. Either add an Opt(...) to the row in _spec.py, or record the decision in _INTENTIONALLY_UNEXPOSED with the reason.
+assert not {'if_unreferenced'}

src/onepin/.fern/metadata.json

@@ -30,7 +30,7 @@
       }
     ]
   },
-  "originGitCommit": "45e96724ab4ffc17fdc44d6f21e1f71206c318cc",
+  "originGitCommit": "5f8c05331687cedffed0c6ac9e97d81b9c338aa9",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "ciProvider": "github"

src/onepin/__init__.py

@@ -301,7 +301,11 @@
         ListVoicesRequestSourceItem,
         PreviewVoicesRequestLanguage,
     )
-    from .workflows import ListWorkflowsRequestOrderItem, ListWorkflowsRequestSortItem
+    from .workflows import (
+        ListWorkflowUploadsApiV1WorkflowsWorkflowIdUploadsGetRequestCategory,
+        ListWorkflowsRequestOrderItem,
+        ListWorkflowsRequestSortItem,
+    )
 _dynamic_imports: typing.Dict[str, str] = {
     "ApiCountedListResponseCatalogVoiceOut": ".types",
     "ApiCountedListResponseVoiceOut": ".types",
@@ -404,6 +408,7 @@
     "ListVoicesRequestOrderItem": ".voices",
     "ListVoicesRequestSortItem": ".voices",
     "ListVoicesRequestSourceItem": ".voices",
+    "ListWorkflowUploadsApiV1WorkflowsWorkflowIdUploadsGetRequestCategory": ".workflows",
     "ListWorkflowsRequestOrderItem": ".workflows",
     "ListWorkflowsRequestSortItem": ".workflows",
     "Meta": ".types",
@@ -726,6 +731,7 @@ def __dir__():
     "ListVoicesRequestOrderItem",
     "ListVoicesRequestSortItem",
     "ListVoicesRequestSourceItem",
+    "ListWorkflowUploadsApiV1WorkflowsWorkflowIdUploadsGetRequestCategory",
     "ListWorkflowsRequestOrderItem",
     "ListWorkflowsRequestSortItem",
     "Meta",

src/onepin/core/http_client.py

@@ -184,8 +184,33 @@ def _should_retry(response: httpx.Response) -> bool:
 )
 
 
+_AUTH_HEADERS: typing.FrozenSet[str] = frozenset()
+
+
 def _redact_headers(headers: typing.Dict[str, str]) -> typing.Dict[str, str]:
-    return {k: ("[REDACTED]" if k.lower() in _SENSITIVE_HEADERS else v) for k, v in headers.items()}
+    return {
+        k: ("[REDACTED]" if k.lower() in _SENSITIVE_HEADERS or k.lower() in _AUTH_HEADERS else v)
+        for k, v in headers.items()
+    }
+
+
+def _merge_headers(*header_dicts: typing.Optional[typing.Dict[str, typing.Any]]) -> typing.Dict[str, typing.Any]:
+    """
+    Merge header dicts left to right. Header names are case-insensitive, so a later
+    `x-api-key` replaces an earlier `X-API-Key` instead of producing two headers.
+    """
+    merged: typing.Dict[str, typing.Any] = {}
+    keys_by_lower: typing.Dict[str, str] = {}
+    for header_dict in header_dicts:
+        if not header_dict:
+            continue
+        for key, value in header_dict.items():
+            existing_key = keys_by_lower.get(key.lower())
+            if existing_key is not None:
+                del merged[existing_key]
+            keys_by_lower[key.lower()] = key
+            merged[key] = value
+    return merged
 
 
 def _build_url(base_url: str, path: typing.Optional[str]) -> str:
@@ -425,11 +450,11 @@ def request(
         _request_url = _build_url(base_url, path)
         _request_headers = jsonable_encoder(
             remove_none_from_dict(
-                {
-                    **self.base_headers(),
-                    **(headers if headers is not None else {}),
-                    **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
-                }
+                _merge_headers(
+                    self.base_headers(),
+                    headers,
+                    request_options.get("additional_headers") if request_options is not None else None,
+                )
             )
         )
         _request_headers = drop_content_type_without_body(
@@ -463,7 +488,12 @@ def request(
                 files=request_files,
                 timeout=timeout,
             )
-        except (httpx.ConnectError, httpx.RemoteProtocolError):
+        except (httpx.ConnectError, httpx.RemoteProtocolError) as error:
+            # A protocol error may occur after the server applied the request, even while reading a 200 body.
+            if isinstance(error, httpx.RemoteProtocolError) and not (
+                request_options is not None and request_options.get("retry_remote_protocol_errors", False)
+            ):
+                raise
             if retries < max_retries:
                 time.sleep(_retry_timeout_from_retries(retries=retries))
                 return self.request(
@@ -594,11 +624,11 @@ def stream(
         _request_url = _build_url(base_url, path)
         _request_headers = jsonable_encoder(
             remove_none_from_dict(
-                {
-                    **self.base_headers(),
-                    **(headers if headers is not None else {}),
-                    **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                }
+                _merge_headers(
+                    self.base_headers(),
+                    headers,
+                    request_options.get("additional_headers") if request_options is not None else None,
+                )
             )
         )
         _request_headers = drop_content_type_without_body(
@@ -735,11 +765,11 @@ async def request(
         _request_url = _build_url(base_url, path)
         _request_headers = jsonable_encoder(
             remove_none_from_dict(
-                {
-                    **_headers,
-                    **(headers if headers is not None else {}),
-                    **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
-                }
+                _merge_headers(
+                    _headers,
+                    headers,
+                    request_options.get("additional_headers") if request_options is not None else None,
+                )
             )
         )
         _request_headers = drop_content_type_without_body(
@@ -773,7 +803,12 @@ async def request(
                 files=request_files,
                 timeout=timeout,
             )
-        except (httpx.ConnectError, httpx.RemoteProtocolError):
+        except (httpx.ConnectError, httpx.RemoteProtocolError) as error:
+            # A protocol error may occur after the server applied the request, even while reading a 200 body.
+            if isinstance(error, httpx.RemoteProtocolError) and not (
+                request_options is not None and request_options.get("retry_remote_protocol_errors", False)
+            ):
+                raise
             if retries < max_retries:
                 await asyncio.sleep(_retry_timeout_from_retries(retries=retries))
                 return await self.request(
@@ -907,11 +942,11 @@ async def stream(
         _request_url = _build_url(base_url, path)
         _request_headers = jsonable_encoder(
             remove_none_from_dict(
-                {
-                    **_headers,
-                    **(headers if headers is not None else {}),
-                    **(request_options.get("additional_headers", {}) if request_options is not None else {}),
-                }
+                _merge_headers(
+                    _headers,
+                    headers,
+                    request_options.get("additional_headers") if request_options is not None else None,
+                )
             )
         )
         _request_headers = drop_content_type_without_body(

src/onepin/core/pagination.py

@@ -3,7 +3,20 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import AsyncIterator, Awaitable, Callable, Generic, Iterator, List, Optional, TypeVar
+from typing import (
+    Any,
+    AsyncIterator,
+    Awaitable,
+    Callable,
+    Generic,
+    Iterator,
+    List,
+    Mapping,
+    Optional,
+    Sequence,
+    TypeVar,
+    get_args,
+)
 
 # Generic to represent the underlying type of the results within a page
 T = TypeVar("T")
@@ -80,3 +93,73 @@ async def iter_pages(self) -> AsyncIterator[AsyncPager[T, R]]:
 
     async def next_page(self) -> Optional[AsyncPager[T, R]]:
         return await self.get_next() if self.get_next is not None else None
+
+
+def get_nested_page_value(container: Any, path: Sequence[str], default: Any = None) -> Any:
+    """
+    Read a nested paging value (e.g. `options.offset`) from a request parameter that may be
+    a dict, a model, None, or omitted (`...`). Returns `default` when any segment is missing.
+    """
+    value = container
+    for key in path:
+        if value is None or value is ...:
+            return default
+        value = value.get(key) if isinstance(value, Mapping) else getattr(value, key, None)
+    return default if value is None or value is ... else value
+
+
+def with_nested_page_value(container: Any, path: Sequence[str], value: Any, container_type: Any = None) -> Any:
+    """
+    Return a copy of a request parameter with the nested paging value at `path` replaced,
+    creating omitted containers and keeping every other field. When `container_type` (or the
+    annotation of the parent model's field) is a model, created containers are built through that
+    model so field aliases (e.g. `page_offset` -> `pageOffset`) apply on the wire.
+    """
+    if len(path) == 0:
+        return value
+    key, rest = path[0], path[1:]
+    if container is None or container is ...:
+        return _build_container(container_type, {key: with_nested_page_value(None, rest, value)})
+    if isinstance(container, Mapping):
+        return {**container, key: with_nested_page_value(container.get(key), rest, value)}
+    updated = with_nested_page_value(
+        getattr(container, key, None), rest, value, _get_field_annotation(type(container), key)
+    )
+    if hasattr(container, "model_copy"):
+        return container.model_copy(update={key: updated})
+    return container.copy(update={key: updated})
+
+
+def _build_container(container_type: Any, data: Mapping[str, Any]) -> Any:
+    model = _find_model_class(container_type)
+    if model is None:
+        return data
+    try:
+        if hasattr(model, "model_validate"):
+            return model.model_validate(data)
+        return model.parse_obj(data)
+    except (TypeError, ValueError):
+        return data
+
+
+def _find_model_class(annotation: Any) -> Any:
+    models = []
+    pending = [annotation]
+    while pending:
+        candidate = pending.pop()
+        if isinstance(candidate, type):
+            if hasattr(candidate, "model_validate") or hasattr(candidate, "parse_obj"):
+                models.append(candidate)
+        else:
+            pending.extend(get_args(candidate))
+    return models[0] if len(models) == 1 else None
+
+
+def _get_field_annotation(model: Any, key: str) -> Any:
+    fields = getattr(model, "model_fields", None)
+    if isinstance(fields, Mapping):
+        return fields[key].annotation if key in fields else None
+    legacy_fields = getattr(model, "__fields__", None)
+    if isinstance(legacy_fields, Mapping) and key in legacy_fields:
+        return legacy_fields[key].outer_type_
+    return None