@iterable/cli 0.4.0 → 0.5.0

package/COMMANDS.md

@@ -1,4 +1,4 @@
-# Available Commands (111)
+# Available Commands (120)
 
 All commands follow the pattern: `iterable <category> <command> [options]`
 
@@ -432,7 +432,72 @@ iterable events track-bulk --events <events...>
 | `--events` | json[] | **yes** |  |
 
 
-## experiments (4)
+## experiments (13)
+
+### cancel
+
+Cancel a running or winner-found campaign experiment without declaring a winner
+
+```
+iterable experiments cancel <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
+
+### copy-variant
+
+Copy a template into a new variant on a draft or ready campaign experiment
+
+```
+iterable experiments copy-variant --copyFromTemplateId <copyFromTemplateId> --experimentId <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `--copyFromTemplateId` | number | **yes** | Template ID to copy into a new variant |
+| `--experimentId` | number | **yes** | Experiment ID |
+| `--name` | string | no | Display name for the new variant |
+
+### create
+
+Create a draft campaign experiment. The campaign template becomes the control.
+
+```
+iterable experiments create --campaignId <campaignId> --experimentType <experimentType>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `--campaignId` | number | **yes** | Campaign ID |
+| `--experimentType` | `SubjectLine` \| `PreheaderText` \| `FromNameAndSender` \| `EmailBody` \| `WholeEmail` | **yes** | What to test. Send-time, send-time optimization, and frequency optimization are not supported. |
+| `--name` | string | no | Display name. If omitted, Iterable uses '{campaign name} Experiment'. |
+
+### declare-winner
+
+Declare a winning variant and end a running or winner-found campaign experiment
+
+```
+iterable experiments declare-winner --experimentId <experimentId> --variantId <variantId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `--experimentId` | number | **yes** | Experiment ID |
+| `--variantId` | number | **yes** | Variant ID to declare as the winner. The holdout group cannot be selected. |
+
+### delete
+
+Delete a draft, ready, or errored campaign experiment
+
+```
+iterable experiments delete <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
 
 ### get
 
@@ -461,6 +526,32 @@ iterable experiments get-metrics
 | `--experimentId` | number[] | no | Experiment IDs to export (can specify multiple) |
 | `--startDateTime` | string | no | Export starting from (ISO 8601 format) |
 
+### get-totals
+
+Get lifetime send and conversion totals for a campaign experiment
+
+```
+iterable experiments get-totals <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
+
+### get-trends
+
+Get the performance time series for a campaign experiment. Provide both start and end times, or omit both to use the run window.
+
+```
+iterable experiments get-trends <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
+| `--endDateTime` | string | no | Series end (ISO 8601). Required when startDateTime is set. |
+| `--startDateTime` | string | no | Series start (ISO 8601). Required when endDateTime is set. |
+
 ### get-variants
 
 Get variant content for an experiment, including subject lines, preheaders, HTML source, and plain text
@@ -490,6 +581,35 @@ iterable experiments list
 | `--startDate` | string | no | Filter experiments starting from this date (ISO 8601 format) |
 | `--status` | `draft` \| `running` \| `finished` | no | Filter by status (draft, running, finished) |
 
+### start
+
+Start a draft or ready campaign experiment
+
+```
+iterable experiments start <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
+
+### update-settings
+
+Update settings on a draft or ready campaign experiment. Omit a field to leave it unchanged.
+
+```
+iterable experiments update-settings <experimentId>
+```
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `experimentId` | number | **yes** | Experiment ID |
+| `--conversionEventSettings` | json | no | Conversion settings. Omit to leave unchanged. (JSON: {systemConversionEventType, customConversionId}) |
+| `--evenlySplitVariations` | boolean | no | Set true to split traffic evenly and clear blast and trigger settings. false is rejected. Omit to leave allocation unchanged. |
+| `--explorationBlastSettings` | json | no | Blast exploration settings. Null removes them. Omit to leave unchanged. (JSON: {testSizePercentage, testDurationMinutes}) |
+| `--explorationTriggerSettings` | json | no | Trigger exploration settings. Null removes them. Omit to leave unchanged. (JSON: {testSendsPerVariation}) |
+| `--holdoutSettings` | json | no | Holdout settings. Null removes them. Omit to leave unchanged. (JSON: {holdOutGroupSize, attributionPeriodHours}) |
+
 
 ## export (4)
 

package/dist/commands/experiments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"experiments.d.ts","sourceRoot":"","sources":["../../src/commands/experiments.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpD,eAAO,MAAM,kBAAkB,EAAE,iBAAiB,EA+BjD,CAAC"}
+{"version":3,"file":"experiments.d.ts","sourceRoot":"","sources":["../../src/commands/experiments.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGpD,eAAO,MAAM,kBAAkB,EAAE,iBAAiB,EAsGjD,CAAC"}

package/dist/commands/experiments.js

@@ -1,4 +1,4 @@
-import { GetExperimentMetricsParamsSchema, GetExperimentParamsSchema, GetExperimentVariantsParamsSchema, ListExperimentsParamsSchema, } from "@iterable/api";
+import { CopyExperimentVariantParamsSchema, CreateExperimentParamsSchema, DeclareExperimentWinnerParamsSchema, ExperimentIdParamsSchema, GetExperimentMetricsParamsSchema, GetExperimentParamsSchema, GetExperimentTrendsParamsSchema, GetExperimentVariantsParamsSchema, ListExperimentsParamsSchema, UpdateExperimentSettingsParamsSchema, } from "@iterable/api";
 import { defineCommand } from "./types.js";
 export const experimentCommands = [
     defineCommand({
@@ -29,5 +29,69 @@ export const experimentCommands = [
         clientMethod: "getExperimentVariants",
         schema: GetExperimentVariantsParamsSchema,
     }),
+    defineCommand({
+        category: "experiments",
+        name: "get-totals",
+        description: "Get lifetime send and conversion totals for a campaign experiment",
+        clientMethod: "getExperimentTotals",
+        schema: ExperimentIdParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "get-trends",
+        description: "Get the performance time series for a campaign experiment. Provide both start and end times, or omit both to use the run window.",
+        clientMethod: "getExperimentTrends",
+        schema: GetExperimentTrendsParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "create",
+        description: "Create a draft campaign experiment. The campaign template becomes the control.",
+        clientMethod: "createExperiment",
+        schema: CreateExperimentParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "copy-variant",
+        description: "Copy a template into a new variant on a draft or ready campaign experiment",
+        clientMethod: "copyExperimentVariant",
+        schema: CopyExperimentVariantParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "update-settings",
+        description: "Update settings on a draft or ready campaign experiment. Omit a field to leave it unchanged.",
+        clientMethod: "updateExperimentSettings",
+        schema: UpdateExperimentSettingsParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "start",
+        description: "Start a draft or ready campaign experiment",
+        clientMethod: "startExperiment",
+        schema: ExperimentIdParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "cancel",
+        description: "Cancel a running or winner-found campaign experiment without declaring a winner",
+        clientMethod: "cancelExperiment",
+        schema: ExperimentIdParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "declare-winner",
+        description: "Declare a winning variant and end a running or winner-found campaign experiment",
+        clientMethod: "declareExperimentWinner",
+        schema: DeclareExperimentWinnerParamsSchema,
+    }),
+    defineCommand({
+        category: "experiments",
+        name: "delete",
+        description: "Delete a draft, ready, or errored campaign experiment",
+        clientMethod: "deleteExperiment",
+        schema: ExperimentIdParamsSchema,
+        destructive: true,
+    }),
 ];
 //# sourceMappingURL=experiments.js.map

package/dist/commands/experiments.js.map

@@ -1 +1 @@
-{"version":3,"file":"experiments.js","sourceRoot":"","sources":["../../src/commands/experiments.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gCAAgC,EAChC,yBAAyB,EACzB,iCAAiC,EACjC,2BAA2B,GAC5B,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,CAAC,MAAM,kBAAkB,GAAwB;IACrD,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,MAAM;QACZ,WAAW,EACT,8EAA8E;QAChF,YAAY,EAAE,iBAAiB;QAC/B,MAAM,EAAE,2BAA2B;KACpC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,4DAA4D;QACzE,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;KAClC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,iDAAiD;QAC9D,YAAY,EAAE,sBAAsB;QACpC,MAAM,EAAE,gCAAgC;KACzC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,yGAAyG;QAC3G,YAAY,EAAE,uBAAuB;QACrC,MAAM,EAAE,iCAAiC;KAC1C,CAAC;CACH,CAAC"}
+{"version":3,"file":"experiments.js","sourceRoot":"","sources":["../../src/commands/experiments.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,4BAA4B,EAC5B,mCAAmC,EACnC,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,EACzB,+BAA+B,EAC/B,iCAAiC,EACjC,2BAA2B,EAC3B,oCAAoC,GACrC,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,CAAC,MAAM,kBAAkB,GAAwB;IACrD,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,MAAM;QACZ,WAAW,EACT,8EAA8E;QAChF,YAAY,EAAE,iBAAiB;QAC/B,MAAM,EAAE,2BAA2B;KACpC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,4DAA4D;QACzE,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,yBAAyB;KAClC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,iDAAiD;QAC9D,YAAY,EAAE,sBAAsB;QACpC,MAAM,EAAE,gCAAgC;KACzC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,yGAAyG;QAC3G,YAAY,EAAE,uBAAuB;QACrC,MAAM,EAAE,iCAAiC;KAC1C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,YAAY;QAClB,WAAW,EACT,mEAAmE;QACrE,YAAY,EAAE,qBAAqB;QACnC,MAAM,EAAE,wBAAwB;KACjC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,YAAY;QAClB,WAAW,EACT,kIAAkI;QACpI,YAAY,EAAE,qBAAqB;QACnC,MAAM,EAAE,+BAA+B;KACxC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,gFAAgF;QAClF,YAAY,EAAE,kBAAkB;QAChC,MAAM,EAAE,4BAA4B;KACrC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,4EAA4E;QAC9E,YAAY,EAAE,uBAAuB;QACrC,MAAM,EAAE,iCAAiC;KAC1C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EACT,8FAA8F;QAChG,YAAY,EAAE,0BAA0B;QACxC,MAAM,EAAE,oCAAoC;KAC7C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,4CAA4C;QACzD,YAAY,EAAE,iBAAiB;QAC/B,MAAM,EAAE,wBAAwB;KACjC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,iFAAiF;QACnF,YAAY,EAAE,kBAAkB;QAChC,MAAM,EAAE,wBAAwB;KACjC,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,iFAAiF;QACnF,YAAY,EAAE,yBAAyB;QACvC,MAAM,EAAE,mCAAmC;KAC5C,CAAC;IACF,aAAa,CAAC;QACZ,QAAQ,EAAE,aAAa;QACvB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,uDAAuD;QACpE,YAAY,EAAE,kBAAkB;QAChC,MAAM,EAAE,wBAAwB;QAChC,WAAW,EAAE,IAAI;KAClB,CAAC;CACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iterable/cli",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Command-line interface for the Iterable API",
   "keywords": [
     "iterable",
@@ -60,7 +60,7 @@
     "update-commands": "node scripts/update-commands.js"
   },
   "dependencies": {
-    "@iterable/api": "0.12.0",
+    "@iterable/api": "0.13.1",
     "@primno/dpapi": "2.0.1",
     "boxen": "8.0.1",
     "chalk": "5.6.2",
@@ -70,7 +70,7 @@
     "ora": "9.3.0",
     "package-manager-detector": "1.6.0",
     "semver": "7.7.4",
-    "zod": "4.3.6",
+    "zod": "4.6.7",
     "zod-opts": "1.0.0"
   },
   "devDependencies": {