Skip to content

Commit dfd1166

Browse files
jottakkaFrancisco Liberal
andauthored
[Ready][Many toolkits] Adding Who Am I tool documentation (#426)
* updating documentation * Remove unwanted example files, keep only who_am_i and generate_google_file_picker_url files * fixing some docs * adding for notion * adding Jira who am i tool info * updating docs for slack and google slides --------- Co-authored-by: Francisco Liberal <[email protected]>
1 parent 89d2d5f commit dfd1166

File tree

54 files changed

+1394
-14
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1394
-14
lines changed

pages/toolkits/customer-support/zendesk.mdx

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ToolFooter from "@/components/ToolFooter";
1111
author="Arcade"
1212
codeLink="https://github.com/ArcadeAI/arcade-ai/tree/main/toolkits/zendesk"
1313
authType="OAuth2"
14-
versions={["0.1.0"]}
14+
versions={["1.0.0"]}
1515
/>
1616

1717
<Badges repo="arcadeai/arcade_zendesk" />
@@ -37,6 +37,7 @@ This toolkit streamlines the process of handling customer inquiries and accessin
3737
["Zendesk.AddTicketComment", "Add a comment to an existing Zendesk ticket."],
3838
["Zendesk.MarkTicketSolved", "Mark a Zendesk ticket as solved, optionally with a final comment."],
3939
["Zendesk.SearchArticles", "Search for Help Center articles in your Zendesk knowledge base."],
40+
["Zendesk.WhoAmI", "Get comprehensive user profile and Zendesk account information."],
4041
]
4142
}
4243
/>
@@ -189,6 +190,31 @@ Search for Help Center articles in your Zendesk knowledge base.
189190

190191
This tool requires the following secrets: `zendesk_subdomain` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets#supplying-the-secret))
191192

193+
## Zendesk.WhoAmI
194+
195+
<br />
196+
<TabbedCodeBlock
197+
tabs={[
198+
{
199+
label: "Call the Tool Directly",
200+
content: {
201+
Python: ["/examples/integrations/toolkits/zendesk/who_am_i_example_call_tool.py"],
202+
JavaScript: ["/examples/integrations/toolkits/zendesk/who_am_i_example_call_tool.js"],
203+
},
204+
},
205+
]}
206+
/>
207+
208+
Get comprehensive user profile and Zendesk account information.
209+
210+
**Parameters**
211+
212+
This tool does not take any parameters.
213+
214+
**Secrets**
215+
216+
This tool requires the following secrets: `zendesk_subdomain` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets#supplying-the-secret))
217+
192218

193219

194220
<ToolFooter pipPackageName="arcade_zendesk" />

pages/toolkits/customer-support/zendesk/reference.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,5 @@ Below is a reference of enumerations used by some tools in the Zendesk toolkit:
1919

2020
- **CREATED_AT**: `created_at`
2121
- **RELEVANCE**: `relevance`
22+
23+

pages/toolkits/productivity/gmail.mdx

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ToolFooter from "@/components/ToolFooter";
1111
author="Arcade"
1212
authType="oauth2"
1313
authProviderName="Google"
14-
versions={["0.1.0"]}
14+
versions={["3.1.0"]}
1515
/>
1616

1717
<Badges repo="arcadeai/arcade_gmail" />
@@ -43,6 +43,7 @@ These tools are currently available in the Arcade Gmail toolkit.
4343
["Gmail.SearchThreads", "Search for threads in the user's mailbox."],
4444
["Gmail.ListThreads", "List threads in the user's mailbox."],
4545
["Gmail.GetThread", "Get the specified thread by ID."],
46+
["Gmail.WhoAmI", "Get comprehensive user profile and Gmail account information."],
4647
]}
4748
/>
4849

@@ -385,6 +386,27 @@ Get the specified thread by ID.
385386

386387
- **`thread_id`** _(string, required)_ The ID of the thread to retrieve.
387388

389+
## Gmail.WhoAmI
390+
391+
<br />
392+
<TabbedCodeBlock
393+
tabs={[
394+
{
395+
label: "Call the Tool Directly",
396+
content: {
397+
Python: ["/examples/integrations/toolkits/gmail/who_am_i_example_call_tool.py"],
398+
JavaScript: ["/examples/integrations/toolkits/gmail/who_am_i_example_call_tool.js"],
399+
},
400+
},
401+
]}
402+
/>
403+
404+
Get comprehensive user profile and Gmail account information.
405+
406+
**Parameters**
407+
408+
This tool does not take any parameters.
409+
388410
## Auth
389411

390412
The Arcade Gmail toolkit uses the [Google auth provider](/home/auth-providers/google) to connect to users' Google accounts.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Gmail Reference
2+
3+
Below is a reference of enumerations used by some tools in the Gmail toolkit:
4+
5+
## GmailReplyToWhom
6+
7+
- **EVERY_RECIPIENT**: `every_recipient`
8+
- **ONLY_THE_SENDER**: `only_the_sender`
9+
10+
## DateRange
11+
12+
- **TODAY**: `today`
13+
- **YESTERDAY**: `yesterday`
14+
- **LAST_7_DAYS**: `last_7_days`
15+
- **LAST_30_DAYS**: `last_30_days`
16+
- **THIS_MONTH**: `this_month`
17+
- **LAST_MONTH**: `last_month`
18+
- **THIS_YEAR**: `this_year`
19+
20+

pages/toolkits/productivity/google_calendar.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ToolFooter from "@/components/ToolFooter";
1111
author="Arcade"
1212
authType="oauth2"
1313
authProviderName="Google"
14-
versions={["0.1.0"]}
14+
versions={["3.1.0"]}
1515
/>
1616

1717
<Badges repo="arcadeai/arcade_google_calendar" />
@@ -33,6 +33,7 @@ These tools are currently available in the Arcade Google Calendar toolkit.
3333
["GoogleCalendar.UpdateEvent", "Update an existing event in Google Calendar."],
3434
["GoogleCalendar.DeleteEvent", "Delete an event from Google Calendar."],
3535
["GoogleCalendar.FindTimeSlotsWhenEveryoneIsFree", "Provides time slots when everyone is free within a given date range and time boundaries."],
36+
["GoogleCalendar.WhoAmI", "Get comprehensive user profile and Google Calendar environment information."],
3637
]}
3738
/>
3839

@@ -229,6 +230,29 @@ Provides time slots when everyone is free within a given date range and time bou
229230

230231
---
231232

233+
## GoogleCalendar.WhoAmI
234+
235+
<br />
236+
<TabbedCodeBlock
237+
tabs={[
238+
{
239+
label: "Call the Tool Directly",
240+
content: {
241+
Python: ["/examples/integrations/toolkits/google_calendar/who_am_i_example_call_tool.py"],
242+
JavaScript: ["/examples/integrations/toolkits/google_calendar/who_am_i_example_call_tool.js"],
243+
},
244+
},
245+
]}
246+
/>
247+
248+
Get comprehensive user profile and Google Calendar environment information.
249+
250+
**Parameters**
251+
252+
This tool does not take any parameters.
253+
254+
---
255+
232256
## Auth
233257

234258
The Arcade Google Calendar toolkit uses the [Google auth provider](/home/auth-providers/google) to connect to users' Google accounts.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# GoogleCalendar Reference
2+
3+
Below is a reference of enumerations used by some tools in the GoogleCalendar toolkit:
4+
5+
## EventVisibility
6+
7+
- **DEFAULT**: `default`
8+
- **PUBLIC**: `public`
9+
- **PRIVATE**: `private`
10+
- **CONFIDENTIAL**: `confidential`
11+
12+
## SendUpdatesOptions
13+
14+
- **NONE**: `none`
15+
- **ALL**: `all`
16+
- **EXTERNAL_ONLY**: `externalOnly`
17+
18+

pages/toolkits/productivity/google_contacts.mdx

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ToolFooter from "@/components/ToolFooter";
1111
author="Arcade"
1212
authType="oauth2"
1313
authProviderName="Google"
14-
versions={["0.1.0"]}
14+
versions={["3.1.0"]}
1515
/>
1616

1717
<Badges repo="arcadeai/arcade_google_contacts" />
@@ -31,6 +31,7 @@ These tools are currently available in the Arcade Google Contacts toolkit.
3131
["GoogleContacts.SearchContactsByEmail", "Search the user's contacts in Google Contacts by email address."],
3232
["GoogleContacts.SearchContactsByName", "Search the user's contacts in Google Contacts by name."],
3333
["GoogleContacts.CreateContact", "Create a new contact record in Google Contacts."],
34+
["GoogleContacts.WhoAmI", "Get comprehensive user profile and Google Contacts environment information."],
3435
]}
3536
/>
3637

@@ -121,6 +122,28 @@ Create a new contact record in Google Contacts.
121122
- **`family_name`** _(string, optional)_: The optional family name of the contact.
122123
- **`email`** _(string, optional)_: The optional email address of the contact.
123124

125+
---
126+
127+
## GoogleContacts.WhoAmI
128+
129+
<br />
130+
<TabbedCodeBlock
131+
tabs={[
132+
{
133+
label: "Call the Tool with User Authorization",
134+
content: {
135+
Python: ["/examples/integrations/toolkits/google_contacts/who_am_i_example_call_tool.py"],
136+
JavaScript: ["/examples/integrations/toolkits/google_contacts/who_am_i_example_call_tool.js"],
137+
},
138+
},
139+
]}
140+
/>
141+
142+
Get comprehensive user profile and Google Contacts environment information.
143+
144+
**Parameters**
145+
146+
This tool does not take any parameters.
124147

125148
---
126149

pages/toolkits/productivity/google_docs.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ToolFooter from "@/components/ToolFooter";
1111
author="Arcade"
1212
authType="oauth2"
1313
authProviderName="Google"
14-
versions={["0.1.0"]}
14+
versions={["4.1.0"]}
1515
/>
1616

1717
<Warning>
@@ -31,6 +31,7 @@ These tools are currently available in the Arcade Google Docs toolkit.
3131
<TableOfContents
3232
headers={["Tool Name", "Description"]}
3333
data={[
34+
["GoogleDocs.WhoAmI", "Get comprehensive user profile and Google Docs environment information."],
3435
["GoogleDocs.GetDocumentById", "Retrieve a Google Docs document by ID.", ],
3536
["GoogleDocs.GetDocumentAsDocMD", "Retrieve a Google Docs document by ID in DocMD format with metadata tags.", ],
3637
["GoogleDocs.EditDocument", "Edit a Google Docs document using natural language edit requests.", ],
@@ -51,6 +52,29 @@ These tools are currently available in the Arcade Google Docs toolkit.
5152
provider](/home/auth-providers/google#using-google-auth-in-custom-tools).
5253
</Tip>
5354

55+
## GoogleDocs.WhoAmI
56+
57+
<br />
58+
<TabbedCodeBlock
59+
tabs={[
60+
{
61+
label: "Call the Tool with User Authorization",
62+
content: {
63+
Python: ["/examples/integrations/toolkits/google_docs/who_am_i_example_call_tool.py"],
64+
JavaScript: ["/examples/integrations/toolkits/google_docs/who_am_i_example_call_tool.js"],
65+
},
66+
},
67+
]}
68+
/>
69+
70+
Get comprehensive user profile and Google Docs environment information.
71+
72+
**Parameters**
73+
74+
This tool does not take any parameters.
75+
76+
---
77+
5478
## GoogleDocs.GetDocumentById
5579

5680
<br />
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# GoogleDocs Reference
2+
3+
Below is a reference of enumerations used by some tools in the GoogleDocs toolkit:
4+
5+
## OrderBy
6+
7+
- **CREATED_TIME**: `createdTime`
8+
- **CREATED_TIME_DESC**: `createdTime desc`
9+
- **FOLDER**: `folder`
10+
- **FOLDER_DESC**: `folder desc`
11+
- **MODIFIED_BY_ME_TIME**: `modifiedByMeTime`
12+
- **MODIFIED_BY_ME_TIME_DESC**: `modifiedByMeTime desc`
13+
- **MODIFIED_TIME**: `modifiedTime`
14+
- **MODIFIED_TIME_DESC**: `modifiedTime desc`
15+
- **NAME**: `name`
16+
- **NAME_DESC**: `name desc`
17+
- **NAME_NATURAL**: `name_natural`
18+
- **NAME_NATURAL_DESC**: `name_natural desc`
19+
- **QUOTA_BYTES_USED**: `quotaBytesUsed`
20+
- **QUOTA_BYTES_USED_DESC**: `quotaBytesUsed desc`
21+
- **RECENCY**: `recency`
22+
- **RECENCY_DESC**: `recency desc`
23+
- **SHARED_WITH_ME_TIME**: `sharedWithMeTime`
24+
- **SHARED_WITH_ME_TIME_DESC**: `sharedWithMeTime desc`
25+
- **STARRED**: `starred`
26+
- **STARRED_DESC**: `starred desc`
27+
- **VIEWED_BY_ME_TIME**: `viewedByMeTime`
28+
- **VIEWED_BY_ME_TIME_DESC**: `viewedByMeTime desc`
29+
30+
## DocumentFormat
31+
32+
- **MARKDOWN**: `markdown`
33+
- **HTML**: `html`
34+
- **GOOGLE_API_JSON**: `google_api_json`
35+
36+

pages/toolkits/productivity/google_drive.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import ToolFooter from "@/components/ToolFooter";
1010
description="Enable agents to interact with GoogleDrive"
1111
author="Arcade"
1212
authType="OAuth2"
13-
versions={["3.0.0"]}
13+
versions={["4.1.0"]}
1414
/>
1515

1616
<Badges repo="arcadeai/arcade_google_drive" />
@@ -27,6 +27,7 @@ The GoogleDrive toolkit provides a set of tools for interacting with Google Driv
2727
headers={["Tool Name", "Description"]}
2828
data={
2929
[
30+
["GoogleDrive.WhoAmI", "Get comprehensive user profile and Google Drive environment information."],
3031
["GoogleDrive.GetFileTreeStructure", "Get the file/folder tree structure of the user's Google Drive."],
3132
["GoogleDrive.GenerateGoogleFilePickerUrl", "Generate a Google File Picker URL for user-driven file selection and authorization."],
3233
["GoogleDrive.SearchFiles", "Search for files in Google Drive"],
@@ -40,6 +41,29 @@ The GoogleDrive toolkit provides a set of tools for interacting with Google Driv
4041
own tools](/home/build-tools/create-a-toolkit).
4142
</Tip>
4243

44+
## GoogleDrive.WhoAmI
45+
46+
<br />
47+
<TabbedCodeBlock
48+
tabs={[
49+
{
50+
label: "Call the Tool with User Authorization",
51+
content: {
52+
Python: ["/examples/integrations/toolkits/google_drive/who_am_i_example_call_tool.py"],
53+
JavaScript: ["/examples/integrations/toolkits/google_drive/who_am_i_example_call_tool.js"],
54+
},
55+
},
56+
]}
57+
/>
58+
59+
Get comprehensive user profile and Google Drive environment information.
60+
61+
**Parameters**
62+
63+
This tool does not take any parameters.
64+
65+
---
66+
4367
## GoogleDrive.GetFileTreeStructure
4468

4569
<br />

0 commit comments

Comments
 (0)