transcodely 0.3.0__tar.gz → 0.3.1__tar.gz

{transcodely-0.3.0 → transcodely-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: transcodely
-Version: 0.3.0
+Version: 0.3.1
 Summary: Official Python SDK for the Transcodely video transcoding API
 Project-URL: Homepage, https://transcodely.com
 Project-URL: Documentation, https://transcodely.com/docs

{transcodely-0.3.0 → transcodely-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "transcodely"
-version = "0.3.0"
+version = "0.3.1"
 description = "Official Python SDK for the Transcodely video transcoding API"
 readme = "README.md"
 license = "MIT"

transcodely-0.3.1/src/transcodely/resources/_helpers.py

@@ -0,0 +1,66 @@
+"""Internal helpers shared by resource modules."""
+
+from __future__ import annotations
+
+from typing import Any, Mapping, Optional, Union
+
+from google.protobuf import json_format
+from google.protobuf.descriptor import EnumDescriptor
+from google.protobuf.message import Message
+
+from .._codec.json_codec import expand_enum_value, simplify_enum_value, transform_enums_in_dict
+
+
+def fill_from_dict(msg: Message, data: Mapping[str, Any]) -> Message:
+    """Populate ``msg`` from a plain dict, accepting simplified-enum strings.
+
+    The codec's enum-expand pass lets callers pass ``{"codec": "h264"}`` while
+    the proto stores ``VIDEO_CODEC_H264`` (an int after parse).
+    """
+    payload = dict(data)
+    transform_enums_in_dict(payload, msg.DESCRIPTOR, mode="expand")
+    json_format.ParseDict(payload, msg, ignore_unknown_fields=True)
+    return msg
+
+
+def resolve_enum(value: Union[int, str], enum_desc: EnumDescriptor) -> int:
+    """Resolve an enum value from either the raw proto int or a string.
+
+    Strings may be the simplified lowercase wire form (``"standard"``,
+    ``"processing"``) or the canonical proto name (``"JOB_PRIORITY_STANDARD"``) —
+    both resolve to the same int via the codec's inbound ``expand`` rule. Ints
+    pass through unchanged (proto3 enums are open, so an unknown int is the
+    caller's responsibility). Used for scalar enum kwargs that are set on a
+    request directly rather than through :func:`fill_from_dict`.
+    """
+    if isinstance(value, bool):  # bool is an int subclass — reject it explicitly.
+        raise TypeError(f"{enum_desc.name} value must be an int or str, got bool: {value!r}")
+    if isinstance(value, int):
+        return value
+    if isinstance(value, str):
+        name = expand_enum_value(value, enum_desc)
+        entry = enum_desc.values_by_name.get(name)
+        if entry is None:
+            allowed = ", ".join(
+                simplify_enum_value(v.name, enum_desc) for v in enum_desc.values if v.number != 0
+            )
+            raise ValueError(
+                f"unknown {enum_desc.name} value {value!r}; expected one of: {allowed}"
+            )
+        return int(entry.number)
+    raise TypeError(f"{enum_desc.name} value must be an int or str, got {type(value).__name__}")
+
+
+def assign_pagination(
+    req_pagination: Any,
+    *,
+    limit: Optional[int] = None,
+    cursor: Optional[str] = None,
+    offset: Optional[int] = None,
+) -> None:
+    if limit is not None:
+        req_pagination.limit = limit
+    if cursor is not None:
+        req_pagination.cursor = cursor
+    if offset is not None:
+        req_pagination.offset = offset

{transcodely-0.3.0 → transcodely-0.3.1}/src/transcodely/resources/apps.py

@@ -31,11 +31,23 @@ class Apps:
     def list(
         self,
         *,
+        org_id: Optional[str] = None,
         limit: Optional[int] = None,
+        include_archived: Optional[bool] = None,
         opts: Optional[CallOptions] = None,
     ) -> Page[app_pb2.App]:
+        """List apps in an organization.
+
+        ``org_id`` (the parent organization, e.g. ``"org_a1b2c3d4e5"``) is required
+        by the API. Pass ``include_archived=True`` to include archived apps.
+        """
+
         def fetch(cursor: Optional[str]) -> PageContents[app_pb2.App]:
             req = app_pb2.ListAppsRequest()
+            if org_id is not None:
+                req.org_id = org_id
+            if include_archived is not None:
+                req.include_archived = include_archived
             assign_pagination(req.pagination, limit=limit, cursor=cursor)
             res = self._t.unary(_SERVICE, "List", req, app_pb2.ListAppsResponse(), opts)
             return PageContents(

{transcodely-0.3.0 → transcodely-0.3.1}/src/transcodely/resources/jobs.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
-from typing import Any, Generator, Mapping, Optional
+from typing import Any, Generator, Mapping, Optional, Union
 
 from .._transport.transport import CallOptions, Transport
 from ..pagination import Page, PageContents
 from ..streaming import watch
 from ..v1 import job_pb2
+from ._helpers import assign_pagination, fill_from_dict, resolve_enum
 
 _SERVICE = "transcodely.v1.JobService"
 
@@ -21,35 +22,54 @@ class Jobs:
         input_url: Optional[str] = None,
         outputs: Optional[list[Mapping[str, Any]]] = None,
         *,
-        idempotency_key: Optional[str] = None,
+        output_origin_id: Optional[str] = None,
+        output_path_template: Optional[str] = None,
+        input_origin_id: Optional[str] = None,
+        input_path: Optional[str] = None,
+        priority: Optional[Union[int, str]] = None,
+        delayed_start: Optional[bool] = None,
         webhook_url: Optional[str] = None,
-        priority: Optional[int] = None,
         metadata: Optional[Mapping[str, str]] = None,
+        idempotency_key: Optional[str] = None,
         request: Optional[job_pb2.CreateJobRequest] = None,
         opts: Optional[CallOptions] = None,
     ) -> job_pb2.Job:
-        """Create a new transcoding job. Auto-fills ``idempotency_key`` if omitted."""
+        """Create a new transcoding job.
+
+        Keyword arguments mirror the API's snake_case fields. Enum-valued fields —
+        ``priority`` here, plus any enum inside ``outputs`` dicts — accept either the
+        simplified lowercase string (``"standard"``, ``"h264"``) or the raw proto int.
+        Provide inputs via ``input_url`` (direct URL) OR ``input_origin_id`` +
+        ``input_path`` (origin mode); the server rejects both. Pass a fully-built
+        ``request=`` to bypass the convenience kwargs entirely. ``idempotency_key`` is
+        auto-filled with a uuid4 when omitted. ``output_path_template`` overrides where
+        rendered outputs are written within the output origin (e.g.
+        ``"videos/{job_id}/{output}"``).
+        """
         if request is None:
-            req = job_pb2.CreateJobRequest()
+            payload: dict[str, Any] = {}
             if input_url is not None:
-                req.input_url = input_url
+                payload["input_url"] = input_url
+            if input_origin_id is not None:
+                payload["input_origin_id"] = input_origin_id
+            if input_path is not None:
+                payload["input_path"] = input_path
+            if output_origin_id is not None:
+                payload["output_origin_id"] = output_origin_id
+            if output_path_template is not None:
+                payload["output_path_template"] = output_path_template
             if outputs:
-                from google.protobuf import json_format
-
-                from .._codec.json_codec import transform_enums_in_dict
-
-                # Outputs are nested messages — round-trip through JSON so callers can
-                # pass plain dicts with simplified-enum strings.
-                payload = {"outputs": list(outputs)}
-                transform_enums_in_dict(payload, req.DESCRIPTOR, mode="expand")
-                json_format.ParseDict(payload, req, ignore_unknown_fields=True)
-            if webhook_url is not None:
-                req.webhook_url = webhook_url
+                payload["outputs"] = list(outputs)
             if priority is not None:
-                req.priority = priority
+                payload["priority"] = priority
+            if delayed_start is not None:
+                payload["delayed_start"] = delayed_start
+            if webhook_url is not None:
+                payload["webhook_url"] = webhook_url
             if metadata:
-                for k, v in metadata.items():
-                    req.metadata[k] = v
+                payload["metadata"] = dict(metadata)
+            req = job_pb2.CreateJobRequest()
+            fill_from_dict(req, payload)
         else:
             req = request
         if not req.idempotency_key:
@@ -66,22 +86,37 @@ class Jobs:
     def list(
         self,
         *,
-        status: Optional[int] = None,
+        status: Optional[Union[int, str]] = None,
         limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        pagination: Optional[Mapping[str, Any]] = None,
         opts: Optional[CallOptions] = None,
     ) -> Page[job_pb2.Job]:
-        from ..v1 import common_pb2
+        """List jobs, optionally filtered by ``status``.
+
+        ``status`` accepts the simplified lowercase string (``"processing"``) or the
+        raw ``JobStatus`` int. Pagination may be given as ``limit`` / ``offset``
+        keyword args or as a ``pagination={"limit": ..., "offset": ..., "cursor": ...}``
+        mapping; explicit keyword args take precedence over the mapping.
+        """
+        status_value = (
+            resolve_enum(status, job_pb2.JobStatus.DESCRIPTOR) if status is not None else None
+        )
+        pag = dict(pagination) if pagination else {}
+        eff_limit = limit if limit is not None else pag.get("limit")
+        eff_offset = offset if offset is not None else pag.get("offset")
+        start_cursor = pag.get("cursor")
 
         def fetch(cursor: Optional[str]) -> PageContents[job_pb2.Job]:
             req = job_pb2.ListJobsRequest()
-            if status is not None:
-                req.status = status
-            pagination = common_pb2.PaginationRequest()
-            if limit is not None:
-                pagination.limit = limit
-            if cursor is not None:
-                pagination.cursor = cursor
-            req.pagination.CopyFrom(pagination)
+            if status_value is not None:
+                req.status = status_value
+            assign_pagination(
+                req.pagination,
+                limit=eff_limit,
+                cursor=cursor if cursor is not None else start_cursor,
+                offset=eff_offset,
+            )
             res = self._t.unary(_SERVICE, "List", req, job_pb2.ListJobsResponse(), opts)
             return PageContents(
                 items=list(res.jobs),

{transcodely-0.3.0 → transcodely-0.3.1}/src/transcodely/resources/memberships.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from .._transport.transport import CallOptions, Transport
 from ..pagination import Page, PageContents
 from ..v1 import membership_pb2
-from ._helpers import assign_pagination, fill_from_dict
+from ._helpers import assign_pagination, fill_from_dict, resolve_enum
 
 _SERVICE = "transcodely.v1.MembershipService"
 
@@ -19,11 +19,25 @@ class Memberships:
     def list(
         self,
         *,
+        status: Optional[Union[int, str]] = None,
         limit: Optional[int] = None,
         opts: Optional[CallOptions] = None,
     ) -> Page[membership_pb2.MembershipWithUser]:
+        """List memberships, optionally filtered by ``status``.
+
+        ``status`` accepts the simplified lowercase string (``"active"``,
+        ``"invited"``, ``"suspended"``) or the raw ``MembershipStatus`` int.
+        """
+        status_value = (
+            resolve_enum(status, membership_pb2.MembershipStatus.DESCRIPTOR)
+            if status is not None
+            else None
+        )
+
         def fetch(cursor: Optional[str]) -> PageContents[membership_pb2.MembershipWithUser]:
             req = membership_pb2.ListMembershipsRequest()
+            if status_value is not None:
+                req.status = status_value
             assign_pagination(req.pagination, limit=limit, cursor=cursor)
             res = self._t.unary(
                 _SERVICE, "List", req, membership_pb2.ListMembershipsResponse(), opts

{transcodely-0.3.0 → transcodely-0.3.1}/src/transcodely/resources/users.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 from .._transport.transport import CallOptions, Transport
 from ..pagination import Page, PageContents
 from ..v1 import user_pb2
-from ._helpers import assign_pagination, fill_from_dict
+from ._helpers import assign_pagination, fill_from_dict, resolve_enum
 
 _SERVICE = "transcodely.v1.UserService"
 
@@ -32,11 +32,23 @@ class Users:
     def list(
         self,
         *,
+        status: Optional[Union[int, str]] = None,
         limit: Optional[int] = None,
         opts: Optional[CallOptions] = None,
     ) -> Page[user_pb2.User]:
+        """List users, optionally filtered by ``status``.
+
+        ``status`` accepts the simplified lowercase string (``"active"``,
+        ``"suspended"``, ``"deleted"``) or the raw ``UserStatus`` int.
+        """
+        status_value = (
+            resolve_enum(status, user_pb2.UserStatus.DESCRIPTOR) if status is not None else None
+        )
+
         def fetch(cursor: Optional[str]) -> PageContents[user_pb2.User]:
             req = user_pb2.ListUsersRequest()
+            if status_value is not None:
+                req.status = status_value
             assign_pagination(req.pagination, limit=limit, cursor=cursor)
             res = self._t.unary(_SERVICE, "List", req, user_pb2.ListUsersResponse(), opts)
             return PageContents(

{transcodely-0.3.0 → transcodely-0.3.1}/src/transcodely/version.py

@@ -1,7 +1,7 @@
 """Version constants exposed at the top of the package."""
 
 #: SDK package version. Bumped by release-please from pyproject.toml.
-SDK_VERSION = "0.3.0"  # x-release-please-version
+SDK_VERSION = "0.3.1"  # x-release-please-version
 
 #: Calendar-versioned API this release pins. Sent on every request as
 #: `Transcodely-Version`. Override per-client via ``api_version=``.

transcodely-0.3.0/src/transcodely/resources/_helpers.py

@@ -1,29 +0,0 @@
-"""Internal helpers shared by resource modules."""
-
-from __future__ import annotations
-
-from typing import Any, Mapping, Optional
-
-from google.protobuf import json_format
-from google.protobuf.message import Message
-
-from .._codec.json_codec import transform_enums_in_dict
-
-
-def fill_from_dict(msg: Message, data: Mapping[str, Any]) -> Message:
-    """Populate ``msg`` from a plain dict, accepting simplified-enum strings.
-
-    The codec's enum-expand pass lets callers pass ``{"codec": "h264"}`` while
-    the proto stores ``VIDEO_CODEC_H264`` (an int after parse).
-    """
-    payload = dict(data)
-    transform_enums_in_dict(payload, msg.DESCRIPTOR, mode="expand")
-    json_format.ParseDict(payload, msg, ignore_unknown_fields=True)
-    return msg
-
-
-def assign_pagination(req_pagination: Any, *, limit: Optional[int], cursor: Optional[str]) -> None:
-    if limit is not None:
-        req_pagination.limit = limit
-    if cursor is not None:
-        req_pagination.cursor = cursor