Skip to content

chore: update integration docs #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
botpress-docs-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: update integration docs #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
892 changes: 892 additions & 0 deletions snippets/integrations/cards/botpress/freshdesk.mdx
View file
Open in desktop

Large diffs are not rendered by default.

346 changes: 346 additions & 0 deletions snippets/integrations/cards/botpress/googledrivekb.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,346 @@
{/* This file is auto-generated. Do not edit directly. */}
{/* vale off */}

Here's a reference for all [Cards](/studio/concepts/cards/introduction) available with the integration:

### Download file data

<span>{"Download data from a file in Google Drive"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the Google Drive file whose content will be downloaded"}</span>
</ResponseField>
<ResponseField
name="index"
type="boolean"
required
>
<span>{"Indicates if the file is to be indexed or not"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="bpFileId"
type="string"
required
>
<span>{"The Botpress file ID corresponding to the file that was uploaded from Google Drive to the Files API"}</span>
</ResponseField>
<ResponseField
name="url"
type="string"
required
>
<span>{"The URL to access the file content. Use this instead of constructing the URL from the file ID."}</span>
</ResponseField>
</Expandable>
</ResponseField>

### List Files

<span>{"List files in Google Drive"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to use to get the next page of results"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="items"
type="array"
required
>
<span>{"The list of items listed in Google Drive. Results may be paginated. If set, use nextToken to get additional results"}</span>

<Expandable title="array item properties">
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the Google Drive file"}</span>
</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The name of the file"}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The ID of the file that is the parent of this file. If not set, 'My Drive' is the parent"}</span>
</ResponseField>
<ResponseField
name="mimeType"
type="string"
required
>
<span>{"The media type of the file"}</span>
</ResponseField>
<ResponseField
name="size"
type="number"
required
>
<span>{"The size in bytes of the file"}</span>
</ResponseField>
<ResponseField
name="contentHash"
type="string"
>
<span>{"The hash of the file content, or version/revision number"}</span>
</ResponseField>
<ResponseField
name="lastModifiedDate"
type="string (date-time)"
>
<span>{"The last modified date of the file in RFC 3339 format"}</span>
</ResponseField>
<ResponseField
name="path"
type="array"
required
>
<span>{"An array of the path's components sorted by level (root to leaf)"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="meta"
type="object"
required
>
<span>{"Metadata about the list results, including pagination information"}</span>

<Expandable>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to pass as input to the next call of the list action to list additional items"}</span>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

### List folders

<span>{"List folders in Google Drive"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to use to get the next page of results"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="items"
type="array"
required
>
<span>{"The list of items listed in Google Drive. Results may be paginated. If set, use nextToken to get additional results"}</span>

<Expandable title="array item properties">
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the Google Drive file"}</span>
</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The name of the file"}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The ID of the file that is the parent of this file. If not set, 'My Drive' is the parent"}</span>
</ResponseField>
<ResponseField
name="mimeType"
type="string"
required
>
<span>{"The media type of the folder"}</span>
</ResponseField>
<ResponseField
name="path"
type="array"
required
>
<span>{"An array of the path's components sorted by level (root to leaf)"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="meta"
type="object"
required
>
<span>{"Metadata about the list results, including pagination information"}</span>

<Expandable>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to pass as input to the next call of the list action to list additional items"}</span>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

### Read File

<span>{"Read a file's metadata in a Google Drive"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the Google Drive file"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<span>{"The file read from Google Drive"}</span>

<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The ID of the Google Drive file"}</span>
</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The name of the file"}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The ID of the file that is the parent of this file. If not set, 'My Drive' is the parent"}</span>
</ResponseField>
<ResponseField
name="mimeType"
type="string"
required
>
<span>{"The media type of the file"}</span>
</ResponseField>
<ResponseField
name="size"
type="number"
required
>
<span>{"The size in bytes of the file"}</span>
</ResponseField>
<ResponseField
name="contentHash"
type="string"
>
<span>{"The hash of the file content, or version/revision number"}</span>
</ResponseField>
<ResponseField
name="lastModifiedDate"
type="string (date-time)"
>
<span>{"The last modified date of the file in RFC 3339 format"}</span>
</ResponseField>
<ResponseField
name="path"
type="array"
required
>
<span>{"An array of the path's components sorted by level (root to leaf)"}</span>
</ResponseField>
</Expandable>
</ResponseField>

### Sync Channels

<span>{"Sync channels for file change subscriptions"}</span>

<ResponseField
name="input"
type="object"
>
This Card has no input fields.
</ResponseField>

<ResponseField
name="output"
type="object"
>
This Card has no output.
</ResponseField>


{/* vale on */}
Loading
Loading