New Components - helpdocs

components/helpdocs/actions/create-article/create-article.mjs

@@ -0,0 +1,92 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-create-article",
+  name: "Create Article",
+  description: "Create a new article in your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/8Y2t6NVxeU-creating-an-article)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The title of the article",
+    },
+    categoryId: {
+      propDefinition: [
+        helpdocs,
+        "categoryId",
+      ],
+      optional: true,
+    },
+    body: {
+      type: "string",
+      label: "Body",
+      description: "The body of the article",
+      optional: true,
+    },
+    isPrivate: {
+      type: "boolean",
+      label: "Is Private",
+      description: "Whether the article is private",
+      optional: true,
+    },
+    isPublished: {
+      type: "boolean",
+      label: "Is Published",
+      description: "Whether the article is published",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The description of the article",
+      optional: true,
+    },
+    shortVersion: {
+      type: "string",
+      label: "Short Version",
+      description: "The short version of the article",
+      optional: true,
+    },
+    slug: {
+      type: "string",
+      label: "Slug",
+      description: "The slug of the article",
+      optional: true,
+    },
+    tags: {
+      type: "string[]",
+      label: "Tags",
+      description: "The tags of the article",
+      optional: true,
+    },
+    multilingual: {
+      type: "string[]",
+      label: "Multilingual",
+      description: "The language code(s) of the article (e.g. `en`, `fr`, etc.)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { article } = await this.helpdocs.createArticle({
+      $,
+      data: {
+        title: this.title,
+        category_id: this.categoryId,
+        body: this.body,
+        is_private: this.isPrivate,
+        is_published: this.isPublished,
+        description: this.description,
+        short_version: this.shortVersion,
+        slug: this.slug,
+        tags: this.tags,
+        multilingual: this.multilingual,
+      },
+    });
+
+    $.export("$summary", `Created article ${this.title}`);
+    return article;
+  },
+};

components/helpdocs/actions/create-category/create-category.mjs

@@ -0,0 +1,35 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-create-category",
+  name: "Create Category",
+  description: "Create a new category in your HelpDocs knowledge base to organize articles. [See the documentation](https://apidocs.helpdocs.io/article/i5gdcZ7b9s-creating-a-category)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The title of the category",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The description of the category",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { category } = await this.helpdocs.createCategory({
+      $,
+      data: {
+        title: this.title,
+        description: this.description,
+      },
+    });
+
+    $.export("$summary", `Created category ${this.title}`);
+    return category;
+  },
+};

components/helpdocs/actions/delete-article/delete-article.mjs

@@ -0,0 +1,27 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-delete-article",
+  name: "Delete Article",
+  description: "Delete an article from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/0iyvUUh7py-deleting-an-article)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    articleId: {
+      propDefinition: [
+        helpdocs,
+        "articleId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.helpdocs.deleteArticle({
+      $,
+      articleId: this.articleId,
+    });
+
+    $.export("$summary", `Deleted article ${this.articleId}`);
+    return response;
+  },
+};

components/helpdocs/actions/delete-category/delete-category.mjs

@@ -0,0 +1,27 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-delete-category",
+  name: "Delete Category",
+  description: "Delete a category from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/Hw8fVbXt1V-deleting-a-category)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    categoryId: {
+      propDefinition: [
+        helpdocs,
+        "categoryId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.helpdocs.deleteCategory({
+      $,
+      categoryId: this.categoryId,
+    });
+
+    $.export("$summary", `Deleted category ${this.categoryId}`);
+    return response;
+  },
+};

components/helpdocs/actions/generate-chatbot-source-page/generate-chatbot-source-page.mjs

@@ -0,0 +1,23 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-generate-chatbot-source-page",
+  name: "Generate Chatbot Source Page",
+  description: "The chatbot source page feature allows you to generate a comprehensive list of all your Knowledge Base articles that can be fed directly to your chatbot. This makes it easy to leverage your existing documentation to power AI assistants and help your customers find answers quickly. [See the documentation](https://apidocs.helpdocs.io/article/4xha228dwf-generating-a-chatbot-source-page)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+  },
+  async run({ $ }) {
+    const response = await this.helpdocs.listArticles({
+      $,
+      params: {
+        format: "list",
+      },
+    });
+
+    $.export("$summary", "Generated chatbot source page");
+    return response;
+  },
+};

components/helpdocs/actions/get-article-versions/get-article-versions.mjs

@@ -0,0 +1,36 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-get-article-versions",
+  name: "Get Article Versions",
+  description: "Retrieve version history and details for a specific article in your knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/c3svl5hvb2-getting-article-versions)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    articleId: {
+      propDefinition: [
+        helpdocs,
+        "articleId",
+      ],
+    },
+    languageCode: {
+      type: "string",
+      label: "Language Code",
+      description: "Restrict returned articles to a language (e.g. `en`, `fr`, etc.)",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.helpdocs.getArticleVersions({
+      $,
+      articleId: this.articleId,
+      params: {
+        language_code: this.languageCode,
+      },
+    });
+
+    $.export("$summary", `Retrieved article versions for ${this.articleId}`);
+    return response;
+  },
+};

components/helpdocs/actions/get-article/get-article.mjs

@@ -0,0 +1,27 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-get-article",
+  name: "Get Article",
+  description: "Retrieve a specific article from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/lc6AVtLvrv-getting-a-single-article)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    articleId: {
+      propDefinition: [
+        helpdocs,
+        "articleId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { article } = await this.helpdocs.getArticle({
+      $,
+      articleId: this.articleId,
+    });
+
+    $.export("$summary", `Found article ${this.articleId}`);
+    return article;
+  },
+};

components/helpdocs/actions/get-category/get-category.mjs

@@ -0,0 +1,27 @@
+import helpdocs from "../../helpdocs.app.mjs";
+
+export default {
+  key: "helpdocs-get-category",
+  name: "Get Category",
+  description: "Retrieve a category from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/FCRNPUXm3i-getting-a-single-category)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    helpdocs,
+    categoryId: {
+      propDefinition: [
+        helpdocs,
+        "categoryId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { category } = await this.helpdocs.getCategory({
+      $,
+      categoryId: this.categoryId,
+    });
+
+    $.export("$summary", `Retrieved category ${this.categoryId}`);
+    return category;
+  },
+};