Skip to content

Commit 7db4697

Browse files
caidobotcaidobot
committed
Update SDK Documentation
1 parent fd6efb4 commit 7db4697

26 files changed

+1035
-1
lines changed

‎src/reference/sdks/frontend/ai.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,51 @@ Creates a new AI provider instance that can be used with the [ai](https://ai-sdk
6767
[`AIProvider`](#aiprovider)
6868

6969
A provider instance compatible with the [ai](https://ai-sdk.dev/) library.
70+
71+
##### getUpstreamProviders()
72+
73+
> **getUpstreamProviders**: () => [`AIUpstreamProvider`](#aiupstreamprovider)[]
74+
75+
Gets the list of upstream AI providers with their configuration status.
76+
77+
###### Returns
78+
79+
[`AIUpstreamProvider`](#aiupstreamprovider)[]
80+
81+
An array of AI upstream providers with their configuration status.
82+
83+
***
84+
85+
### AIUpstreamProvider
86+
87+
> **AIUpstreamProvider** = `object`
88+
89+
AI upstream provider information.
90+
91+
#### Properties
92+
93+
##### id
94+
95+
> **id**: [`AIUpstreamProviderId`](#aiupstreamproviderid)
96+
97+
##### status
98+
99+
> **status**: [`AIUpstreamProviderStatus`](#aiupstreamproviderstatus)
100+
101+
***
102+
103+
### AIUpstreamProviderId
104+
105+
> **AIUpstreamProviderId** = `"anthropic"` \| `"google"` \| `"openai"` \| `"openrouter"`
106+
107+
AI upstream provider ID.
108+
109+
***
110+
111+
### AIUpstreamProviderStatus
112+
113+
> **AIUpstreamProviderStatus** = `"Ready"` \| `"Missing"`
114+
115+
AI upstream provider status.
116+
Ready: The upstream provider is ready to use.
117+
Missing: The upstream provider is not configured.

‎src/reference/sdks/frontend/assistant.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Assistant
2+
3+
### AssistantPageContext
4+
5+
> **AssistantPageContext** = `object`
6+
7+
Assistant page context.
8+
9+
#### Properties
10+
11+
##### kind
12+
13+
> **kind**: `"Assistant"`

‎src/reference/sdks/frontend/automate.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
11
# Automate
22

3+
### AutomateEntry
4+
5+
> **AutomateEntry** = `object`
6+
7+
A automate entry.
8+
9+
#### Properties
10+
11+
##### createdAt
12+
13+
> **createdAt**: `Date`
14+
15+
The date the entry was created.
16+
17+
##### id
18+
19+
> **id**: [`ID`](utils.md#id)
20+
21+
The ID of the entry.
22+
23+
##### name
24+
25+
> **name**: `string`
26+
27+
The name of the entry.
28+
29+
***
30+
31+
### AutomatePageContext
32+
33+
> **AutomatePageContext** = `object`
34+
35+
Automate page context.
36+
37+
#### Properties
38+
39+
##### kind
40+
41+
> **kind**: `"Automate"`
42+
43+
##### requestSelection
44+
45+
> **requestSelection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>
46+
47+
##### selection
48+
49+
> **selection**: [`Selection`](utils.md#selection)\<\{ `id`: [`ID`](utils.md#id); `kind`: `"AutomateSession"`; \} \| \{ `id`: [`ID`](utils.md#id); `kind`: `"AutomateEntry"`; \}\>
50+
51+
***
52+
353
### AutomateSDK
454

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

959
#### Properties
1060

61+
##### addEntryIndicator()
62+
63+
> **addEntryIndicator**: (`entryId`: `ID`, `indicator`: `AddIndicatorOptions`) => `Indicator`
64+
65+
Add an indicator to an automate entry.
66+
Indicators are displayed next to the entry name in the collections tree.
67+
68+
###### Parameters
69+
70+
| Parameter | Type | Description |
71+
| ------ | ------ | ------ |
72+
| `entryId` | `ID` | The ID of the entry to add the indicator to. |
73+
| `indicator` | `AddIndicatorOptions` | The indicator configuration. |
74+
75+
###### Returns
76+
77+
`Indicator`
78+
79+
A handle object with a `remove` method to remove the indicator.
80+
81+
###### Example
82+
83+
```ts
84+
const indicator = sdk.automate.addEntryIndicator(entryId, {
85+
icon: "fas fa-exclamation-triangle",
86+
description: "Security warning",
87+
});
88+
89+
// Later, remove the indicator
90+
indicator.remove();
91+
```
92+
1193
##### addRequestEditorExtension()
1294

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

41123
`void`
124+
125+
##### addResponseViewMode()
126+
127+
> **addResponseViewMode**: (`options`: [`ResponseViewModeOptions`](response.md#responseviewmodeoptions)) => `void`
128+
129+
Add a custom response view mode.
130+
131+
###### Parameters
132+
133+
| Parameter | Type | Description |
134+
| ------ | ------ | ------ |
135+
| `options` | [`ResponseViewModeOptions`](response.md#responseviewmodeoptions) | The view mode options. |
136+
137+
###### Returns
138+
139+
`void`
140+
141+
##### getEntries()
142+
143+
> **getEntries**: (`sessionId`: `ID`) => `AutomateEntry`[]
144+
145+
Get the list of all automate entries.
146+
147+
###### Parameters
148+
149+
| Parameter | Type | Description |
150+
| ------ | ------ | ------ |
151+
| `sessionId` | `ID` | The ID of the session to get the entries of. |
152+
153+
###### Returns
154+
155+
`AutomateEntry`[]
156+
157+
The list of all automate entries.
158+
159+
##### getSessions()
160+
161+
> **getSessions**: () => `AutomateSession`[]
162+
163+
Get the list of all automate sessions.
164+
165+
###### Returns
166+
167+
`AutomateSession`[]
168+
169+
The list of all automate sessions.
170+
171+
***
172+
173+
### AutomateSession
174+
175+
> **AutomateSession** = `object`
176+
177+
A automate session.
178+
179+
#### Properties
180+
181+
##### createdAt
182+
183+
> **createdAt**: `Date`
184+
185+
The date the session was created.
186+
187+
##### entryIds
188+
189+
> **entryIds**: [`ID`](utils.md#id)[]
190+
191+
The IDs of all entries in this session.
192+
193+
##### id
194+
195+
> **id**: [`ID`](utils.md#id)
196+
197+
The ID of the session.
198+
199+
##### name
200+
201+
> **name**: `string`
202+
203+
The name of the session.

‎src/reference/sdks/frontend/backups.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Backups
2+
3+
### BackupsPageContext
4+
5+
> **BackupsPageContext** = `object`
6+
7+
Backups page context.
8+
9+
#### Properties
10+
11+
##### kind
12+
13+
> **kind**: `"Backups"`

‎src/reference/sdks/frontend/certificate.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Certificate
2+
3+
### CertificatePageContext
4+
5+
> **CertificatePageContext** = `object`
6+
7+
Certificate page context.
8+
9+
#### Properties
10+
11+
##### kind
12+
13+
> **kind**: `"Certificate"`

‎src/reference/sdks/frontend/environment.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Environment
22

3+
### EnvironmentPageContext
4+
5+
> **EnvironmentPageContext** = `object`
6+
7+
Environment page context.
8+
9+
#### Properties
10+
11+
##### kind
12+
13+
> **kind**: `"Environment"`
14+
15+
##### selection
16+
17+
> **selection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>
18+
19+
***
20+
321
### EnvironmentSDK
422

523
> **EnvironmentSDK** = `object`

‎src/reference/sdks/frontend/exports.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Exports
2+
3+
### ExportsPageContext
4+
5+
> **ExportsPageContext** = `object`
6+
7+
Exports page context.
8+
9+
#### Properties
10+
11+
##### kind
12+
13+
> **kind**: `"Exports"`

‎src/reference/sdks/frontend/files.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,20 @@ The asset file.
7676

7777
***
7878

79+
### FilesPageContext
80+
81+
> **FilesPageContext** = `object`
82+
83+
Files page context.
84+
85+
#### Properties
86+
87+
##### kind
88+
89+
> **kind**: `"Files"`
90+
91+
***
92+
7993
### FilesSDK
8094

8195
> **FilesSDK** = `object`

‎src/reference/sdks/frontend/filters.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,24 @@ The HTTPQL expression of the filter.
5151

5252
***
5353

54+
### FilterPageContext
55+
56+
> **FilterPageContext** = `object`
57+
58+
Filter page context.
59+
60+
#### Properties
61+
62+
##### kind
63+
64+
> **kind**: `"Filter"`
65+
66+
##### selection
67+
68+
> **selection**: [`Selection`](utils.md#selection)\<[`ID`](utils.md#id)\>
69+
70+
***
71+
5472
### FiltersSDK
5573

5674
> **FiltersSDK** = `object`

0 commit comments

Comments
 (0)