zinkee 0.1.32 → 0.1.34

package/src/utils/examples.ts

@@ -677,38 +677,58 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   ]),
   "records create": buildCommandExamples([
     {
-      description: "Minimal create using just two plain string fields.",
+      description:
+        "Create a single record with --set/--set-json (the single-record flags build one record, sent as a one-element 'records' array).",
       command:
         `zinkee --json records create contacts --set contact-name="Ada Lovelace" --set contact-email=ada@example.com`,
       raw: `{
-  "values": {
-    "contact-name": "Ada Lovelace",
-    "contact-email": "ada@example.com"
-  }
+  "records": [
+    {
+      "contact-name": "Ada Lovelace",
+      "contact-email": "ada@example.com"
+    }
+  ]
 }`,
       response: `{
-  "recordId": "550e8400-e29b-41d4-a716-446655440000",
-  "values": {
-    "contact-name": "Ada Lovelace",
-    "contact-email": "ada@example.com"
-  }
+  "created": [
+    "550e8400-e29b-41d4-a716-446655440000"
+  ],
+  "errors": []
 }`,
     },
     {
       description:
-        "Create a record mixing text, option, number, date, reference and member fields. ReferenceField values must match the target's current targetDisplayField (read it from the target record before writing).",
-      command:
-        `zinkee --json records create contacts --set contact-name="Grace Hopper" --set contact-email=grace@example.com --set status=2 --set amount=1999.99 --set due-date=2026-06-01T09:00:00Z --set customer-ref="CUST-12" --set owner=6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d`,
+        "Create many records from a JSON array file (one object per record, slug -> value). Best-effort: valid records are created and invalid ones are reported per index in 'errors'. ReferenceField values must match the target's current targetDisplayField.",
+      command: `zinkee --json records create contacts --records-file ./records.json`,
       raw: `{
-  "values": {
-    "contact-name": "Grace Hopper",
-    "contact-email": "grace@example.com",
-    "status": 2,
-    "amount": 1999.99,
-    "due-date": "2026-06-01T09:00:00Z",
-    "customer-ref": "CUST-12",
-    "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
-  }
+  "records": [
+    {
+      "contact-name": "Ada Lovelace",
+      "contact-email": "ada@example.com"
+    },
+    {
+      "contact-name": "Grace Hopper",
+      "contact-email": "grace@example.com",
+      "status": 2,
+      "amount": 1999.99,
+      "due-date": "2026-06-01T09:00:00Z",
+      "customer-ref": "8ad602a1-f6e3-43f6-9ab2-f1c5afc99621",
+      "owner": "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
+    }
+  ]
+}`,
+      response: `{
+  "created": [
+    "550e8400-e29b-41d4-a716-446655440000"
+  ],
+  "errors": [
+    {
+      "index": 1,
+      "reason": "record_field_not_found",
+      "message": "Field 'contact-emial' was not found in schema '2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e'.",
+      "action": "Use a valid field slug from the schema and retry."
+    }
+  ]
 }`,
     },
   ]),
@@ -2461,10 +2481,25 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
   ]),
   "records delete": buildCommandExamples([
     {
-      description: "Delete a record.",
-      command: `zinkee --json records delete contacts ${SAMPLE_UUID}`,
+      description: "Delete one or more records by id (--record is repeatable).",
+      command: `zinkee --json records delete contacts --record 550e8400-e29b-41d4-a716-446655440000 --record 6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d`,
       response: `{
-  "recordId": "550e8400-e29b-41d4-a716-446655440000",
+  "recordIds": [
+    "550e8400-e29b-41d4-a716-446655440000",
+    "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
+  ],
+  "deleted": true
+}`,
+    },
+    {
+      description:
+        "Delete many records listing one uuid per line in a file (merged with any --record flags and de-duplicated).",
+      command: `zinkee --json records delete contacts --records-file ./record-ids.txt`,
+      response: `{
+  "recordIds": [
+    "550e8400-e29b-41d4-a716-446655440000",
+    "6c8a3e0d-4e5f-4a1b-9c2d-3e4f5a6b7c8d"
+  ],
   "deleted": true
 }`,
     },