Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
864 changes: 437 additions & 427 deletions .github/scripts/utils/docs-generator.js

Large diffs are not rendered by default.

280 changes: 0 additions & 280 deletions snippets/integrations/cards/botpress/confluence.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -233,286 +233,6 @@ Available options: `current`, `draft`, `archived`, `historical`, `trashed`, `any
This Card has no output.
</ResponseField>

### List items in folder

<span>{"List the files and folders in a folder"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="folderId"
type="string"
>
<span>{"The folder's ID. This could be a unique identifier from the external service, or a relative or absolute path, so long as it's unique."}</span>
</ResponseField>
<ResponseField
name="filters"
type="object"
>
<span>{"Optional search filters"}</span>

<Expandable>
<ResponseField
name="itemType"
type="enum<string>"
>
<span>{"The entity type"}</span>

Available options: `file`, `folder`
</ResponseField>
<ResponseField
name="maxSizeInBytes"
type="number"
>
<span>{"Filter the items by maximum size (in bytes)"}</span>
</ResponseField>
<ResponseField
name="modifiedAfter"
type="string (date-time)"
>
<span>{"Filter the items modified after the given date"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to get the next page of items. Leave empty to get the first page."}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="items"
type="array"
required
>
<span>{"The files and folders in the folder"}</span>

<Tabs>
<Tab title="file">
<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The file's ID. This could be a unique identifier from the external service, or a relative or absolute path, so long as it's unique."}</span>
</ResponseField>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The file's name. This will be displayed in the Botpress UI and be used as the file's name on Files API.\""}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The parent folder ID. Leave empty if the file is in the root folder."}</span>
</ResponseField>
<ResponseField
name="absolutePath"
type="string"
>
<span>{"The absolute path of the file. Leave empty if not available."}</span>
</ResponseField>
<ResponseField
name="sizeInBytes"
type="number"
>
<span>{"The file size in bytes, if available"}</span>
</ResponseField>
<ResponseField
name="lastModifiedDate"
type="string (date-time)"
>
<span>{"The last modified date of the file, if available"}</span>
</ResponseField>
<ResponseField
name="contentHash"
type="string"
>
<span>{"The hash of the file content, or version/revision number, if available"}</span>
</ResponseField>
</Expandable>
</Tab>
<Tab title="folder">
<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The folder's ID. This could be a unique identifier from the external service, or a relative or absolute path, so long as it's unique."}</span>
</ResponseField>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The folder's name. This will be displayed in the Botpress UI and be used as the folder's name on Files API.\""}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The parent folder ID. Leave empty if the folder is in the root folder."}</span>
</ResponseField>
<ResponseField
name="absolutePath"
type="string"
>
<span>{"The absolute path of the folder. Leave empty if not available."}</span>
</ResponseField>
</Expandable>
</Tab>
</Tabs>
</ResponseField>
<ResponseField
name="meta"
type="object"
required
>


<Expandable>
<ResponseField
name="nextToken"
type="string"
>
<span>{"The token to get the next page of items."}</span>
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

### Transfer file to Botpress

<span>{"Transfer a file from an external service to Botpress"}</span>

<ResponseField
name="input"
type="object"
>
<Expandable>
<ResponseField
name="file"
type="object"
required
>
<span>{"The file to transfer"}</span>

<Expandable>
<ResponseField
name="id"
type="string"
required
>
<span>{"The file's ID. This could be a unique identifier from the external service, or a relative or absolute path, so long as it's unique."}</span>
</ResponseField>
<ResponseField
name="type"
type="string"
required
>

</ResponseField>
<ResponseField
name="name"
type="string"
required
>
<span>{"The file's name. This will be displayed in the Botpress UI and be used as the file's name on Files API.\""}</span>
</ResponseField>
<ResponseField
name="parentId"
type="string"
>
<span>{"The parent folder ID. Leave empty if the file is in the root folder."}</span>
</ResponseField>
<ResponseField
name="absolutePath"
type="string"
>
<span>{"The absolute path of the file. Leave empty if not available."}</span>
</ResponseField>
<ResponseField
name="sizeInBytes"
type="number"
>
<span>{"The file size in bytes, if available"}</span>
</ResponseField>
<ResponseField
name="lastModifiedDate"
type="string (date-time)"
>
<span>{"The last modified date of the file, if available"}</span>
</ResponseField>
<ResponseField
name="contentHash"
type="string"
>
<span>{"The hash of the file content, or version/revision number, if available"}</span>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField
name="fileKey"
type="string"
required
>
<span>{"The file key to use in Botpress"}</span>
</ResponseField>
<ResponseField
name="shouldIndex"
type="boolean"
>
<span>{"Whether to index the file in vector storage"}</span>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField
name="output"
type="object"
>
<Expandable>
<ResponseField
name="botpressFileId"
type="string"
required
>
<span>{"The file ID of the uploaded file on Botpress"}</span>
</ResponseField>
</Expandable>
</ResponseField>

### Get Page

<ResponseField
Expand Down
Loading