@iterable/cli 0.3.5 → 0.4.0

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.
Files changed (5) hide show
  1. package/COMMANDS.md +23 -10
  2. package/dist/commands/catalogs.d.ts.map +1 -1
  3. package/dist/commands/catalogs.js +12 -5
  4. package/dist/commands/catalogs.js.map +1 -1
  5. package/package.json +4 -3
package/COMMANDS.md CHANGED
@@ -1,4 +1,4 @@
1
- # Available Commands (110)
1
+ # Available Commands (111)
2
2
 
3
3
  All commands follow the pattern: `iterable <category> <command> [options]`
4
4
 
@@ -197,7 +197,7 @@ iterable campaigns trigger --campaignId <campaignId> --listIds <listIds...>
197
197
  | `--suppressionListIds` | number[] | no | Lists to suppress |
198
198
 
199
199
 
200
- ## catalogs (12)
200
+ ## catalogs (13)
201
201
 
202
202
  ### bulk-delete-items
203
203
 
@@ -317,6 +317,19 @@ iterable catalogs partial-update-item --catalogName <catalogName> --itemId <item
317
317
  | `--itemId` | string | **yes** | ID of the catalog item |
318
318
  | `--update` | json | **yes** | Fields to update |
319
319
 
320
+ ### partial-update-items
321
+
322
+ Bulk partial update catalog items (merge fields per item ID)
323
+
324
+ ```
325
+ iterable catalogs partial-update-items <catalogName> --documents <json>
326
+ ```
327
+
328
+ | Option | Type | Required | Description |
329
+ |--------|------|----------|-------------|
330
+ | `catalogName` | string | **yes** | Name of the catalog |
331
+ | `--documents` | json | **yes** | Map of catalog item ID to field values |
332
+
320
333
  ### replace-item
321
334
 
322
335
  Replace (PUT) a catalog item - replaces the entire item with new value
@@ -331,31 +344,31 @@ iterable catalogs replace-item --catalogName <catalogName> --itemId <itemId> --v
331
344
  | `--itemId` | string | **yes** | ID of the catalog item |
332
345
  | `--value` | json | **yes** | New value for the item |
333
346
 
334
- ### update-field-mappings
347
+ ### replace-items
335
348
 
336
- Update catalog field mappings (data types)
349
+ Bulk replace catalog items (each item becomes only provided fields)
337
350
 
338
351
  ```
339
- iterable catalogs update-field-mappings <catalogName> --mappingsUpdates <mappingsUpdates...>
352
+ iterable catalogs replace-items <catalogName> --documents <json>
340
353
  ```
341
354
 
342
355
  | Option | Type | Required | Description |
343
356
  |--------|------|----------|-------------|
344
357
  | `catalogName` | string | **yes** | Name of the catalog |
345
- | `--mappingsUpdates` | string[] | **yes** | Field mappings to update |
358
+ | `--documents` | json | **yes** | Map of catalog item ID to field values |
346
359
 
347
- ### update-items
360
+ ### update-field-mappings
348
361
 
349
- Update catalog items
362
+ Update catalog field mappings (data types)
350
363
 
351
364
  ```
352
- iterable catalogs update-items <catalogName> --items <items...>
365
+ iterable catalogs update-field-mappings <catalogName> --mappingsUpdates <mappingsUpdates...>
353
366
  ```
354
367
 
355
368
  | Option | Type | Required | Description |
356
369
  |--------|------|----------|-------------|
357
370
  | `catalogName` | string | **yes** | Name of the catalog |
358
- | `--items` | json[] | **yes** | Catalog items to update |
371
+ | `--mappingsUpdates` | string[] | **yes** | Field mappings to update |
359
372
 
360
373
 
361
374
  ## events (4)
package/dist/commands/catalogs.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"catalogs.d.ts","sourceRoot":"","sources":["../../src/commands/catalogs.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpD,eAAO,MAAM,eAAe,EAAE,iBAAiB,EA2F9C,CAAC"}
1
+ {"version":3,"file":"catalogs.d.ts","sourceRoot":"","sources":["../../src/commands/catalogs.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpD,eAAO,MAAM,eAAe,EAAE,iBAAiB,EAmG9C,CAAC"}
package/dist/commands/catalogs.js CHANGED
@@ -1,4 +1,4 @@
1
- import { BulkDeleteCatalogItemsParamsSchema, CreateCatalogParamsSchema, DeleteCatalogItemParamsSchema, DeleteCatalogParamsSchema, GetCatalogFieldMappingsParamsSchema, GetCatalogItemParamsSchema, GetCatalogItemsParamsSchema, GetCatalogsParamsSchema, PartialUpdateCatalogItemParamsSchema, ReplaceCatalogItemParamsSchema, UpdateCatalogFieldMappingsParamsSchema, UpdateCatalogItemParamsSchema, } from "@iterable/api";
1
+ import { BulkDeleteCatalogItemsParamsSchema, CreateCatalogParamsSchema, DeleteCatalogItemParamsSchema, DeleteCatalogParamsSchema, GetCatalogFieldMappingsParamsSchema, GetCatalogItemParamsSchema, GetCatalogItemsParamsSchema, GetCatalogsParamsSchema, PartialUpdateCatalogItemParamsSchema, PartialUpdateCatalogItemsParamsSchema, ReplaceCatalogItemParamsSchema, ReplaceCatalogItemsParamsSchema, UpdateCatalogFieldMappingsParamsSchema, } from "@iterable/api";
2
2
  import { defineCommand } from "./types.js";
3
3
  export const catalogCommands = [
4
4
  defineCommand({
@@ -53,10 +53,17 @@ export const catalogCommands = [
53
53
  }),
54
54
  defineCommand({
55
55
  category: "catalogs",
56
- name: "update-items",
57
- description: "Update catalog items",
58
- clientMethod: "updateCatalogItems",
59
- schema: UpdateCatalogItemParamsSchema,
56
+ name: "partial-update-items",
57
+ description: "Bulk partial update catalog items (merge fields per item ID)",
58
+ clientMethod: "partialUpdateCatalogItems",
59
+ schema: PartialUpdateCatalogItemsParamsSchema,
60
+ }),
61
+ defineCommand({
62
+ category: "catalogs",
63
+ name: "replace-items",
64
+ description: "Bulk replace catalog items (each item becomes only provided fields)",
65
+ clientMethod: "replaceCatalogItems",
66
+ schema: ReplaceCatalogItemsParamsSchema,
60
67
  }),
61
68
  defineCommand({
62
69
  category: "catalogs",
package/dist/commands/catalogs.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"catalogs.js","sourceRoot":"","sources":["../../src/commands/catalogs.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kCAAkC,EAClC,yBAAyB,EACzB,6BAA6B,EAC7B,yBAAyB,EACzB,mCAAmC,EACnC,0BAA0B,EAC1B,2BAA2B,EAC3B,uBAAuB,EACvB,oCAAoC,EACpC,8BAA8B,EAC9B,sCAAsC,EACtC,6BAA6B,GAC9B,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,CAAC,MAAM,eAAe,GAAwB;IAClD,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,mDAAmD;QAChE,YAAY,EAAE,aAAa;QAC3B,MAAM,EAAE,uBAAuB;KAChC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,WAAW;QACjB,WAAW,EACT,+DAA+D;QACjE,YAAY,EAAE,iBAAiB;QAC/B,MAAM,EAAE,2BAA2B;KACpC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,mCAAmC;QAChD,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,0BAA0B;KACnC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;KAClC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;QAC/B,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;QACjC,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,iDAAiD;QAC9D,YAAY,EAAE,yBAAyB;QACvC,MAAM,EAAE,mCAAmC;KAC5C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EAAE,4CAA4C;QACzD,YAAY,EAAE,4BAA4B;QAC1C,MAAM,EAAE,sCAAsC;KAC/C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,oBAAoB;QAClC,MAAM,EAAE,6BAA6B;KACtC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,sCAAsC;QACnD,YAAY,EAAE,mBAAmB;QACjC,MAAM,EAAE,6BAA6B;QACrC,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,wBAAwB;QACtC,MAAM,EAAE,kCAAkC;QAC1C,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,uEAAuE;QACzE,YAAY,EAAE,0BAA0B;QACxC,MAAM,EAAE,oCAAoC;KAC7C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,wEAAwE;QAC1E,YAAY,EAAE,oBAAoB;QAClC,MAAM,EAAE,8BAA8B;KACvC,CAAC;CACH,CAAC"}
1
+ {"version":3,"file":"catalogs.js","sourceRoot":"","sources":["../../src/commands/catalogs.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kCAAkC,EAClC,yBAAyB,EACzB,6BAA6B,EAC7B,yBAAyB,EACzB,mCAAmC,EACnC,0BAA0B,EAC1B,2BAA2B,EAC3B,uBAAuB,EACvB,oCAAoC,EACpC,qCAAqC,EACrC,8BAA8B,EAC9B,+BAA+B,EAC/B,sCAAsC,GACvC,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,CAAC,MAAM,eAAe,GAAwB;IAClD,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,mDAAmD;QAChE,YAAY,EAAE,aAAa;QAC3B,MAAM,EAAE,uBAAuB;KAChC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,WAAW;QACjB,WAAW,EACT,+DAA+D;QACjE,YAAY,EAAE,iBAAiB;QAC/B,MAAM,EAAE,2BAA2B;KACpC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,mCAAmC;QAChD,YAAY,EAAE,gBAAgB;QAC9B,MAAM,EAAE,0BAA0B;KACnC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,sBAAsB;QACnC,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;KAClC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,kBAAkB;QAC/B,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;QACjC,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,iDAAiD;QAC9D,YAAY,EAAE,yBAAyB;QACvC,MAAM,EAAE,mCAAmC;KAC5C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EAAE,4CAA4C;QACzD,YAAY,EAAE,4BAA4B;QAC1C,MAAM,EAAE,sCAAsC;KAC/C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,8DAA8D;QAC3E,YAAY,EAAE,2BAA2B;QACzC,MAAM,EAAE,qCAAqC;KAC9C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,eAAe;QACrB,WAAW,EACT,qEAAqE;QACvE,YAAY,EAAE,qBAAqB;QACnC,MAAM,EAAE,+BAA+B;KACxC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,sCAAsC;QACnD,YAAY,EAAE,mBAAmB;QACjC,MAAM,EAAE,6BAA6B;QACrC,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,wBAAwB;QACtC,MAAM,EAAE,kCAAkC;QAC1C,WAAW,EAAE,IAAI;KAClB,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,uEAAuE;QACzE,YAAY,EAAE,0BAA0B;QACxC,MAAM,EAAE,oCAAoC;KAC7C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,UAAU;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,wEAAwE;QAC1E,YAAY,EAAE,oBAAoB;QAClC,MAAM,EAAE,8BAA8B;KACvC,CAAC;CACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iterable/cli",
3
- "version": "0.3.5",
3
+ "version": "0.4.0",
4
4
  "description": "Command-line interface for the Iterable API",
5
5
  "keywords": [
6
6
  "iterable",
@@ -37,7 +37,8 @@
37
37
  "minimumReleaseAge": 4320,
38
38
  "minimumReleaseAgeExclude": [
39
39
  "@iterable/*"
40
- ]
40
+ ],
41
+ "overrides": {}
41
42
  },
42
43
  "scripts": {
43
44
  "build": "pnpm format && pnpm lint:fix && tsc --project tsconfig.build.json && pnpm update-commands && chmod +x dist/index.js",
@@ -59,7 +60,7 @@
59
60
  "update-commands": "node scripts/update-commands.js"
60
61
  },
61
62
  "dependencies": {
62
- "@iterable/api": "0.11.1",
63
+ "@iterable/api": "0.12.0",
63
64
  "@primno/dpapi": "2.0.1",
64
65
  "boxen": "8.0.1",
65
66
  "chalk": "5.6.2",