Skip to content

Commit 9259838

Browse files
botpress-docs-actions[bot]adkah
botpress-docs-actions[bot]
and
adkah
authored
chore: update integration docs (#399)
Co-authored-by: adkah <98672834+adkah@users.noreply.github.com>
1 parent 0d4894e commit 9259838

File tree

5 files changed

+443
-16
lines changed

5 files changed

+443
-16
lines changed

‎snippets/integrations/cards/botpress/linear.mdx‎

Lines changed: 204 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,50 @@ Available options: `issue`
332332
</Expandable>
333333
</ResponseField>
334334

335+
### Get or Create a Conversation
336+
337+
<span>{"Proactively create a conversation from a bot"}</span>
338+
339+
<ResponseField
340+
name="input"
341+
type="object"
342+
>
343+
<Expandable>
344+
<ResponseField
345+
name="conversation"
346+
type="object"
347+
required
348+
>
349+
350+
351+
<Expandable>
352+
<ResponseField
353+
name="id"
354+
type="string"
355+
required
356+
>
357+
<span>{"The issue ID on Linear"}</span>
358+
</ResponseField>
359+
</Expandable>
360+
</ResponseField>
361+
</Expandable>
362+
</ResponseField>
363+
364+
<ResponseField
365+
name="output"
366+
type="object"
367+
>
368+
<Expandable>
369+
<ResponseField
370+
name="conversationId"
371+
type="string"
372+
required
373+
>
374+
<span>{"The Botpress ID of the created conversation"}</span>
375+
</ResponseField>
376+
</Expandable>
377+
</ResponseField>
378+
335379
### Get User Profile
336380

337381
<span>{"Get a user profile from Linear"}</span>
@@ -344,9 +388,8 @@ Available options: `issue`
344388
<ResponseField
345389
name="linearUserId"
346390
type="string"
347-
required
348391
>
349-
<span>{"The user's ID on Linear. Ex: {{event.payload.linearIds.creatorId}}"}</span>
392+
<span>{"The user's ID on Linear. Ex: {{event.payload.linearIds.creatorId}}. If omitted, returns the current user."}</span>
350393
</ResponseField>
351394
</Expandable>
352395
</ResponseField>
@@ -700,6 +743,69 @@ Available options: `issue`
700743
</Expandable>
701744
</ResponseField>
702745

746+
### List States
747+
748+
<span>{"List states from Linear"}</span>
749+
750+
<ResponseField
751+
name="input"
752+
type="object"
753+
>
754+
<Expandable>
755+
<ResponseField
756+
name="count"
757+
type="number"
758+
default={10}
759+
>
760+
<span>{"The number of states to return"}</span>
761+
</ResponseField>
762+
<ResponseField
763+
name="startCursor"
764+
type="string"
765+
>
766+
<span>{"The cursor to start from"}</span>
767+
</ResponseField>
768+
</Expandable>
769+
</ResponseField>
770+
771+
<ResponseField
772+
name="output"
773+
type="object"
774+
>
775+
<Expandable>
776+
<ResponseField
777+
name="states"
778+
type="array"
779+
required
780+
>
781+
<span>{"The list of states"}</span>
782+
783+
<Expandable title="array item properties">
784+
<ResponseField
785+
name="id"
786+
type="string"
787+
required
788+
>
789+
<span>{"The unique identifier of the entity"}</span>
790+
</ResponseField>
791+
<ResponseField
792+
name="name"
793+
type="string"
794+
required
795+
>
796+
<span>{"The state's name"}</span>
797+
</ResponseField>
798+
</Expandable>
799+
</ResponseField>
800+
<ResponseField
801+
name="nextCursor"
802+
type="string"
803+
>
804+
<span>{"The cursor to fetch the next page"}</span>
805+
</ResponseField>
806+
</Expandable>
807+
</ResponseField>
808+
703809
### List Teams
704810

705811
<span>{"List teams from Linear"}</span>
@@ -731,6 +837,13 @@ Available options: `issue`
731837
>
732838
<span>{"The unique identifier of the entity"}</span>
733839
</ResponseField>
840+
<ResponseField
841+
name="key"
842+
type="string"
843+
required
844+
>
845+
<span>{"The team's key"}</span>
846+
</ResponseField>
734847
<ResponseField
735848
name="name"
736849
type="string"
@@ -890,6 +1003,95 @@ Available options: `issue`
8901003
This Card has no output.
8911004
</ResponseField>
8921005

1006+
### Resolve Comment
1007+
1008+
<span>{"Resolve a comment by id"}</span>
1009+
1010+
<ResponseField
1011+
name="input"
1012+
type="object"
1013+
>
1014+
<Expandable>
1015+
<ResponseField
1016+
name="id"
1017+
type="string"
1018+
required
1019+
>
1020+
<span>{"The comment ID"}</span>
1021+
</ResponseField>
1022+
</Expandable>
1023+
</ResponseField>
1024+
1025+
<ResponseField
1026+
name="output"
1027+
type="object"
1028+
>
1029+
<Expandable>
1030+
<ResponseField
1031+
name="success"
1032+
type="boolean"
1033+
required
1034+
>
1035+
<span>{"Whether the operation was successful"}</span>
1036+
</ResponseField>
1037+
</Expandable>
1038+
</ResponseField>
1039+
1040+
### Send Raw GraphQL Query
1041+
1042+
<span>{"Send a raw GraphQL query to the linear API"}</span>
1043+
1044+
<ResponseField
1045+
name="input"
1046+
type="object"
1047+
>
1048+
<Expandable>
1049+
<ResponseField
1050+
name="query"
1051+
type="string"
1052+
required
1053+
>
1054+
<span>{"The GraphQL query"}</span>
1055+
</ResponseField>
1056+
<ResponseField
1057+
name="parameters"
1058+
type="array"
1059+
>
1060+
<span>{"The query parameters"}</span>
1061+
1062+
<Expandable title="array item properties">
1063+
<ResponseField
1064+
name="name"
1065+
type="string"
1066+
required
1067+
>
1068+
<span>{"The parameter name"}</span>
1069+
</ResponseField>
1070+
<ResponseField
1071+
name="value"
1072+
type="string"
1073+
>
1074+
<span>{"The parameter value"}</span>
1075+
</ResponseField>
1076+
</Expandable>
1077+
</ResponseField>
1078+
</Expandable>
1079+
</ResponseField>
1080+
1081+
<ResponseField
1082+
name="output"
1083+
type="object"
1084+
>
1085+
<Expandable>
1086+
<ResponseField
1087+
name="result"
1088+
type="string"
1089+
>
1090+
<span>{"The query result"}</span>
1091+
</ResponseField>
1092+
</Expandable>
1093+
</ResponseField>
1094+
8931095
### Update Issue
8941096

8951097
<span>{"Update an issue on Linear"}</span>

‎snippets/integrations/cards/botpress/tally.mdx‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
{/* This file is auto-generated. Do not edit directly. */}
2+
{/* vale off */}
3+
4+
Here's a reference for all [Cards](/studio/concepts/cards/introduction) available with the integration:
5+
6+
### List Submissions
7+
8+
<span>{"List all the submissions for a specified form"}</span>
9+
10+
<ResponseField
11+
name="input"
12+
type="object"
13+
>
14+
<Expandable>
15+
<ResponseField
16+
name="formId"
17+
type="string"
18+
required
19+
>
20+
<span>{"Tally form ID"}</span>
21+
</ResponseField>
22+
<ResponseField
23+
name="page"
24+
type="integer"
25+
>
26+
<span>{"Page number for pagination"}</span>
27+
</ResponseField>
28+
<ResponseField
29+
name="filter"
30+
type="enum<string>"
31+
>
32+
<span>{"Filter submissions by status"}</span>
33+
34+
Available options: `all`, `completed`, `partial`
35+
</ResponseField>
36+
<ResponseField
37+
name="startDate"
38+
type="string"
39+
>
40+
<span>{"Start date for filtering submissions"}</span>
41+
</ResponseField>
42+
<ResponseField
43+
name="endDate"
44+
type="string"
45+
>
46+
<span>{"End date for filtering submissions"}</span>
47+
</ResponseField>
48+
<ResponseField
49+
name="afterId"
50+
type="string"
51+
>
52+
<span>{"ID of the submission after which to start listing"}</span>
53+
</ResponseField>
54+
</Expandable>
55+
</ResponseField>
56+
57+
<ResponseField
58+
name="output"
59+
type="object"
60+
>
61+
<Expandable>
62+
<ResponseField
63+
name="questions"
64+
type="array"
65+
required
66+
>
67+
<span>{"List of questions"}</span>
68+
69+
<Expandable title="array item properties">
70+
<ResponseField
71+
name="id"
72+
type="string"
73+
required
74+
>
75+
<span>{"Question ID"}</span>
76+
</ResponseField>
77+
<ResponseField
78+
name="type"
79+
type="string"
80+
>
81+
<span>{"Question type"}</span>
82+
</ResponseField>
83+
<ResponseField
84+
name="title"
85+
type="string | null"
86+
>
87+
88+
</ResponseField>
89+
</Expandable>
90+
</ResponseField>
91+
<ResponseField
92+
name="submissions"
93+
type="array"
94+
required
95+
>
96+
<span>{"List of submissions"}</span>
97+
98+
<Expandable title="array item properties">
99+
<ResponseField
100+
name="id"
101+
type="string"
102+
required
103+
>
104+
<span>{"Submission ID"}</span>
105+
</ResponseField>
106+
<ResponseField
107+
name="responses"
108+
type="array"
109+
required
110+
>
111+
112+
113+
<Expandable title="array item properties">
114+
<ResponseField
115+
name="questionId"
116+
type="string"
117+
required
118+
>
119+
<span>{"Question ID"}</span>
120+
</ResponseField>
121+
<ResponseField
122+
name="value"
123+
type="string"
124+
>
125+
<span>{"Response value"}</span>
126+
</ResponseField>
127+
<ResponseField
128+
name="answer"
129+
type="string"
130+
>
131+
<span>{"Response answer"}</span>
132+
</ResponseField>
133+
</Expandable>
134+
</ResponseField>
135+
</Expandable>
136+
</ResponseField>
137+
</Expandable>
138+
</ResponseField>
139+
140+
141+
{/* vale on */}

0 commit comments

Comments
 (0)