zinkee 0.1.63 → 0.1.64

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -501,9 +501,16 @@ refuses `records delete` of a record it points at; nothing is deleted. Blocked b
501
501
  (comma-separated values), `between` (exactly two comma-separated values `from,to`,
502
502
  both included), `is_empty`, `is_not_empty`.
503
503
 
504
+ On a reference field, `eq`, `neq` and `in` take the target record id (a UUID in any
505
+ letter case) and match the records that point at it, or whose visible value is that
506
+ same text. Any other value, the compound `recordId::label` that reads return included,
507
+ is compared with the visible value, so records pointing at different records with the
508
+ same visible value match together. `in` can mix ids and visible values.
509
+
504
510
  ```bash
505
511
  zinkee --json records query contacts --where "contact-name not_contains test"
506
512
  zinkee --json records query contacts --where "due-date between 2026-10-01,2026-10-31"
513
+ zinkee --json records query deals --where "customer-ref eq 8ad602a1-f6e3-43f6-9ab2-f1c5afc99621"
507
514
  ```
508
515
 
509
516
  For OR, pass the API's native `where` with `--where-json`: a JSON array of conditions
@@ -554,6 +561,8 @@ zinkee --json records aggregate deals --where "status eq OPEN" --metric count --
554
561
  `--json` prints `{"data": [<groups>], "meta": {"command", "configPath", "aggregate"}}`.
555
562
  Each group is `{"key": {<slug>: {"value", "label"}}, "metrics": {<alias>: <value>}}`;
556
563
  records with an empty value share one group whose key is `{"value": null, "label": null}`.
564
+ The `value` of a reference key is the target record id in lower case: reuse it in
565
+ `--where "<field> eq <value>"` (or `in`) to list the records of that group.
557
566
  `meta.aggregate` holds `count`, `total`, `limit`, `truncated` and `timezone`: when
558
567
  `truncated` is true, raise `--limit` or narrow the filters. The request is a read:
559
568
  it works with `--read-only` and never sends an `Idempotency-Key`. See
@@ -653,6 +653,26 @@ var specificExamples = {
653
653
  "count": 1,
654
654
  "hasMore": false
655
655
  }
656
+ }`
657
+ },
658
+ {
659
+ description: "Records whose reference field points at a given record. On a reference field, eq, neq and in take the target record id (a UUID in any letter case) and match the records that point at it (or whose visible value is that same text). Any other value, the compound 'recordId::label' that reads return included, is compared with the visible value, so records pointing at different records with the same visible value match together.",
660
+ command: 'zinkee --json records query deals --select id,deal-name,customer-ref --where "customer-ref eq 8ad602a1-f6e3-43f6-9ab2-f1c5afc99621"',
661
+ raw: `{
662
+ "select": ["id", "deal-name", "customer-ref"],
663
+ "where": [
664
+ { "field": "customer-ref", "op": "eq", "value": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621" }
665
+ ]
666
+ }`
667
+ },
668
+ {
669
+ description: "Records whose reference field points at any of several records: in takes a comma-separated list and can mix target record ids and visible values.",
670
+ command: 'zinkee --json records query deals --select id,deal-name,customer-ref --where "customer-ref in 8ad602a1-f6e3-43f6-9ab2-f1c5afc99621,3f2b7c1e-9d4a-4e8b-b6a5-0c1d2e3f4a5b"',
671
+ raw: `{
672
+ "select": ["id", "deal-name", "customer-ref"],
673
+ "where": [
674
+ { "field": "customer-ref", "op": "in", "value": ["8ad602a1-f6e3-43f6-9ab2-f1c5afc99621", "3f2b7c1e-9d4a-4e8b-b6a5-0c1d2e3f4a5b"] }
675
+ ]
656
676
  }`
657
677
  },
658
678
  {
@@ -4723,4 +4743,4 @@ function withResponseEnvelope({ responseMeta, ...example }, commandName) {
4723
4743
  export {
4724
4744
  getCommandExamples
4725
4745
  };
4726
- //# sourceMappingURL=examples-MPBE5OXQ.js.map
4746
+ //# sourceMappingURL=examples-RRNLFYD4.js.map