zinkee 0.1.65 → 0.1.66

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
@@ -621,6 +621,45 @@ zinkee --json logs list <schema-slug> <record-uuid>
621
621
 
622
622
  ---
623
623
 
624
+ ## Members
625
+
626
+ `members list` returns the active members of the workspace
627
+ (`GET /api/v2/members`), sorted by alias, without pending invitations or service
628
+ accounts. It is a read: it works with `--read-only`.
629
+
630
+ ```bash
631
+ zinkee members list
632
+ zinkee --json members list
633
+ ```
634
+
635
+ ```json
636
+ {
637
+ "data": [
638
+ { "email": "maria@example.com", "alias": "María López", "currentUser": true },
639
+ { "email": "pablo@example.com", "alias": "pablo", "currentUser": false }
640
+ ],
641
+ "meta": { "command": "members list" }
642
+ }
643
+ ```
644
+
645
+ - `email` is the value a member field stores: write it exactly with `--set`, and
646
+ filter by it with `eq` or `in` in `records query` and `records aggregate`.
647
+ - `alias` is the display name, the same label `records aggregate` gives a group
648
+ by a member field.
649
+ - `currentUser` is `true` only on your own entry, when the CLI runs with a user
650
+ token (as in Kraken); with an API key it is always `false`. Member fields do not
651
+ accept `myself` when writing, so to assign a record to yourself, write the
652
+ `email` of the entry with `currentUser: true`.
653
+
654
+ ```bash
655
+ # Assign a record to a member, then find the records of one or more members
656
+ zinkee records update deals <record-uuid> --set owner=maria@example.com
657
+ zinkee --json records query deals --where "owner eq maria@example.com"
658
+ zinkee --json records aggregate deals --where "owner in maria@example.com,pablo@example.com" --group-by owner
659
+ ```
660
+
661
+ ---
662
+
624
663
  ## Navigation
625
664
 
626
665
  Organize schemas into database folders. The navigation menu holds databases, so only schemas can be moved here.
@@ -1033,7 +1033,7 @@ var specificExamples = {
1033
1033
  "amount": 1999.99,
1034
1034
  "due-date": "2026-06-01T09:00:00Z",
1035
1035
  "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621",
1036
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1036
+ "owner": "maria@example.com"
1037
1037
  }
1038
1038
  ]
1039
1039
  }`,
@@ -1123,19 +1123,19 @@ var specificExamples = {
1123
1123
  "status": 2,
1124
1124
  "amount": 1250.50,
1125
1125
  "due-date": "2026-05-15T12:00:00Z",
1126
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1126
+ "owner": "maria@example.com"
1127
1127
  }
1128
1128
  }`
1129
1129
  },
1130
1130
  {
1131
1131
  description: "Patch multiple typed values at once.",
1132
- command: "zinkee --json records update contacts 550e8400-e29b-41d4-a716-446655440000 --set status=3 --set amount=2500.00 --set due-date=2026-07-01T09:00:00Z --set owner=6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1132
+ command: "zinkee --json records update contacts 550e8400-e29b-41d4-a716-446655440000 --set status=3 --set amount=2500.00 --set due-date=2026-07-01T09:00:00Z --set owner=maria@example.com",
1133
1133
  raw: `{
1134
1134
  "set": {
1135
1135
  "status": 3,
1136
1136
  "amount": 2500.00,
1137
1137
  "due-date": "2026-07-01T09:00:00Z",
1138
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
1138
+ "owner": "maria@example.com"
1139
1139
  }
1140
1140
  }`
1141
1141
  },
@@ -1630,12 +1630,12 @@ var specificExamples = {
1630
1630
  }`
1631
1631
  },
1632
1632
  {
1633
- description: "Create a MEMBER variable with a default user id.",
1634
- command: "zinkee --json displays variables create 0f6f062f-1478-4df2-96a1-c495d037d260 --type MEMBER --name Owner --default 6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1633
+ description: "Create a MEMBER variable with a default member (the email that members list returns).",
1634
+ command: "zinkee --json displays variables create 0f6f062f-1478-4df2-96a1-c495d037d260 --type MEMBER --name Owner --default maria@example.com",
1635
1635
  raw: `{
1636
1636
  "type": "MEMBER",
1637
1637
  "name": "Owner",
1638
- "defaultValue": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
1638
+ "defaultValue": "maria@example.com",
1639
1639
  "allowMultiple": false,
1640
1640
  "staticVariable": false
1641
1641
  }`
@@ -2887,7 +2887,7 @@ var specificExamples = {
2887
2887
  "status": 2,
2888
2888
  "amount": 1250.50,
2889
2889
  "due-date": "2026-05-15T12:00:00Z",
2890
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
2890
+ "owner": "maria@example.com"
2891
2891
  }
2892
2892
  },
2893
2893
  {
@@ -2928,7 +2928,7 @@ var specificExamples = {
2928
2928
  "status": 2,
2929
2929
  "amount": 1250.50,
2930
2930
  "due-date": "2026-05-15T12:00:00Z",
2931
- "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
2931
+ "owner": "maria@example.com"
2932
2932
  }
2933
2933
  }`
2934
2934
  }
@@ -3033,6 +3033,24 @@ var specificExamples = {
3033
3033
  "operation": "UPDATE"
3034
3034
  }
3035
3035
  }
3036
+ ]`
3037
+ }
3038
+ ],
3039
+ "members list": [
3040
+ {
3041
+ description: "List the active members of the workspace, sorted by alias (no pending invitations or service accounts). Write the exact 'email' in a member field and filter by it ('eq', 'in'); 'alias' is the display name, the label records aggregate gives a member group. 'currentUser' is true only on the caller's entry with a user token, always false with an API key; member fields do not accept 'myself' when writing.",
3042
+ command: "zinkee --json members list",
3043
+ response: `[
3044
+ {
3045
+ "email": "maria@example.com",
3046
+ "alias": "Mar\xEDa L\xF3pez",
3047
+ "currentUser": true
3048
+ },
3049
+ {
3050
+ "email": "pablo@example.com",
3051
+ "alias": "pablo",
3052
+ "currentUser": false
3053
+ }
3036
3054
  ]`
3037
3055
  }
3038
3056
  ],
@@ -3276,7 +3294,7 @@ var specificExamples = {
3276
3294
  "id": "cccccccc-3333-4333-a333-333333333333",
3277
3295
  "type": "MEMBER",
3278
3296
  "name": "Owner",
3279
- "defaultValue": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d",
3297
+ "defaultValue": "maria@example.com",
3280
3298
  "allowMultiple": false,
3281
3299
  "staticVariable": false
3282
3300
  }
@@ -4768,4 +4786,4 @@ function withResponseEnvelope({ responseMeta, ...example }, commandName) {
4768
4786
  export {
4769
4787
  getCommandExamples
4770
4788
  };
4771
- //# sourceMappingURL=examples-SC6U5M4S.js.map
4789
+ //# sourceMappingURL=examples-C7OUOX34.js.map