loxo-cli 0.2.2__tar.gz → 0.3.0__tar.gz

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [0.3.0]
+
+### Added
+
+- `loxo ref custom-fields` gains `--object/-o` and `--custom-only`. `--object`
+  filters to one object's fields by matching `item_type` case-insensitively
+  (e.g. `--object deal`); an unknown value errors with the available object
+  types. `--custom-only` hides built-in fields, leaving just the agency-defined
+  ones. The table now shows `key`, `name`, and `type` (plus `item_type` when
+  unfiltered) instead of `id`/`name`, so the opaque keys (`custom_text_3`) map to
+  their plain-language names at a glance. `--json` carries the full field record
+  plus a derived flat `type`.
+
+## [0.2.3]
+
+### Changed
+
+- `loxo activities list` drops the `--job-id` filter and gains `--company-id`.
+  Loxo's `person_events` endpoint rejects `job_id` as a query parameter (HTTP
+  422 `Invalid parameters: [:job_id]`), so the flag never worked. `person_id`
+  and `company_id` are the only server-side filters the endpoint accepts.
+  (`activities add --job-id` is unaffected — there `job_id` is a request-body
+  field, not a query parameter.)
+
 ## [0.2.2]
 
 ### Fixed

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: loxo-cli
-Version: 0.2.2
+Version: 0.3.0
 Summary: Unofficial command-line interface for the Loxo recruiting ATS/CRM API
 Project-URL: Homepage, https://github.com/alphaomegateam/loxo-cli
 License: MIT
@@ -91,7 +91,9 @@ printed by `loxo configure list`, logged, or shown in `--verbose` output.
 
 Custom (dynamic) fields are supported on writes via repeatable `--field key=value`
 (use `key[]=value` to force a list, e.g. hierarchy fields). Discover valid keys with
-`loxo ref custom-fields`.
+`loxo ref custom-fields`, which maps each key (`custom_text_3`) to its plain-language
+name and type. Filter to one object with `--object deal` (matches the field's
+`item_type`, case-insensitive) and hide built-ins with `--custom-only`.
 
 ## Output
 

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/README.md

@@ -76,7 +76,9 @@ printed by `loxo configure list`, logged, or shown in `--verbose` output.
 
 Custom (dynamic) fields are supported on writes via repeatable `--field key=value`
 (use `key[]=value` to force a list, e.g. hierarchy fields). Discover valid keys with
-`loxo ref custom-fields`.
+`loxo ref custom-fields`, which maps each key (`custom_text_3`) to its plain-language
+name and type. Filter to one object with `--object deal` (matches the field's
+`item_type`, case-insensitive) and hide built-ins with `--custom-only`.
 
 ## Output
 

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "loxo-cli"
-version = "0.2.2"
+version = "0.3.0"
 description = "Unofficial command-line interface for the Loxo recruiting ATS/CRM API"
 readme = "README.md"
 license = { text = "MIT" }

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/src/loxo_cli/commands/activities.py

@@ -16,16 +16,19 @@ activities_app = typer.Typer(
 def list_activities(
     ctx: typer.Context,
     person_id: Optional[int] = typer.Option(None, "--person-id"),
-    job_id: Optional[int] = typer.Option(None, "--job-id"),
+    company_id: Optional[int] = typer.Option(None, "--company-id"),
     all_pages: bool = typer.Option(False, "--all"),
     per_page: int = typer.Option(50, "--per-page"),
 ) -> None:
+    # Loxo's person_events endpoint only accepts person_id / company_id as
+    # server-side filters. job_id is not a valid query param (returns 422), so
+    # it is intentionally not exposed here — filter by person or company instead.
     state = ctx.obj
     params: dict = {}
     if person_id is not None:
         params["person_id"] = person_id
-    if job_id is not None:
-        params["job_id"] = job_id
+    if company_id is not None:
+        params["company_id"] = company_id
     client = state.client()
     if all_pages:
         rows = list(

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/src/loxo_cli/commands/ref.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from typing import Any, Optional
+
 import typer
 
 from loxo_cli.pagination import extract_items, paginate
@@ -52,16 +54,58 @@ def lists(ctx: typer.Context) -> None:
     _list_reference(ctx, "person_lists", paginated=False)
 
 
+def _emit_custom_fields(
+    ctx: typer.Context, object_filter: Optional[str], custom_only: bool
+) -> None:
+    state = ctx.obj
+    # dynamic_fields returns its full config list in one response and ignores
+    # after_id, so fetch once (driving the keyset paginator would loop -> 429).
+    rows: list[dict[str, Any]] = extract_items(state.client().get("dynamic_fields"), None)
+    if object_filter:
+        wanted = object_filter.strip().lower()
+        available = sorted({r["item_type"] for r in rows if r.get("item_type")})
+        if wanted not in {a.lower() for a in available}:
+            raise typer.BadParameter(
+                f"Unknown object {object_filter!r}. Available: {', '.join(available)}",
+                param_hint="--object",
+            )
+        rows = [r for r in rows if (r.get("item_type") or "").lower() == wanted]
+    if custom_only:
+        rows = [r for r in rows if not r.get("built_in")]
+    for r in rows:
+        r["type"] = (r.get("dynamic_field_type") or {}).get("name")
+    # item_type is constant once filtered, so drop that column.
+    cols = ["key", "name", "type"] if object_filter else ["key", "name", "type", "item_type"]
+    state.emit(rows, columns=cols)
+
+
 @ref_app.command("custom-fields")
-def custom_fields(ctx: typer.Context) -> None:
+def custom_fields(
+    ctx: typer.Context,
+    object_filter: Optional[str] = typer.Option(
+        None,
+        "--object",
+        "-o",
+        help="Filter to one object's fields (matches item_type, case-insensitive).",
+    ),
+    custom_only: bool = typer.Option(
+        False,
+        "--custom-only",
+        help="Show only agency-defined fields (exclude built-ins).",
+    ),
+) -> None:
     """List agency custom (dynamic) field definitions."""
-    _list_reference(ctx, "dynamic_fields", paginated=False)
+    _emit_custom_fields(ctx, object_filter, custom_only)
 
 
 @ref_app.command("dynamic-fields", hidden=True)
-def dynamic_fields_alias(ctx: typer.Context) -> None:
+def dynamic_fields_alias(
+    ctx: typer.Context,
+    object_filter: Optional[str] = typer.Option(None, "--object", "-o"),
+    custom_only: bool = typer.Option(False, "--custom-only"),
+) -> None:
     """Alias of custom-fields."""
-    _list_reference(ctx, "dynamic_fields", paginated=False)
+    _emit_custom_fields(ctx, object_filter, custom_only)
 
 
 @ref_app.command("hierarchies")

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/tests/test_cmd_activities.py

@@ -21,6 +21,31 @@ def test_activities_list():
     assert json.loads(result.stdout)[0]["notes"] == "called"
 
 
+@respx.mock
+def test_activities_list_filters_by_person_and_company():
+    route = respx.get("https://app.loxo.co/api/acme/person_events").mock(
+        return_value=httpx.Response(200, json={"scroll_id": None, "person_events": []})
+    )
+    result = runner.invoke(
+        app,
+        ["--json", "activities", "list", "--person-id", "50", "--company-id", "7"],
+        env=ENV,
+    )
+    assert result.exit_code == 0
+    assert dict(route.calls.last.request.url.params) == {
+        "person_id": "50",
+        "company_id": "7",
+        "per_page": "50",
+    }
+
+
+def test_activities_list_has_no_job_id_option():
+    # job_id is not a valid person_events query param (Loxo returns 422), so the
+    # list command must not advertise a --job-id filter.
+    result = runner.invoke(app, ["activities", "list", "--help"], env=ENV)
+    assert "--job-id" not in result.stdout
+
+
 @respx.mock
 def test_activities_add_wraps_person_event():
     captured = {}

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/tests/test_cmd_ref.py

@@ -54,20 +54,102 @@ def test_ref_source_types_still_paginates():
     assert route.call_count == 3
 
 
+# A representative slice of GET /dynamic_fields: built-in and agency-defined
+# fields spread across more than one object (item_type).
+DYNAMIC_FIELDS = [
+    {
+        "id": 1,
+        "name": "Account manager",
+        "key": "owned_by_id",
+        "item_type": "Deal",
+        "dynamic_field_type": {"id": 3, "name": "Enumeration"},
+        "built_in": True,
+    },
+    {
+        "id": 2,
+        "name": "UTM Medium",
+        "key": "custom_text_3",
+        "item_type": "Deal",
+        "dynamic_field_type": {"id": 1, "name": "Text"},
+        "built_in": False,
+    },
+    {
+        "id": 3,
+        "name": "First Name",
+        "key": "first_name",
+        "item_type": "Person",
+        "dynamic_field_type": {"id": 1, "name": "Text"},
+        "built_in": True,
+    },
+]
+
+
 @respx.mock
 def test_ref_custom_fields_single_fetch():
     # dynamic_fields is a flat config list that ignores after_id, so the command
     # fetches it exactly once rather than driving the keyset paginator (which the
     # endpoint would loop forever, causing 429s). A single non-empty response is
-    # all the endpoint ever returns.
+    # all the endpoint ever returns. With no filter every field comes back, and
+    # each row now exposes its `key`.
     route = respx.get("https://app.loxo.co/api/acme/dynamic_fields").mock(
-        return_value=httpx.Response(200, json=[{"id": 1, "name": "custom_text_3"}])
+        return_value=httpx.Response(200, json=DYNAMIC_FIELDS)
     )
     result = runner.invoke(app, ["--json", "ref", "custom-fields"], env=ENV)
-    assert json.loads(result.stdout)[0]["name"] == "custom_text_3"
+    keys = [x["key"] for x in json.loads(result.stdout)]
+    assert keys == ["owned_by_id", "custom_text_3", "first_name"]
     assert route.call_count == 1
 
 
+@respx.mock
+def test_ref_custom_fields_filter_by_object():
+    # --object matches item_type case-insensitively and returns only that
+    # object's fields.
+    respx.get("https://app.loxo.co/api/acme/dynamic_fields").mock(
+        return_value=httpx.Response(200, json=DYNAMIC_FIELDS)
+    )
+    result = runner.invoke(app, ["--json", "ref", "custom-fields", "--object", "deal"], env=ENV)
+    rows = json.loads(result.stdout)
+    assert {x["item_type"] for x in rows} == {"Deal"}
+    assert [x["key"] for x in rows] == ["owned_by_id", "custom_text_3"]
+
+
+@respx.mock
+def test_ref_custom_fields_unknown_object_errors():
+    # An item_type that isn't present is a usage error that names the available
+    # object types.
+    respx.get("https://app.loxo.co/api/acme/dynamic_fields").mock(
+        return_value=httpx.Response(200, json=DYNAMIC_FIELDS)
+    )
+    result = runner.invoke(app, ["ref", "custom-fields", "--object", "bogus"], env=ENV)
+    assert result.exit_code == 2
+    combined = result.output + (result.stderr if result.stderr_bytes else "")
+    assert "Deal" in combined and "Person" in combined
+
+
+@respx.mock
+def test_ref_custom_fields_custom_only_drops_builtins():
+    # --custom-only keeps only agency-defined (built_in == False) fields.
+    respx.get("https://app.loxo.co/api/acme/dynamic_fields").mock(
+        return_value=httpx.Response(200, json=DYNAMIC_FIELDS)
+    )
+    result = runner.invoke(app, ["--json", "ref", "custom-fields", "--custom-only"], env=ENV)
+    rows = json.loads(result.stdout)
+    assert [x["key"] for x in rows] == ["custom_text_3"]
+
+
+@respx.mock
+def test_ref_custom_fields_json_carries_key_and_derived_type():
+    # JSON output preserves the full record and adds a flat `type` derived from
+    # dynamic_field_type.name.
+    respx.get("https://app.loxo.co/api/acme/dynamic_fields").mock(
+        return_value=httpx.Response(200, json=DYNAMIC_FIELDS)
+    )
+    result = runner.invoke(app, ["--json", "ref", "custom-fields", "--object", "deal"], env=ENV)
+    row = json.loads(result.stdout)[0]
+    assert row["key"] == "owned_by_id"
+    assert row["type"] == "Enumeration"
+
+
 @respx.mock
 def test_ref_lists_uses_person_lists_endpoint():
     # `ref lists` maps to the person_lists endpoint (GET /lists 404s). It returns

{loxo_cli-0.2.2 → loxo_cli-0.3.0}/uv.lock

@@ -274,7 +274,7 @@ wheels = [
 
 [[package]]
 name = "loxo-cli"
-version = "0.2.2"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "click" },