@airweave/sdk 0.1.11 → 0.1.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +3 -11
- package/Client.js +15 -30
- package/README.md +12 -8
- package/api/resources/connections/client/Client.d.ts +3 -2
- package/api/resources/connections/client/Client.js +38 -25
- package/api/resources/destinations/client/Client.d.ts +3 -2
- package/api/resources/destinations/client/Client.js +8 -5
- package/api/resources/embeddingModels/client/Client.d.ts +3 -2
- package/api/resources/embeddingModels/client/Client.js +8 -5
- package/api/resources/index.d.ts +0 -5
- package/api/resources/index.js +1 -6
- package/api/resources/sources/client/Client.d.ts +3 -2
- package/api/resources/sources/client/Client.js +8 -5
- package/api/resources/sync/client/Client.d.ts +3 -2
- package/api/resources/sync/client/Client.js +26 -17
- package/api/resources/users/client/Client.d.ts +3 -2
- package/api/resources/users/client/Client.js +5 -3
- package/api/resources/whiteLabels/client/Client.d.ts +3 -2
- package/api/resources/whiteLabels/client/Client.js +26 -17
- package/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.d.ts +1 -2
- package/{dist/api/resources/chat/client/requests → api/types}/ChatCreate.d.ts +1 -5
- package/{dist/api/resources/chat/client/requests → api/types}/ChatMessageCreate.d.ts +1 -4
- package/api/{resources/chat/client/requests → types}/ChatUpdate.d.ts +1 -2
- package/api/types/index.d.ts +4 -0
- package/api/types/index.js +4 -0
- package/dist/Client.d.ts +3 -11
- package/dist/Client.js +15 -30
- package/dist/api/resources/connections/client/Client.d.ts +3 -2
- package/dist/api/resources/connections/client/Client.js +38 -25
- package/dist/api/resources/destinations/client/Client.d.ts +3 -2
- package/dist/api/resources/destinations/client/Client.js +8 -5
- package/dist/api/resources/embeddingModels/client/Client.d.ts +3 -2
- package/dist/api/resources/embeddingModels/client/Client.js +8 -5
- package/dist/api/resources/index.d.ts +0 -5
- package/dist/api/resources/index.js +1 -6
- package/dist/api/resources/sources/client/Client.d.ts +3 -2
- package/dist/api/resources/sources/client/Client.js +8 -5
- package/dist/api/resources/sync/client/Client.d.ts +3 -2
- package/dist/api/resources/sync/client/Client.js +26 -17
- package/dist/api/resources/users/client/Client.d.ts +3 -2
- package/dist/api/resources/users/client/Client.js +5 -3
- package/dist/api/resources/whiteLabels/client/Client.d.ts +3 -2
- package/dist/api/resources/whiteLabels/client/Client.js +26 -17
- package/dist/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.d.ts +1 -2
- package/{api/resources/chat/client/requests → dist/api/types}/ChatCreate.d.ts +1 -5
- package/{api/resources/chat/client/requests → dist/api/types}/ChatMessageCreate.d.ts +1 -4
- package/dist/api/{resources/chat/client/requests → types}/ChatUpdate.d.ts +1 -2
- package/dist/api/types/index.d.ts +4 -0
- package/dist/api/types/index.js +4 -0
- package/dist/environments.d.ts +8 -0
- package/dist/environments.js +10 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +3 -1
- package/dist/serialization/resources/index.d.ts +0 -5
- package/dist/serialization/resources/index.js +1 -6
- package/dist/serialization/types/ApiKeyCreate.d.ts +12 -0
- package/{serialization/resources/apiKeys/client/requests → dist/serialization/types}/ApiKeyCreate.js +1 -1
- package/{serialization/resources/chat/client/requests → dist/serialization/types}/ChatCreate.d.ts +4 -4
- package/dist/serialization/{resources/chat/client/requests → types}/ChatCreate.js +1 -1
- package/dist/serialization/types/ChatMessageCreate.d.ts +13 -0
- package/{serialization/resources/chat/client/requests → dist/serialization/types}/ChatMessageCreate.js +1 -1
- package/dist/serialization/{resources/chat/client/requests → types}/ChatUpdate.d.ts +4 -4
- package/{serialization/resources/chat/client/requests → dist/serialization/types}/ChatUpdate.js +1 -1
- package/dist/serialization/types/index.d.ts +4 -0
- package/dist/serialization/types/index.js +4 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/environments.d.ts +8 -0
- package/environments.js +10 -0
- package/index.d.ts +1 -0
- package/index.js +3 -1
- package/package.json +1 -1
- package/reference.md +310 -1200
- package/serialization/resources/index.d.ts +0 -5
- package/serialization/resources/index.js +1 -6
- package/serialization/types/ApiKeyCreate.d.ts +12 -0
- package/{dist/serialization/resources/apiKeys/client/requests → serialization/types}/ApiKeyCreate.js +1 -1
- package/{dist/serialization/resources/chat/client/requests → serialization/types}/ChatCreate.d.ts +4 -4
- package/serialization/{resources/chat/client/requests → types}/ChatCreate.js +1 -1
- package/serialization/types/ChatMessageCreate.d.ts +13 -0
- package/{dist/serialization/resources/chat/client/requests → serialization/types}/ChatMessageCreate.js +1 -1
- package/serialization/{resources/chat/client/requests → types}/ChatUpdate.d.ts +4 -4
- package/{dist/serialization/resources/chat/client/requests → serialization/types}/ChatUpdate.js +1 -1
- package/serialization/types/index.d.ts +4 -0
- package/serialization/types/index.js +4 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/apiKeys/client/Client.d.ts +0 -130
- package/api/resources/apiKeys/client/Client.js +0 -386
- package/api/resources/apiKeys/client/index.d.ts +0 -1
- package/api/resources/apiKeys/client/index.js +0 -17
- package/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
- package/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js +0 -5
- package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +0 -11
- package/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js +0 -5
- package/api/resources/apiKeys/client/requests/index.d.ts +0 -3
- package/api/resources/apiKeys/client/requests/index.js +0 -2
- package/api/resources/apiKeys/index.d.ts +0 -1
- package/api/resources/apiKeys/index.js +0 -17
- package/api/resources/chat/client/Client.d.ts +0 -133
- package/api/resources/chat/client/Client.js +0 -585
- package/api/resources/chat/client/index.d.ts +0 -1
- package/api/resources/chat/client/index.js +0 -17
- package/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +0 -11
- package/api/resources/chat/client/requests/ListChatsChatGetRequest.js +0 -5
- package/api/resources/chat/client/requests/index.d.ts +0 -4
- package/api/resources/chat/client/requests/index.js +0 -2
- package/api/resources/chat/index.d.ts +0 -1
- package/api/resources/chat/index.js +0 -17
- package/api/resources/health/client/Client.d.ts +0 -39
- package/api/resources/health/client/Client.js +0 -115
- package/api/resources/health/client/index.d.ts +0 -1
- package/api/resources/health/client/index.js +0 -2
- package/api/resources/health/index.d.ts +0 -1
- package/api/resources/health/index.js +0 -17
- package/dist/api/resources/apiKeys/client/Client.d.ts +0 -130
- package/dist/api/resources/apiKeys/client/Client.js +0 -386
- package/dist/api/resources/apiKeys/client/index.d.ts +0 -1
- package/dist/api/resources/apiKeys/client/index.js +0 -17
- package/dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.d.ts +0 -12
- package/dist/api/resources/apiKeys/client/requests/DeleteApiKeyApiKeysDeleteRequest.js +0 -5
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.d.ts +0 -11
- package/dist/api/resources/apiKeys/client/requests/ReadApiKeysApiKeysGetRequest.js +0 -5
- package/dist/api/resources/apiKeys/client/requests/index.d.ts +0 -3
- package/dist/api/resources/apiKeys/client/requests/index.js +0 -2
- package/dist/api/resources/apiKeys/index.d.ts +0 -1
- package/dist/api/resources/apiKeys/index.js +0 -17
- package/dist/api/resources/chat/client/Client.d.ts +0 -133
- package/dist/api/resources/chat/client/Client.js +0 -585
- package/dist/api/resources/chat/client/index.d.ts +0 -1
- package/dist/api/resources/chat/client/index.js +0 -17
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.d.ts +0 -11
- package/dist/api/resources/chat/client/requests/ListChatsChatGetRequest.js +0 -5
- package/dist/api/resources/chat/client/requests/index.d.ts +0 -4
- package/dist/api/resources/chat/client/requests/index.js +0 -2
- package/dist/api/resources/chat/index.d.ts +0 -1
- package/dist/api/resources/chat/index.js +0 -17
- package/dist/api/resources/health/client/Client.d.ts +0 -39
- package/dist/api/resources/health/client/Client.js +0 -115
- package/dist/api/resources/health/client/index.d.ts +0 -1
- package/dist/api/resources/health/client/index.js +0 -2
- package/dist/api/resources/health/index.d.ts +0 -1
- package/dist/api/resources/health/index.js +0 -17
- package/dist/serialization/resources/apiKeys/client/index.d.ts +0 -2
- package/dist/serialization/resources/apiKeys/client/index.js +0 -41
- package/dist/serialization/resources/apiKeys/client/readApiKeys.d.ts +0 -11
- package/dist/serialization/resources/apiKeys/client/readApiKeys.js +0 -42
- package/dist/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -12
- package/dist/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/apiKeys/client/requests/index.js +0 -5
- package/dist/serialization/resources/apiKeys/index.d.ts +0 -1
- package/dist/serialization/resources/apiKeys/index.js +0 -17
- package/dist/serialization/resources/chat/client/index.d.ts +0 -3
- package/dist/serialization/resources/chat/client/index.js +0 -42
- package/dist/serialization/resources/chat/client/listChats.d.ts +0 -11
- package/dist/serialization/resources/chat/client/listChats.js +0 -42
- package/dist/serialization/resources/chat/client/openaiKeySet.d.ts +0 -9
- package/dist/serialization/resources/chat/client/openaiKeySet.js +0 -41
- package/dist/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/dist/serialization/resources/chat/client/requests/index.d.ts +0 -3
- package/dist/serialization/resources/chat/client/requests/index.js +0 -9
- package/dist/serialization/resources/chat/index.d.ts +0 -1
- package/dist/serialization/resources/chat/index.js +0 -17
- package/dist/serialization/resources/health/client/healthCheck.d.ts +0 -9
- package/dist/serialization/resources/health/client/healthCheck.js +0 -41
- package/dist/serialization/resources/health/client/index.d.ts +0 -1
- package/dist/serialization/resources/health/client/index.js +0 -37
- package/dist/serialization/resources/health/index.d.ts +0 -1
- package/dist/serialization/resources/health/index.js +0 -17
- package/serialization/resources/apiKeys/client/index.d.ts +0 -2
- package/serialization/resources/apiKeys/client/index.js +0 -41
- package/serialization/resources/apiKeys/client/readApiKeys.d.ts +0 -11
- package/serialization/resources/apiKeys/client/readApiKeys.js +0 -42
- package/serialization/resources/apiKeys/client/requests/ApiKeyCreate.d.ts +0 -12
- package/serialization/resources/apiKeys/client/requests/index.d.ts +0 -1
- package/serialization/resources/apiKeys/client/requests/index.js +0 -5
- package/serialization/resources/apiKeys/index.d.ts +0 -1
- package/serialization/resources/apiKeys/index.js +0 -17
- package/serialization/resources/chat/client/index.d.ts +0 -3
- package/serialization/resources/chat/client/index.js +0 -42
- package/serialization/resources/chat/client/listChats.d.ts +0 -11
- package/serialization/resources/chat/client/listChats.js +0 -42
- package/serialization/resources/chat/client/openaiKeySet.d.ts +0 -9
- package/serialization/resources/chat/client/openaiKeySet.js +0 -41
- package/serialization/resources/chat/client/requests/ChatMessageCreate.d.ts +0 -13
- package/serialization/resources/chat/client/requests/index.d.ts +0 -3
- package/serialization/resources/chat/client/requests/index.js +0 -9
- package/serialization/resources/chat/index.d.ts +0 -1
- package/serialization/resources/chat/index.js +0 -17
- package/serialization/resources/health/client/healthCheck.d.ts +0 -9
- package/serialization/resources/health/client/healthCheck.js +0 -41
- package/serialization/resources/health/client/index.d.ts +0 -1
- package/serialization/resources/health/client/index.js +0 -37
- package/serialization/resources/health/index.d.ts +0 -1
- package/serialization/resources/health/index.js +0 -17
- /package/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.js +0 -0
- /package/api/{resources/chat/client/requests → types}/ChatCreate.js +0 -0
- /package/api/{resources/chat/client/requests → types}/ChatMessageCreate.js +0 -0
- /package/api/{resources/chat/client/requests → types}/ChatUpdate.js +0 -0
- /package/dist/api/{resources/apiKeys/client/requests → types}/ApiKeyCreate.js +0 -0
- /package/dist/api/{resources/chat/client/requests → types}/ChatCreate.js +0 -0
- /package/dist/api/{resources/chat/client/requests → types}/ChatMessageCreate.js +0 -0
- /package/dist/api/{resources/chat/client/requests → types}/ChatUpdate.js +0 -0
package/reference.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Users
|
|
4
4
|
|
|
5
|
-
<details><summary><code>client.
|
|
5
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">readUser</a>() -> AirweaveSDK.User</code></summary>
|
|
6
6
|
<dl>
|
|
7
7
|
<dd>
|
|
8
8
|
|
|
@@ -14,10 +14,15 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Get current user.
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
## Args:
|
|
20
|
+
|
|
21
|
+
current_user (User): The current user.
|
|
22
|
+
|
|
23
|
+
## Returns:
|
|
24
|
+
|
|
25
|
+
schemas.User: The user object.
|
|
21
26
|
|
|
22
27
|
</dd>
|
|
23
28
|
</dl>
|
|
@@ -33,7 +38,7 @@ dict: A dictionary containing the status of the API.
|
|
|
33
38
|
<dd>
|
|
34
39
|
|
|
35
40
|
```typescript
|
|
36
|
-
await client.
|
|
41
|
+
await client.users.readUser();
|
|
37
42
|
```
|
|
38
43
|
|
|
39
44
|
</dd>
|
|
@@ -49,7 +54,7 @@ await client.health.healthCheck();
|
|
|
49
54
|
<dl>
|
|
50
55
|
<dd>
|
|
51
56
|
|
|
52
|
-
**requestOptions:** `
|
|
57
|
+
**requestOptions:** `Users.RequestOptions`
|
|
53
58
|
|
|
54
59
|
</dd>
|
|
55
60
|
</dl>
|
|
@@ -60,9 +65,9 @@ await client.health.healthCheck();
|
|
|
60
65
|
</dl>
|
|
61
66
|
</details>
|
|
62
67
|
|
|
63
|
-
##
|
|
68
|
+
## Sources
|
|
64
69
|
|
|
65
|
-
<details><summary><code>client.
|
|
70
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.Source</code></summary>
|
|
66
71
|
<dl>
|
|
67
72
|
<dd>
|
|
68
73
|
|
|
@@ -74,18 +79,17 @@ await client.health.healthCheck();
|
|
|
74
79
|
<dl>
|
|
75
80
|
<dd>
|
|
76
81
|
|
|
77
|
-
|
|
82
|
+
Get source by id.
|
|
78
83
|
|
|
79
84
|
## Args:
|
|
80
85
|
|
|
81
86
|
db (AsyncSession): The database session.
|
|
82
|
-
|
|
83
|
-
limit (int): Maximum number of records to return.
|
|
87
|
+
short_name (str): The short name of the source.
|
|
84
88
|
user (schemas.User): The current user.
|
|
85
89
|
|
|
86
90
|
## Returns:
|
|
87
91
|
|
|
88
|
-
|
|
92
|
+
schemas.Source: The source object.
|
|
89
93
|
|
|
90
94
|
</dd>
|
|
91
95
|
</dl>
|
|
@@ -101,7 +105,7 @@ Retrieve all API keys for the current user.
|
|
|
101
105
|
<dd>
|
|
102
106
|
|
|
103
107
|
```typescript
|
|
104
|
-
await client.
|
|
108
|
+
await client.sources.readSource("short_name");
|
|
105
109
|
```
|
|
106
110
|
|
|
107
111
|
</dd>
|
|
@@ -117,7 +121,7 @@ await client.apiKeys.readApiKeys();
|
|
|
117
121
|
<dl>
|
|
118
122
|
<dd>
|
|
119
123
|
|
|
120
|
-
**
|
|
124
|
+
**shortName:** `string`
|
|
121
125
|
|
|
122
126
|
</dd>
|
|
123
127
|
</dl>
|
|
@@ -125,7 +129,7 @@ await client.apiKeys.readApiKeys();
|
|
|
125
129
|
<dl>
|
|
126
130
|
<dd>
|
|
127
131
|
|
|
128
|
-
**requestOptions:** `
|
|
132
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
129
133
|
|
|
130
134
|
</dd>
|
|
131
135
|
</dl>
|
|
@@ -136,7 +140,7 @@ await client.apiKeys.readApiKeys();
|
|
|
136
140
|
</dl>
|
|
137
141
|
</details>
|
|
138
142
|
|
|
139
|
-
<details><summary><code>client.
|
|
143
|
+
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSources</a>() -> AirweaveSDK.Source[]</code></summary>
|
|
140
144
|
<dl>
|
|
141
145
|
<dd>
|
|
142
146
|
|
|
@@ -148,20 +152,11 @@ await client.apiKeys.readApiKeys();
|
|
|
148
152
|
<dl>
|
|
149
153
|
<dd>
|
|
150
154
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
Returns a temporary plain key for the user to store securely.
|
|
154
|
-
This is not stored in the database.
|
|
155
|
-
|
|
156
|
-
## Args:
|
|
157
|
-
|
|
158
|
-
db (AsyncSession): The database session.
|
|
159
|
-
api_key_in (schemas.APIKeyCreate): The API key creation data.
|
|
160
|
-
user (schemas.User): The current user.
|
|
155
|
+
Get all sources for the current user.
|
|
161
156
|
|
|
162
157
|
## Returns:
|
|
163
158
|
|
|
164
|
-
schemas.
|
|
159
|
+
list[schemas.Source]: The list of sources.
|
|
165
160
|
|
|
166
161
|
</dd>
|
|
167
162
|
</dl>
|
|
@@ -177,7 +172,7 @@ This is not stored in the database.
|
|
|
177
172
|
<dd>
|
|
178
173
|
|
|
179
174
|
```typescript
|
|
180
|
-
await client.
|
|
175
|
+
await client.sources.readSources();
|
|
181
176
|
```
|
|
182
177
|
|
|
183
178
|
</dd>
|
|
@@ -193,15 +188,7 @@ await client.apiKeys.createApiKey();
|
|
|
193
188
|
<dl>
|
|
194
189
|
<dd>
|
|
195
190
|
|
|
196
|
-
**
|
|
197
|
-
|
|
198
|
-
</dd>
|
|
199
|
-
</dl>
|
|
200
|
-
|
|
201
|
-
<dl>
|
|
202
|
-
<dd>
|
|
203
|
-
|
|
204
|
-
**requestOptions:** `ApiKeys.RequestOptions`
|
|
191
|
+
**requestOptions:** `Sources.RequestOptions`
|
|
205
192
|
|
|
206
193
|
</dd>
|
|
207
194
|
</dl>
|
|
@@ -212,7 +199,9 @@ await client.apiKeys.createApiKey();
|
|
|
212
199
|
</dl>
|
|
213
200
|
</details>
|
|
214
201
|
|
|
215
|
-
|
|
202
|
+
## Destinations
|
|
203
|
+
|
|
204
|
+
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
216
205
|
<dl>
|
|
217
206
|
<dd>
|
|
218
207
|
|
|
@@ -224,21 +213,7 @@ await client.apiKeys.createApiKey();
|
|
|
224
213
|
<dl>
|
|
225
214
|
<dd>
|
|
226
215
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
## Args:
|
|
230
|
-
|
|
231
|
-
db (AsyncSession): The database session.
|
|
232
|
-
id (UUID): The ID of the API key.
|
|
233
|
-
user (schemas.User): The current user.
|
|
234
|
-
|
|
235
|
-
## Returns:
|
|
236
|
-
|
|
237
|
-
schemas.APIKey: The revoked API key object.
|
|
238
|
-
|
|
239
|
-
## Raises:
|
|
240
|
-
|
|
241
|
-
HTTPException: If the API key is not found.
|
|
216
|
+
Get all available destinations.
|
|
242
217
|
|
|
243
218
|
</dd>
|
|
244
219
|
</dl>
|
|
@@ -254,9 +229,7 @@ Delete an API key.
|
|
|
254
229
|
<dd>
|
|
255
230
|
|
|
256
231
|
```typescript
|
|
257
|
-
await client.
|
|
258
|
-
id: "id",
|
|
259
|
-
});
|
|
232
|
+
await client.destinations.listDestinations();
|
|
260
233
|
```
|
|
261
234
|
|
|
262
235
|
</dd>
|
|
@@ -272,15 +245,7 @@ await client.apiKeys.deleteApiKey({
|
|
|
272
245
|
<dl>
|
|
273
246
|
<dd>
|
|
274
247
|
|
|
275
|
-
**
|
|
276
|
-
|
|
277
|
-
</dd>
|
|
278
|
-
</dl>
|
|
279
|
-
|
|
280
|
-
<dl>
|
|
281
|
-
<dd>
|
|
282
|
-
|
|
283
|
-
**requestOptions:** `ApiKeys.RequestOptions`
|
|
248
|
+
**requestOptions:** `Destinations.RequestOptions`
|
|
284
249
|
|
|
285
250
|
</dd>
|
|
286
251
|
</dl>
|
|
@@ -291,7 +256,7 @@ await client.apiKeys.deleteApiKey({
|
|
|
291
256
|
</dl>
|
|
292
257
|
</details>
|
|
293
258
|
|
|
294
|
-
<details><summary><code>client.
|
|
259
|
+
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">readDestination</a>(shortName) -> AirweaveSDK.DestinationWithConfigFields</code></summary>
|
|
295
260
|
<dl>
|
|
296
261
|
<dd>
|
|
297
262
|
|
|
@@ -303,21 +268,7 @@ await client.apiKeys.deleteApiKey({
|
|
|
303
268
|
<dl>
|
|
304
269
|
<dd>
|
|
305
270
|
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
## Args:
|
|
309
|
-
|
|
310
|
-
db (AsyncSession): The database session.
|
|
311
|
-
id (UUID): The ID of the API key.
|
|
312
|
-
user (schemas.User): The current user.
|
|
313
|
-
|
|
314
|
-
## Returns:
|
|
315
|
-
|
|
316
|
-
schemas.APIKey: The API key object.
|
|
317
|
-
|
|
318
|
-
## Raises:
|
|
319
|
-
|
|
320
|
-
HTTPException: If the API key is not found.
|
|
271
|
+
Get destination by short name.
|
|
321
272
|
|
|
322
273
|
</dd>
|
|
323
274
|
</dl>
|
|
@@ -333,7 +284,7 @@ Retrieve an API key by ID.
|
|
|
333
284
|
<dd>
|
|
334
285
|
|
|
335
286
|
```typescript
|
|
336
|
-
await client.
|
|
287
|
+
await client.destinations.readDestination("short_name");
|
|
337
288
|
```
|
|
338
289
|
|
|
339
290
|
</dd>
|
|
@@ -349,7 +300,7 @@ await client.apiKeys.readApiKey("id");
|
|
|
349
300
|
<dl>
|
|
350
301
|
<dd>
|
|
351
302
|
|
|
352
|
-
**
|
|
303
|
+
**shortName:** `string`
|
|
353
304
|
|
|
354
305
|
</dd>
|
|
355
306
|
</dl>
|
|
@@ -357,7 +308,7 @@ await client.apiKeys.readApiKey("id");
|
|
|
357
308
|
<dl>
|
|
358
309
|
<dd>
|
|
359
310
|
|
|
360
|
-
**requestOptions:** `
|
|
311
|
+
**requestOptions:** `Destinations.RequestOptions`
|
|
361
312
|
|
|
362
313
|
</dd>
|
|
363
314
|
</dl>
|
|
@@ -368,9 +319,9 @@ await client.apiKeys.readApiKey("id");
|
|
|
368
319
|
</dl>
|
|
369
320
|
</details>
|
|
370
321
|
|
|
371
|
-
##
|
|
322
|
+
## EmbeddingModels
|
|
372
323
|
|
|
373
|
-
<details><summary><code>client.
|
|
324
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
374
325
|
<dl>
|
|
375
326
|
<dd>
|
|
376
327
|
|
|
@@ -382,15 +333,17 @@ await client.apiKeys.readApiKey("id");
|
|
|
382
333
|
<dl>
|
|
383
334
|
<dd>
|
|
384
335
|
|
|
385
|
-
Get
|
|
336
|
+
Get embedding model by id.
|
|
386
337
|
|
|
387
338
|
## Args:
|
|
388
339
|
|
|
389
|
-
|
|
340
|
+
db (AsyncSession): The database session.
|
|
341
|
+
short_name (str): The short name of the embedding model.
|
|
342
|
+
user (schemas.User): The current user.
|
|
390
343
|
|
|
391
344
|
## Returns:
|
|
392
345
|
|
|
393
|
-
schemas.
|
|
346
|
+
schemas.EmbeddingModel: The embedding model object.
|
|
394
347
|
|
|
395
348
|
</dd>
|
|
396
349
|
</dl>
|
|
@@ -406,7 +359,7 @@ Get current user.
|
|
|
406
359
|
<dd>
|
|
407
360
|
|
|
408
361
|
```typescript
|
|
409
|
-
await client.
|
|
362
|
+
await client.embeddingModels.readEmbeddingModel("short_name");
|
|
410
363
|
```
|
|
411
364
|
|
|
412
365
|
</dd>
|
|
@@ -422,7 +375,15 @@ await client.users.readUser();
|
|
|
422
375
|
<dl>
|
|
423
376
|
<dd>
|
|
424
377
|
|
|
425
|
-
**
|
|
378
|
+
**shortName:** `string`
|
|
379
|
+
|
|
380
|
+
</dd>
|
|
381
|
+
</dl>
|
|
382
|
+
|
|
383
|
+
<dl>
|
|
384
|
+
<dd>
|
|
385
|
+
|
|
386
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
426
387
|
|
|
427
388
|
</dd>
|
|
428
389
|
</dl>
|
|
@@ -433,9 +394,7 @@ await client.users.readUser();
|
|
|
433
394
|
</dl>
|
|
434
395
|
</details>
|
|
435
396
|
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
<details><summary><code>client.sources.<a href="/src/api/resources/sources/client/Client.ts">readSource</a>(shortName) -> AirweaveSDK.Source</code></summary>
|
|
397
|
+
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModels</a>() -> AirweaveSDK.EmbeddingModel[]</code></summary>
|
|
439
398
|
<dl>
|
|
440
399
|
<dd>
|
|
441
400
|
|
|
@@ -447,17 +406,16 @@ await client.users.readUser();
|
|
|
447
406
|
<dl>
|
|
448
407
|
<dd>
|
|
449
408
|
|
|
450
|
-
Get
|
|
409
|
+
Get all embedding models.
|
|
451
410
|
|
|
452
411
|
## Args:
|
|
453
412
|
|
|
454
413
|
db (AsyncSession): The database session.
|
|
455
|
-
short_name (str): The short name of the source.
|
|
456
414
|
user (schemas.User): The current user.
|
|
457
415
|
|
|
458
416
|
## Returns:
|
|
459
417
|
|
|
460
|
-
schemas.
|
|
418
|
+
list[schemas.EmbeddingModel]: The list of embedding models.
|
|
461
419
|
|
|
462
420
|
</dd>
|
|
463
421
|
</dl>
|
|
@@ -473,7 +431,7 @@ Get source by id.
|
|
|
473
431
|
<dd>
|
|
474
432
|
|
|
475
433
|
```typescript
|
|
476
|
-
await client.
|
|
434
|
+
await client.embeddingModels.readEmbeddingModels();
|
|
477
435
|
```
|
|
478
436
|
|
|
479
437
|
</dd>
|
|
@@ -489,15 +447,7 @@ await client.sources.readSource("short_name");
|
|
|
489
447
|
<dl>
|
|
490
448
|
<dd>
|
|
491
449
|
|
|
492
|
-
**
|
|
493
|
-
|
|
494
|
-
</dd>
|
|
495
|
-
</dl>
|
|
496
|
-
|
|
497
|
-
<dl>
|
|
498
|
-
<dd>
|
|
499
|
-
|
|
500
|
-
**requestOptions:** `Sources.RequestOptions`
|
|
450
|
+
**requestOptions:** `EmbeddingModels.RequestOptions`
|
|
501
451
|
|
|
502
452
|
</dd>
|
|
503
453
|
</dl>
|
|
@@ -508,7 +458,9 @@ await client.sources.readSource("short_name");
|
|
|
508
458
|
</dl>
|
|
509
459
|
</details>
|
|
510
460
|
|
|
511
|
-
|
|
461
|
+
## Connections
|
|
462
|
+
|
|
463
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
512
464
|
<dl>
|
|
513
465
|
<dd>
|
|
514
466
|
|
|
@@ -520,11 +472,7 @@ await client.sources.readSource("short_name");
|
|
|
520
472
|
<dl>
|
|
521
473
|
<dd>
|
|
522
474
|
|
|
523
|
-
Get
|
|
524
|
-
|
|
525
|
-
## Returns:
|
|
526
|
-
|
|
527
|
-
list[schemas.Source]: The list of sources.
|
|
475
|
+
Get a specific connection.
|
|
528
476
|
|
|
529
477
|
</dd>
|
|
530
478
|
</dl>
|
|
@@ -540,7 +488,7 @@ Get all sources for the current user.
|
|
|
540
488
|
<dd>
|
|
541
489
|
|
|
542
490
|
```typescript
|
|
543
|
-
await client.
|
|
491
|
+
await client.connections.getConnection("connection_id");
|
|
544
492
|
```
|
|
545
493
|
|
|
546
494
|
</dd>
|
|
@@ -556,7 +504,15 @@ await client.sources.readSources();
|
|
|
556
504
|
<dl>
|
|
557
505
|
<dd>
|
|
558
506
|
|
|
559
|
-
**
|
|
507
|
+
**connectionId:** `string`
|
|
508
|
+
|
|
509
|
+
</dd>
|
|
510
|
+
</dl>
|
|
511
|
+
|
|
512
|
+
<dl>
|
|
513
|
+
<dd>
|
|
514
|
+
|
|
515
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
560
516
|
|
|
561
517
|
</dd>
|
|
562
518
|
</dl>
|
|
@@ -567,9 +523,7 @@ await client.sources.readSources();
|
|
|
567
523
|
</dl>
|
|
568
524
|
</details>
|
|
569
525
|
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
<details><summary><code>client.destinations.<a href="/src/api/resources/destinations/client/Client.ts">listDestinations</a>() -> AirweaveSDK.Destination[]</code></summary>
|
|
526
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
|
|
573
527
|
<dl>
|
|
574
528
|
<dd>
|
|
575
529
|
|
|
@@ -581,7 +535,7 @@ await client.sources.readSources();
|
|
|
581
535
|
<dl>
|
|
582
536
|
<dd>
|
|
583
537
|
|
|
584
|
-
Get all
|
|
538
|
+
Get all active connections for the current user across all integration types.
|
|
585
539
|
|
|
586
540
|
</dd>
|
|
587
541
|
</dl>
|
|
@@ -597,7 +551,7 @@ Get all available destinations.
|
|
|
597
551
|
<dd>
|
|
598
552
|
|
|
599
553
|
```typescript
|
|
600
|
-
await client.
|
|
554
|
+
await client.connections.listAllConnectedIntegrations();
|
|
601
555
|
```
|
|
602
556
|
|
|
603
557
|
</dd>
|
|
@@ -613,7 +567,7 @@ await client.destinations.listDestinations();
|
|
|
613
567
|
<dl>
|
|
614
568
|
<dd>
|
|
615
569
|
|
|
616
|
-
**requestOptions:** `
|
|
570
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
617
571
|
|
|
618
572
|
</dd>
|
|
619
573
|
</dl>
|
|
@@ -624,7 +578,7 @@ await client.destinations.listDestinations();
|
|
|
624
578
|
</dl>
|
|
625
579
|
</details>
|
|
626
580
|
|
|
627
|
-
<details><summary><code>client.
|
|
581
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listConnectedIntegrations</a>(integrationType) -> AirweaveSDK.Connection[]</code></summary>
|
|
628
582
|
<dl>
|
|
629
583
|
<dd>
|
|
630
584
|
|
|
@@ -636,7 +590,15 @@ await client.destinations.listDestinations();
|
|
|
636
590
|
<dl>
|
|
637
591
|
<dd>
|
|
638
592
|
|
|
639
|
-
Get
|
|
593
|
+
Get all integrations of specified type connected to the current user.
|
|
594
|
+
|
|
595
|
+
Args:
|
|
596
|
+
integration_type (IntegrationType): The type of integration to get connections for.
|
|
597
|
+
db (AsyncSession): The database session.
|
|
598
|
+
user (schemas.User): The current user.
|
|
599
|
+
|
|
600
|
+
Returns:
|
|
601
|
+
list[schemas.Connection]: The list of connections.
|
|
640
602
|
|
|
641
603
|
</dd>
|
|
642
604
|
</dl>
|
|
@@ -652,7 +614,7 @@ Get destination by short name.
|
|
|
652
614
|
<dd>
|
|
653
615
|
|
|
654
616
|
```typescript
|
|
655
|
-
await client.
|
|
617
|
+
await client.connections.listConnectedIntegrations("source");
|
|
656
618
|
```
|
|
657
619
|
|
|
658
620
|
</dd>
|
|
@@ -668,7 +630,7 @@ await client.destinations.readDestination("short_name");
|
|
|
668
630
|
<dl>
|
|
669
631
|
<dd>
|
|
670
632
|
|
|
671
|
-
**
|
|
633
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
672
634
|
|
|
673
635
|
</dd>
|
|
674
636
|
</dl>
|
|
@@ -676,7 +638,7 @@ await client.destinations.readDestination("short_name");
|
|
|
676
638
|
<dl>
|
|
677
639
|
<dd>
|
|
678
640
|
|
|
679
|
-
**requestOptions:** `
|
|
641
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
680
642
|
|
|
681
643
|
</dd>
|
|
682
644
|
</dl>
|
|
@@ -687,9 +649,7 @@ await client.destinations.readDestination("short_name");
|
|
|
687
649
|
</dl>
|
|
688
650
|
</details>
|
|
689
651
|
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
<details><summary><code>client.embeddingModels.<a href="/src/api/resources/embeddingModels/client/Client.ts">readEmbeddingModel</a>(shortName) -> AirweaveSDK.EmbeddingModelWithConfigFields</code></summary>
|
|
652
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectIntegration</a>(integrationType, shortName, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
693
653
|
<dl>
|
|
694
654
|
<dd>
|
|
695
655
|
|
|
@@ -701,17 +661,16 @@ await client.destinations.readDestination("short_name");
|
|
|
701
661
|
<dl>
|
|
702
662
|
<dd>
|
|
703
663
|
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
## Args:
|
|
707
|
-
|
|
708
|
-
db (AsyncSession): The database session.
|
|
709
|
-
short_name (str): The short name of the embedding model.
|
|
710
|
-
user (schemas.User): The current user.
|
|
664
|
+
Connect to a source, destination, or embedding model.
|
|
711
665
|
|
|
712
|
-
|
|
666
|
+
Expects a POST body with:
|
|
713
667
|
|
|
714
|
-
|
|
668
|
+
```json
|
|
669
|
+
{
|
|
670
|
+
"name": "required connection name",
|
|
671
|
+
... other config fields specific to the integration type ...
|
|
672
|
+
}
|
|
673
|
+
```
|
|
715
674
|
|
|
716
675
|
</dd>
|
|
717
676
|
</dl>
|
|
@@ -727,7 +686,11 @@ Get embedding model by id.
|
|
|
727
686
|
<dd>
|
|
728
687
|
|
|
729
688
|
```typescript
|
|
730
|
-
await client.
|
|
689
|
+
await client.connections.connectIntegration("source", "short_name", {
|
|
690
|
+
configFields: {
|
|
691
|
+
key: "value",
|
|
692
|
+
},
|
|
693
|
+
});
|
|
731
694
|
```
|
|
732
695
|
|
|
733
696
|
</dd>
|
|
@@ -743,6 +706,14 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
743
706
|
<dl>
|
|
744
707
|
<dd>
|
|
745
708
|
|
|
709
|
+
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
710
|
+
|
|
711
|
+
</dd>
|
|
712
|
+
</dl>
|
|
713
|
+
|
|
714
|
+
<dl>
|
|
715
|
+
<dd>
|
|
716
|
+
|
|
746
717
|
**shortName:** `string`
|
|
747
718
|
|
|
748
719
|
</dd>
|
|
@@ -751,7 +722,15 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
751
722
|
<dl>
|
|
752
723
|
<dd>
|
|
753
724
|
|
|
754
|
-
**
|
|
725
|
+
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
726
|
+
|
|
727
|
+
</dd>
|
|
728
|
+
</dl>
|
|
729
|
+
|
|
730
|
+
<dl>
|
|
731
|
+
<dd>
|
|
732
|
+
|
|
733
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
755
734
|
|
|
756
735
|
</dd>
|
|
757
736
|
</dl>
|
|
@@ -762,7 +741,7 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
762
741
|
</dl>
|
|
763
742
|
</details>
|
|
764
743
|
|
|
765
|
-
<details><summary><code>client.
|
|
744
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnectionCredentials</a>(connectionId) -> Record<string, unknown></code></summary>
|
|
766
745
|
<dl>
|
|
767
746
|
<dd>
|
|
768
747
|
|
|
@@ -774,16 +753,15 @@ await client.embeddingModels.readEmbeddingModel("short_name");
|
|
|
774
753
|
<dl>
|
|
775
754
|
<dd>
|
|
776
755
|
|
|
777
|
-
Get
|
|
778
|
-
|
|
779
|
-
## Args:
|
|
780
|
-
|
|
781
|
-
db (AsyncSession): The database session.
|
|
782
|
-
user (schemas.User): The current user.
|
|
756
|
+
Get the credentials for a connection.
|
|
783
757
|
|
|
784
|
-
|
|
758
|
+
Args:
|
|
759
|
+
connection_id (UUID): The ID of the connection to get credentials for
|
|
760
|
+
db (AsyncSession): The database session
|
|
761
|
+
user (schemas.User): The current user
|
|
785
762
|
|
|
786
|
-
|
|
763
|
+
Returns:
|
|
764
|
+
dict: The credentials for the connection
|
|
787
765
|
|
|
788
766
|
</dd>
|
|
789
767
|
</dl>
|
|
@@ -799,7 +777,7 @@ Get all embedding models.
|
|
|
799
777
|
<dd>
|
|
800
778
|
|
|
801
779
|
```typescript
|
|
802
|
-
await client.
|
|
780
|
+
await client.connections.getConnectionCredentials("connection_id");
|
|
803
781
|
```
|
|
804
782
|
|
|
805
783
|
</dd>
|
|
@@ -815,7 +793,15 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
815
793
|
<dl>
|
|
816
794
|
<dd>
|
|
817
795
|
|
|
818
|
-
**
|
|
796
|
+
**connectionId:** `string`
|
|
797
|
+
|
|
798
|
+
</dd>
|
|
799
|
+
</dl>
|
|
800
|
+
|
|
801
|
+
<dl>
|
|
802
|
+
<dd>
|
|
803
|
+
|
|
804
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
819
805
|
|
|
820
806
|
</dd>
|
|
821
807
|
</dl>
|
|
@@ -826,9 +812,7 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
826
812
|
</dl>
|
|
827
813
|
</details>
|
|
828
814
|
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
815
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">deleteConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
832
816
|
<dl>
|
|
833
817
|
<dd>
|
|
834
818
|
|
|
@@ -840,205 +824,18 @@ await client.embeddingModels.readEmbeddingModels();
|
|
|
840
824
|
<dl>
|
|
841
825
|
<dd>
|
|
842
826
|
|
|
843
|
-
|
|
827
|
+
Delete a connection.
|
|
844
828
|
|
|
845
|
-
|
|
846
|
-
</dl>
|
|
847
|
-
</dd>
|
|
848
|
-
</dl>
|
|
849
|
-
|
|
850
|
-
#### 🔌 Usage
|
|
851
|
-
|
|
852
|
-
<dl>
|
|
853
|
-
<dd>
|
|
854
|
-
|
|
855
|
-
<dl>
|
|
856
|
-
<dd>
|
|
857
|
-
|
|
858
|
-
```typescript
|
|
859
|
-
await client.connections.getConnection("connection_id");
|
|
860
|
-
```
|
|
861
|
-
|
|
862
|
-
</dd>
|
|
863
|
-
</dl>
|
|
864
|
-
</dd>
|
|
865
|
-
</dl>
|
|
866
|
-
|
|
867
|
-
#### ⚙️ Parameters
|
|
868
|
-
|
|
869
|
-
<dl>
|
|
870
|
-
<dd>
|
|
871
|
-
|
|
872
|
-
<dl>
|
|
873
|
-
<dd>
|
|
874
|
-
|
|
875
|
-
**connectionId:** `string`
|
|
876
|
-
|
|
877
|
-
</dd>
|
|
878
|
-
</dl>
|
|
879
|
-
|
|
880
|
-
<dl>
|
|
881
|
-
<dd>
|
|
882
|
-
|
|
883
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
884
|
-
|
|
885
|
-
</dd>
|
|
886
|
-
</dl>
|
|
887
|
-
</dd>
|
|
888
|
-
</dl>
|
|
889
|
-
|
|
890
|
-
</dd>
|
|
891
|
-
</dl>
|
|
892
|
-
</details>
|
|
893
|
-
|
|
894
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listAllConnectedIntegrations</a>() -> AirweaveSDK.Connection[]</code></summary>
|
|
895
|
-
<dl>
|
|
896
|
-
<dd>
|
|
897
|
-
|
|
898
|
-
#### 📝 Description
|
|
899
|
-
|
|
900
|
-
<dl>
|
|
901
|
-
<dd>
|
|
902
|
-
|
|
903
|
-
<dl>
|
|
904
|
-
<dd>
|
|
905
|
-
|
|
906
|
-
Get all active connections for the current user across all integration types.
|
|
907
|
-
|
|
908
|
-
</dd>
|
|
909
|
-
</dl>
|
|
910
|
-
</dd>
|
|
911
|
-
</dl>
|
|
912
|
-
|
|
913
|
-
#### 🔌 Usage
|
|
914
|
-
|
|
915
|
-
<dl>
|
|
916
|
-
<dd>
|
|
917
|
-
|
|
918
|
-
<dl>
|
|
919
|
-
<dd>
|
|
920
|
-
|
|
921
|
-
```typescript
|
|
922
|
-
await client.connections.listAllConnectedIntegrations();
|
|
923
|
-
```
|
|
924
|
-
|
|
925
|
-
</dd>
|
|
926
|
-
</dl>
|
|
927
|
-
</dd>
|
|
928
|
-
</dl>
|
|
929
|
-
|
|
930
|
-
#### ⚙️ Parameters
|
|
931
|
-
|
|
932
|
-
<dl>
|
|
933
|
-
<dd>
|
|
934
|
-
|
|
935
|
-
<dl>
|
|
936
|
-
<dd>
|
|
937
|
-
|
|
938
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
939
|
-
|
|
940
|
-
</dd>
|
|
941
|
-
</dl>
|
|
942
|
-
</dd>
|
|
943
|
-
</dl>
|
|
944
|
-
|
|
945
|
-
</dd>
|
|
946
|
-
</dl>
|
|
947
|
-
</details>
|
|
948
|
-
|
|
949
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">listConnectedIntegrations</a>(integrationType) -> AirweaveSDK.Connection[]</code></summary>
|
|
950
|
-
<dl>
|
|
951
|
-
<dd>
|
|
952
|
-
|
|
953
|
-
#### 📝 Description
|
|
954
|
-
|
|
955
|
-
<dl>
|
|
956
|
-
<dd>
|
|
957
|
-
|
|
958
|
-
<dl>
|
|
959
|
-
<dd>
|
|
960
|
-
|
|
961
|
-
Get all integrations of specified type connected to the current user.
|
|
829
|
+
Deletes the connection and integration credential.
|
|
962
830
|
|
|
963
831
|
Args:
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
832
|
+
db (AsyncSession): The database session
|
|
833
|
+
connection_id (UUID): The ID of the connection to delete
|
|
834
|
+
delete_syncs_and_data (bool): Whether to delete the associated syncs and data
|
|
835
|
+
user (schemas.User): The current user
|
|
967
836
|
|
|
968
837
|
Returns:
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
</dd>
|
|
972
|
-
</dl>
|
|
973
|
-
</dd>
|
|
974
|
-
</dl>
|
|
975
|
-
|
|
976
|
-
#### 🔌 Usage
|
|
977
|
-
|
|
978
|
-
<dl>
|
|
979
|
-
<dd>
|
|
980
|
-
|
|
981
|
-
<dl>
|
|
982
|
-
<dd>
|
|
983
|
-
|
|
984
|
-
```typescript
|
|
985
|
-
await client.connections.listConnectedIntegrations("source");
|
|
986
|
-
```
|
|
987
|
-
|
|
988
|
-
</dd>
|
|
989
|
-
</dl>
|
|
990
|
-
</dd>
|
|
991
|
-
</dl>
|
|
992
|
-
|
|
993
|
-
#### ⚙️ Parameters
|
|
994
|
-
|
|
995
|
-
<dl>
|
|
996
|
-
<dd>
|
|
997
|
-
|
|
998
|
-
<dl>
|
|
999
|
-
<dd>
|
|
1000
|
-
|
|
1001
|
-
**integrationType:** `AirweaveSDK.IntegrationType`
|
|
1002
|
-
|
|
1003
|
-
</dd>
|
|
1004
|
-
</dl>
|
|
1005
|
-
|
|
1006
|
-
<dl>
|
|
1007
|
-
<dd>
|
|
1008
|
-
|
|
1009
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1010
|
-
|
|
1011
|
-
</dd>
|
|
1012
|
-
</dl>
|
|
1013
|
-
</dd>
|
|
1014
|
-
</dl>
|
|
1015
|
-
|
|
1016
|
-
</dd>
|
|
1017
|
-
</dl>
|
|
1018
|
-
</details>
|
|
1019
|
-
|
|
1020
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">connectIntegration</a>(integrationType, shortName, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1021
|
-
<dl>
|
|
1022
|
-
<dd>
|
|
1023
|
-
|
|
1024
|
-
#### 📝 Description
|
|
1025
|
-
|
|
1026
|
-
<dl>
|
|
1027
|
-
<dd>
|
|
1028
|
-
|
|
1029
|
-
<dl>
|
|
1030
|
-
<dd>
|
|
1031
|
-
|
|
1032
|
-
Connect to a source, destination, or embedding model.
|
|
1033
|
-
|
|
1034
|
-
Expects a POST body with:
|
|
1035
|
-
|
|
1036
|
-
```json
|
|
1037
|
-
{
|
|
1038
|
-
"name": "required connection name",
|
|
1039
|
-
... other config fields specific to the integration type ...
|
|
1040
|
-
}
|
|
1041
|
-
```
|
|
838
|
+
schemas.Connection: The deleted connection
|
|
1042
839
|
|
|
1043
840
|
</dd>
|
|
1044
841
|
</dl>
|
|
@@ -1054,11 +851,7 @@ Expects a POST body with:
|
|
|
1054
851
|
<dd>
|
|
1055
852
|
|
|
1056
853
|
```typescript
|
|
1057
|
-
await client.connections.
|
|
1058
|
-
configFields: {
|
|
1059
|
-
key: "value",
|
|
1060
|
-
},
|
|
1061
|
-
});
|
|
854
|
+
await client.connections.deleteConnection("connection_id");
|
|
1062
855
|
```
|
|
1063
856
|
|
|
1064
857
|
</dd>
|
|
@@ -1074,23 +867,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
1074
867
|
<dl>
|
|
1075
868
|
<dd>
|
|
1076
869
|
|
|
1077
|
-
**
|
|
1078
|
-
|
|
1079
|
-
</dd>
|
|
1080
|
-
</dl>
|
|
1081
|
-
|
|
1082
|
-
<dl>
|
|
1083
|
-
<dd>
|
|
1084
|
-
|
|
1085
|
-
**shortName:** `string`
|
|
1086
|
-
|
|
1087
|
-
</dd>
|
|
1088
|
-
</dl>
|
|
1089
|
-
|
|
1090
|
-
<dl>
|
|
1091
|
-
<dd>
|
|
1092
|
-
|
|
1093
|
-
**request:** `AirweaveSDK.BodyConnectIntegrationConnectionsConnectIntegrationTypeShortNamePost`
|
|
870
|
+
**connectionId:** `string`
|
|
1094
871
|
|
|
1095
872
|
</dd>
|
|
1096
873
|
</dl>
|
|
@@ -1109,7 +886,7 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
1109
886
|
</dl>
|
|
1110
887
|
</details>
|
|
1111
888
|
|
|
1112
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">
|
|
889
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectSourceConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1113
890
|
<dl>
|
|
1114
891
|
<dd>
|
|
1115
892
|
|
|
@@ -1121,15 +898,14 @@ await client.connections.connectIntegration("source", "short_name", {
|
|
|
1121
898
|
<dl>
|
|
1122
899
|
<dd>
|
|
1123
900
|
|
|
1124
|
-
|
|
901
|
+
Disconnect from a source connection.
|
|
1125
902
|
|
|
1126
903
|
Args:
|
|
1127
|
-
connection_id (UUID): The ID of the connection to get credentials for
|
|
1128
904
|
db (AsyncSession): The database session
|
|
905
|
+
connection_id (UUID): The ID of the connection to disconnect
|
|
1129
906
|
user (schemas.User): The current user
|
|
1130
|
-
|
|
1131
907
|
Returns:
|
|
1132
|
-
|
|
908
|
+
schemas.Connection: The disconnected connection
|
|
1133
909
|
|
|
1134
910
|
</dd>
|
|
1135
911
|
</dl>
|
|
@@ -1145,7 +921,7 @@ dict: The credentials for the connection
|
|
|
1145
921
|
<dd>
|
|
1146
922
|
|
|
1147
923
|
```typescript
|
|
1148
|
-
await client.connections.
|
|
924
|
+
await client.connections.disconnectSourceConnection("connection_id");
|
|
1149
925
|
```
|
|
1150
926
|
|
|
1151
927
|
</dd>
|
|
@@ -1169,686 +945,7 @@ await client.connections.getConnectionCredentials("connection_id");
|
|
|
1169
945
|
<dl>
|
|
1170
946
|
<dd>
|
|
1171
947
|
|
|
1172
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1173
|
-
|
|
1174
|
-
</dd>
|
|
1175
|
-
</dl>
|
|
1176
|
-
</dd>
|
|
1177
|
-
</dl>
|
|
1178
|
-
|
|
1179
|
-
</dd>
|
|
1180
|
-
</dl>
|
|
1181
|
-
</details>
|
|
1182
|
-
|
|
1183
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">deleteConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1184
|
-
<dl>
|
|
1185
|
-
<dd>
|
|
1186
|
-
|
|
1187
|
-
#### 📝 Description
|
|
1188
|
-
|
|
1189
|
-
<dl>
|
|
1190
|
-
<dd>
|
|
1191
|
-
|
|
1192
|
-
<dl>
|
|
1193
|
-
<dd>
|
|
1194
|
-
|
|
1195
|
-
Delete a connection.
|
|
1196
|
-
|
|
1197
|
-
Deletes the connection and integration credential.
|
|
1198
|
-
|
|
1199
|
-
Args:
|
|
1200
|
-
db (AsyncSession): The database session
|
|
1201
|
-
connection_id (UUID): The ID of the connection to delete
|
|
1202
|
-
delete_syncs_and_data (bool): Whether to delete the associated syncs and data
|
|
1203
|
-
user (schemas.User): The current user
|
|
1204
|
-
|
|
1205
|
-
Returns:
|
|
1206
|
-
schemas.Connection: The deleted connection
|
|
1207
|
-
|
|
1208
|
-
</dd>
|
|
1209
|
-
</dl>
|
|
1210
|
-
</dd>
|
|
1211
|
-
</dl>
|
|
1212
|
-
|
|
1213
|
-
#### 🔌 Usage
|
|
1214
|
-
|
|
1215
|
-
<dl>
|
|
1216
|
-
<dd>
|
|
1217
|
-
|
|
1218
|
-
<dl>
|
|
1219
|
-
<dd>
|
|
1220
|
-
|
|
1221
|
-
```typescript
|
|
1222
|
-
await client.connections.deleteConnection("connection_id");
|
|
1223
|
-
```
|
|
1224
|
-
|
|
1225
|
-
</dd>
|
|
1226
|
-
</dl>
|
|
1227
|
-
</dd>
|
|
1228
|
-
</dl>
|
|
1229
|
-
|
|
1230
|
-
#### ⚙️ Parameters
|
|
1231
|
-
|
|
1232
|
-
<dl>
|
|
1233
|
-
<dd>
|
|
1234
|
-
|
|
1235
|
-
<dl>
|
|
1236
|
-
<dd>
|
|
1237
|
-
|
|
1238
|
-
**connectionId:** `string`
|
|
1239
|
-
|
|
1240
|
-
</dd>
|
|
1241
|
-
</dl>
|
|
1242
|
-
|
|
1243
|
-
<dl>
|
|
1244
|
-
<dd>
|
|
1245
|
-
|
|
1246
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1247
|
-
|
|
1248
|
-
</dd>
|
|
1249
|
-
</dl>
|
|
1250
|
-
</dd>
|
|
1251
|
-
</dl>
|
|
1252
|
-
|
|
1253
|
-
</dd>
|
|
1254
|
-
</dl>
|
|
1255
|
-
</details>
|
|
1256
|
-
|
|
1257
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectSourceConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1258
|
-
<dl>
|
|
1259
|
-
<dd>
|
|
1260
|
-
|
|
1261
|
-
#### 📝 Description
|
|
1262
|
-
|
|
1263
|
-
<dl>
|
|
1264
|
-
<dd>
|
|
1265
|
-
|
|
1266
|
-
<dl>
|
|
1267
|
-
<dd>
|
|
1268
|
-
|
|
1269
|
-
Disconnect from a source connection.
|
|
1270
|
-
|
|
1271
|
-
Args:
|
|
1272
|
-
db (AsyncSession): The database session
|
|
1273
|
-
connection_id (UUID): The ID of the connection to disconnect
|
|
1274
|
-
user (schemas.User): The current user
|
|
1275
|
-
Returns:
|
|
1276
|
-
schemas.Connection: The disconnected connection
|
|
1277
|
-
|
|
1278
|
-
</dd>
|
|
1279
|
-
</dl>
|
|
1280
|
-
</dd>
|
|
1281
|
-
</dl>
|
|
1282
|
-
|
|
1283
|
-
#### 🔌 Usage
|
|
1284
|
-
|
|
1285
|
-
<dl>
|
|
1286
|
-
<dd>
|
|
1287
|
-
|
|
1288
|
-
<dl>
|
|
1289
|
-
<dd>
|
|
1290
|
-
|
|
1291
|
-
```typescript
|
|
1292
|
-
await client.connections.disconnectSourceConnection("connection_id");
|
|
1293
|
-
```
|
|
1294
|
-
|
|
1295
|
-
</dd>
|
|
1296
|
-
</dl>
|
|
1297
|
-
</dd>
|
|
1298
|
-
</dl>
|
|
1299
|
-
|
|
1300
|
-
#### ⚙️ Parameters
|
|
1301
|
-
|
|
1302
|
-
<dl>
|
|
1303
|
-
<dd>
|
|
1304
|
-
|
|
1305
|
-
<dl>
|
|
1306
|
-
<dd>
|
|
1307
|
-
|
|
1308
|
-
**connectionId:** `string`
|
|
1309
|
-
|
|
1310
|
-
</dd>
|
|
1311
|
-
</dl>
|
|
1312
|
-
|
|
1313
|
-
<dl>
|
|
1314
|
-
<dd>
|
|
1315
|
-
|
|
1316
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1317
|
-
|
|
1318
|
-
</dd>
|
|
1319
|
-
</dl>
|
|
1320
|
-
</dd>
|
|
1321
|
-
</dl>
|
|
1322
|
-
|
|
1323
|
-
</dd>
|
|
1324
|
-
</dl>
|
|
1325
|
-
</details>
|
|
1326
|
-
|
|
1327
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectDestinationConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1328
|
-
<dl>
|
|
1329
|
-
<dd>
|
|
1330
|
-
|
|
1331
|
-
#### 📝 Description
|
|
1332
|
-
|
|
1333
|
-
<dl>
|
|
1334
|
-
<dd>
|
|
1335
|
-
|
|
1336
|
-
<dl>
|
|
1337
|
-
<dd>
|
|
1338
|
-
|
|
1339
|
-
Disconnect from a destination connection.
|
|
1340
|
-
|
|
1341
|
-
Args:
|
|
1342
|
-
db (AsyncSession): The database session
|
|
1343
|
-
connection_id (UUID): The ID of the connection to disconnect
|
|
1344
|
-
user (schemas.User): The current user
|
|
1345
|
-
|
|
1346
|
-
Returns:
|
|
1347
|
-
schemas.Connection: The disconnected connection
|
|
1348
|
-
|
|
1349
|
-
</dd>
|
|
1350
|
-
</dl>
|
|
1351
|
-
</dd>
|
|
1352
|
-
</dl>
|
|
1353
|
-
|
|
1354
|
-
#### 🔌 Usage
|
|
1355
|
-
|
|
1356
|
-
<dl>
|
|
1357
|
-
<dd>
|
|
1358
|
-
|
|
1359
|
-
<dl>
|
|
1360
|
-
<dd>
|
|
1361
|
-
|
|
1362
|
-
```typescript
|
|
1363
|
-
await client.connections.disconnectDestinationConnection("connection_id");
|
|
1364
|
-
```
|
|
1365
|
-
|
|
1366
|
-
</dd>
|
|
1367
|
-
</dl>
|
|
1368
|
-
</dd>
|
|
1369
|
-
</dl>
|
|
1370
|
-
|
|
1371
|
-
#### ⚙️ Parameters
|
|
1372
|
-
|
|
1373
|
-
<dl>
|
|
1374
|
-
<dd>
|
|
1375
|
-
|
|
1376
|
-
<dl>
|
|
1377
|
-
<dd>
|
|
1378
|
-
|
|
1379
|
-
**connectionId:** `string`
|
|
1380
|
-
|
|
1381
|
-
</dd>
|
|
1382
|
-
</dl>
|
|
1383
|
-
|
|
1384
|
-
<dl>
|
|
1385
|
-
<dd>
|
|
1386
|
-
|
|
1387
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1388
|
-
|
|
1389
|
-
</dd>
|
|
1390
|
-
</dl>
|
|
1391
|
-
</dd>
|
|
1392
|
-
</dl>
|
|
1393
|
-
|
|
1394
|
-
</dd>
|
|
1395
|
-
</dl>
|
|
1396
|
-
</details>
|
|
1397
|
-
|
|
1398
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2AuthUrl</a>({ ...params }) -> string</code></summary>
|
|
1399
|
-
<dl>
|
|
1400
|
-
<dd>
|
|
1401
|
-
|
|
1402
|
-
#### 📝 Description
|
|
1403
|
-
|
|
1404
|
-
<dl>
|
|
1405
|
-
<dd>
|
|
1406
|
-
|
|
1407
|
-
<dl>
|
|
1408
|
-
<dd>
|
|
1409
|
-
|
|
1410
|
-
Get the OAuth2 authorization URL for a source.
|
|
1411
|
-
|
|
1412
|
-
</dd>
|
|
1413
|
-
</dl>
|
|
1414
|
-
</dd>
|
|
1415
|
-
</dl>
|
|
1416
|
-
|
|
1417
|
-
#### 🔌 Usage
|
|
1418
|
-
|
|
1419
|
-
<dl>
|
|
1420
|
-
<dd>
|
|
1421
|
-
|
|
1422
|
-
<dl>
|
|
1423
|
-
<dd>
|
|
1424
|
-
|
|
1425
|
-
```typescript
|
|
1426
|
-
await client.connections.getOauth2AuthUrl({
|
|
1427
|
-
shortName: "short_name",
|
|
1428
|
-
});
|
|
1429
|
-
```
|
|
1430
|
-
|
|
1431
|
-
</dd>
|
|
1432
|
-
</dl>
|
|
1433
|
-
</dd>
|
|
1434
|
-
</dl>
|
|
1435
|
-
|
|
1436
|
-
#### ⚙️ Parameters
|
|
1437
|
-
|
|
1438
|
-
<dl>
|
|
1439
|
-
<dd>
|
|
1440
|
-
|
|
1441
|
-
<dl>
|
|
1442
|
-
<dd>
|
|
1443
|
-
|
|
1444
|
-
**request:** `AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest`
|
|
1445
|
-
|
|
1446
|
-
</dd>
|
|
1447
|
-
</dl>
|
|
1448
|
-
|
|
1449
|
-
<dl>
|
|
1450
|
-
<dd>
|
|
1451
|
-
|
|
1452
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1453
|
-
|
|
1454
|
-
</dd>
|
|
1455
|
-
</dl>
|
|
1456
|
-
</dd>
|
|
1457
|
-
</dl>
|
|
1458
|
-
|
|
1459
|
-
</dd>
|
|
1460
|
-
</dl>
|
|
1461
|
-
</details>
|
|
1462
|
-
|
|
1463
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2Code</a>({ ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1464
|
-
<dl>
|
|
1465
|
-
<dd>
|
|
1466
|
-
|
|
1467
|
-
#### 📝 Description
|
|
1468
|
-
|
|
1469
|
-
<dl>
|
|
1470
|
-
<dd>
|
|
1471
|
-
|
|
1472
|
-
<dl>
|
|
1473
|
-
<dd>
|
|
1474
|
-
|
|
1475
|
-
Send the OAuth2 authorization code for a source.
|
|
1476
|
-
|
|
1477
|
-
This will:
|
|
1478
|
-
|
|
1479
|
-
1. Get the OAuth2 settings for the source
|
|
1480
|
-
2. Exchange the authorization code for a token
|
|
1481
|
-
3. Create an integration credential with the token
|
|
1482
|
-
</dd>
|
|
1483
|
-
</dl>
|
|
1484
|
-
</dd>
|
|
1485
|
-
</dl>
|
|
1486
|
-
|
|
1487
|
-
#### 🔌 Usage
|
|
1488
|
-
|
|
1489
|
-
<dl>
|
|
1490
|
-
<dd>
|
|
1491
|
-
|
|
1492
|
-
<dl>
|
|
1493
|
-
<dd>
|
|
1494
|
-
|
|
1495
|
-
```typescript
|
|
1496
|
-
await client.connections.sendOauth2Code({
|
|
1497
|
-
shortName: "short_name",
|
|
1498
|
-
code: "code",
|
|
1499
|
-
});
|
|
1500
|
-
```
|
|
1501
|
-
|
|
1502
|
-
</dd>
|
|
1503
|
-
</dl>
|
|
1504
|
-
</dd>
|
|
1505
|
-
</dl>
|
|
1506
|
-
|
|
1507
|
-
#### ⚙️ Parameters
|
|
1508
|
-
|
|
1509
|
-
<dl>
|
|
1510
|
-
<dd>
|
|
1511
|
-
|
|
1512
|
-
<dl>
|
|
1513
|
-
<dd>
|
|
1514
|
-
|
|
1515
|
-
**request:** `AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost`
|
|
1516
|
-
|
|
1517
|
-
</dd>
|
|
1518
|
-
</dl>
|
|
1519
|
-
|
|
1520
|
-
<dl>
|
|
1521
|
-
<dd>
|
|
1522
|
-
|
|
1523
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1524
|
-
|
|
1525
|
-
</dd>
|
|
1526
|
-
</dl>
|
|
1527
|
-
</dd>
|
|
1528
|
-
</dl>
|
|
1529
|
-
|
|
1530
|
-
</dd>
|
|
1531
|
-
</dl>
|
|
1532
|
-
</details>
|
|
1533
|
-
|
|
1534
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1535
|
-
<dl>
|
|
1536
|
-
<dd>
|
|
1537
|
-
|
|
1538
|
-
#### 📝 Description
|
|
1539
|
-
|
|
1540
|
-
<dl>
|
|
1541
|
-
<dd>
|
|
1542
|
-
|
|
1543
|
-
<dl>
|
|
1544
|
-
<dd>
|
|
1545
|
-
|
|
1546
|
-
Exchange the OAuth2 authorization code for a white label integration.
|
|
1547
|
-
|
|
1548
|
-
</dd>
|
|
1549
|
-
</dl>
|
|
1550
|
-
</dd>
|
|
1551
|
-
</dl>
|
|
1552
|
-
|
|
1553
|
-
#### 🔌 Usage
|
|
1554
|
-
|
|
1555
|
-
<dl>
|
|
1556
|
-
<dd>
|
|
1557
|
-
|
|
1558
|
-
<dl>
|
|
1559
|
-
<dd>
|
|
1560
|
-
|
|
1561
|
-
```typescript
|
|
1562
|
-
await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
1563
|
-
```
|
|
1564
|
-
|
|
1565
|
-
</dd>
|
|
1566
|
-
</dl>
|
|
1567
|
-
</dd>
|
|
1568
|
-
</dl>
|
|
1569
|
-
|
|
1570
|
-
#### ⚙️ Parameters
|
|
1571
|
-
|
|
1572
|
-
<dl>
|
|
1573
|
-
<dd>
|
|
1574
|
-
|
|
1575
|
-
<dl>
|
|
1576
|
-
<dd>
|
|
1577
|
-
|
|
1578
|
-
**whiteLabelId:** `string`
|
|
1579
|
-
|
|
1580
|
-
</dd>
|
|
1581
|
-
</dl>
|
|
1582
|
-
|
|
1583
|
-
<dl>
|
|
1584
|
-
<dd>
|
|
1585
|
-
|
|
1586
|
-
**request:** `string`
|
|
1587
|
-
|
|
1588
|
-
</dd>
|
|
1589
|
-
</dl>
|
|
1590
|
-
|
|
1591
|
-
<dl>
|
|
1592
|
-
<dd>
|
|
1593
|
-
|
|
1594
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1595
|
-
|
|
1596
|
-
</dd>
|
|
1597
|
-
</dl>
|
|
1598
|
-
</dd>
|
|
1599
|
-
</dl>
|
|
1600
|
-
|
|
1601
|
-
</dd>
|
|
1602
|
-
</dl>
|
|
1603
|
-
</details>
|
|
1604
|
-
|
|
1605
|
-
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
1606
|
-
<dl>
|
|
1607
|
-
<dd>
|
|
1608
|
-
|
|
1609
|
-
#### 📝 Description
|
|
1610
|
-
|
|
1611
|
-
<dl>
|
|
1612
|
-
<dd>
|
|
1613
|
-
|
|
1614
|
-
<dl>
|
|
1615
|
-
<dd>
|
|
1616
|
-
|
|
1617
|
-
Get the OAuth2 authorization URL for a white label integration.
|
|
1618
|
-
|
|
1619
|
-
</dd>
|
|
1620
|
-
</dl>
|
|
1621
|
-
</dd>
|
|
1622
|
-
</dl>
|
|
1623
|
-
|
|
1624
|
-
#### 🔌 Usage
|
|
1625
|
-
|
|
1626
|
-
<dl>
|
|
1627
|
-
<dd>
|
|
1628
|
-
|
|
1629
|
-
<dl>
|
|
1630
|
-
<dd>
|
|
1631
|
-
|
|
1632
|
-
```typescript
|
|
1633
|
-
await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
1634
|
-
```
|
|
1635
|
-
|
|
1636
|
-
</dd>
|
|
1637
|
-
</dl>
|
|
1638
|
-
</dd>
|
|
1639
|
-
</dl>
|
|
1640
|
-
|
|
1641
|
-
#### ⚙️ Parameters
|
|
1642
|
-
|
|
1643
|
-
<dl>
|
|
1644
|
-
<dd>
|
|
1645
|
-
|
|
1646
|
-
<dl>
|
|
1647
|
-
<dd>
|
|
1648
|
-
|
|
1649
|
-
**whiteLabelId:** `string`
|
|
1650
|
-
|
|
1651
|
-
</dd>
|
|
1652
|
-
</dl>
|
|
1653
|
-
|
|
1654
|
-
<dl>
|
|
1655
|
-
<dd>
|
|
1656
|
-
|
|
1657
|
-
**requestOptions:** `Connections.RequestOptions`
|
|
1658
|
-
|
|
1659
|
-
</dd>
|
|
1660
|
-
</dl>
|
|
1661
|
-
</dd>
|
|
1662
|
-
</dl>
|
|
1663
|
-
|
|
1664
|
-
</dd>
|
|
1665
|
-
</dl>
|
|
1666
|
-
</details>
|
|
1667
|
-
|
|
1668
|
-
## Sync
|
|
1669
|
-
|
|
1670
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
1671
|
-
<dl>
|
|
1672
|
-
<dd>
|
|
1673
|
-
|
|
1674
|
-
#### 📝 Description
|
|
1675
|
-
|
|
1676
|
-
<dl>
|
|
1677
|
-
<dd>
|
|
1678
|
-
|
|
1679
|
-
<dl>
|
|
1680
|
-
<dd>
|
|
1681
|
-
|
|
1682
|
-
List all syncs for the current user.
|
|
1683
|
-
|
|
1684
|
-
</dd>
|
|
1685
|
-
</dl>
|
|
1686
|
-
</dd>
|
|
1687
|
-
</dl>
|
|
1688
|
-
|
|
1689
|
-
#### 🔌 Usage
|
|
1690
|
-
|
|
1691
|
-
<dl>
|
|
1692
|
-
<dd>
|
|
1693
|
-
|
|
1694
|
-
<dl>
|
|
1695
|
-
<dd>
|
|
1696
|
-
|
|
1697
|
-
```typescript
|
|
1698
|
-
await client.sync.listSyncs();
|
|
1699
|
-
```
|
|
1700
|
-
|
|
1701
|
-
</dd>
|
|
1702
|
-
</dl>
|
|
1703
|
-
</dd>
|
|
1704
|
-
</dl>
|
|
1705
|
-
|
|
1706
|
-
#### ⚙️ Parameters
|
|
1707
|
-
|
|
1708
|
-
<dl>
|
|
1709
|
-
<dd>
|
|
1710
|
-
|
|
1711
|
-
<dl>
|
|
1712
|
-
<dd>
|
|
1713
|
-
|
|
1714
|
-
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1715
|
-
|
|
1716
|
-
</dd>
|
|
1717
|
-
</dl>
|
|
1718
|
-
|
|
1719
|
-
<dl>
|
|
1720
|
-
<dd>
|
|
1721
|
-
|
|
1722
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1723
|
-
|
|
1724
|
-
</dd>
|
|
1725
|
-
</dl>
|
|
1726
|
-
</dd>
|
|
1727
|
-
</dl>
|
|
1728
|
-
|
|
1729
|
-
</dd>
|
|
1730
|
-
</dl>
|
|
1731
|
-
</details>
|
|
1732
|
-
|
|
1733
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
1734
|
-
<dl>
|
|
1735
|
-
<dd>
|
|
1736
|
-
|
|
1737
|
-
#### 📝 Description
|
|
1738
|
-
|
|
1739
|
-
<dl>
|
|
1740
|
-
<dd>
|
|
1741
|
-
|
|
1742
|
-
<dl>
|
|
1743
|
-
<dd>
|
|
1744
|
-
|
|
1745
|
-
Create a new sync configuration.
|
|
1746
|
-
|
|
1747
|
-
</dd>
|
|
1748
|
-
</dl>
|
|
1749
|
-
</dd>
|
|
1750
|
-
</dl>
|
|
1751
|
-
|
|
1752
|
-
#### 🔌 Usage
|
|
1753
|
-
|
|
1754
|
-
<dl>
|
|
1755
|
-
<dd>
|
|
1756
|
-
|
|
1757
|
-
<dl>
|
|
1758
|
-
<dd>
|
|
1759
|
-
|
|
1760
|
-
```typescript
|
|
1761
|
-
await client.sync.createSync({
|
|
1762
|
-
name: "name",
|
|
1763
|
-
sourceConnectionId: "source_connection_id",
|
|
1764
|
-
});
|
|
1765
|
-
```
|
|
1766
|
-
|
|
1767
|
-
</dd>
|
|
1768
|
-
</dl>
|
|
1769
|
-
</dd>
|
|
1770
|
-
</dl>
|
|
1771
|
-
|
|
1772
|
-
#### ⚙️ Parameters
|
|
1773
|
-
|
|
1774
|
-
<dl>
|
|
1775
|
-
<dd>
|
|
1776
|
-
|
|
1777
|
-
<dl>
|
|
1778
|
-
<dd>
|
|
1779
|
-
|
|
1780
|
-
**request:** `AirweaveSDK.SyncCreate`
|
|
1781
|
-
|
|
1782
|
-
</dd>
|
|
1783
|
-
</dl>
|
|
1784
|
-
|
|
1785
|
-
<dl>
|
|
1786
|
-
<dd>
|
|
1787
|
-
|
|
1788
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
1789
|
-
|
|
1790
|
-
</dd>
|
|
1791
|
-
</dl>
|
|
1792
|
-
</dd>
|
|
1793
|
-
</dl>
|
|
1794
|
-
|
|
1795
|
-
</dd>
|
|
1796
|
-
</dl>
|
|
1797
|
-
</details>
|
|
1798
|
-
|
|
1799
|
-
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
1800
|
-
<dl>
|
|
1801
|
-
<dd>
|
|
1802
|
-
|
|
1803
|
-
#### 📝 Description
|
|
1804
|
-
|
|
1805
|
-
<dl>
|
|
1806
|
-
<dd>
|
|
1807
|
-
|
|
1808
|
-
<dl>
|
|
1809
|
-
<dd>
|
|
1810
|
-
|
|
1811
|
-
Get a specific sync by ID.
|
|
1812
|
-
|
|
1813
|
-
</dd>
|
|
1814
|
-
</dl>
|
|
1815
|
-
</dd>
|
|
1816
|
-
</dl>
|
|
1817
|
-
|
|
1818
|
-
#### 🔌 Usage
|
|
1819
|
-
|
|
1820
|
-
<dl>
|
|
1821
|
-
<dd>
|
|
1822
|
-
|
|
1823
|
-
<dl>
|
|
1824
|
-
<dd>
|
|
1825
|
-
|
|
1826
|
-
```typescript
|
|
1827
|
-
await client.sync.getSync("sync_id");
|
|
1828
|
-
```
|
|
1829
|
-
|
|
1830
|
-
</dd>
|
|
1831
|
-
</dl>
|
|
1832
|
-
</dd>
|
|
1833
|
-
</dl>
|
|
1834
|
-
|
|
1835
|
-
#### ⚙️ Parameters
|
|
1836
|
-
|
|
1837
|
-
<dl>
|
|
1838
|
-
<dd>
|
|
1839
|
-
|
|
1840
|
-
<dl>
|
|
1841
|
-
<dd>
|
|
1842
|
-
|
|
1843
|
-
**syncId:** `string`
|
|
1844
|
-
|
|
1845
|
-
</dd>
|
|
1846
|
-
</dl>
|
|
1847
|
-
|
|
1848
|
-
<dl>
|
|
1849
|
-
<dd>
|
|
1850
|
-
|
|
1851
|
-
**requestOptions:** `Sync.RequestOptions`
|
|
948
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1852
949
|
|
|
1853
950
|
</dd>
|
|
1854
951
|
</dl>
|
|
@@ -1859,7 +956,7 @@ await client.sync.getSync("sync_id");
|
|
|
1859
956
|
</dl>
|
|
1860
957
|
</details>
|
|
1861
958
|
|
|
1862
|
-
<details><summary><code>client.
|
|
959
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">disconnectDestinationConnection</a>(connectionId) -> AirweaveSDK.Connection</code></summary>
|
|
1863
960
|
<dl>
|
|
1864
961
|
<dd>
|
|
1865
962
|
|
|
@@ -1871,7 +968,15 @@ await client.sync.getSync("sync_id");
|
|
|
1871
968
|
<dl>
|
|
1872
969
|
<dd>
|
|
1873
970
|
|
|
1874
|
-
|
|
971
|
+
Disconnect from a destination connection.
|
|
972
|
+
|
|
973
|
+
Args:
|
|
974
|
+
db (AsyncSession): The database session
|
|
975
|
+
connection_id (UUID): The ID of the connection to disconnect
|
|
976
|
+
user (schemas.User): The current user
|
|
977
|
+
|
|
978
|
+
Returns:
|
|
979
|
+
schemas.Connection: The disconnected connection
|
|
1875
980
|
|
|
1876
981
|
</dd>
|
|
1877
982
|
</dl>
|
|
@@ -1887,7 +992,7 @@ Delete a sync configuration and optionally its associated data.
|
|
|
1887
992
|
<dd>
|
|
1888
993
|
|
|
1889
994
|
```typescript
|
|
1890
|
-
await client.
|
|
995
|
+
await client.connections.disconnectDestinationConnection("connection_id");
|
|
1891
996
|
```
|
|
1892
997
|
|
|
1893
998
|
</dd>
|
|
@@ -1903,15 +1008,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1903
1008
|
<dl>
|
|
1904
1009
|
<dd>
|
|
1905
1010
|
|
|
1906
|
-
**
|
|
1907
|
-
|
|
1908
|
-
</dd>
|
|
1909
|
-
</dl>
|
|
1910
|
-
|
|
1911
|
-
<dl>
|
|
1912
|
-
<dd>
|
|
1913
|
-
|
|
1914
|
-
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
1011
|
+
**connectionId:** `string`
|
|
1915
1012
|
|
|
1916
1013
|
</dd>
|
|
1917
1014
|
</dl>
|
|
@@ -1919,7 +1016,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1919
1016
|
<dl>
|
|
1920
1017
|
<dd>
|
|
1921
1018
|
|
|
1922
|
-
**requestOptions:** `
|
|
1019
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1923
1020
|
|
|
1924
1021
|
</dd>
|
|
1925
1022
|
</dl>
|
|
@@ -1930,7 +1027,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1930
1027
|
</dl>
|
|
1931
1028
|
</details>
|
|
1932
1029
|
|
|
1933
|
-
<details><summary><code>client.
|
|
1030
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2AuthUrl</a>({ ...params }) -> string</code></summary>
|
|
1934
1031
|
<dl>
|
|
1935
1032
|
<dd>
|
|
1936
1033
|
|
|
@@ -1942,7 +1039,7 @@ await client.sync.deleteSync("sync_id");
|
|
|
1942
1039
|
<dl>
|
|
1943
1040
|
<dd>
|
|
1944
1041
|
|
|
1945
|
-
|
|
1042
|
+
Get the OAuth2 authorization URL for a source.
|
|
1946
1043
|
|
|
1947
1044
|
</dd>
|
|
1948
1045
|
</dl>
|
|
@@ -1958,7 +1055,9 @@ Trigger a sync run.
|
|
|
1958
1055
|
<dd>
|
|
1959
1056
|
|
|
1960
1057
|
```typescript
|
|
1961
|
-
await client.
|
|
1058
|
+
await client.connections.getOauth2AuthUrl({
|
|
1059
|
+
shortName: "short_name",
|
|
1060
|
+
});
|
|
1962
1061
|
```
|
|
1963
1062
|
|
|
1964
1063
|
</dd>
|
|
@@ -1974,7 +1073,7 @@ await client.sync.runSync("sync_id");
|
|
|
1974
1073
|
<dl>
|
|
1975
1074
|
<dd>
|
|
1976
1075
|
|
|
1977
|
-
**
|
|
1076
|
+
**request:** `AirweaveSDK.GetOauth2AuthUrlConnectionsOauth2SourceAuthUrlGetRequest`
|
|
1978
1077
|
|
|
1979
1078
|
</dd>
|
|
1980
1079
|
</dl>
|
|
@@ -1982,7 +1081,7 @@ await client.sync.runSync("sync_id");
|
|
|
1982
1081
|
<dl>
|
|
1983
1082
|
<dd>
|
|
1984
1083
|
|
|
1985
|
-
**requestOptions:** `
|
|
1084
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
1986
1085
|
|
|
1987
1086
|
</dd>
|
|
1988
1087
|
</dl>
|
|
@@ -1993,7 +1092,7 @@ await client.sync.runSync("sync_id");
|
|
|
1993
1092
|
</dl>
|
|
1994
1093
|
</details>
|
|
1995
1094
|
|
|
1996
|
-
<details><summary><code>client.
|
|
1095
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2Code</a>({ ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
1997
1096
|
<dl>
|
|
1998
1097
|
<dd>
|
|
1999
1098
|
|
|
@@ -2005,12 +1104,17 @@ await client.sync.runSync("sync_id");
|
|
|
2005
1104
|
<dl>
|
|
2006
1105
|
<dd>
|
|
2007
1106
|
|
|
2008
|
-
|
|
1107
|
+
Send the OAuth2 authorization code for a source.
|
|
2009
1108
|
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
1109
|
+
This will:
|
|
1110
|
+
|
|
1111
|
+
1. Get the OAuth2 settings for the source
|
|
1112
|
+
2. Exchange the authorization code for a token
|
|
1113
|
+
3. Create an integration credential with the token
|
|
1114
|
+
</dd>
|
|
1115
|
+
</dl>
|
|
1116
|
+
</dd>
|
|
1117
|
+
</dl>
|
|
2014
1118
|
|
|
2015
1119
|
#### 🔌 Usage
|
|
2016
1120
|
|
|
@@ -2021,7 +1125,10 @@ List all jobs for a specific sync.
|
|
|
2021
1125
|
<dd>
|
|
2022
1126
|
|
|
2023
1127
|
```typescript
|
|
2024
|
-
await client.
|
|
1128
|
+
await client.connections.sendOauth2Code({
|
|
1129
|
+
shortName: "short_name",
|
|
1130
|
+
code: "code",
|
|
1131
|
+
});
|
|
2025
1132
|
```
|
|
2026
1133
|
|
|
2027
1134
|
</dd>
|
|
@@ -2037,7 +1144,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
2037
1144
|
<dl>
|
|
2038
1145
|
<dd>
|
|
2039
1146
|
|
|
2040
|
-
**
|
|
1147
|
+
**request:** `AirweaveSDK.BodySendOauth2CodeConnectionsOauth2SourceCodePost`
|
|
2041
1148
|
|
|
2042
1149
|
</dd>
|
|
2043
1150
|
</dl>
|
|
@@ -2045,7 +1152,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
2045
1152
|
<dl>
|
|
2046
1153
|
<dd>
|
|
2047
1154
|
|
|
2048
|
-
**requestOptions:** `
|
|
1155
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
2049
1156
|
|
|
2050
1157
|
</dd>
|
|
2051
1158
|
</dl>
|
|
@@ -2056,7 +1163,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
2056
1163
|
</dl>
|
|
2057
1164
|
</details>
|
|
2058
1165
|
|
|
2059
|
-
<details><summary><code>client.
|
|
1166
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">sendOauth2WhiteLabelCode</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
2060
1167
|
<dl>
|
|
2061
1168
|
<dd>
|
|
2062
1169
|
|
|
@@ -2068,7 +1175,7 @@ await client.sync.listSyncJobs("sync_id");
|
|
|
2068
1175
|
<dl>
|
|
2069
1176
|
<dd>
|
|
2070
1177
|
|
|
2071
|
-
|
|
1178
|
+
Exchange the OAuth2 authorization code for a white label integration.
|
|
2072
1179
|
|
|
2073
1180
|
</dd>
|
|
2074
1181
|
</dl>
|
|
@@ -2084,9 +1191,7 @@ Get details of a specific sync job.
|
|
|
2084
1191
|
<dd>
|
|
2085
1192
|
|
|
2086
1193
|
```typescript
|
|
2087
|
-
await client.
|
|
2088
|
-
syncId: "sync_id",
|
|
2089
|
-
});
|
|
1194
|
+
await client.connections.sendOauth2WhiteLabelCode("white_label_id", "string");
|
|
2090
1195
|
```
|
|
2091
1196
|
|
|
2092
1197
|
</dd>
|
|
@@ -2102,7 +1207,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2102
1207
|
<dl>
|
|
2103
1208
|
<dd>
|
|
2104
1209
|
|
|
2105
|
-
**
|
|
1210
|
+
**whiteLabelId:** `string`
|
|
2106
1211
|
|
|
2107
1212
|
</dd>
|
|
2108
1213
|
</dl>
|
|
@@ -2110,7 +1215,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2110
1215
|
<dl>
|
|
2111
1216
|
<dd>
|
|
2112
1217
|
|
|
2113
|
-
**request:** `
|
|
1218
|
+
**request:** `string`
|
|
2114
1219
|
|
|
2115
1220
|
</dd>
|
|
2116
1221
|
</dl>
|
|
@@ -2118,7 +1223,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2118
1223
|
<dl>
|
|
2119
1224
|
<dd>
|
|
2120
1225
|
|
|
2121
|
-
**requestOptions:** `
|
|
1226
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
2122
1227
|
|
|
2123
1228
|
</dd>
|
|
2124
1229
|
</dl>
|
|
@@ -2129,7 +1234,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2129
1234
|
</dl>
|
|
2130
1235
|
</details>
|
|
2131
1236
|
|
|
2132
|
-
<details><summary><code>client.
|
|
1237
|
+
<details><summary><code>client.connections.<a href="/src/api/resources/connections/client/Client.ts">getOauth2WhiteLabelAuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
2133
1238
|
<dl>
|
|
2134
1239
|
<dd>
|
|
2135
1240
|
|
|
@@ -2141,7 +1246,7 @@ await client.sync.getSyncJob("job_id", {
|
|
|
2141
1246
|
<dl>
|
|
2142
1247
|
<dd>
|
|
2143
1248
|
|
|
2144
|
-
|
|
1249
|
+
Get the OAuth2 authorization URL for a white label integration.
|
|
2145
1250
|
|
|
2146
1251
|
</dd>
|
|
2147
1252
|
</dl>
|
|
@@ -2157,7 +1262,7 @@ Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
|
2157
1262
|
<dd>
|
|
2158
1263
|
|
|
2159
1264
|
```typescript
|
|
2160
|
-
await client.
|
|
1265
|
+
await client.connections.getOauth2WhiteLabelAuthUrl("white_label_id");
|
|
2161
1266
|
```
|
|
2162
1267
|
|
|
2163
1268
|
</dd>
|
|
@@ -2173,7 +1278,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2173
1278
|
<dl>
|
|
2174
1279
|
<dd>
|
|
2175
1280
|
|
|
2176
|
-
**
|
|
1281
|
+
**whiteLabelId:** `string`
|
|
2177
1282
|
|
|
2178
1283
|
</dd>
|
|
2179
1284
|
</dl>
|
|
@@ -2181,7 +1286,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2181
1286
|
<dl>
|
|
2182
1287
|
<dd>
|
|
2183
1288
|
|
|
2184
|
-
**requestOptions:** `
|
|
1289
|
+
**requestOptions:** `Connections.RequestOptions`
|
|
2185
1290
|
|
|
2186
1291
|
</dd>
|
|
2187
1292
|
</dl>
|
|
@@ -2192,9 +1297,9 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2192
1297
|
</dl>
|
|
2193
1298
|
</details>
|
|
2194
1299
|
|
|
2195
|
-
##
|
|
1300
|
+
## Sync
|
|
2196
1301
|
|
|
2197
|
-
<details><summary><code>client.
|
|
1302
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncs</a>({ ...params }) -> AirweaveSDK.ListSyncsSyncGetResponse</code></summary>
|
|
2198
1303
|
<dl>
|
|
2199
1304
|
<dd>
|
|
2200
1305
|
|
|
@@ -2206,7 +1311,7 @@ await client.sync.subscribeSyncJob("job_id");
|
|
|
2206
1311
|
<dl>
|
|
2207
1312
|
<dd>
|
|
2208
1313
|
|
|
2209
|
-
List all
|
|
1314
|
+
List all syncs for the current user.
|
|
2210
1315
|
|
|
2211
1316
|
</dd>
|
|
2212
1317
|
</dl>
|
|
@@ -2222,7 +1327,7 @@ List all white labels for the current user's organization.
|
|
|
2222
1327
|
<dd>
|
|
2223
1328
|
|
|
2224
1329
|
```typescript
|
|
2225
|
-
await client.
|
|
1330
|
+
await client.sync.listSyncs();
|
|
2226
1331
|
```
|
|
2227
1332
|
|
|
2228
1333
|
</dd>
|
|
@@ -2238,7 +1343,15 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2238
1343
|
<dl>
|
|
2239
1344
|
<dd>
|
|
2240
1345
|
|
|
2241
|
-
**
|
|
1346
|
+
**request:** `AirweaveSDK.ListSyncsSyncGetRequest`
|
|
1347
|
+
|
|
1348
|
+
</dd>
|
|
1349
|
+
</dl>
|
|
1350
|
+
|
|
1351
|
+
<dl>
|
|
1352
|
+
<dd>
|
|
1353
|
+
|
|
1354
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2242
1355
|
|
|
2243
1356
|
</dd>
|
|
2244
1357
|
</dl>
|
|
@@ -2249,7 +1362,7 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2249
1362
|
</dl>
|
|
2250
1363
|
</details>
|
|
2251
1364
|
|
|
2252
|
-
<details><summary><code>client.
|
|
1365
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">createSync</a>({ ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
2253
1366
|
<dl>
|
|
2254
1367
|
<dd>
|
|
2255
1368
|
|
|
@@ -2261,7 +1374,7 @@ await client.whiteLabels.listWhiteLabels();
|
|
|
2261
1374
|
<dl>
|
|
2262
1375
|
<dd>
|
|
2263
1376
|
|
|
2264
|
-
Create new
|
|
1377
|
+
Create a new sync configuration.
|
|
2265
1378
|
|
|
2266
1379
|
</dd>
|
|
2267
1380
|
</dl>
|
|
@@ -2277,12 +1390,9 @@ Create new white label integration.
|
|
|
2277
1390
|
<dd>
|
|
2278
1391
|
|
|
2279
1392
|
```typescript
|
|
2280
|
-
await client.
|
|
1393
|
+
await client.sync.createSync({
|
|
2281
1394
|
name: "name",
|
|
2282
|
-
|
|
2283
|
-
redirectUrl: "redirect_url",
|
|
2284
|
-
clientId: "client_id",
|
|
2285
|
-
clientSecret: "client_secret",
|
|
1395
|
+
sourceConnectionId: "source_connection_id",
|
|
2286
1396
|
});
|
|
2287
1397
|
```
|
|
2288
1398
|
|
|
@@ -2299,7 +1409,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2299
1409
|
<dl>
|
|
2300
1410
|
<dd>
|
|
2301
1411
|
|
|
2302
|
-
**request:** `AirweaveSDK.
|
|
1412
|
+
**request:** `AirweaveSDK.SyncCreate`
|
|
2303
1413
|
|
|
2304
1414
|
</dd>
|
|
2305
1415
|
</dl>
|
|
@@ -2307,7 +1417,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2307
1417
|
<dl>
|
|
2308
1418
|
<dd>
|
|
2309
1419
|
|
|
2310
|
-
**requestOptions:** `
|
|
1420
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2311
1421
|
|
|
2312
1422
|
</dd>
|
|
2313
1423
|
</dl>
|
|
@@ -2318,7 +1428,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2318
1428
|
</dl>
|
|
2319
1429
|
</details>
|
|
2320
1430
|
|
|
2321
|
-
<details><summary><code>client.
|
|
1431
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSync</a>(syncId) -> AirweaveSDK.Sync</code></summary>
|
|
2322
1432
|
<dl>
|
|
2323
1433
|
<dd>
|
|
2324
1434
|
|
|
@@ -2330,7 +1440,7 @@ await client.whiteLabels.createWhiteLabel({
|
|
|
2330
1440
|
<dl>
|
|
2331
1441
|
<dd>
|
|
2332
1442
|
|
|
2333
|
-
Get a specific
|
|
1443
|
+
Get a specific sync by ID.
|
|
2334
1444
|
|
|
2335
1445
|
</dd>
|
|
2336
1446
|
</dl>
|
|
@@ -2346,7 +1456,7 @@ Get a specific white label integration.
|
|
|
2346
1456
|
<dd>
|
|
2347
1457
|
|
|
2348
1458
|
```typescript
|
|
2349
|
-
await client.
|
|
1459
|
+
await client.sync.getSync("sync_id");
|
|
2350
1460
|
```
|
|
2351
1461
|
|
|
2352
1462
|
</dd>
|
|
@@ -2362,7 +1472,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2362
1472
|
<dl>
|
|
2363
1473
|
<dd>
|
|
2364
1474
|
|
|
2365
|
-
**
|
|
1475
|
+
**syncId:** `string`
|
|
2366
1476
|
|
|
2367
1477
|
</dd>
|
|
2368
1478
|
</dl>
|
|
@@ -2370,7 +1480,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2370
1480
|
<dl>
|
|
2371
1481
|
<dd>
|
|
2372
1482
|
|
|
2373
|
-
**requestOptions:** `
|
|
1483
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2374
1484
|
|
|
2375
1485
|
</dd>
|
|
2376
1486
|
</dl>
|
|
@@ -2381,7 +1491,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2381
1491
|
</dl>
|
|
2382
1492
|
</details>
|
|
2383
1493
|
|
|
2384
|
-
<details><summary><code>client.
|
|
1494
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">deleteSync</a>(syncId, { ...params }) -> AirweaveSDK.Sync</code></summary>
|
|
2385
1495
|
<dl>
|
|
2386
1496
|
<dd>
|
|
2387
1497
|
|
|
@@ -2393,7 +1503,7 @@ await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
|
2393
1503
|
<dl>
|
|
2394
1504
|
<dd>
|
|
2395
1505
|
|
|
2396
|
-
|
|
1506
|
+
Delete a sync configuration and optionally its associated data.
|
|
2397
1507
|
|
|
2398
1508
|
</dd>
|
|
2399
1509
|
</dl>
|
|
@@ -2409,7 +1519,7 @@ Update a white label integration.
|
|
|
2409
1519
|
<dd>
|
|
2410
1520
|
|
|
2411
1521
|
```typescript
|
|
2412
|
-
await client.
|
|
1522
|
+
await client.sync.deleteSync("sync_id");
|
|
2413
1523
|
```
|
|
2414
1524
|
|
|
2415
1525
|
</dd>
|
|
@@ -2425,7 +1535,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2425
1535
|
<dl>
|
|
2426
1536
|
<dd>
|
|
2427
1537
|
|
|
2428
|
-
**
|
|
1538
|
+
**syncId:** `string`
|
|
2429
1539
|
|
|
2430
1540
|
</dd>
|
|
2431
1541
|
</dl>
|
|
@@ -2433,7 +1543,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2433
1543
|
<dl>
|
|
2434
1544
|
<dd>
|
|
2435
1545
|
|
|
2436
|
-
**request:** `AirweaveSDK.
|
|
1546
|
+
**request:** `AirweaveSDK.DeleteSyncSyncSyncIdDeleteRequest`
|
|
2437
1547
|
|
|
2438
1548
|
</dd>
|
|
2439
1549
|
</dl>
|
|
@@ -2441,7 +1551,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2441
1551
|
<dl>
|
|
2442
1552
|
<dd>
|
|
2443
1553
|
|
|
2444
|
-
**requestOptions:** `
|
|
1554
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2445
1555
|
|
|
2446
1556
|
</dd>
|
|
2447
1557
|
</dl>
|
|
@@ -2452,7 +1562,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2452
1562
|
</dl>
|
|
2453
1563
|
</details>
|
|
2454
1564
|
|
|
2455
|
-
<details><summary><code>client.
|
|
1565
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">runSync</a>(syncId) -> AirweaveSDK.SyncJob</code></summary>
|
|
2456
1566
|
<dl>
|
|
2457
1567
|
<dd>
|
|
2458
1568
|
|
|
@@ -2464,7 +1574,7 @@ await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
|
2464
1574
|
<dl>
|
|
2465
1575
|
<dd>
|
|
2466
1576
|
|
|
2467
|
-
|
|
1577
|
+
Trigger a sync run.
|
|
2468
1578
|
|
|
2469
1579
|
</dd>
|
|
2470
1580
|
</dl>
|
|
@@ -2480,7 +1590,7 @@ Delete a white label integration.
|
|
|
2480
1590
|
<dd>
|
|
2481
1591
|
|
|
2482
1592
|
```typescript
|
|
2483
|
-
await client.
|
|
1593
|
+
await client.sync.runSync("sync_id");
|
|
2484
1594
|
```
|
|
2485
1595
|
|
|
2486
1596
|
</dd>
|
|
@@ -2496,7 +1606,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2496
1606
|
<dl>
|
|
2497
1607
|
<dd>
|
|
2498
1608
|
|
|
2499
|
-
**
|
|
1609
|
+
**syncId:** `string`
|
|
2500
1610
|
|
|
2501
1611
|
</dd>
|
|
2502
1612
|
</dl>
|
|
@@ -2504,7 +1614,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2504
1614
|
<dl>
|
|
2505
1615
|
<dd>
|
|
2506
1616
|
|
|
2507
|
-
**requestOptions:** `
|
|
1617
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2508
1618
|
|
|
2509
1619
|
</dd>
|
|
2510
1620
|
</dl>
|
|
@@ -2515,7 +1625,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2515
1625
|
</dl>
|
|
2516
1626
|
</details>
|
|
2517
1627
|
|
|
2518
|
-
<details><summary><code>client.
|
|
1628
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">listSyncJobs</a>(syncId) -> AirweaveSDK.SyncJob[]</code></summary>
|
|
2519
1629
|
<dl>
|
|
2520
1630
|
<dd>
|
|
2521
1631
|
|
|
@@ -2527,7 +1637,7 @@ await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
|
2527
1637
|
<dl>
|
|
2528
1638
|
<dd>
|
|
2529
1639
|
|
|
2530
|
-
|
|
1640
|
+
List all jobs for a specific sync.
|
|
2531
1641
|
|
|
2532
1642
|
</dd>
|
|
2533
1643
|
</dl>
|
|
@@ -2543,7 +1653,7 @@ Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
|
2543
1653
|
<dd>
|
|
2544
1654
|
|
|
2545
1655
|
```typescript
|
|
2546
|
-
await client.
|
|
1656
|
+
await client.sync.listSyncJobs("sync_id");
|
|
2547
1657
|
```
|
|
2548
1658
|
|
|
2549
1659
|
</dd>
|
|
@@ -2559,7 +1669,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2559
1669
|
<dl>
|
|
2560
1670
|
<dd>
|
|
2561
1671
|
|
|
2562
|
-
**
|
|
1672
|
+
**syncId:** `string`
|
|
2563
1673
|
|
|
2564
1674
|
</dd>
|
|
2565
1675
|
</dl>
|
|
@@ -2567,7 +1677,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2567
1677
|
<dl>
|
|
2568
1678
|
<dd>
|
|
2569
1679
|
|
|
2570
|
-
**requestOptions:** `
|
|
1680
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2571
1681
|
|
|
2572
1682
|
</dd>
|
|
2573
1683
|
</dl>
|
|
@@ -2578,7 +1688,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2578
1688
|
</dl>
|
|
2579
1689
|
</details>
|
|
2580
1690
|
|
|
2581
|
-
<details><summary><code>client.
|
|
1691
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">getSyncJob</a>(jobId, { ...params }) -> AirweaveSDK.SyncJob</code></summary>
|
|
2582
1692
|
<dl>
|
|
2583
1693
|
<dd>
|
|
2584
1694
|
|
|
@@ -2590,7 +1700,7 @@ await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
|
2590
1700
|
<dl>
|
|
2591
1701
|
<dd>
|
|
2592
1702
|
|
|
2593
|
-
|
|
1703
|
+
Get details of a specific sync job.
|
|
2594
1704
|
|
|
2595
1705
|
</dd>
|
|
2596
1706
|
</dl>
|
|
@@ -2606,7 +1716,9 @@ Exchange OAuth2 code for tokens and create connection.
|
|
|
2606
1716
|
<dd>
|
|
2607
1717
|
|
|
2608
1718
|
```typescript
|
|
2609
|
-
await client.
|
|
1719
|
+
await client.sync.getSyncJob("job_id", {
|
|
1720
|
+
syncId: "sync_id",
|
|
1721
|
+
});
|
|
2610
1722
|
```
|
|
2611
1723
|
|
|
2612
1724
|
</dd>
|
|
@@ -2622,7 +1734,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2622
1734
|
<dl>
|
|
2623
1735
|
<dd>
|
|
2624
1736
|
|
|
2625
|
-
**
|
|
1737
|
+
**jobId:** `string`
|
|
2626
1738
|
|
|
2627
1739
|
</dd>
|
|
2628
1740
|
</dl>
|
|
@@ -2630,7 +1742,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2630
1742
|
<dl>
|
|
2631
1743
|
<dd>
|
|
2632
1744
|
|
|
2633
|
-
**request:** `
|
|
1745
|
+
**request:** `AirweaveSDK.GetSyncJobSyncJobJobIdGetRequest`
|
|
2634
1746
|
|
|
2635
1747
|
</dd>
|
|
2636
1748
|
</dl>
|
|
@@ -2638,7 +1750,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2638
1750
|
<dl>
|
|
2639
1751
|
<dd>
|
|
2640
1752
|
|
|
2641
|
-
**requestOptions:** `
|
|
1753
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2642
1754
|
|
|
2643
1755
|
</dd>
|
|
2644
1756
|
</dl>
|
|
@@ -2649,7 +1761,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2649
1761
|
</dl>
|
|
2650
1762
|
</details>
|
|
2651
1763
|
|
|
2652
|
-
<details><summary><code>client.
|
|
1764
|
+
<details><summary><code>client.sync.<a href="/src/api/resources/sync/client/Client.ts">subscribeSyncJob</a>(jobId) -> unknown</code></summary>
|
|
2653
1765
|
<dl>
|
|
2654
1766
|
<dd>
|
|
2655
1767
|
|
|
@@ -2661,7 +1773,7 @@ await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string"
|
|
|
2661
1773
|
<dl>
|
|
2662
1774
|
<dd>
|
|
2663
1775
|
|
|
2664
|
-
|
|
1776
|
+
Server-Sent Events (SSE) endpoint to subscribe to a sync job's progress.
|
|
2665
1777
|
|
|
2666
1778
|
</dd>
|
|
2667
1779
|
</dl>
|
|
@@ -2677,7 +1789,7 @@ List all syncs for a specific white label.
|
|
|
2677
1789
|
<dd>
|
|
2678
1790
|
|
|
2679
1791
|
```typescript
|
|
2680
|
-
await client.
|
|
1792
|
+
await client.sync.subscribeSyncJob("job_id");
|
|
2681
1793
|
```
|
|
2682
1794
|
|
|
2683
1795
|
</dd>
|
|
@@ -2693,7 +1805,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2693
1805
|
<dl>
|
|
2694
1806
|
<dd>
|
|
2695
1807
|
|
|
2696
|
-
**
|
|
1808
|
+
**jobId:** `string`
|
|
2697
1809
|
|
|
2698
1810
|
</dd>
|
|
2699
1811
|
</dl>
|
|
@@ -2701,7 +1813,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2701
1813
|
<dl>
|
|
2702
1814
|
<dd>
|
|
2703
1815
|
|
|
2704
|
-
**requestOptions:** `
|
|
1816
|
+
**requestOptions:** `Sync.RequestOptions`
|
|
2705
1817
|
|
|
2706
1818
|
</dd>
|
|
2707
1819
|
</dl>
|
|
@@ -2712,9 +1824,9 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2712
1824
|
</dl>
|
|
2713
1825
|
</details>
|
|
2714
1826
|
|
|
2715
|
-
##
|
|
1827
|
+
## WhiteLabels
|
|
2716
1828
|
|
|
2717
|
-
<details><summary><code>client.
|
|
1829
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabels</a>() -> AirweaveSDK.WhiteLabel[]</code></summary>
|
|
2718
1830
|
<dl>
|
|
2719
1831
|
<dd>
|
|
2720
1832
|
|
|
@@ -2726,10 +1838,7 @@ await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
|
2726
1838
|
<dl>
|
|
2727
1839
|
<dd>
|
|
2728
1840
|
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
Returns:
|
|
2732
|
-
bool: True if the OpenAI API key is set, False otherwise.
|
|
1841
|
+
List all white labels for the current user's organization.
|
|
2733
1842
|
|
|
2734
1843
|
</dd>
|
|
2735
1844
|
</dl>
|
|
@@ -2745,7 +1854,7 @@ bool: True if the OpenAI API key is set, False otherwise.
|
|
|
2745
1854
|
<dd>
|
|
2746
1855
|
|
|
2747
1856
|
```typescript
|
|
2748
|
-
await client.
|
|
1857
|
+
await client.whiteLabels.listWhiteLabels();
|
|
2749
1858
|
```
|
|
2750
1859
|
|
|
2751
1860
|
</dd>
|
|
@@ -2761,7 +1870,7 @@ await client.chat.openaiKeySet();
|
|
|
2761
1870
|
<dl>
|
|
2762
1871
|
<dd>
|
|
2763
1872
|
|
|
2764
|
-
**requestOptions:** `
|
|
1873
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2765
1874
|
|
|
2766
1875
|
</dd>
|
|
2767
1876
|
</dl>
|
|
@@ -2772,7 +1881,7 @@ await client.chat.openaiKeySet();
|
|
|
2772
1881
|
</dl>
|
|
2773
1882
|
</details>
|
|
2774
1883
|
|
|
2775
|
-
<details><summary><code>client.
|
|
1884
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">createWhiteLabel</a>({ ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2776
1885
|
<dl>
|
|
2777
1886
|
<dd>
|
|
2778
1887
|
|
|
@@ -2784,7 +1893,7 @@ await client.chat.openaiKeySet();
|
|
|
2784
1893
|
<dl>
|
|
2785
1894
|
<dd>
|
|
2786
1895
|
|
|
2787
|
-
|
|
1896
|
+
Create new white label integration.
|
|
2788
1897
|
|
|
2789
1898
|
</dd>
|
|
2790
1899
|
</dl>
|
|
@@ -2800,7 +1909,13 @@ List all chats for the current user.
|
|
|
2800
1909
|
<dd>
|
|
2801
1910
|
|
|
2802
1911
|
```typescript
|
|
2803
|
-
await client.
|
|
1912
|
+
await client.whiteLabels.createWhiteLabel({
|
|
1913
|
+
name: "name",
|
|
1914
|
+
sourceShortName: "source_short_name",
|
|
1915
|
+
redirectUrl: "redirect_url",
|
|
1916
|
+
clientId: "client_id",
|
|
1917
|
+
clientSecret: "client_secret",
|
|
1918
|
+
});
|
|
2804
1919
|
```
|
|
2805
1920
|
|
|
2806
1921
|
</dd>
|
|
@@ -2816,7 +1931,7 @@ await client.chat.listChats();
|
|
|
2816
1931
|
<dl>
|
|
2817
1932
|
<dd>
|
|
2818
1933
|
|
|
2819
|
-
**request:** `AirweaveSDK.
|
|
1934
|
+
**request:** `AirweaveSDK.WhiteLabelCreate`
|
|
2820
1935
|
|
|
2821
1936
|
</dd>
|
|
2822
1937
|
</dl>
|
|
@@ -2824,7 +1939,7 @@ await client.chat.listChats();
|
|
|
2824
1939
|
<dl>
|
|
2825
1940
|
<dd>
|
|
2826
1941
|
|
|
2827
|
-
**requestOptions:** `
|
|
1942
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2828
1943
|
|
|
2829
1944
|
</dd>
|
|
2830
1945
|
</dl>
|
|
@@ -2835,7 +1950,7 @@ await client.chat.listChats();
|
|
|
2835
1950
|
</dl>
|
|
2836
1951
|
</details>
|
|
2837
1952
|
|
|
2838
|
-
<details><summary><code>client.
|
|
1953
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2839
1954
|
<dl>
|
|
2840
1955
|
<dd>
|
|
2841
1956
|
|
|
@@ -2847,7 +1962,7 @@ await client.chat.listChats();
|
|
|
2847
1962
|
<dl>
|
|
2848
1963
|
<dd>
|
|
2849
1964
|
|
|
2850
|
-
|
|
1965
|
+
Get a specific white label integration.
|
|
2851
1966
|
|
|
2852
1967
|
</dd>
|
|
2853
1968
|
</dl>
|
|
@@ -2863,10 +1978,7 @@ Create a new chat.
|
|
|
2863
1978
|
<dd>
|
|
2864
1979
|
|
|
2865
1980
|
```typescript
|
|
2866
|
-
await client.
|
|
2867
|
-
name: "name",
|
|
2868
|
-
syncId: "sync_id",
|
|
2869
|
-
});
|
|
1981
|
+
await client.whiteLabels.getWhiteLabel("white_label_id");
|
|
2870
1982
|
```
|
|
2871
1983
|
|
|
2872
1984
|
</dd>
|
|
@@ -2882,7 +1994,7 @@ await client.chat.createChat({
|
|
|
2882
1994
|
<dl>
|
|
2883
1995
|
<dd>
|
|
2884
1996
|
|
|
2885
|
-
**
|
|
1997
|
+
**whiteLabelId:** `string`
|
|
2886
1998
|
|
|
2887
1999
|
</dd>
|
|
2888
2000
|
</dl>
|
|
@@ -2890,7 +2002,7 @@ await client.chat.createChat({
|
|
|
2890
2002
|
<dl>
|
|
2891
2003
|
<dd>
|
|
2892
2004
|
|
|
2893
|
-
**requestOptions:** `
|
|
2005
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2894
2006
|
|
|
2895
2007
|
</dd>
|
|
2896
2008
|
</dl>
|
|
@@ -2901,7 +2013,7 @@ await client.chat.createChat({
|
|
|
2901
2013
|
</dl>
|
|
2902
2014
|
</details>
|
|
2903
2015
|
|
|
2904
|
-
<details><summary><code>client.
|
|
2016
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">updateWhiteLabel</a>(whiteLabelId, { ...params }) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2905
2017
|
<dl>
|
|
2906
2018
|
<dd>
|
|
2907
2019
|
|
|
@@ -2913,7 +2025,7 @@ await client.chat.createChat({
|
|
|
2913
2025
|
<dl>
|
|
2914
2026
|
<dd>
|
|
2915
2027
|
|
|
2916
|
-
|
|
2028
|
+
Update a white label integration.
|
|
2917
2029
|
|
|
2918
2030
|
</dd>
|
|
2919
2031
|
</dl>
|
|
@@ -2929,7 +2041,7 @@ Get a specific chat by ID.
|
|
|
2929
2041
|
<dd>
|
|
2930
2042
|
|
|
2931
2043
|
```typescript
|
|
2932
|
-
await client.
|
|
2044
|
+
await client.whiteLabels.updateWhiteLabel("white_label_id");
|
|
2933
2045
|
```
|
|
2934
2046
|
|
|
2935
2047
|
</dd>
|
|
@@ -2945,7 +2057,15 @@ await client.chat.getChat("chat_id");
|
|
|
2945
2057
|
<dl>
|
|
2946
2058
|
<dd>
|
|
2947
2059
|
|
|
2948
|
-
**
|
|
2060
|
+
**whiteLabelId:** `string`
|
|
2061
|
+
|
|
2062
|
+
</dd>
|
|
2063
|
+
</dl>
|
|
2064
|
+
|
|
2065
|
+
<dl>
|
|
2066
|
+
<dd>
|
|
2067
|
+
|
|
2068
|
+
**request:** `AirweaveSDK.WhiteLabelUpdate`
|
|
2949
2069
|
|
|
2950
2070
|
</dd>
|
|
2951
2071
|
</dl>
|
|
@@ -2953,7 +2073,7 @@ await client.chat.getChat("chat_id");
|
|
|
2953
2073
|
<dl>
|
|
2954
2074
|
<dd>
|
|
2955
2075
|
|
|
2956
|
-
**requestOptions:** `
|
|
2076
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
2957
2077
|
|
|
2958
2078
|
</dd>
|
|
2959
2079
|
</dl>
|
|
@@ -2964,7 +2084,7 @@ await client.chat.getChat("chat_id");
|
|
|
2964
2084
|
</dl>
|
|
2965
2085
|
</details>
|
|
2966
2086
|
|
|
2967
|
-
<details><summary><code>client.
|
|
2087
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">deleteWhiteLabel</a>(whiteLabelId) -> AirweaveSDK.WhiteLabel</code></summary>
|
|
2968
2088
|
<dl>
|
|
2969
2089
|
<dd>
|
|
2970
2090
|
|
|
@@ -2976,7 +2096,7 @@ await client.chat.getChat("chat_id");
|
|
|
2976
2096
|
<dl>
|
|
2977
2097
|
<dd>
|
|
2978
2098
|
|
|
2979
|
-
|
|
2099
|
+
Delete a white label integration.
|
|
2980
2100
|
|
|
2981
2101
|
</dd>
|
|
2982
2102
|
</dl>
|
|
@@ -2992,7 +2112,7 @@ Update a chat.
|
|
|
2992
2112
|
<dd>
|
|
2993
2113
|
|
|
2994
2114
|
```typescript
|
|
2995
|
-
await client.
|
|
2115
|
+
await client.whiteLabels.deleteWhiteLabel("white_label_id");
|
|
2996
2116
|
```
|
|
2997
2117
|
|
|
2998
2118
|
</dd>
|
|
@@ -3008,15 +2128,7 @@ await client.chat.updateChat("chat_id");
|
|
|
3008
2128
|
<dl>
|
|
3009
2129
|
<dd>
|
|
3010
2130
|
|
|
3011
|
-
**
|
|
3012
|
-
|
|
3013
|
-
</dd>
|
|
3014
|
-
</dl>
|
|
3015
|
-
|
|
3016
|
-
<dl>
|
|
3017
|
-
<dd>
|
|
3018
|
-
|
|
3019
|
-
**request:** `AirweaveSDK.ChatUpdate`
|
|
2131
|
+
**whiteLabelId:** `string`
|
|
3020
2132
|
|
|
3021
2133
|
</dd>
|
|
3022
2134
|
</dl>
|
|
@@ -3024,7 +2136,7 @@ await client.chat.updateChat("chat_id");
|
|
|
3024
2136
|
<dl>
|
|
3025
2137
|
<dd>
|
|
3026
2138
|
|
|
3027
|
-
**requestOptions:** `
|
|
2139
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3028
2140
|
|
|
3029
2141
|
</dd>
|
|
3030
2142
|
</dl>
|
|
@@ -3035,7 +2147,7 @@ await client.chat.updateChat("chat_id");
|
|
|
3035
2147
|
</dl>
|
|
3036
2148
|
</details>
|
|
3037
2149
|
|
|
3038
|
-
<details><summary><code>client.
|
|
2150
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">getWhiteLabelOauth2AuthUrl</a>(whiteLabelId) -> string</code></summary>
|
|
3039
2151
|
<dl>
|
|
3040
2152
|
<dd>
|
|
3041
2153
|
|
|
@@ -3047,7 +2159,7 @@ await client.chat.updateChat("chat_id");
|
|
|
3047
2159
|
<dl>
|
|
3048
2160
|
<dd>
|
|
3049
2161
|
|
|
3050
|
-
|
|
2162
|
+
Generate the OAuth2 authorization URL by delegating to oauth2_service.
|
|
3051
2163
|
|
|
3052
2164
|
</dd>
|
|
3053
2165
|
</dl>
|
|
@@ -3063,7 +2175,7 @@ Archive a chat.
|
|
|
3063
2175
|
<dd>
|
|
3064
2176
|
|
|
3065
2177
|
```typescript
|
|
3066
|
-
await client.
|
|
2178
|
+
await client.whiteLabels.getWhiteLabelOauth2AuthUrl("white_label_id");
|
|
3067
2179
|
```
|
|
3068
2180
|
|
|
3069
2181
|
</dd>
|
|
@@ -3079,7 +2191,7 @@ await client.chat.deleteChat("chat_id");
|
|
|
3079
2191
|
<dl>
|
|
3080
2192
|
<dd>
|
|
3081
2193
|
|
|
3082
|
-
**
|
|
2194
|
+
**whiteLabelId:** `string`
|
|
3083
2195
|
|
|
3084
2196
|
</dd>
|
|
3085
2197
|
</dl>
|
|
@@ -3087,7 +2199,7 @@ await client.chat.deleteChat("chat_id");
|
|
|
3087
2199
|
<dl>
|
|
3088
2200
|
<dd>
|
|
3089
2201
|
|
|
3090
|
-
**requestOptions:** `
|
|
2202
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3091
2203
|
|
|
3092
2204
|
</dd>
|
|
3093
2205
|
</dl>
|
|
@@ -3098,7 +2210,7 @@ await client.chat.deleteChat("chat_id");
|
|
|
3098
2210
|
</dl>
|
|
3099
2211
|
</details>
|
|
3100
2212
|
|
|
3101
|
-
<details><summary><code>client.
|
|
2213
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">exchangeWhiteLabelOauth2Code</a>(whiteLabelId, { ...params }) -> AirweaveSDK.Connection</code></summary>
|
|
3102
2214
|
<dl>
|
|
3103
2215
|
<dd>
|
|
3104
2216
|
|
|
@@ -3110,7 +2222,7 @@ await client.chat.deleteChat("chat_id");
|
|
|
3110
2222
|
<dl>
|
|
3111
2223
|
<dd>
|
|
3112
2224
|
|
|
3113
|
-
|
|
2225
|
+
Exchange OAuth2 code for tokens and create connection.
|
|
3114
2226
|
|
|
3115
2227
|
</dd>
|
|
3116
2228
|
</dl>
|
|
@@ -3126,9 +2238,7 @@ Send a message to a chat.
|
|
|
3126
2238
|
<dd>
|
|
3127
2239
|
|
|
3128
2240
|
```typescript
|
|
3129
|
-
await client.
|
|
3130
|
-
content: "content",
|
|
3131
|
-
});
|
|
2241
|
+
await client.whiteLabels.exchangeWhiteLabelOauth2Code("white_label_id", "string");
|
|
3132
2242
|
```
|
|
3133
2243
|
|
|
3134
2244
|
</dd>
|
|
@@ -3144,7 +2254,7 @@ await client.chat.sendMessage("chat_id", {
|
|
|
3144
2254
|
<dl>
|
|
3145
2255
|
<dd>
|
|
3146
2256
|
|
|
3147
|
-
**
|
|
2257
|
+
**whiteLabelId:** `string`
|
|
3148
2258
|
|
|
3149
2259
|
</dd>
|
|
3150
2260
|
</dl>
|
|
@@ -3152,7 +2262,7 @@ await client.chat.sendMessage("chat_id", {
|
|
|
3152
2262
|
<dl>
|
|
3153
2263
|
<dd>
|
|
3154
2264
|
|
|
3155
|
-
**request:** `
|
|
2265
|
+
**request:** `string`
|
|
3156
2266
|
|
|
3157
2267
|
</dd>
|
|
3158
2268
|
</dl>
|
|
@@ -3160,7 +2270,7 @@ await client.chat.sendMessage("chat_id", {
|
|
|
3160
2270
|
<dl>
|
|
3161
2271
|
<dd>
|
|
3162
2272
|
|
|
3163
|
-
**requestOptions:** `
|
|
2273
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3164
2274
|
|
|
3165
2275
|
</dd>
|
|
3166
2276
|
</dl>
|
|
@@ -3171,7 +2281,7 @@ await client.chat.sendMessage("chat_id", {
|
|
|
3171
2281
|
</dl>
|
|
3172
2282
|
</details>
|
|
3173
2283
|
|
|
3174
|
-
<details><summary><code>client.
|
|
2284
|
+
<details><summary><code>client.whiteLabels.<a href="/src/api/resources/whiteLabels/client/Client.ts">listWhiteLabelSyncs</a>(whiteLabelId) -> AirweaveSDK.Sync[]</code></summary>
|
|
3175
2285
|
<dl>
|
|
3176
2286
|
<dd>
|
|
3177
2287
|
|
|
@@ -3183,7 +2293,7 @@ await client.chat.sendMessage("chat_id", {
|
|
|
3183
2293
|
<dl>
|
|
3184
2294
|
<dd>
|
|
3185
2295
|
|
|
3186
|
-
|
|
2296
|
+
List all syncs for a specific white label.
|
|
3187
2297
|
|
|
3188
2298
|
</dd>
|
|
3189
2299
|
</dl>
|
|
@@ -3199,7 +2309,7 @@ Stream an AI response for a chat message.
|
|
|
3199
2309
|
<dd>
|
|
3200
2310
|
|
|
3201
2311
|
```typescript
|
|
3202
|
-
await client.
|
|
2312
|
+
await client.whiteLabels.listWhiteLabelSyncs("white_label_id");
|
|
3203
2313
|
```
|
|
3204
2314
|
|
|
3205
2315
|
</dd>
|
|
@@ -3215,7 +2325,7 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3215
2325
|
<dl>
|
|
3216
2326
|
<dd>
|
|
3217
2327
|
|
|
3218
|
-
**
|
|
2328
|
+
**whiteLabelId:** `string`
|
|
3219
2329
|
|
|
3220
2330
|
</dd>
|
|
3221
2331
|
</dl>
|
|
@@ -3223,7 +2333,7 @@ await client.chat.streamChatResponse("chat_id");
|
|
|
3223
2333
|
<dl>
|
|
3224
2334
|
<dd>
|
|
3225
2335
|
|
|
3226
|
-
**requestOptions:** `
|
|
2336
|
+
**requestOptions:** `WhiteLabels.RequestOptions`
|
|
3227
2337
|
|
|
3228
2338
|
</dd>
|
|
3229
2339
|
</dl>
|