@knocklabs/cli 1.0.3 → 1.0.5

package/oclif.manifest.json

@@ -1330,52 +1330,6 @@
         "switch.js"
       ]
     },
-    "channel:list": {
-      "aliases": [],
-      "args": {},
-      "flags": {
-        "json": {
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "name": "json",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "service-token": {
-          "env": "KNOCK_SERVICE_TOKEN",
-          "name": "service-token",
-          "required": false,
-          "summary": "The service token to authenticate with.",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "api-origin": {
-          "hidden": true,
-          "name": "api-origin",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "channel:list",
-      "pluginAlias": "@knocklabs/cli",
-      "pluginName": "@knocklabs/cli",
-      "pluginType": "core",
-      "strict": true,
-      "summary": "Display all channels configured for the account.",
-      "enableJsonFlag": true,
-      "isESM": false,
-      "relativePath": [
-        "dist",
-        "commands",
-        "channel",
-        "list.js"
-      ]
-    },
     "commit:get": {
       "aliases": [],
       "args": {
@@ -1479,6 +1433,28 @@
           "summary": "Remove the confirmation prompt.",
           "allowNo": false,
           "type": "boolean"
+        },
+        "resource-type": {
+          "name": "resource-type",
+          "summary": "Commit only changes for the given resource type. Can be used alone or together with --resource-id.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "email_layout",
+            "guide",
+            "message_type",
+            "partial",
+            "translation",
+            "workflow"
+          ],
+          "type": "option"
+        },
+        "resource-id": {
+          "name": "resource-id",
+          "summary": "Commit only changes for the given resource identifier. Must be used together with --resource-type.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1488,7 +1464,7 @@
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Commit all changes in development environment.",
+      "summary": "Commit all changes in development environment, or only changes for a specific resource type.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
@@ -1667,6 +1643,52 @@
         "promote.js"
       ]
     },
+    "channel:list": {
+      "aliases": [],
+      "args": {},
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": false,
+          "summary": "The service token to authenticate with.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-origin": {
+          "hidden": true,
+          "name": "api-origin",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "channel:list",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display all channels configured for the account.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "channel",
+        "list.js"
+      ]
+    },
     "environment:list": {
       "aliases": [],
       "args": {},
@@ -2454,11 +2476,11 @@
         "validate.js"
       ]
     },
-    "message-type:get": {
+    "layout:get": {
       "aliases": [],
       "args": {
-        "messageTypeKey": {
-          "name": "messageTypeKey",
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
           "required": true
         }
       },
@@ -2511,22 +2533,22 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:get",
+      "id": "layout:get",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display a single in-app message type from an environment.",
+      "summary": "Display a single email layout from an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "get.js"
       ]
     },
-    "message-type:list": {
+    "layout:list": {
       "aliases": [],
       "args": {},
       "flags": {
@@ -2599,22 +2621,22 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:list",
+      "id": "layout:list",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display all in-app message types for an environment.",
+      "summary": "Display all email layouts for an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "list.js"
       ]
     },
-    "message-type:new": {
+    "layout:new": {
       "aliases": [],
       "args": {},
       "flags": {
@@ -2638,7 +2660,7 @@
         "name": {
           "char": "n",
           "name": "name",
-          "summary": "The name of the message type",
+          "summary": "The name of the email layout",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -2646,14 +2668,14 @@
         "key": {
           "char": "k",
           "name": "key",
-          "summary": "The key of the message type",
+          "summary": "The key of the email layout",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "environment": {
           "name": "environment",
-          "summary": "The environment to create the message type in. Defaults to development.",
+          "summary": "The environment to create the email layout in. Defaults to development.",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2668,20 +2690,20 @@
         },
         "force": {
           "name": "force",
-          "summary": "Force the creation of the message type directory without confirmation.",
+          "summary": "Force the creation of the email layout directory without confirmation.",
           "allowNo": false,
           "type": "boolean"
         },
         "push": {
           "char": "p",
           "name": "push",
-          "summary": "Whether or not to push the message type to Knock after creation.",
+          "summary": "Whether or not to push the email layout to Knock after creation.",
           "allowNo": false,
           "type": "boolean"
         },
         "template": {
           "name": "template",
-          "summary": "The template to use for the message type. Should be `message-types/{key}`.",
+          "summary": "The template to use for the email layout. Should be `email-layouts/{key}`.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -2689,26 +2711,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:new",
+      "id": "layout:new",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Create a new message type with a minimal configuration.",
+      "summary": "Create a new email layout with a minimal configuration.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "new.js"
       ]
     },
-    "message-type:open": {
+    "layout:open": {
       "aliases": [],
       "args": {
-        "messageTypeKey": {
-          "name": "messageTypeKey",
+        "layoutKey": {
+          "name": "layoutKey",
           "required": true
         }
       },
@@ -2748,26 +2770,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:open",
+      "id": "layout:open",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Open a message type in the Knock dashboard.",
+      "summary": "Open a layout in the Knock dashboard.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "open.js"
       ]
     },
-    "message-type:pull": {
+    "layout:pull": {
       "aliases": [],
       "args": {
-        "messageTypeKey": {
-          "name": "messageTypeKey",
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
           "required": false
         }
       },
@@ -2806,16 +2828,19 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to pull all in-app message types from the specified environment.",
+          "summary": "Whether to pull all email layouts from the specified environment.",
           "allowNo": false,
           "type": "boolean"
         },
-        "message-types-dir": {
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
           "dependsOn": [
             "all"
           ],
-          "name": "message-types-dir",
-          "summary": "The target directory path to pull all in-app message types into.",
+          "name": "layouts-dir",
+          "summary": "The target directory path to pull all email layouts into.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -2835,26 +2860,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:pull",
+      "id": "layout:pull",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Pull one or more in-app message types from an environment into a local file system.",
+      "summary": "Pull one or more email layouts from an environment into a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "pull.js"
       ]
     },
-    "message-type:push": {
+    "layout:push": {
       "aliases": [],
       "args": {
-        "messageTypeKey": {
-          "name": "messageTypeKey",
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
           "required": false
         }
       },
@@ -2878,7 +2903,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Pushing a message type is only allowed in the development environment",
+          "summary": "Pushing an email layout is only allowed in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2896,23 +2921,26 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to push all message types from the target directory.",
+          "summary": "Whether to push all layouts from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "message-types-dir": {
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
           "dependsOn": [
             "all"
           ],
-          "name": "message-types-dir",
-          "summary": "The target directory path to find all message types to push.",
+          "name": "layouts-dir",
+          "summary": "The target directory path to find all layouts to push.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "commit": {
           "name": "commit",
-          "summary": "Push and commit the message type(s) at the same time",
+          "summary": "Push and commit the layout(s) at the same time",
           "allowNo": false,
           "type": "boolean"
         },
@@ -2936,26 +2964,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:push",
+      "id": "layout:push",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Push one or more message types from a local file system to Knock.",
+      "summary": "Push one or more email layouts from a local file system to Knock.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "push.js"
       ]
     },
-    "message-type:validate": {
+    "layout:validate": {
       "aliases": [],
       "args": {
-        "messageTypeKey": {
-          "name": "messageTypeKey",
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
           "required": false
         }
       },
@@ -2979,7 +3007,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Validating a message type is only done in the development environment",
+          "summary": "Validating a layout is only done in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -2997,16 +3025,19 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to validate all message types from the target directory.",
+          "summary": "Whether to validate all layouts from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "message-types-dir": {
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
           "dependsOn": [
             "all"
           ],
-          "name": "message-types-dir",
-          "summary": "The target directory path to find all message types to validate.",
+          "name": "layouts-dir",
+          "summary": "The target directory path to find all layouts to validate.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -3014,26 +3045,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "message-type:validate",
+      "id": "layout:validate",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Validate one or more message types from a local file system.",
+      "summary": "Validate one or more layouts from a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "message-type",
+        "layout",
         "validate.js"
       ]
     },
-    "layout:get": {
+    "message-type:get": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "messageTypeKey": {
+          "name": "messageTypeKey",
           "required": true
         }
       },
@@ -3086,22 +3117,22 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:get",
+      "id": "message-type:get",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display a single email layout from an environment.",
+      "summary": "Display a single in-app message type from an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "get.js"
       ]
     },
-    "layout:list": {
+    "message-type:list": {
       "aliases": [],
       "args": {},
       "flags": {
@@ -3174,22 +3205,22 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:list",
+      "id": "message-type:list",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display all email layouts for an environment.",
+      "summary": "Display all in-app message types for an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "list.js"
       ]
     },
-    "layout:new": {
+    "message-type:new": {
       "aliases": [],
       "args": {},
       "flags": {
@@ -3213,7 +3244,7 @@
         "name": {
           "char": "n",
           "name": "name",
-          "summary": "The name of the email layout",
+          "summary": "The name of the message type",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -3221,14 +3252,14 @@
         "key": {
           "char": "k",
           "name": "key",
-          "summary": "The key of the email layout",
+          "summary": "The key of the message type",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "environment": {
           "name": "environment",
-          "summary": "The environment to create the email layout in. Defaults to development.",
+          "summary": "The environment to create the message type in. Defaults to development.",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -3243,20 +3274,20 @@
         },
         "force": {
           "name": "force",
-          "summary": "Force the creation of the email layout directory without confirmation.",
+          "summary": "Force the creation of the message type directory without confirmation.",
           "allowNo": false,
           "type": "boolean"
         },
         "push": {
           "char": "p",
           "name": "push",
-          "summary": "Whether or not to push the email layout to Knock after creation.",
+          "summary": "Whether or not to push the message type to Knock after creation.",
           "allowNo": false,
           "type": "boolean"
         },
         "template": {
           "name": "template",
-          "summary": "The template to use for the email layout. Should be `email-layouts/{key}`.",
+          "summary": "The template to use for the message type. Should be `message-types/{key}`.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -3264,26 +3295,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:new",
+      "id": "message-type:new",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Create a new email layout with a minimal configuration.",
+      "summary": "Create a new message type with a minimal configuration.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "new.js"
       ]
     },
-    "layout:open": {
+    "message-type:open": {
       "aliases": [],
       "args": {
-        "layoutKey": {
-          "name": "layoutKey",
+        "messageTypeKey": {
+          "name": "messageTypeKey",
           "required": true
         }
       },
@@ -3323,26 +3354,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:open",
+      "id": "message-type:open",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Open a layout in the Knock dashboard.",
+      "summary": "Open a message type in the Knock dashboard.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "open.js"
       ]
     },
-    "layout:pull": {
+    "message-type:pull": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "messageTypeKey": {
+          "name": "messageTypeKey",
           "required": false
         }
       },
@@ -3381,19 +3412,16 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to pull all email layouts from the specified environment.",
+          "summary": "Whether to pull all in-app message types from the specified environment.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "message-types-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to pull all email layouts into.",
+          "name": "message-types-dir",
+          "summary": "The target directory path to pull all in-app message types into.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -3413,26 +3441,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:pull",
+      "id": "message-type:pull",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Pull one or more email layouts from an environment into a local file system.",
+      "summary": "Pull one or more in-app message types from an environment into a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "pull.js"
       ]
     },
-    "layout:push": {
+    "message-type:push": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "messageTypeKey": {
+          "name": "messageTypeKey",
           "required": false
         }
       },
@@ -3456,7 +3484,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Pushing an email layout is only allowed in the development environment",
+          "summary": "Pushing a message type is only allowed in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -3474,26 +3502,23 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to push all layouts from the target directory.",
+          "summary": "Whether to push all message types from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "message-types-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to find all layouts to push.",
+          "name": "message-types-dir",
+          "summary": "The target directory path to find all message types to push.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "commit": {
           "name": "commit",
-          "summary": "Push and commit the layout(s) at the same time",
+          "summary": "Push and commit the message type(s) at the same time",
           "allowNo": false,
           "type": "boolean"
         },
@@ -3517,26 +3542,26 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:push",
+      "id": "message-type:push",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Push one or more email layouts from a local file system to Knock.",
+      "summary": "Push one or more message types from a local file system to Knock.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "push.js"
       ]
     },
-    "layout:validate": {
+    "message-type:validate": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "messageTypeKey": {
+          "name": "messageTypeKey",
           "required": false
         }
       },
@@ -3560,7 +3585,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Validating a layout is only done in the development environment",
+          "summary": "Validating a message type is only done in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -3578,19 +3603,16 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to validate all layouts from the target directory.",
+          "summary": "Whether to validate all message types from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "message-types-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to find all layouts to validate.",
+          "name": "message-types-dir",
+          "summary": "The target directory path to find all message types to validate.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -3598,18 +3620,18 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "layout:validate",
+      "id": "message-type:validate",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Validate one or more layouts from a local file system.",
+      "summary": "Validate one or more message types from a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "message-type",
         "validate.js"
       ]
     },
@@ -5471,5 +5493,5 @@
       ]
     }
   },
-  "version": "1.0.3"
+  "version": "1.0.5"
 }