@knocklabs/cli 0.1.22 → 0.1.23

package/oclif.manifest.json

@@ -418,6 +418,28 @@
           "allowNo": true,
           "type": "boolean"
         },
+        "resource-type": {
+          "name": "resource-type",
+          "summary": "Filter commits by resource type. Must be used 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": "Filter commits by resource identifier. Must be used together with resource-type. For most resources, this will be the resource key. In the case of translations, this will be the locale code and namespace, separated by a /. For example, en/courses or en.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "after": {
           "name": "after",
           "summary": "The cursor after which to fetch the next page.",
@@ -516,11 +538,160 @@
         "promote.js"
       ]
     },
-    "layout:get": {
+    "guide:activate": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "guideKey": {
+          "name": "guideKey",
+          "required": true
+        }
+      },
+      "description": "This enables or disables a guide in a given environment without\nneeding to go through environment promotion.\n\nYou can activate or deactivate a guide immediately or schedule it to be activated \nor deactivated at a later time using the --from and --until flags.",
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "required": true,
+          "summary": "The environment to use.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "status": {
+          "exclusive": [
+            "from",
+            "until"
+          ],
+          "name": "status",
+          "summary": "The guide active status to set. Cannot be used with --from/--until.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "type": "option"
+        },
+        "from": {
+          "exclusive": [
+            "status"
+          ],
+          "name": "from",
+          "summary": "Activate the guide from this ISO8601 UTC datetime (e.g., '2024-01-15T10:30:00Z').",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "until": {
+          "exclusive": [
+            "status"
+          ],
+          "name": "until",
+          "summary": "Deactivate the guide at this ISO8601 UTC datetime (e.g., '2024-01-15T18:30:00Z').",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "name": "force",
+          "summary": "Remove the confirmation prompt.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "guide:activate",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Activate or deactivate a guide in a given environment.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "guide",
+        "activate.js"
+      ]
+    },
+    "guide:generate-types": {
+      "aliases": [],
+      "args": {},
+      "description": "Generate types for all guides in an environment and write them to a file.",
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "Select the environment to generate types for.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-file": {
+          "name": "output-file",
+          "required": true,
+          "summary": "The output file to write the generated types to. We currently support .ts, .py, .go, .rb files only. Your file extension will determine the target language for the generated types.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "guide:generate-types",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "guide",
+        "generate-types.js"
+      ]
+    },
+    "guide:get": {
+      "aliases": [],
+      "args": {
+        "guideKey": {
+          "name": "guideKey",
           "required": true
         }
       },
@@ -565,23 +736,24 @@
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "layout:get",
+      "id": "guide:get",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display a single email layout from an environment.",
+      "summary": "Display a single guide from an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "guide",
         "get.js"
       ]
     },
-    "layout:list": {
+    "guide:list": {
       "aliases": [],
       "args": {},
       "flags": {
@@ -646,27 +818,28 @@
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "layout:list",
+      "id": "guide:list",
       "pluginAlias": "@knocklabs/cli",
       "pluginName": "@knocklabs/cli",
       "pluginType": "core",
       "strict": true,
-      "summary": "Display all email layouts for an environment.",
+      "summary": "Display all guides for an environment.",
       "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "guide",
         "list.js"
       ]
     },
-    "layout:pull": {
+    "guide:pull": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "guideKey": {
+          "name": "guideKey",
           "required": false
         }
       },
@@ -698,19 +871,16 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to pull all email layouts from the specified environment.",
+          "summary": "Whether to pull all guides from the specified environment.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "guides-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to pull all email layouts into.",
+          "name": "guides-dir",
+          "summary": "The target directory path to pull all guides into.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -729,27 +899,28 @@
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "layout:pull",
+      "id": "guide: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 guides from an environment into a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "guide",
         "pull.js"
       ]
     },
-    "layout:push": {
+    "guide:push": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "guideKey": {
+          "name": "guideKey",
           "required": false
         }
       },
@@ -773,7 +944,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Pushing an email layout is only allowed in the development environment",
+          "summary": "Pushing a guide is only allowed in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -784,26 +955,23 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to push all layouts from the target directory.",
+          "summary": "Whether to push all guides from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "guides-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to find all layouts to push.",
+          "name": "guides-dir",
+          "summary": "The target directory path to find all guides 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 guide(s) at the same time",
           "allowNo": false,
           "type": "boolean"
         },
@@ -820,27 +988,28 @@
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "layout:push",
+      "id": "guide: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 guides from a local file system to Knock.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "guide",
         "push.js"
       ]
     },
-    "layout:validate": {
+    "guide:validate": {
       "aliases": [],
       "args": {
-        "emailLayoutKey": {
-          "name": "emailLayoutKey",
+        "guideKey": {
+          "name": "guideKey",
           "required": false
         }
       },
@@ -864,7 +1033,7 @@
         },
         "environment": {
           "name": "environment",
-          "summary": "Validating a layout is only done in the development environment",
+          "summary": "Validating a guide is only done in the development environment",
           "default": "development",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -875,38 +1044,36 @@
         },
         "all": {
           "name": "all",
-          "summary": "Whether to validate all layouts from the target directory.",
+          "summary": "Whether to validate all guides from the target directory.",
           "allowNo": false,
           "type": "boolean"
         },
-        "layouts-dir": {
-          "aliases": [
-            "email-layouts-dir"
-          ],
+        "guides-dir": {
           "dependsOn": [
             "all"
           ],
-          "name": "layouts-dir",
-          "summary": "The target directory path to find all layouts to validate.",
+          "name": "guides-dir",
+          "summary": "The target directory path to find all guides to validate.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         }
       },
       "hasDynamicHelp": false,
+      "hidden": true,
       "hiddenAliases": [],
-      "id": "layout:validate",
+      "id": "guide: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 guides from a local file system.",
       "enableJsonFlag": false,
       "isESM": false,
       "relativePath": [
         "dist",
         "commands",
-        "layout",
+        "guide",
         "validate.js"
       ]
     },
@@ -1300,6 +1467,400 @@
         "validate.js"
       ]
     },
+    "layout:get": {
+      "aliases": [],
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": true
+        }
+      },
+      "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": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "layout:get",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display a single email layout from an environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "layout",
+        "get.js"
+      ]
+    },
+    "layout: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": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "after": {
+          "name": "after",
+          "summary": "The cursor after which to fetch the next page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "before": {
+          "name": "before",
+          "summary": "The cursor before which to fetch the previous page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "limit": {
+          "name": "limit",
+          "summary": "The total number of entries to fetch per page.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "layout:list",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Display all email layouts for an environment.",
+      "enableJsonFlag": true,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "layout",
+        "list.js"
+      ]
+    },
+    "layout:pull": {
+      "aliases": [],
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "The environment to use.",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to pull all email layouts from the specified environment.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
+          "dependsOn": [
+            "all"
+          ],
+          "name": "layouts-dir",
+          "summary": "The target directory path to pull all email layouts into.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "hide-uncommitted-changes": {
+          "name": "hide-uncommitted-changes",
+          "summary": "Hide any uncommitted changes.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "name": "force",
+          "summary": "Remove the confirmation prompt.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "layout: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.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "layout",
+        "pull.js"
+      ]
+    },
+    "layout:push": {
+      "aliases": [],
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "Pushing an email layout is only allowed in the development environment",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to push all layouts from the target directory.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
+          "dependsOn": [
+            "all"
+          ],
+          "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 layout(s) at the same time",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "commit-message": {
+          "char": "m",
+          "dependsOn": [
+            "commit"
+          ],
+          "name": "commit-message",
+          "summary": "Use the given value as the commit message",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "layout: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.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "layout",
+        "push.js"
+      ]
+    },
+    "layout:validate": {
+      "aliases": [],
+      "args": {
+        "emailLayoutKey": {
+          "name": "emailLayoutKey",
+          "required": false
+        }
+      },
+      "flags": {
+        "service-token": {
+          "env": "KNOCK_SERVICE_TOKEN",
+          "name": "service-token",
+          "required": true,
+          "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"
+        },
+        "environment": {
+          "name": "environment",
+          "summary": "Validating a layout is only done in the development environment",
+          "default": "development",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "development"
+          ],
+          "type": "option"
+        },
+        "all": {
+          "name": "all",
+          "summary": "Whether to validate all layouts from the target directory.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "layouts-dir": {
+          "aliases": [
+            "email-layouts-dir"
+          ],
+          "dependsOn": [
+            "all"
+          ],
+          "name": "layouts-dir",
+          "summary": "The target directory path to find all layouts to validate.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "layout:validate",
+      "pluginAlias": "@knocklabs/cli",
+      "pluginName": "@knocklabs/cli",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Validate one or more layouts from a local file system.",
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "layout",
+        "validate.js"
+      ]
+    },
     "partial:get": {
       "aliases": [],
       "args": {
@@ -2172,7 +2733,7 @@
     "workflow:generate-types": {
       "aliases": [],
       "args": {},
-      "description": "Generate types for all workflows in the development environment and write them to a file.",
+      "description": "Generate types for all workflows in an environment and write them to a file.",
       "flags": {
         "service-token": {
           "env": "KNOCK_SERVICE_TOKEN",
@@ -2752,5 +3313,5 @@
       ]
     }
   },
-  "version": "0.1.22"
+  "version": "0.1.23"
 }