Skip to content
Open
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
48 changes: 48 additions & 0 deletions src/reference/sdks/frontend/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,51 @@ Creates a new AI provider instance that can be used with the [ai](https://ai-sdk
[`AIProvider`](#aiprovider)

A provider instance compatible with the [ai](https://ai-sdk.dev/) library.

##### getUpstreamProviders()

> **getUpstreamProviders**: () => [`AIUpstreamProvider`](#aiupstreamprovider)[]

Gets the list of upstream AI providers with their configuration status.

###### Returns

[`AIUpstreamProvider`](#aiupstreamprovider)[]

An array of AI upstream providers with their configuration status.

***

### AIUpstreamProvider

> **AIUpstreamProvider** = `object`

AI upstream provider information.

#### Properties

##### id

> **id**: [`AIUpstreamProviderId`](#aiupstreamproviderid)

##### status

> **status**: [`AIUpstreamProviderStatus`](#aiupstreamproviderstatus)

***

### AIUpstreamProviderId

> **AIUpstreamProviderId** = `"anthropic"` \| `"google"` \| `"openai"` \| `"openrouter"`

AI upstream provider ID.

***

### AIUpstreamProviderStatus

> **AIUpstreamProviderStatus** = `"Ready"` \| `"Missing"`

AI upstream provider status.
Ready: The upstream provider is ready to use.
Missing: The upstream provider is not configured.
13 changes: 13 additions & 0 deletions src/reference/sdks/frontend/assistant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Assistant

### AssistantPageContext

> **AssistantPageContext** = `object`

Assistant page context.

#### Properties

##### kind

> **kind**: `"Assistant"`
162 changes: 162 additions & 0 deletions src/reference/sdks/frontend/automate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,55 @@
# Automate

### AutomateEntry

> **AutomateEntry** = `object`

A automate entry.

#### Properties

##### createdAt

> **createdAt**: `Date`

The date the entry was created.

##### id

> **id**: [`ID`](utils.md#id)

The ID of the entry.

##### name

> **name**: `string`

The name of the entry.

***

### AutomatePageContext

> **AutomatePageContext** = `object`

Automate page context.

#### Properties

##### kind

> **kind**: `"Automate"`

##### requestSelection

> **requestSelection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>

##### selection

> **selection**: [`Selection`](utils.md#selection)\<\{ `id`: [`ID`](utils.md#id); `kind`: `"AutomateSession"`; \} \| \{ `id`: [`ID`](utils.md#id); `kind`: `"AutomateEntry"`; \}\>

***

### AutomateSDK

> **AutomateSDK** = `object`
Expand All @@ -8,6 +58,38 @@ Utilities to interact with the Automate page.

#### Properties

##### addEntryIndicator()

> **addEntryIndicator**: (`entryId`: [`ID`](utils.md#id), `indicator`: [`AddIndicatorOptions`](utils.md#addindicatoroptions)) => [`Indicator`](utils.md#indicator)

Add an indicator to an automate entry.
Indicators are displayed next to the entry name in the collections tree.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `entryId` | [`ID`](utils.md#id) | The ID of the entry to add the indicator to. |
| `indicator` | [`AddIndicatorOptions`](utils.md#addindicatoroptions) | The indicator configuration. |

###### Returns

[`Indicator`](utils.md#indicator)

A handle object with a `remove` method to remove the indicator.

###### Example

```ts
const indicator = sdk.automate.addEntryIndicator(entryId, {
icon: "fas fa-exclamation-triangle",
description: "Security warning",
});

// Later, remove the indicator
indicator.remove();
```

##### addRequestEditorExtension()

> **addRequestEditorExtension**: (`extension`: `Extension`) => `void`
Expand Down Expand Up @@ -39,3 +121,83 @@ Add a custom request view mode.
###### Returns

`void`

##### addResponseViewMode()

> **addResponseViewMode**: (`options`: [`ResponseViewModeOptions`](response.md#responseviewmodeoptions)) => `void`

Add a custom response view mode.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options` | [`ResponseViewModeOptions`](response.md#responseviewmodeoptions) | The view mode options. |

###### Returns

`void`

##### getEntries()

> **getEntries**: (`sessionId`: [`ID`](utils.md#id)) => [`AutomateEntry`](#automateentry)[]

Get the list of all automate entries.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `sessionId` | [`ID`](utils.md#id) | The ID of the session to get the entries of. |

###### Returns

[`AutomateEntry`](#automateentry)[]

The list of all automate entries.

##### getSessions()

> **getSessions**: () => [`AutomateSession`](#automatesession)[]

Get the list of all automate sessions.

###### Returns

[`AutomateSession`](#automatesession)[]

The list of all automate sessions.

***

### AutomateSession

> **AutomateSession** = `object`

A automate session.

#### Properties

##### createdAt

> **createdAt**: `Date`

The date the session was created.

##### entryIds

> **entryIds**: [`ID`](utils.md#id)[]

The IDs of all entries in this session.

##### id

> **id**: [`ID`](utils.md#id)

The ID of the session.

##### name

> **name**: `string`

The name of the session.
13 changes: 13 additions & 0 deletions src/reference/sdks/frontend/backups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Backups

### BackupsPageContext

> **BackupsPageContext** = `object`

Backups page context.

#### Properties

##### kind

> **kind**: `"Backups"`
13 changes: 13 additions & 0 deletions src/reference/sdks/frontend/certificate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Certificate

### CertificatePageContext

> **CertificatePageContext** = `object`

Certificate page context.

#### Properties

##### kind

> **kind**: `"Certificate"`
18 changes: 18 additions & 0 deletions src/reference/sdks/frontend/environment.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Environment

### EnvironmentPageContext

> **EnvironmentPageContext** = `object`

Environment page context.

#### Properties

##### kind

> **kind**: `"Environment"`

##### selection

> **selection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>

***

### EnvironmentSDK

> **EnvironmentSDK** = `object`
Expand Down
13 changes: 13 additions & 0 deletions src/reference/sdks/frontend/exports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Exports

### ExportsPageContext

> **ExportsPageContext** = `object`

Exports page context.

#### Properties

##### kind

> **kind**: `"Exports"`
14 changes: 14 additions & 0 deletions src/reference/sdks/frontend/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,20 @@ The asset file.

***

### FilesPageContext

> **FilesPageContext** = `object`

Files page context.

#### Properties

##### kind

> **kind**: `"Files"`

***

### FilesSDK

> **FilesSDK** = `object`
Expand Down
18 changes: 18 additions & 0 deletions src/reference/sdks/frontend/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,24 @@ The HTTPQL expression of the filter.

***

### FilterPageContext

> **FilterPageContext** = `object`

Filter page context.

#### Properties

##### kind

> **kind**: `"Filter"`

##### selection

> **selection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>

***

### FiltersSDK

> **FiltersSDK** = `object`
Expand Down
Loading