[Ready] Adding ClickUp documentation (#413)

* Adding ClickUp documentation

* udating docs

* updating

* fix

* change after Renato's review

---------

Co-authored-by: Francisco Liberal <[email protected]>

Author: jottakka

pages/toolkits/productivity/clickup.mdx

@@ -0,0 +1,38 @@
+# Clickup Reference
+
+Below is a reference of enumerations used by some tools in the Clickup toolkit:
+
+## TaskPriority
+
+Task priority values are used in the `Clickup.CreateTask` tool to set the priority of a new task. Those are default values and cannot be changed by the user.
+
+- **URGENT**: `URGENT`
+- **HIGH**: `HIGH`
+- **NORMAL**: `NORMAL`
+- **LOW**: `LOW`
+
+## FilterScope
+
+Filter scope values are used in the `Clickup.GetTasksByScope` tool to filter tasks by scope. The following enumeration values represent the possible scopes supported by the Clickup API:
+
+- **ALL**: `all`
+- **SPACES**: `spaces`
+- **FOLDERS**: `folders`
+- **LISTS**: `lists`
+
+## TaskOrderBy
+
+Task order by values are used in the `Clickup.GetTasksByScope` tool to order tasks by a specific field. The following enumeration values represent the possible order by fields supported by the Clickup API:
+
+- **CREATED**: `created`
+- **UPDATED**: `updated`
+- **DUE_DATE**: `due_date`
+
+## CommentResolution
+
+Comment resolution values are used in the comment tools to set the resolution of a comment. The following enumeration values represent the possible resolutions supported by the Clickup API:
+
+- **SET_AS_RESOLVED**: `resolved`
+- **SET_AS_UNRESOLVED**: `unresolved`
+
+

pages/toolkits/productivity/clickup/reference.mdx

@@ -0,0 +1,30 @@
+import { Arcade } from "@arcadeai/arcadejs";
+
+const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
+
+const USER_ID = "{arcade_user_id}";
+const TOOL_NAME = "Clickup.CreateComment";
+
+// Start the authorization process
+const authResponse = await client.tools.authorize({tool_name: TOOL_NAME});
+
+if (authResponse.status !== "completed") {
+  console.log(`Click this link to authorize: ${authResponse.url}`);
+}
+
+// Wait for the authorization to complete
+await client.auth.waitForCompletion(authResponse);
+
+const toolInput = {
+  "task_id": "12345",
+  "comment_text": "This is a sample comment.",
+  "assignee_id": 678
+};
+
+const response = await client.tools.execute({
+  tool_name: TOOL_NAME,
+  input: toolInput,
+  user_id: USER_ID,
+});
+
+console.log(JSON.stringify(response.output.value, null, 2));

public/examples/integrations/toolkits/clickup/create_comment_example_call_tool.js

@@ -0,0 +1,26 @@
+import json
+from arcadepy import Arcade
+
+client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
+
+USER_ID = "{arcade_user_id}"
+TOOL_NAME = "Clickup.CreateComment"
+
+auth_response = client.tools.authorize(tool_name=TOOL_NAME)
+
+if auth_response.status != "completed":
+    print(f"Click this link to authorize: {auth_response.url}")
+
+# Wait for the authorization to complete
+client.auth.wait_for_completion(auth_response)
+
+tool_input = {
+    'task_id': '12345', 'comment_text': 'This is a sample comment.', 'assignee_id': 678
+}
+
+response = client.tools.execute(
+    tool_name=TOOL_NAME,
+    input=tool_input,
+    user_id=USER_ID,
+)
+print(json.dumps(response.output.value, indent=2))

public/examples/integrations/toolkits/clickup/create_comment_example_call_tool.py

@@ -0,0 +1,30 @@
+import { Arcade } from "@arcadeai/arcadejs";
+
+const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
+
+const USER_ID = "{arcade_user_id}";
+const TOOL_NAME = "Clickup.CreateCommentReply";
+
+// Start the authorization process
+const authResponse = await client.tools.authorize({tool_name: TOOL_NAME});
+
+if (authResponse.status !== "completed") {
+  console.log(`Click this link to authorize: ${authResponse.url}`);
+}
+
+// Wait for the authorization to complete
+await client.auth.waitForCompletion(authResponse);
+
+const toolInput = {
+  "comment_id": "12345",
+  "reply_text": "Thanks for the update!",
+  "assignee_id": 678
+};
+
+const response = await client.tools.execute({
+  tool_name: TOOL_NAME,
+  input: toolInput,
+  user_id: USER_ID,
+});
+
+console.log(JSON.stringify(response.output.value, null, 2));

public/examples/integrations/toolkits/clickup/create_comment_reply_example_call_tool.js

@@ -0,0 +1,26 @@
+import json
+from arcadepy import Arcade
+
+client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
+
+USER_ID = "{arcade_user_id}"
+TOOL_NAME = "Clickup.CreateCommentReply"
+
+auth_response = client.tools.authorize(tool_name=TOOL_NAME)
+
+if auth_response.status != "completed":
+    print(f"Click this link to authorize: {auth_response.url}")
+
+# Wait for the authorization to complete
+client.auth.wait_for_completion(auth_response)
+
+tool_input = {
+    'comment_id': '12345', 'reply_text': 'Thanks for the update!', 'assignee_id': 678
+}
+
+response = client.tools.execute(
+    tool_name=TOOL_NAME,
+    input=tool_input,
+    user_id=USER_ID,
+)
+print(json.dumps(response.output.value, indent=2))

public/examples/integrations/toolkits/clickup/create_comment_reply_example_call_tool.py

@@ -0,0 +1,33 @@
+import { Arcade } from "@arcadeai/arcadejs";
+
+const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
+
+const USER_ID = "{arcade_user_id}";
+const TOOL_NAME = "Clickup.CreateTaskComment";
+
+// Start the authorization process
+const authResponse = await client.tools.authorize({
+    tool_name: TOOL_NAME,
+    user_id: USER_ID
+});
+
+if (authResponse.status !== "completed") {
+  console.log(`Click this link to authorize: ${authResponse.url}`);
+}
+
+// Wait for the authorization to complete
+await client.auth.waitForCompletion(authResponse);
+
+const toolInput = {
+  "task_id": "5k9z1a2b",
+  "comment_text": "Please review the API changes and update the integration tests accordingly.",
+  "assignee_id": 12345
+};
+
+const response = await client.tools.execute({
+  tool_name: TOOL_NAME,
+  input: toolInput,
+  user_id: USER_ID,
+});
+
+console.log(JSON.stringify(response.output.value, null, 2));

public/examples/integrations/toolkits/clickup/create_task_comment_example_call_tool.js

@@ -0,0 +1,31 @@
+import json
+from arcadepy import Arcade
+
+client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
+
+USER_ID = "{arcade_user_id}"
+TOOL_NAME = "Clickup.CreateTaskComment"
+
+auth_response = client.tools.authorize(
+    tool_name=TOOL_NAME,
+    user_id=TOOL_NAME
+)
+
+if auth_response.status != "completed":
+    print(f"Click this link to authorize: {auth_response.url}")
+
+# Wait for the authorization to complete
+client.auth.wait_for_completion(auth_response)
+
+tool_input = {
+    'task_id': '5k9z1a2b',
+    'comment_text': 'Please review the API changes and update the integration tests accordingly.',
+    'assignee_id': 12345
+}
+
+response = client.tools.execute(
+    tool_name=TOOL_NAME,
+    input=tool_input,
+    user_id=USER_ID,
+)
+print(json.dumps(response.output.value, indent=2))

public/examples/integrations/toolkits/clickup/create_task_comment_example_call_tool.py

@@ -0,0 +1,33 @@
+import { Arcade } from "@arcadeai/arcadejs";
+
+const client = new Arcade(); // Automatically finds the `ARCADE_API_KEY` env variable
+
+const USER_ID = "{arcade_user_id}";
+const TOOL_NAME = "Clickup.CreateTaskCommentReply";
+
+// Start the authorization process
+const authResponse = await client.tools.authorize({
+    tool_name: TOOL_NAME,
+    user_id: USER_ID
+});
+
+if (authResponse.status !== "completed") {
+  console.log(`Click this link to authorize: ${authResponse.url}`);
+}
+
+// Wait for the authorization to complete
+await client.auth.waitForCompletion(authResponse);
+
+const toolInput = {
+  "comment_id": "cmt_987654321",
+  "reply_text": "Thanks — I’ve reviewed this and updated the spec. Please confirm the API endpoints by EOD.",
+  "assignee_id": 4321
+};
+
+const response = await client.tools.execute({
+  tool_name: TOOL_NAME,
+  input: toolInput,
+  user_id: USER_ID,
+});
+
+console.log(JSON.stringify(response.output.value, null, 2));

public/examples/integrations/toolkits/clickup/create_task_comment_reply_example_call_tool.js

@@ -0,0 +1,32 @@
+import json
+from arcadepy import Arcade
+
+client = Arcade()  # Automatically finds the `ARCADE_API_KEY` env variable
+
+USER_ID = "{arcade_user_id}"
+TOOL_NAME = "Clickup.CreateTaskCommentReply"
+
+auth_response = client.tools.authorize(
+    tool_name=TOOL_NAME,
+    user_id=TOOL_NAME
+)
+
+if auth_response.status != "completed":
+    print(f"Click this link to authorize: {auth_response.url}")
+
+# Wait for the authorization to complete
+client.auth.wait_for_completion(auth_response)
+
+tool_input = {
+    'comment_id': 'cmt_987654321',
+    'reply_text': 'Thanks — I’ve reviewed this and updated the spec. Please confirm the API '
+                  'endpoints by EOD.',
+    'assignee_id': 4321
+}
+
+response = client.tools.execute(
+    tool_name=TOOL_NAME,
+    input=tool_input,
+    user_id=USER_ID,
+)
+print(json.dumps(response.output.value, indent=2))